view launcher/src/test/java/com/redhat/thermostat/launcher/internal/DependencyManagerTest.java @ 2573:006ac47d1506

Fix Version Checks in Dependency Analysis Fixes the dependency analysis code in Launcher and the Dependency analyzer command - Parses version strings from the OSGI manifest - When building the dependency graph, ensures that the correct versions of each bundle are used Reviewed-by: neugens, jkang Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2016-December/021832.html
author Joshua Matsuoka <jmatsuok@redhat.com>
date Thu, 26 Jan 2017 12:14:51 -0500
parents e7fd8adb5f9c
children
line wrap: on
line source

/*
 * Copyright 2012-2017 Red Hat, Inc.
 *
 * This file is part of Thermostat.
 *
 * Thermostat is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published
 * by the Free Software Foundation; either version 2, or (at your
 * option) any later version.
 *
 * Thermostat is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Thermostat; see the file COPYING.  If not see
 * <http://www.gnu.org/licenses/>.
 *
 * Linking this code with other modules is making a combined work
 * based on this code.  Thus, the terms and conditions of the GNU
 * General Public License cover the whole combination.
 *
 * As a special exception, the copyright holders of this code give
 * you permission to link this code with independent modules to
 * produce an executable, regardless of the license terms of these
 * independent modules, and to copy and distribute the resulting
 * executable under terms of your choice, provided that you also
 * meet, for each linked independent module, the terms and conditions
 * of the license of that module.  An independent module is a module
 * which is not derived from or based on this code.  If you modify
 * this code, you may extend this exception to your version of the
 * library, but you are not obligated to do so.  If you do not wish
 * to do so, delete this exception statement from your version.
 */

package com.redhat.thermostat.launcher.internal;

import com.redhat.thermostat.launcher.BundleInformation;
import com.redhat.thermostat.shared.config.CommonPaths;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.mockito.Mockito;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.FileVisitResult;
import java.nio.file.FileVisitor;
import java.nio.file.attribute.BasicFileAttributes;
import java.util.ArrayList;
import java.util.jar.Attributes;
import java.util.jar.JarOutputStream;
import java.util.jar.Manifest;
import java.util.List;

import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.when;
import static org.junit.Assert.assertEquals;

public class DependencyManagerTest {

    private DependencyManager depManager;
    private File underneathTheBridge;
    private File userPluginRoot;
    private File systemPluginRoot;

    @Before
    public void setUp() throws Exception {
        CommonPaths paths = Mockito.mock(CommonPaths.class);
        userPluginRoot = Files.createTempDirectory("userPluginRoot").toFile();
        systemPluginRoot = Files.createTempDirectory("systemPluginRoot").toFile();
        try {
            underneathTheBridge = Files.createTempDirectory("underneathTheBridge").toFile();
        } catch (IOException e) {
            e.printStackTrace();
        }
        underneathTheBridge.deleteOnExit();
        userPluginRoot.deleteOnExit();
        systemPluginRoot.deleteOnExit();
        createJar("Bundle1", "com.redhat.thermostat.bundle1;version=\"1.1.1\",com.redhat.thermostat.bundle1.package1;version=\"1.1.1\",com.redhat.thermostat.bundle1.package2;version=\"1.1.2\"", "", "1.1.1", underneathTheBridge.toPath());
        createJar("Bundle2", "com.redhat.thermostat.bundle2;version=\"1.1.1\",com.redhat.thermostat.bundle2.package1;version=\"1.1.1\",com.redhat.thermostat.bundle2.package2;version=\"1.1.3\"", "com.redhat.thermostat.bundle1;version=\"[1,2)\"", "1.1.1", underneathTheBridge.toPath());
        createJar("Bundle3", "com.redhat.thermostat.bundle3;version=\"2.1.0\",com.redhat.thermostat.bundle3.package1;version=\"2.1.1\",com.redhat.thermostat.bundle3.package4;version=\"2.1.2\"", "com.redhat.thermostat.bundle1;version=\"[1.1.1,1.1.2)\",com.redhat.thermostat.bundle2.package1;version=\"[1.1.1,1.1.2)\"", "2.1.0", underneathTheBridge.toPath());
        createJar("Bundle4-9.1.0", "com.redhat.thermostat.bundle4;version=\"9.1.0\",com.redhat.thermostat.bundle4.package1;version=\"9.1.0\",com.redhat.thermostat.bundle4.package2;version=\"9.1.0\"", "com.redhat.thermostat.bundle1,com.redhat.thermostat.bundle2.package1;version=\"1.1.1\",com.redhat.thermostat.bundle3.package4;version=\"[2,3)\"", "9.1.0", underneathTheBridge.toPath());
        createJar("Bundle4-9.1.3", "com.redhat.thermostat.bundle4;version=\"9.1.3\",com.redhat.thermostat.bundle4.package1;version=\"9.1.3\",com.redhat.thermostat.bundle4.package2;version=\"9.1.3\"", "com.redhat.thermostat.bundle1,com.redhat.thermostat.bundle2.package1;version=\"1.1.1\",com.redhat.thermostat.bundle3.package4;version=\"[2,3)\"", "9.1.3", underneathTheBridge.toPath());
        createJar("Bundle4-9.3", "com.redhat.thermostat.bundle4;version=\"9.3\",com.redhat.thermostat.bundle4.package1;version=\"9.3\",com.redhat.thermostat.bundle4.package2;version=\"9.3\"", "com.redhat.thermostat.bundle1,com.redhat.thermostat.bundle2.package1;version=\"1.1.1\",com.redhat.thermostat.bundle3.package4;version=\"[2,3)\"", "9.3", underneathTheBridge.toPath());
        createJar("Bundle5", "com.redhat.thermostat.bundle5;version=\"1.1\"", "com.redhat.thermostat.bundle4.package1;version=\"[9.1.3,9.1.4)\"", "1.1", userPluginRoot.toPath());
        createJar("Bundle6", "com.redhat.thermostat.bundle6;version=\"13.1\"", "com.redhat.thermostat.bundle4;version=\"[9.2,10)\"", "13.1", userPluginRoot.toPath());
        createJar("Bundle7", "com.redhat.thermostat.bundle7;version=\"1.0\"", "com.redhat.thermostat.bundle1;version=\"3.1\",com.redhat.thermostat.bundle2;version=\"9.9.9\",com.redhat.thermostat.bundle4;version=\"[10,11]\"", "1.0", userPluginRoot.toPath());
        createJar("Bundle8", "com.redhat.thermostat.bundle8;version=\"1.0\",com.redhat.thermostat.framework;version=\"4.2.0\"", "", "1.0", userPluginRoot.toPath());
        createJar("Bundle9", "com.redhat.thermostat.bundle9;version=\"1.0\"", "com.redhat.thermostat.framework;version=\"4.2.0\"", "1.0", userPluginRoot.toPath());

        createJar("Cycle-1", "cycle1;version=\"1.0\"", "cycle2;version=\"1.0\"", "1.0", underneathTheBridge.toPath());
        createJar("Cycle-2", "cycle2;version=\"1.0\"", "cycle3;version=\"1.0\"", "1.0", underneathTheBridge.toPath());
        createJar("Cycle-3", "cycle3;version=\"1.0\"", "cycle1;version=\"1.0\"", "1.0", underneathTheBridge.toPath());
        createJar("Cycle-Connector", "cycle4;version=\"1.0\"", "cycle1;version=\"1.0\"", "1.0", underneathTheBridge.toPath());
        when(paths.getUserPluginRoot()).thenReturn(userPluginRoot);
        when(paths.getSystemPluginRoot()).thenReturn(systemPluginRoot);
        when(paths.getSystemLibRoot()).thenReturn(underneathTheBridge);
        depManager = new DependencyManager(paths);
    }

    @After
    public void tearDown() {
        try {
            deleteDirectory(underneathTheBridge.toPath());
            deleteDirectory(userPluginRoot.toPath());
            deleteDirectory(systemPluginRoot.toPath());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    @Test
    public void testBundleWithNoDependencies() {
        ArrayList<BundleInformation> results = new ArrayList<>(depManager.getDependencies(new BundleInformation("Bundle1", "1.1.1")));
        assertEquals(0, results.size());
    }

    @Test
    public void testDependencySearch() {
        ArrayList<BundleInformation> results = new ArrayList<>(depManager.getDependencies(new BundleInformation("Bundle4-9.1.0", "9.1.0")));
        assertEquals("Bundle4-9.1.0", results.get(0).getName());
        assertEquals("9.1.0", results.get(0).getVersion());
        assertEquals("Bundle3", results.get(1).getName());
        assertEquals("2.1.0", results.get(1).getVersion());
        assertEquals("Bundle2", results.get(2).getName());
        assertEquals("1.1.1", results.get(2).getVersion());
        assertEquals("Bundle1", results.get(3).getName());
        assertEquals("1.1.1", results.get(3).getVersion());
    }

    @Test
    public void testVersionDependency() {
        ArrayList<BundleInformation> results = new ArrayList<>(depManager.getDependencies(new BundleInformation("Bundle5", "1.1")));
        assertEquals("Bundle5", results.get(0).getName());
        assertEquals("1.1", results.get(0).getVersion());
        assertEquals("Bundle4-9.1.3", results.get(1).getName());
        assertEquals("9.1.3", results.get(1).getVersion());
        assertEquals("Bundle3", results.get(2).getName());
        assertEquals("2.1.0", results.get(2).getVersion());
        assertEquals("Bundle2", results.get(3).getName());
        assertEquals("1.1.1", results.get(3).getVersion());
        assertEquals("Bundle1", results.get(4).getName());
        assertEquals("1.1.1", results.get(4).getVersion());
    }

    @Test
    public void testVersionDependency2() {
        ArrayList<BundleInformation> results = new ArrayList<>(depManager.getDependencies(new BundleInformation("Bundle6", "13.1")));
        assertEquals("Bundle6", results.get(0).getName());
        assertEquals("13.1", results.get(0).getVersion());
        assertEquals("Bundle4-9.3", results.get(1).getName());
        assertEquals("9.3", results.get(1).getVersion());
        assertEquals("Bundle3", results.get(2).getName());
        assertEquals("2.1.0", results.get(2).getVersion());
        assertEquals("Bundle2", results.get(3).getName());
        assertEquals("1.1.1", results.get(3).getVersion());
        assertEquals("Bundle1", results.get(4).getName());
        assertEquals("1.1.1", results.get(4).getVersion());
    }

    @Test
    public void testMissingVersion() {
        ArrayList<BundleInformation> results = new ArrayList<>(depManager.getDependencies(new BundleInformation("Bundle7", "1.0")));
        assertEquals(0, results.size());
    }

    @Test
    public void testNonExistentDependency() {
        List<BundleInformation> bundles = depManager.getDependencies(new BundleInformation("blob", "1.x"));
        assertEquals(0, bundles.size());
    }

    /**
     * The file visitor should scan system and user plugin roots
     * recursively however it should not scan system lib root recursively.
     */
    @Test
    public void testScannedLocations() {
        CommonPaths paths = mock(CommonPaths.class);
        File systemLibRoot = mock(File.class);
        File[] libContents = {underneathTheBridge};
        when(paths.getUserPluginRoot()).thenReturn(userPluginRoot);
        when(paths.getSystemPluginRoot()).thenReturn(systemPluginRoot);
        when(paths.getSystemLibRoot()).thenReturn(systemLibRoot);
        when(systemLibRoot.listFiles()).thenReturn(libContents);
        DependencyManager testManager = new DependencyManager(paths);
        Mockito.verify(systemLibRoot, times(1)).listFiles();
        assertEquals(3, testManager.getLocations().size());
        assertEquals(systemPluginRoot.toPath(), testManager.getLocations().get(0));
        assertEquals(userPluginRoot.toPath(), testManager.getLocations().get(1));
        assertEquals(underneathTheBridge.toPath(), testManager.getLocations().get(2));
    }

    @Test (expected = IllegalStateException.class)
    public void testInvalidStart() {
        ArrayList<BundleInformation> result = new ArrayList<>(depManager.getDependencies(new BundleInformation("Cycle-1", "1.0")));
    }

    @Test (expected = IllegalStateException.class)
    public void testCycle() {
        ArrayList<BundleInformation> result = new ArrayList<>(depManager.getDependencies(new BundleInformation("Cycle-Connector", "1.0")));
    }

    private Path createJar(String name, String exportsDirective, String importDirective, String version, Path base) throws Exception {
        Manifest manifest = new Manifest();
        manifest.getMainAttributes().put(Attributes.Name.MANIFEST_VERSION, version);
        manifest.getMainAttributes().put(new Attributes.Name("Export-Package"), exportsDirective + ";");
        if (importDirective != null) {
            manifest.getMainAttributes().put(new Attributes.Name("Import-Package"), importDirective + ";");
        }
        Path path = Paths.get(base.toFile().getAbsoluteFile() + "/" + name + ".jar");
        manifest.getMainAttributes().put(new Attributes.Name("Bundle-SymbolicName"), name);
        manifest.getMainAttributes().put(new Attributes.Name("Bundle-Version"), version);
        FileOutputStream stream = new FileOutputStream(path.toFile());
        JarOutputStream target = new JarOutputStream(stream, manifest);
        target.close();
        return path;
    }

    void deleteDirectory(Path dir) throws IOException {
        Files.walkFileTree(dir, new FileVisitor<Path>() {

            @Override
            public FileVisitResult preVisitDirectory(Path dir,
                                                     BasicFileAttributes attrs) throws IOException {
                return FileVisitResult.CONTINUE;
            }

            @Override
            public FileVisitResult visitFile(Path file,
                                             BasicFileAttributes attrs) throws IOException {
                Files.delete(file);
                return FileVisitResult.CONTINUE;
            }

            @Override
            public FileVisitResult visitFileFailed(Path file, IOException exc)
                    throws IOException {
                exc.printStackTrace();
                return FileVisitResult.CONTINUE;
            }

            @Override
            public FileVisitResult postVisitDirectory(Path dir, IOException exc)
                    throws IOException {
                Files.delete(dir);
                return FileVisitResult.CONTINUE;
            }
        });
    }
}