123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179 |
- /*
- * Copyright (C) 2012-present the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
- package org.pf4j;
-
- import org.junit.jupiter.api.BeforeEach;
- import org.junit.jupiter.api.Test;
- import org.junit.jupiter.api.io.TempDir;
-
- import java.io.IOException;
- import java.nio.charset.Charset;
- import java.nio.file.Files;
- import java.nio.file.Path;
- import java.util.Arrays;
- import java.util.List;
-
- import static org.junit.jupiter.api.Assertions.assertEquals;
- import static org.junit.jupiter.api.Assertions.assertFalse;
- import static org.junit.jupiter.api.Assertions.assertThrows;
- import static org.junit.jupiter.api.Assertions.assertTrue;
-
- public class PropertiesPluginDescriptorFinderTest {
-
- private VersionManager versionManager;
-
- @TempDir
- Path pluginsPath;
-
- @BeforeEach
- public void setUp() throws IOException {
- Charset charset = Charset.forName("UTF-8");
-
- Path pluginPath = Files.createDirectories(pluginsPath.resolve("test-plugin-1"));
- Files.write(pluginPath.resolve("plugin.properties"), getPlugin1Properties(), charset);
-
- pluginPath = Files.createDirectories(pluginsPath.resolve("test-plugin-2"));
- Files.write(pluginPath.resolve("plugin.properties"), getPlugin2Properties(), charset);
-
- // empty plugin
- Files.createDirectories(pluginsPath.resolve("test-plugin-3"));
-
- // no plugin class
- pluginPath = Files.createDirectories(pluginsPath.resolve("test-plugin-4"));
- Files.write(pluginPath.resolve("plugin.properties"), getPlugin4Properties(), charset);
-
- // no plugin version
- pluginPath = Files.createDirectories(pluginsPath.resolve("test-plugin-5"));
- Files.write(pluginPath.resolve("plugin.properties"), getPlugin5Properties(), charset);
-
- // no plugin id
- pluginPath = Files.createDirectories(pluginsPath.resolve("test-plugin-6"));
- Files.write(pluginPath.resolve("plugin.properties"), getPlugin6Properties(), charset);
-
- versionManager = new DefaultVersionManager();
- }
-
- @Test
- public void testFind() throws Exception {
- PluginDescriptorFinder descriptorFinder = new PropertiesPluginDescriptorFinder();
-
- PluginDescriptor plugin1 = descriptorFinder.find(pluginsPath.resolve("test-plugin-1"));
- PluginDescriptor plugin2 = descriptorFinder.find(pluginsPath.resolve("test-plugin-2"));
-
- assertEquals("test-plugin-1", plugin1.getPluginId());
- assertEquals("Test Plugin 1", plugin1.getPluginDescription());
- assertEquals("org.pf4j.plugin.TestPlugin", plugin1.getPluginClass());
- assertEquals("0.0.1", plugin1.getVersion());
- assertEquals("Decebal Suiu", plugin1.getProvider());
- assertEquals(2, plugin1.getDependencies().size());
- assertEquals("test-plugin-2", plugin1.getDependencies().get(0).getPluginId());
- assertEquals("test-plugin-3", plugin1.getDependencies().get(1).getPluginId());
- assertEquals("~1.0", plugin1.getDependencies().get(1).getPluginVersionSupport());
- assertEquals("Apache-2.0", plugin1.getLicense());
- assertEquals(">=1", plugin1.getRequires());
- assertTrue(versionManager.checkVersionConstraint("1.0.0", plugin1.getRequires()));
- assertFalse(versionManager.checkVersionConstraint("0.1.0", plugin1.getRequires()));
-
- assertEquals("test-plugin-2", plugin2.getPluginId());
- assertEquals("", plugin2.getPluginDescription());
- assertEquals("org.pf4j.plugin.TestPlugin", plugin2.getPluginClass());
- assertEquals("0.0.1", plugin2.getVersion());
- assertEquals("Decebal Suiu", plugin2.getProvider());
- assertEquals(0, plugin2.getDependencies().size());
- assertEquals("*", plugin2.getRequires()); // Default is *
- assertTrue(versionManager.checkVersionConstraint("1.0.0", plugin2.getRequires()));
- }
-
- @Test
- public void testNotFound() {
- PluginDescriptorFinder descriptorFinder = new PropertiesPluginDescriptorFinder();
- assertThrows(PluginException.class, () -> descriptorFinder.find(pluginsPath.resolve("test-plugin-3")));
- }
-
- private List<String> getPlugin1Properties() {
- String[] lines = new String[] {
- "plugin.id=test-plugin-1\n"
- + "plugin.version=0.0.1\n"
- + "plugin.description=Test Plugin 1\n"
- + "plugin.provider=Decebal Suiu\n"
- + "plugin.class=org.pf4j.plugin.TestPlugin\n"
- + "plugin.dependencies=test-plugin-2,test-plugin-3@~1.0\n"
- + "plugin.requires=>=1\n"
- + "plugin.license=Apache-2.0\n"
- + "\n"
- + ""
- };
-
- return Arrays.asList(lines);
- }
-
- private List<String> getPlugin2Properties() {
- String[] lines = new String[] {
- "plugin.id=test-plugin-2\n"
- + "plugin.version=0.0.1\n"
- + "plugin.provider=Decebal Suiu\n"
- + "plugin.class=org.pf4j.plugin.TestPlugin\n"
- + "plugin.dependencies=\n"
- + "\n"
- + ""
- };
-
- return Arrays.asList(lines);
- }
-
- private List<String> getPlugin4Properties() {
- String[] lines = new String[] {
- "plugin.id=test-plugin-2\n"
- + "plugin.version=0.0.1\n"
- + "plugin.provider=Decebal Suiu\n"
- + "plugin.dependencies=\n"
- + "plugin.requires=*\n"
- + "\n"
- + ""
- };
-
- return Arrays.asList(lines);
- }
-
- private List<String> getPlugin5Properties() {
- String[] lines = new String[] {
- "plugin.id=test-plugin-2\n"
- + "plugin.provider=Decebal Suiu\n"
- + "plugin.class=org.pf4j.plugin.TestPlugin\n"
- + "plugin.dependencies=\n"
- + "plugin.requires=*\n"
- + "\n"
- + ""
- };
-
- return Arrays.asList(lines);
- }
-
- private List<String> getPlugin6Properties() {
- String[] lines = new String[] {
- "plugin.version=0.0.1\n"
- + "plugin.provider=Decebal Suiu\n"
- + "plugin.class=org.pf4j.plugin.TestPlugin\n"
- + "plugin.dependencies=\n"
- + "plugin.requires=*\n"
- + "\n"
- + ""
- };
-
- return Arrays.asList(lines);
- }
-
- }
|