import org.sonar.core.plugin.JpaPlugin;
import org.sonar.core.plugin.JpaPluginDao;
import org.sonar.server.platform.DefaultServerFileSystem;
+import org.sonar.server.platform.ServerStartException;
+
+import com.google.common.collect.Maps;
import java.io.File;
import java.io.IOException;
import java.net.URL;
import java.net.URLClassLoader;
-import java.util.*;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+import java.util.Map;
public final class PluginDeployer implements ServerComponent {
private DefaultServerFileSystem fileSystem;
private JpaPluginDao dao;
private PluginClassLoaders classloaders;
- private Map<String, PluginMetadata> pluginByKeys = new HashMap<String, PluginMetadata>();
- private List<PluginMetadata> deprecatedPlugins = new ArrayList<PluginMetadata>();
+ private Map<String, PluginMetadata> pluginByKeys = Maps.newHashMap();
+ private Map<String, PluginMetadata> deprecatedPlugins = Maps.newHashMap();
public PluginDeployer(Server server, DefaultServerFileSystem fileSystem, JpaPluginDao dao, PluginClassLoaders classloaders) {
this.server = server;
}
private void deployDeprecatedPlugins() throws IOException {
- for (PluginMetadata deprecatedPlugin : deprecatedPlugins) {
- if (deprecatedPlugin.getKey() != null && !pluginByKeys.containsKey(deprecatedPlugin.getKey())) {
+ for (PluginMetadata deprecatedPlugin : deprecatedPlugins.values()) {
+ PluginMetadata metadata = pluginByKeys.get(deprecatedPlugin.getKey());
+ if (metadata != null) {
+ FileUtils.deleteQuietly(deprecatedPlugin.getSourceFile());
+ Logs.INFO.info("Old plugin " + deprecatedPlugin.getFilename() + " replaced by new " + metadata.getFilename());
+ } else {
pluginByKeys.put(deprecatedPlugin.getKey(), deprecatedPlugin);
deploy(deprecatedPlugin);
-
- } else {
- FileUtils.deleteQuietly(deprecatedPlugin.getSourceFile());
}
}
}
private void loadCorePlugins() throws IOException {
for (File file : fileSystem.getCorePlugins()) {
- registerPluginMetadata(file, true);
+ registerPluginMetadata(file, true, false);
}
}
private void loadUserPlugins() throws IOException {
for (File file : fileSystem.getUserPlugins()) {
- registerPluginMetadata(file, false);
+ registerPluginMetadata(file, false, false);
}
}
private void moveAndLoadDownloadedPlugins() throws IOException {
if (fileSystem.getDownloadedPluginsDir().exists()) {
- Collection<File> jars = FileUtils.listFiles(fileSystem.getDownloadedPluginsDir(), new String[]{"jar"}, false);
+ Collection<File> jars = FileUtils.listFiles(fileSystem.getDownloadedPluginsDir(), new String[] { "jar" }, false);
for (File jar : jars) {
File movedJar = moveDownloadedFile(jar);
- registerPluginMetadata(movedJar, false);
+ registerPluginMetadata(movedJar, false, true);
}
}
}
return new File(fileSystem.getUserPluginsDir(), jar.getName());
} catch (IOException e) {
- LOG.error("Fail to move the downloaded file:" + jar.getAbsolutePath(), e);
+ LOG.error("Fail to move the downloaded file: " + jar.getAbsolutePath(), e);
return null;
}
}
- private void registerPluginMetadata(File file, boolean corePlugin) throws IOException {
+ private void registerPluginMetadata(File file, boolean corePlugin, boolean canDeleteOld) throws IOException {
PluginMetadata metadata = PluginMetadata.createFromJar(file, corePlugin);
String pluginKey = metadata.getKey();
if (pluginKey != null) {
- PluginMetadata existing = pluginByKeys.get(pluginKey);
- if (existing != null) {
- FileUtils.deleteQuietly(existing.getSourceFile());
- pluginByKeys.remove(pluginKey);
- }
- pluginByKeys.put(pluginKey, metadata);
-
+ registerPluginMetadata(pluginByKeys, file, metadata, canDeleteOld);
} else if (metadata.isOldManifest()) {
loadDeprecatedPlugin(metadata);
- deprecatedPlugins.add(metadata);
+ registerPluginMetadata(deprecatedPlugins, file, metadata, canDeleteOld);
}
}
+ private void registerPluginMetadata(Map<String, PluginMetadata> map, File file, PluginMetadata metadata, boolean canDeleteOld) {
+ String pluginKey = metadata.getKey();
+ PluginMetadata existing = map.get(pluginKey);
+ if (existing != null) {
+ if (canDeleteOld) {
+ FileUtils.deleteQuietly(existing.getSourceFile());
+ map.remove(pluginKey);
+ Logs.INFO.info("Old plugin " + existing.getFilename() + " replaced by new " + metadata.getFilename());
+ } else {
+ throw new ServerStartException("Found two plugins with the same key '" + pluginKey + "': "
+ + metadata.getFilename() + " and "
+ + existing.getFilename());
+ }
+ }
+ map.put(metadata.getKey(), metadata);
+ }
+
private void loadDeprecatedPlugin(PluginMetadata plugin) throws IOException {
// URLClassLoader locks files on Windows
// => copy the file before in a temp directory
String mainClass = plugin.getMainClass();
try {
- URLClassLoader pluginClassLoader = URLClassLoader.newInstance(new URL[]{tempFile.toURI().toURL()}, getClass().getClassLoader());
+ URLClassLoader pluginClassLoader = URLClassLoader.newInstance(new URL[] { tempFile.toURI().toURL() }, getClass().getClassLoader());
Plugin pluginInstance = (Plugin) pluginClassLoader.loadClass(mainClass).newInstance();
plugin.setKey(pluginInstance.getKey());
plugin.setDescription(pluginInstance.getDescription());
} catch (Exception e) {
throw new RuntimeException("The plugin main class can not be created: plugin=" + plugin.getFilename() + ", class=" + mainClass, e);
}
- }
+ if (StringUtils.isBlank(plugin.getKey())) {
+ throw new ServerStartException("Found plugin with empty key: " + plugin.getFilename());
+ }
+ }
}
import org.sonar.jpa.test.AbstractDbUnitTestCase;
import org.sonar.server.platform.DefaultServerFileSystem;
import org.sonar.server.platform.ServerImpl;
+import org.sonar.server.platform.ServerStartException;
import org.sonar.test.TestUtils;
import java.io.File;
import java.text.SimpleDateFormat;
import java.util.List;
-import static junit.framework.Assert.assertNotNull;
import static org.hamcrest.Matchers.is;
+import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertThat;
public class PluginDeployerTest extends AbstractDbUnitTestCase {
@Rule
public TestName name = new TestName();
-
+
@Before
public void start() throws ParseException {
server = new ServerImpl("1", "2.2", new SimpleDateFormat("yyyy-MM-dd").parse("2010-05-18"));
deployer = new PluginDeployer(server, fileSystem, dao, classloaders);
}
-
@Test
public void deployPlugin() throws IOException {
setupData("shared");
// check that the plugin is registered in database
List<JpaPlugin> plugins = dao.getPlugins();
- assertThat(plugins.size(), is(1)); // no more checkstyle
+ assertThat(plugins.size(), is(1)); // no more checkstyle
JpaPlugin plugin = plugins.get(0);
assertThat(plugin.getName(), is("Foo"));
assertThat(plugin.getFiles().size(), is(1));
// check that the plugin is registered in database
List<JpaPlugin> plugins = dao.getPlugins();
- assertThat(plugins.size(), is(1)); // no more checkstyle
+ assertThat(plugins.size(), is(1)); // no more checkstyle
JpaPlugin plugin = plugins.get(0);
assertThat(plugin.getKey(), is("build-breaker"));
assertThat(plugin.getFiles().size(), is(1));
// check that the plugin is registered in database
List<JpaPlugin> plugins = dao.getPlugins();
- assertThat(plugins.size(), is(1)); // no more checkstyle
+ assertThat(plugins.size(), is(1)); // no more checkstyle
JpaPlugin plugin = plugins.get(0);
assertThat(plugin.getFiles().size(), is(2));
JpaPluginFile pluginFile = plugin.getFiles().get(1);
// check that the plugin is registered in database
List<JpaPlugin> plugins = dao.getPlugins();
- assertThat(plugins.size(), is(0));
+ assertThat(plugins.size(), is(0));
+ }
+
+ @Test(expected = ServerStartException.class)
+ public void failIfTwoPluginsWithSameKey() throws IOException {
+ setupData("shared");
+ deployer.start();
+ }
+
+ @Test(expected = ServerStartException.class)
+ public void failIfTwoDeprecatedPluginsWithSameKey() throws IOException {
+ setupData("shared");
+ deployer.start();
}
}
projects / sonarqube.git / commitdiff