Add secure wrapper to plugin manager (#450)

1 files changed, 272 insertions, 0 deletions

diff --git a/pf4j/src/test/java/org/pf4j/SecurePluginManagerWrapperTest.java b/pf4j/src/test/java/org/pf4j/SecurePluginManagerWrapperTest.java
new file mode 100644
index 0000000..f42d83e
--- /dev/null
+++ b/pf4j/src/test/java/org/pf4j/SecurePluginManagerWrapperTest.java
@@ -0,0 +1,272 @@
+package org.pf4j;

+

+import static org.junit.jupiter.api.Assertions.assertTrue;

+import static org.junit.Assert.assertNotNull;

+import static org.junit.jupiter.api.Assertions.assertEquals;

+import static org.junit.jupiter.api.Assertions.assertThrows;

+

+import java.io.IOException;

+import java.nio.file.Path;

+import java.util.List;

+

+import org.junit.jupiter.api.AfterEach;

+import org.junit.jupiter.api.BeforeEach;

+import org.junit.jupiter.api.Test;

+import org.junit.jupiter.api.io.TempDir;

+import org.pf4j.test.PluginJar;

+import org.pf4j.test.TestExtension;

+import org.pf4j.test.TestExtensionPoint;

+import org.pf4j.test.TestPlugin;

+

+public class SecurePluginManagerWrapperTest {

+

+    private static final String OTHER_PLUGIN_ID = "test-plugin-2";

+    private static final String THIS_PLUGIN_ID = "test-plugin-1";

+    private PluginJar thisPlugin;

+    private PluginJar otherPlugin;

+    private PluginManager pluginManager;

+    private PluginManager wrappedPluginManager;

+    private int pluginManagerEvents = 0;

+    private int wrappedPluginManagerEvents = 0;

+

+    @TempDir

+    Path pluginsPath;

+

+    @BeforeEach

+    public void setUp() throws IOException {

+        pluginManagerEvents = 0;

+        wrappedPluginManagerEvents = 0;

+        thisPlugin = new PluginJar.Builder(pluginsPath.resolve("test-plugin1.jar"), THIS_PLUGIN_ID).pluginClass(TestPlugin.class.getName()).pluginVersion("1.2.3").extension(TestExtension.class.getName()).build();

+        otherPlugin = new PluginJar.Builder(pluginsPath.resolve("test-plugin2.jar"), OTHER_PLUGIN_ID).pluginClass(TestPlugin.class.getName()).pluginVersion("1.2.3").extension(TestExtension.class.getName()).build();

+

+        pluginManager = new JarPluginManager(pluginsPath);

+        wrappedPluginManager = new SecurePluginManagerWrapper(pluginManager, THIS_PLUGIN_ID);

+    }

+

+    @AfterEach

+    public void tearDown() {

+        pluginManager.unloadPlugins();

+

+        thisPlugin = null;

+        otherPlugin = null;

+        pluginManager = null;

+    }

+

+    @Test

+    public void pluginStateListeners() {

+        pluginManager.addPluginStateListener(new PluginStateListener() {

+            @Override

+            public void pluginStateChanged(PluginStateEvent event) {

+                pluginManagerEvents++;

+            }

+        });

+        wrappedPluginManager.addPluginStateListener(new PluginStateListener() {

+            @Override

+            public void pluginStateChanged(PluginStateEvent event) {

+                wrappedPluginManagerEvents++;

+            }

+        });

+        pluginManager.loadPlugins();

+        pluginManager.startPlugins();

+        assertEquals(4, pluginManagerEvents);

+        assertEquals(2, wrappedPluginManagerEvents);

+    }

+

+    @Test

+    public void deletePlugin() {

+        pluginManager.loadPlugins();

+        assertThrows(IllegalAccessError.class, () -> wrappedPluginManager.deletePlugin(OTHER_PLUGIN_ID));

+        assertTrue(wrappedPluginManager.deletePlugin(THIS_PLUGIN_ID));

+    }

+

+    @Test

+    public void disablePlugin() {

+        pluginManager.loadPlugins();

+        assertThrows(IllegalAccessError.class, () -> wrappedPluginManager.disablePlugin(OTHER_PLUGIN_ID));

+        assertTrue(wrappedPluginManager.disablePlugin(THIS_PLUGIN_ID));

+    }

+

+    @Test

+    public void enablePlugin() {

+        pluginManager.loadPlugins();

+        assertThrows(IllegalAccessError.class, () -> wrappedPluginManager.enablePlugin(OTHER_PLUGIN_ID));

+        assertThrows(IllegalAccessError.class, () -> wrappedPluginManager.enablePlugin(THIS_PLUGIN_ID));

+    }

+

+    @Test

+    public void getExtensionClasses() {

+        pluginManager.loadPlugins();

+        pluginManager.startPlugins();

+        assertEquals(1, wrappedPluginManager.getExtensionClasses(TestExtensionPoint.class).size());

+

+        assertThrows(IllegalAccessError.class, () -> wrappedPluginManager.getExtensionClasses(TestExtensionPoint.class, OTHER_PLUGIN_ID));

+        assertEquals(1, wrappedPluginManager.getExtensionClasses(TestExtensionPoint.class, THIS_PLUGIN_ID).size());

+

+        assertThrows(IllegalAccessError.class, () -> wrappedPluginManager.getExtensionClasses(OTHER_PLUGIN_ID));

+        assertEquals(1, wrappedPluginManager.getExtensionClasses(THIS_PLUGIN_ID).size());

+    }

+

+    @Test

+    public void getExtensionClassNames() {

+        pluginManager.loadPlugins();

+        assertThrows(IllegalAccessError.class, () -> wrappedPluginManager.getExtensionClassNames(OTHER_PLUGIN_ID));

+        assertEquals(1, wrappedPluginManager.getExtensionClassNames(THIS_PLUGIN_ID).size());

+    }

+

+    @Test

+    public void getExtensionFactory() {

+        pluginManager.loadPlugins();

+        assertEquals(pluginManager.getExtensionFactory(), wrappedPluginManager.getExtensionFactory());

+    }

+

+    @Test

+    public void getExtensions() {

+        pluginManager.loadPlugins();

+        pluginManager.startPlugins();

+        assertEquals(1, wrappedPluginManager.getExtensions(TestExtensionPoint.class).size());

+

+        assertThrows(IllegalAccessError.class, () -> wrappedPluginManager.getExtensions(TestExtensionPoint.class, OTHER_PLUGIN_ID));

+        assertEquals(1, wrappedPluginManager.getExtensions(TestExtensionPoint.class, THIS_PLUGIN_ID).size());

+

+        assertThrows(IllegalAccessError.class, () -> wrappedPluginManager.getExtensions(OTHER_PLUGIN_ID));

+        assertEquals(1, wrappedPluginManager.getExtensions(THIS_PLUGIN_ID).size());

+    }

+

+    @Test

+    public void getPlugin() {

+        pluginManager.loadPlugins();

+        assertThrows(IllegalAccessError.class, () -> wrappedPluginManager.getPlugin(OTHER_PLUGIN_ID));

+        assertEquals(THIS_PLUGIN_ID, wrappedPluginManager.getPlugin(THIS_PLUGIN_ID).getPluginId());

+    }

+

+    @Test

+    public void getPluginClassLoader() {

+        pluginManager.loadPlugins();

+        assertThrows(IllegalAccessError.class, () -> wrappedPluginManager.getPluginClassLoader(OTHER_PLUGIN_ID));

+        assertNotNull(wrappedPluginManager.getPluginClassLoader(THIS_PLUGIN_ID));

+    }

+

+    @Test

+    public void getPlugins() {

+        pluginManager.loadPlugins();

+        assertEquals(2, pluginManager.getPlugins().size());

+        assertEquals(1, wrappedPluginManager.getPlugins().size());

+    }

+

+    @Test

+    public void getPluginsRoot() {

+        assertThrows(IllegalAccessError.class, () -> wrappedPluginManager.getPluginsRoot());

+    }

+

+    @Test

+    public void getPluginsRoots() {

+        assertThrows(IllegalAccessError.class, () -> wrappedPluginManager.getPluginsRoots());

+    }

+

+    @Test

+    public void getResolvedPlugins() {

+        pluginManager.loadPlugins();

+        assertEquals(2, pluginManager.getResolvedPlugins().size());

+        assertEquals(1, wrappedPluginManager.getResolvedPlugins().size());

+    }

+

+    @Test

+    public void getRuntimeMode() {

+        assertEquals(pluginManager.getRuntimeMode(), wrappedPluginManager.getRuntimeMode());

+    }

+

+    @Test

+    public void getStartedPlugins() {

+        pluginManager.loadPlugins();

+        pluginManager.startPlugins();

+        assertEquals(2, pluginManager.getStartedPlugins().size());

+        assertEquals(1, wrappedPluginManager.getStartedPlugins().size());

+    }

+

+    @Test

+    public void getSystemVersion() {

+        assertEquals(pluginManager.getSystemVersion(), wrappedPluginManager.getSystemVersion());

+    }

+

+    @Test

+    public void getUnresolvedPlugins() {

+        assertNotNull(wrappedPluginManager);

+        assertNotNull(wrappedPluginManager.getUnresolvedPlugins());

+        assertTrue(wrappedPluginManager.getUnresolvedPlugins().isEmpty());

+    }

+

+    @Test

+    public void getVersionManager() {

+        assertEquals(pluginManager.getVersionManager(), wrappedPluginManager.getVersionManager());

+    }

+

+    @Test

+    public void isDevelopment() {

+        assertEquals(pluginManager.isDevelopment(), wrappedPluginManager.isDevelopment());

+    }

+

+    @Test

+    public void isNotDevelopment() {

+        assertEquals(pluginManager.isNotDevelopment(), wrappedPluginManager.isNotDevelopment());

+    }

+

+    @Test

+    public void loadPlugin() {

+        assertThrows(IllegalAccessError.class, () -> wrappedPluginManager.loadPlugin(thisPlugin.path()));

+    }

+

+    @Test

+    public void loadPlugins() {

+        assertThrows(IllegalAccessError.class, () -> wrappedPluginManager.loadPlugins());

+    }

+

+    @Test

+    public void setSystemVersion() {

+        assertThrows(IllegalAccessError.class, () -> wrappedPluginManager.setSystemVersion("1.0.0"));

+    }

+

+    @Test

+    public void startPlugin() {

+        pluginManager.loadPlugins();

+        assertThrows(IllegalAccessError.class, () -> wrappedPluginManager.startPlugin(OTHER_PLUGIN_ID));

+        assertThrows(IllegalAccessError.class, () -> wrappedPluginManager.startPlugin(THIS_PLUGIN_ID));

+    }

+

+    @Test

+    public void startPlugins() {

+        assertThrows(IllegalAccessError.class, () -> wrappedPluginManager.startPlugins());

+    }

+

+    @Test

+    public void stopPlugin() {

+        pluginManager.loadPlugins();

+        pluginManager.startPlugins();

+        assertThrows(IllegalAccessError.class, () -> wrappedPluginManager.stopPlugin(OTHER_PLUGIN_ID));

+        assertEquals(PluginState.STOPPED, wrappedPluginManager.stopPlugin(THIS_PLUGIN_ID));

+    }

+

+    @Test

+    public void stopPlugins() {

+        assertThrows(IllegalAccessError.class, () -> wrappedPluginManager.stopPlugins());

+    }

+

+    @Test

+    public void unloadPlugin() {

+        pluginManager.loadPlugins();

+        assertThrows(IllegalAccessError.class, () -> wrappedPluginManager.unloadPlugin(OTHER_PLUGIN_ID));

+        assertTrue(wrappedPluginManager.unloadPlugin(THIS_PLUGIN_ID));

+    }

+

+    @Test

+    public void unloadPlugins() {

+        assertThrows(IllegalAccessError.class, () -> wrappedPluginManager.unloadPlugins());

+    }

+

+    @Test

+    public void whichPlugin() {

+        pluginManager.loadPlugins();

+        pluginManager.startPlugins();

+        assertEquals(null, wrappedPluginManager.whichPlugin(pluginManager.getExtensionClasses(OTHER_PLUGIN_ID).get(0)));

+        assertEquals(THIS_PLUGIN_ID, wrappedPluginManager.whichPlugin(pluginManager.getExtensionClasses(THIS_PLUGIN_ID).get(0)).getPluginId());

+    }

+}