aboutsummaryrefslogtreecommitdiffstats
path: root/container-core/src/test/java/com/yahoo/container/core/config/ApplicationBundleLoaderTest.java
blob: edda7ae8f9fd5520b71b04cf060bcf8d6a553f8d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.container.core.config;

import com.yahoo.container.di.Osgi.GenerationStatus;
import com.yahoo.jdisc.application.BsnVersion;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.osgi.framework.Bundle;

import java.util.Collection;
import java.util.List;

import static com.yahoo.container.core.config.BundleTestUtil.BUNDLE_1;
import static com.yahoo.container.core.config.BundleTestUtil.BUNDLE_1_REF;
import static com.yahoo.container.core.config.BundleTestUtil.BUNDLE_2;
import static com.yahoo.container.core.config.BundleTestUtil.BUNDLE_2_REF;
import static com.yahoo.container.core.config.BundleTestUtil.testBundles;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;

/**
 * @author gjoranv
 */
public class ApplicationBundleLoaderTest {

    private ApplicationBundleLoader bundleLoader;
    private TestOsgi osgi;

    @BeforeEach
    public void setup() {
        osgi = new TestOsgi(testBundles());
        bundleLoader = osgi.bundleLoader();
    }

    @Test
    void bundles_are_installed_and_started() {
        bundleLoader.useBundles(List.of(BUNDLE_1_REF));
        bundleLoader.completeGeneration(GenerationStatus.SUCCESS);
        assertEquals(1, osgi.getInstalledBundles().size());

        // The bundle is installed and started
        TestBundle installedBundle = (TestBundle) osgi.getInstalledBundles().get(0);
        assertEquals(BUNDLE_1.getSymbolicName(), installedBundle.getSymbolicName());
        assertTrue(installedBundle.started);

        // The file reference is active
        assertEquals(1, bundleLoader.getActiveFileReferences().size());
        assertEquals(BUNDLE_1_REF, bundleLoader.getActiveFileReferences().get(0));
    }

    @Test
    void current_bundles_metadata_can_be_retrieved() {
        bundleLoader.useBundles(List.of(BUNDLE_1_REF, BUNDLE_2_REF));
        bundleLoader.completeGeneration(GenerationStatus.SUCCESS);

        List<BsnVersion> activeBundles = bundleLoader.activeBundlesBsnVersion();
        assertEquals(new BsnVersion(BUNDLE_1), activeBundles.get(0));
        assertEquals(new BsnVersion(BUNDLE_2), activeBundles.get(1));
    }

    @Test
    void generation_must_be_marked_complete_before_using_new_bundles() {
        bundleLoader.useBundles(List.of(BUNDLE_1_REF));
        assertThrows(IllegalStateException.class,
                     () -> bundleLoader.useBundles(List.of(BUNDLE_1_REF)));
    }

    @Test
    void no_bundles_are_marked_obsolete_upon_reconfig_with_unchanged_bundles() {
        bundleLoader.useBundles(List.of(BUNDLE_1_REF));
        bundleLoader.completeGeneration(GenerationStatus.SUCCESS);

        bundleLoader.useBundles(List.of(BUNDLE_1_REF, BUNDLE_2_REF));
        Collection<Bundle> obsoleteBundles = bundleLoader.completeGeneration(GenerationStatus.SUCCESS);

        // No bundles are obsolete
        assertTrue(obsoleteBundles.isEmpty());
    }

    @Test
    void new_bundle_can_be_installed_in_reconfig() {
        bundleLoader.useBundles(List.of(BUNDLE_1_REF));
        bundleLoader.completeGeneration(GenerationStatus.SUCCESS);

        bundleLoader.useBundles(List.of(BUNDLE_1_REF, BUNDLE_2_REF));
        Collection<Bundle> obsoleteBundles = bundleLoader.completeGeneration(GenerationStatus.SUCCESS);

        // 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());

        // Both file references are active
        assertEquals(2, bundleLoader.getActiveFileReferences().size());
        assertEquals(BUNDLE_1_REF, bundleLoader.getActiveFileReferences().get(0));
        assertEquals(BUNDLE_2_REF, bundleLoader.getActiveFileReferences().get(1));
    }

    @Test
    void unused_bundle_is_marked_obsolete_after_reconfig() {
        bundleLoader.useBundles(List.of(BUNDLE_1_REF));
        bundleLoader.completeGeneration(GenerationStatus.SUCCESS);

        bundleLoader.useBundles(List.of(BUNDLE_2_REF));
        Collection<Bundle> obsoleteBundles = bundleLoader.completeGeneration(GenerationStatus.SUCCESS);

        // 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());

        // Only the bundle-2 file reference is active
        assertEquals(1, bundleLoader.getActiveFileReferences().size());
        assertEquals(BUNDLE_2_REF, bundleLoader.getActiveFileReferences().get(0));
    }


    @Test
    void previous_generation_can_be_restored_after_a_failed_reconfig() {
        bundleLoader.useBundles(List.of(BUNDLE_1_REF));
        bundleLoader.completeGeneration(GenerationStatus.SUCCESS);

        bundleLoader.useBundles(List.of(BUNDLE_2_REF));

        // Report the generation as a failure.
        Collection<Bundle> bundlesToUninstall = bundleLoader.completeGeneration(GenerationStatus.FAILURE);

        assertEquals(1, bundlesToUninstall.size());
        assertEquals(BUNDLE_2.getSymbolicName(), bundlesToUninstall.iterator().next().getSymbolicName());

        // The bundle from the failed generation is not seen as current. It will still be installed,
        // as uninstalling is handled by the Deconstructor, not included in this test setup.
        assertEquals(1, osgi.getCurrentBundles().size());
        assertEquals(BUNDLE_1.getSymbolicName(), osgi.getCurrentBundles().get(0).getSymbolicName());

        // Only the bundle-1 file reference is active, bundle-2 is removed.
        assertEquals(1, bundleLoader.getActiveFileReferences().size());
        assertEquals(BUNDLE_1_REF, bundleLoader.getActiveFileReferences().get(0));
    }

    @Test
    void bundles_from_committed_config_generation_are_not_uninstalled_upon_future_failed_reconfig() {
        bundleLoader.useBundles(List.of(BUNDLE_1_REF));
        bundleLoader.completeGeneration(GenerationStatus.SUCCESS);

        // Revert to the previous generation, as will be done upon a failed reconfig.
        Collection<Bundle> bundlesToUninstall = bundleLoader.completeGeneration(GenerationStatus.FAILURE);

        assertEquals(0, bundlesToUninstall.size());
        assertEquals(1, osgi.getCurrentBundles().size());

        bundleLoader.useBundles(List.of(BUNDLE_1_REF));
        Collection<Bundle> obsoleteBundles = bundleLoader.completeGeneration(GenerationStatus.SUCCESS);
        assertTrue(obsoleteBundles.isEmpty());
        assertEquals(1, osgi.getCurrentBundles().size());
    }

}