Add unit test and test helpers for BundleLoader

4 files changed, 266 insertions, 0 deletions

diff --git a/container-core/src/test/java/com/yahoo/container/core/config/BundleLoaderTest.java b/container-core/src/test/java/com/yahoo/container/core/config/BundleLoaderTest.java
new file mode 100644
index 00000000000..e5939ba7b30
--- /dev/null
+++ b/container-core/src/test/java/com/yahoo/container/core/config/BundleLoaderTest.java
@@ -0,0 +1,90 @@
+package com.yahoo.container.core.config;
+
+import com.yahoo.config.FileReference;
+import org.junit.Before;
+import org.junit.Test;
+import org.osgi.framework.Bundle;
+
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+
+/**
+ * @author gjoranv
+ */
+public class BundleLoaderTest {
+
+    private static final FileReference BUNDLE_1_REF = new FileReference("bundle-1");
+    private static final Bundle BUNDLE_1 = new TestBundle(BUNDLE_1_REF.value());
+    private static final FileReference BUNDLE_2_REF = new FileReference("bundle-2");
+    private static final Bundle BUNDLE_2 = new TestBundle(BUNDLE_2_REF.value());
+
+    private BundleLoader bundleLoader;
+    private TestOsgi osgi;
+
+    @Before
+    public void setup() {
+        osgi = new TestOsgi(testBundles());
+        var bundleInstaller = new TestBundleInstaller();
+        bundleLoader = new BundleLoader(osgi);
+        bundleLoader.useCustomBundleInstaller(bundleInstaller);
+    }
+
+    @Test
+    public void bundles_are_installed_and_started() {
+        bundleLoader.use(List.of(BUNDLE_1_REF));
+        assertEquals(1, osgi.getInstalledBundles().size());
+
+        TestBundle installedBundle = (TestBundle)osgi.getInstalledBundles().get(0);
+        assertEquals(BUNDLE_1.getSymbolicName(), installedBundle.getSymbolicName());
+        assertTrue(installedBundle.started);
+    }
+
+    @Test
+    public void new_bundle_can_be_installed_in_reconfig() {
+        bundleLoader.use(List.of(BUNDLE_1_REF));
+        Set<Bundle> obsoleteBundles = bundleLoader.use(List.of(BUNDLE_1_REF, BUNDLE_2_REF));
+
+        // No bundles are obsolete
+        assertTrue(obsoleteBundles.isEmpty());
+
+        // Both bundles are installed
+        assertEquals(2, osgi.getInstalledBundles().size());
+        assertEquals(BUNDLE_1.getSymbolicName(), osgi.getInstalledBundles().get(0).getSymbolicName());
+        assertEquals(BUNDLE_2.getSymbolicName(), osgi.getInstalledBundles().get(1).getSymbolicName());
+
+        // Both bundles are current
+        assertEquals(2, osgi.getCurrentBundles().size());
+        assertEquals(BUNDLE_1.getSymbolicName(), osgi.getCurrentBundles().get(0).getSymbolicName());
+        assertEquals(BUNDLE_2.getSymbolicName(), osgi.getCurrentBundles().get(1).getSymbolicName());
+    }
+
+    @Test
+    public void unused_bundle_is_marked_obsolete_after_reconfig() {
+        bundleLoader.use(List.of(BUNDLE_1_REF));
+        Set<Bundle> obsoleteBundles = bundleLoader.use(List.of(BUNDLE_2_REF));
+
+        // The returned set of obsolete bundles contains bundle-1
+        assertEquals(1, obsoleteBundles.size());
+        assertEquals(BUNDLE_1.getSymbolicName(), obsoleteBundles.iterator().next().getSymbolicName());
+
+        // Both bundles are installed
+        assertEquals(2, osgi.getInstalledBundles().size());
+        assertEquals(BUNDLE_1.getSymbolicName(), osgi.getInstalledBundles().get(0).getSymbolicName());
+        assertEquals(BUNDLE_2.getSymbolicName(), osgi.getInstalledBundles().get(1).getSymbolicName());
+
+        // Only bundle-2 is current
+        assertEquals(1, osgi.getCurrentBundles().size());
+        assertEquals(BUNDLE_2.getSymbolicName(), osgi.getCurrentBundles().get(0).getSymbolicName());
+    }
+
+
+    private static Map<String, Bundle> testBundles() {
+        return Map.of(BUNDLE_1_REF.value(), BUNDLE_1,
+                      BUNDLE_2_REF.value(), BUNDLE_2);
+    }
+
+}
diff --git a/container-core/src/test/java/com/yahoo/container/core/config/TestBundle.java b/container-core/src/test/java/com/yahoo/container/core/config/TestBundle.java
new file mode 100644
index 00000000000..b85ce786c9a
--- /dev/null
+++ b/container-core/src/test/java/com/yahoo/container/core/config/TestBundle.java
@@ -0,0 +1,101 @@
+package com.yahoo.container.core.config;
+
+import com.yahoo.container.bundle.MockBundle;
+import org.osgi.framework.Bundle;
+import org.osgi.framework.Version;
+import org.osgi.framework.wiring.BundleCapability;
+import org.osgi.framework.wiring.BundleRequirement;
+import org.osgi.framework.wiring.BundleRevision;
+import org.osgi.framework.wiring.BundleWiring;
+import org.osgi.resource.Capability;
+import org.osgi.resource.Requirement;
+
+import java.util.List;
+
+/**
+ * @author gjoranv
+ */
+class TestBundle extends MockBundle {
+
+    private static final BundleRevision revision = new TestBundleRevision();
+
+    private final String symbolicName;
+
+    boolean started = false;
+
+    TestBundle(String symbolicName) {
+        this.symbolicName = symbolicName;
+    }
+
+    @Override
+    public void start() {
+        started = true;
+    }
+
+    @Override
+    public String getSymbolicName() {
+        return symbolicName;
+    }
+
+
+    @SuppressWarnings("unchecked")
+    @Override
+    public <T> T adapt(Class<T> type) {
+        if (type.equals(BundleRevision.class)) {
+            return (T) revision;
+        } else {
+            throw new UnsupportedOperationException();
+        }
+    }
+
+
+    static class TestBundleRevision implements BundleRevision {
+
+        // Ensure this is not seen as a fragment bundle.
+        @Override
+        public int getTypes() {
+            return 0;
+        }
+
+        @Override
+        public String getSymbolicName() {
+            throw new UnsupportedOperationException();
+        }
+
+        @Override
+        public Version getVersion() {
+            throw new UnsupportedOperationException();
+        }
+
+        @Override
+        public List<BundleCapability> getDeclaredCapabilities(String namespace) {
+            throw new UnsupportedOperationException();
+        }
+
+        @Override
+        public List<BundleRequirement> getDeclaredRequirements(String namespace) {
+            throw new UnsupportedOperationException();
+        }
+
+        @Override
+        public BundleWiring getWiring() {
+            throw new UnsupportedOperationException();
+        }
+
+        @Override
+        public List<Capability> getCapabilities(String namespace) {
+            throw new UnsupportedOperationException();
+        }
+
+        @Override
+        public List<Requirement> getRequirements(String namespace) {
+            throw new UnsupportedOperationException();
+        }
+
+        @Override
+        public Bundle getBundle() {
+            throw new UnsupportedOperationException();
+        }
+    }
+
+}
diff --git a/container-core/src/test/java/com/yahoo/container/core/config/TestBundleInstaller.java b/container-core/src/test/java/com/yahoo/container/core/config/TestBundleInstaller.java
new file mode 100644
index 00000000000..81a8fdce2ce
--- /dev/null
+++ b/container-core/src/test/java/com/yahoo/container/core/config/TestBundleInstaller.java
@@ -0,0 +1,19 @@
+package com.yahoo.container.core.config;
+
+import com.yahoo.config.FileReference;
+import com.yahoo.osgi.Osgi;
+import org.osgi.framework.Bundle;
+
+import java.util.List;
+
+/**
+ * @author gjoranv
+ */
+class TestBundleInstaller implements BundleInstaller {
+
+    @Override
+    public List<Bundle> installBundles(FileReference reference, Osgi osgi) {
+        return osgi.install(reference.value());
+    }
+
+}
diff --git a/container-core/src/test/java/com/yahoo/container/core/config/TestOsgi.java b/container-core/src/test/java/com/yahoo/container/core/config/TestOsgi.java
new file mode 100644
index 00000000000..004e3835ad9
--- /dev/null
+++ b/container-core/src/test/java/com/yahoo/container/core/config/TestOsgi.java
@@ -0,0 +1,56 @@
+package com.yahoo.container.core.config;
+
+import com.yahoo.osgi.MockOsgi;
+import org.osgi.framework.Bundle;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * @author gjoranv
+ */
+class TestOsgi extends MockOsgi {
+
+    private final Map<String, Bundle> availableBundles;
+
+    private final List<Bundle> installedBundles = new ArrayList<>();
+    private final List<Bundle> allowedDuplicates = new ArrayList<>();
+
+    TestOsgi(Map<String, Bundle> availableBundles) {
+        this.availableBundles = availableBundles;
+    }
+
+    @Override
+    public List<Bundle> install(String fileReferenceValue) {
+        if (! availableBundles.containsKey(fileReferenceValue))
+            throw new IllegalArgumentException("No such bundle: " + fileReferenceValue);
+
+        Bundle bundle = availableBundles.get(fileReferenceValue);
+        installedBundles.add(bundle);
+        return List.of(bundle);
+    }
+
+    @Override
+    public Bundle[] getBundles() {
+        return installedBundles.toArray(new Bundle[0]);
+    }
+
+    public List<Bundle> getInstalledBundles() {
+        return installedBundles;
+    }
+
+    @Override
+    public List<Bundle> getCurrentBundles() {
+        var currentBundles = new ArrayList<>(installedBundles);
+        currentBundles.removeAll(allowedDuplicates);
+        return currentBundles;
+    }
+
+    @Override
+    public void allowDuplicateBundles(Collection<Bundle> bundles) {
+        allowedDuplicates.addAll(bundles);
+    }
+
+}