adds verification of dependency versions on plugin installation

This commit is contained in:
Sebastian Sdorra
2020-08-05 15:28:39 +02:00
parent c984844f25
commit c946c130eb
13 changed files with 673 additions and 56 deletions

View File

@@ -96,14 +96,21 @@ class DefaultPluginManagerTest {
@Mock
private Subject subject;
private final PluginInstallationContext context = PluginInstallationContext.empty();
@BeforeEach
void mockInstaller() {
lenient().when(installer.install(any())).then(ic -> {
AvailablePlugin plugin = ic.getArgument(0);
lenient().when(installer.install(any(), any())).then(ic -> {
AvailablePlugin plugin = ic.getArgument(1);
return new PendingPluginInstallation(plugin.install(), null);
});
}
@BeforeEach
void setUpContextFactory() {
manager.setContextFactory((List<AvailablePlugin> availablePlugins) -> context);
}
@Nested
class WithAdminPermissions {
@@ -209,7 +216,7 @@ class DefaultPluginManagerTest {
manager.install("scm-git-plugin", false);
verify(installer).install(git);
verify(installer).install(context, git);
verify(restarter, never()).restart(any(), any());
}
@@ -222,8 +229,8 @@ class DefaultPluginManagerTest {
manager.install("scm-review-plugin", false);
verify(installer).install(mail);
verify(installer).install(review);
verify(installer).install(context, mail);
verify(installer).install(context, review);
}
@Test
@@ -239,7 +246,7 @@ class DefaultPluginManagerTest {
manager.install("scm-review-plugin", false);
ArgumentCaptor<AvailablePlugin> captor = ArgumentCaptor.forClass(AvailablePlugin.class);
verify(installer).install(captor.capture());
verify(installer).install(any(), captor.capture());
assertThat(captor.getValue().getDescriptor().getInformation().getName()).isEqualTo("scm-review-plugin");
}
@@ -256,8 +263,8 @@ class DefaultPluginManagerTest {
manager.install("scm-review-plugin", false);
verify(installer).install(mail);
verify(installer).install(review);
verify(installer).install(context, mail);
verify(installer).install(context, review);
}
@Test
@@ -272,8 +279,8 @@ class DefaultPluginManagerTest {
manager.install("scm-review-plugin", false);
verify(installer).install(mail);
verify(installer).install(review);
verify(installer).install(context, mail);
verify(installer).install(context, review);
}
@Test
@@ -285,8 +292,8 @@ class DefaultPluginManagerTest {
manager.install("scm-review-plugin", false);
verify(installer, never()).install(mail);
verify(installer).install(review);
verify(installer, never()).install(context, mail);
verify(installer).install(context, review);
}
@Test
@@ -299,12 +306,12 @@ class DefaultPluginManagerTest {
when(center.getAvailable()).thenReturn(ImmutableSet.of(review, mail, notification));
PendingPluginInstallation pendingNotification = mock(PendingPluginInstallation.class);
doReturn(pendingNotification).when(installer).install(notification);
doReturn(pendingNotification).when(installer).install(context, notification);
PendingPluginInstallation pendingMail = mock(PendingPluginInstallation.class);
doReturn(pendingMail).when(installer).install(mail);
doReturn(pendingMail).when(installer).install(context, mail);
doThrow(new PluginChecksumMismatchException(mail, "1", "2")).when(installer).install(review);
doThrow(new PluginChecksumMismatchException(mail, "1", "2")).when(installer).install(context, review);
assertThrows(PluginInstallException.class, () -> manager.install("scm-review-plugin", false));
@@ -322,7 +329,7 @@ class DefaultPluginManagerTest {
assertThrows(NotFoundException.class, () -> manager.install("scm-review-plugin", false));
verify(installer, never()).install(any());
verify(installer, never()).install(any(), any());
}
@Test
@@ -332,7 +339,7 @@ class DefaultPluginManagerTest {
manager.install("scm-git-plugin", true);
verify(installer).install(git);
verify(installer).install(context, git);
verify(restarter).restart(any(), any());
}
@@ -353,7 +360,7 @@ class DefaultPluginManagerTest {
manager.install("scm-review-plugin", false);
manager.install("scm-review-plugin", false);
// only one interaction
verify(installer).install(any());
verify(installer).install(any(), any());
}
@Test
@@ -538,7 +545,7 @@ class DefaultPluginManagerTest {
AvailablePlugin git = createAvailable("scm-git-plugin");
when(center.getAvailable()).thenReturn(ImmutableSet.of(git));
PendingPluginInstallation gitPendingPluginInformation = mock(PendingPluginInstallation.class);
when(installer.install(git)).thenReturn(gitPendingPluginInformation);
when(installer.install(context, git)).thenReturn(gitPendingPluginInformation);
manager.install("scm-git-plugin", false);
manager.uninstall("scm-ssh-plugin", false);
@@ -571,8 +578,8 @@ class DefaultPluginManagerTest {
manager.updateAll();
verify(installer).install(newMailPlugin);
verify(installer).install(newReviewPlugin);
verify(installer).install(context, newMailPlugin);
verify(installer).install(context, newReviewPlugin);
}
@@ -587,7 +594,7 @@ class DefaultPluginManagerTest {
manager.updateAll();
verify(installer, never()).install(oldScriptPlugin);
verify(installer, never()).install(context, oldScriptPlugin);
}
@Test
@@ -607,7 +614,7 @@ class DefaultPluginManagerTest {
void shouldFirePluginEventOnFailedInstallation() {
AvailablePlugin review = createAvailable("scm-review-plugin");
when(center.getAvailable()).thenReturn(ImmutableSet.of(review));
doThrow(new PluginDownloadException(review, new IOException())).when(installer).install(review);
doThrow(new PluginDownloadException(review, new IOException())).when(installer).install(context, review);
assertThrows(PluginDownloadException.class, () -> manager.install("scm-review-plugin", false));

View File

@@ -0,0 +1,98 @@
/*
* MIT License
*
* Copyright (c) 2020-present Cloudogu GmbH and Contributors
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package sonia.scm.plugin;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Answers;
import org.mockito.junit.jupiter.MockitoExtension;
import java.util.Collections;
import java.util.Optional;
import java.util.Set;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
@ExtendWith(MockitoExtension.class)
class PluginInstallationContextTest {
@Test
void shouldReturnInstalledPlugin() {
Set<InstalledPlugin> installed = installed("scm-git-plugin", "1.0.0");
Set<AvailablePlugin> pending = Collections.emptySet();
PluginInstallationContext context = PluginInstallationContext.of(installed, pending);
Optional<NameAndVersion> plugin = context.find("scm-git-plugin");
assertThat(plugin).contains(new NameAndVersion("scm-git-plugin", "1.0.0"));
}
@Test
void shouldReturnPendingPlugin() {
Set<InstalledPlugin> installed = Collections.emptySet();
Set<AvailablePlugin> pending = pending("scm-hg-plugin", "1.0.0");
PluginInstallationContext context = PluginInstallationContext.of(installed, pending);
Optional<NameAndVersion> plugin = context.find("scm-hg-plugin");
assertThat(plugin).contains(new NameAndVersion("scm-hg-plugin", "1.0.0"));
}
@Test
void shouldReturnPendingEvenWithInstalled() {
Set<InstalledPlugin> installed = installed("scm-svn-plugin", "1.1.0");
Set<AvailablePlugin> pending = pending("scm-svn-plugin", "1.2.0");
PluginInstallationContext context = PluginInstallationContext.of(installed, pending);
Optional<NameAndVersion> plugin = context.find("scm-svn-plugin");
assertThat(plugin).contains(new NameAndVersion("scm-svn-plugin", "1.2.0"));
}
@Test
void shouldReturnEmpty() {
Set<InstalledPlugin> installed = Collections.emptySet();
Set<AvailablePlugin> pending = Collections.emptySet();
PluginInstallationContext context = PluginInstallationContext.of(installed, pending);
Optional<NameAndVersion> plugin = context.find("scm-legacy-plugin");
assertThat(plugin).isEmpty();
}
private Set<InstalledPlugin> installed(String name, String version) {
return mockSingleton(InstalledPlugin.class, name, version);
}
private Set<AvailablePlugin> pending(String name, String version) {
return mockSingleton(AvailablePlugin.class, name, version);
}
private <P extends Plugin> Set<P> mockSingleton(Class<P> pluginClass, String name, String version) {
P plugin = mock(pluginClass, Answers.RETURNS_DEEP_STUBS);
when(plugin.getDescriptor().getInformation().getName()).thenReturn(name);
when(plugin.getDescriptor().getInformation().getVersion()).thenReturn(version);
return Collections.singleton(plugin);
}
}

View File

@@ -0,0 +1,174 @@
/*
* MIT License
*
* Copyright (c) 2020-present Cloudogu GmbH and Contributors
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package sonia.scm.plugin;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Answers;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
import java.util.Collections;
import java.util.Optional;
import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
import static sonia.scm.plugin.PluginInstallationContext.empty;
@ExtendWith(MockitoExtension.class)
class PluginInstallationVerifierTest {
@Mock(answer = Answers.RETURNS_DEEP_STUBS)
private InstalledPluginDescriptor descriptor;
// hog stands for "Heart of Gold"
private static final String HOG_PLUGIN = "scm-hog-plugin";
// iid stands for "Infinite Improbability Drive"
private static final String IID_PLUGIN = "scm-iid-plugin";
@BeforeEach
void setUpDescriptor() {
PluginInformation information = new PluginInformation();
information.setName(HOG_PLUGIN);
information.setVersion("1.0.0");
when(descriptor.getInformation()).thenReturn(information);
}
@Test
void shouldFailOnCondition() {
PluginInstallationContext context = empty();
assertThrows(PluginConditionFailedException.class, () -> PluginInstallationVerifier.verify(context, descriptor));
}
@Test
void shouldFailOnMissingDependency() {
matchConditions();
when(descriptor.getDependenciesWithVersion()).thenReturn(Collections.singleton(new NameAndVersion(IID_PLUGIN)));
PluginInstallationContext context = empty();
DependencyNotFoundException exception = assertThrows(
DependencyNotFoundException.class, () -> PluginInstallationVerifier.verify(context, descriptor)
);
assertThat(exception.getPlugin()).isEqualTo(HOG_PLUGIN);
assertThat(exception.getMissingDependency()).isEqualTo(IID_PLUGIN);
}
private void matchConditions() {
when(descriptor.getCondition().isSupported()).thenReturn(true);
}
@Test
void shouldFailOnDependencyVersionMismatch() {
matchConditions();
// mock installation of iid 1.0.0
PluginInstallationContext context = mockInstallationOf(IID_PLUGIN, "1.0.0");
// mock dependency of iid 1.1.0
mockDependingOf(IID_PLUGIN, "1.1.0");
DependencyVersionMismatchException exception = assertThrows(
DependencyVersionMismatchException.class, () -> PluginInstallationVerifier.verify(context, descriptor)
);
assertThat(exception.getPlugin()).isEqualTo(HOG_PLUGIN);
assertThat(exception.getDependency()).isEqualTo(IID_PLUGIN);
assertThat(exception.getMinVersion()).isEqualTo("1.1.0");
assertThat(exception.getCurrentVersion()).isEqualTo("1.0.0");
}
@Test
void shouldFailOnOptionalDependencyVersionMismatch() {
matchConditions();
// mock installation of iid 1.0.0
PluginInstallationContext context = mockInstallationOf(IID_PLUGIN, "1.0.0");
// mock dependency of iid 1.1.0
mockOptionalDependingOf(IID_PLUGIN, "1.1.0");
DependencyVersionMismatchException exception = assertThrows(
DependencyVersionMismatchException.class, () -> PluginInstallationVerifier.verify(context, descriptor)
);
assertThat(exception.getPlugin()).isEqualTo(HOG_PLUGIN);
assertThat(exception.getDependency()).isEqualTo(IID_PLUGIN);
assertThat(exception.getMinVersion()).isEqualTo("1.1.0");
assertThat(exception.getCurrentVersion()).isEqualTo("1.0.0");
}
@Test
@SuppressWarnings("squid:S2699") // we are happy if no exception is thrown
void shouldVerifyPlugin() {
matchConditions();
PluginInstallationContext context = empty();
PluginInstallationVerifier.verify(context, descriptor);
}
@Test
@SuppressWarnings("squid:S2699") // we are happy if no exception is thrown
void shouldVerifyPluginWithDependencies() {
matchConditions();
// mock installation of iid 1.1.0
PluginInstallationContext context = mockInstallationOf(IID_PLUGIN, "1.1.0");
// mock dependency of iid 1.1.0
mockDependingOf(IID_PLUGIN, "1.1.0");
PluginInstallationVerifier.verify(context, descriptor);
}
@Test
@SuppressWarnings("squid:S2699") // we are happy if no exception is thrown
void shouldVerifyPluginWithOptionalDependency() {
matchConditions();
PluginInstallationContext context = PluginInstallationContext.empty();
// mock dependency of iid 1.1.0
mockOptionalDependingOf(IID_PLUGIN, "1.1.0");
PluginInstallationVerifier.verify(context, descriptor);
}
private void mockOptionalDependingOf(String plugin, String version) {
when(descriptor.getOptionalDependenciesWithVersion()).thenReturn(Collections.singleton(new NameAndVersion(plugin, version)));
}
private void mockDependingOf(String plugin, String version) {
when(descriptor.getDependenciesWithVersion()).thenReturn(Collections.singleton(new NameAndVersion(plugin, version)));
}
private PluginInstallationContext mockInstallationOf(String plugin, String version) {
PluginInstallationContext context = mock(PluginInstallationContext.class);
when(context.find(IID_PLUGIN)).thenReturn(Optional.of(new NameAndVersion(plugin, version)));
return context;
}
}

View File

@@ -83,7 +83,7 @@ class PluginInstallerTest {
void shouldDownloadPlugin() throws IOException {
mockContent("42");
installer.install(createGitPlugin());
installer.install(PluginInstallationContext.empty(), createGitPlugin());
assertThat(directory.resolve("plugins").resolve("scm-git-plugin.smp")).hasContent("42");
}
@@ -93,7 +93,7 @@ class PluginInstallerTest {
mockContent("42");
AvailablePlugin gitPlugin = createGitPlugin();
PendingPluginInstallation pending = installer.install(gitPlugin);
PendingPluginInstallation pending = installer.install(PluginInstallationContext.empty(), gitPlugin);
assertThat(pending).isNotNull();
assertThat(pending.getPlugin().getDescriptor()).isEqualTo(gitPlugin.getDescriptor());
@@ -117,14 +117,14 @@ class PluginInstallerTest {
void shouldThrowPluginDownloadException() throws IOException {
when(client.get("https://download.hitchhiker.com").request()).thenThrow(new IOException("failed to download"));
assertThrows(PluginDownloadException.class, () -> installer.install(createGitPlugin()));
assertThrows(PluginDownloadException.class, () -> installer.install(PluginInstallationContext.empty(), createGitPlugin()));
}
@Test
void shouldThrowPluginChecksumMismatchException() throws IOException {
mockContent("21");
assertThrows(PluginChecksumMismatchException.class, () -> installer.install(createGitPlugin()));
assertThrows(PluginChecksumMismatchException.class, () -> installer.install(PluginInstallationContext.empty(), createGitPlugin()));
assertThat(directory.resolve("plugins").resolve("scm-git-plugin.smp")).doesNotExist();
}
@@ -134,7 +134,7 @@ class PluginInstallerTest {
when(stream.read(any(), anyInt(), anyInt())).thenThrow(new IOException("failed to read"));
when(client.get("https://download.hitchhiker.com").request().contentAsStream()).thenReturn(stream);
assertThrows(PluginDownloadException.class, () -> installer.install(createGitPlugin()));
assertThrows(PluginDownloadException.class, () -> installer.install(PluginInstallationContext.empty(), createGitPlugin()));
assertThat(directory.resolve("plugins").resolve("scm-git-plugin.smp")).doesNotExist();
}
@@ -144,7 +144,7 @@ class PluginInstallerTest {
InstalledPluginDescriptor supportedPlugin = createPluginDescriptor(false);
when(extractor.extractPluginDescriptor(any())).thenReturn(supportedPlugin);
assertThrows(PluginConditionFailedException.class, () -> installer.install(createGitPlugin()));
assertThrows(PluginConditionFailedException.class, () -> installer.install(PluginInstallationContext.empty(), createGitPlugin()));
assertThat(directory.resolve("plugins").resolve("scm-git-plugin.smp")).doesNotExist();
}