package sonia.scm.plugin; import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableSet; import org.apache.shiro.authz.AuthorizationException; import org.apache.shiro.subject.Subject; import org.apache.shiro.util.ThreadContext; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Nested; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.ExtendWith; import org.mockito.Answers; import org.mockito.ArgumentCaptor; import org.mockito.InjectMocks; import org.mockito.Mock; import org.mockito.junit.jupiter.MockitoExtension; import sonia.scm.NotFoundException; import sonia.scm.event.ScmEventBus; import sonia.scm.lifecycle.RestartEvent; import java.util.List; 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.*; @ExtendWith(MockitoExtension.class) class DefaultPluginManagerTest { @Mock private ScmEventBus eventBus; @Mock private PluginLoader loader; @Mock private PluginCenter center; @Mock private PluginInstaller installer; @InjectMocks private DefaultPluginManager manager; @Mock private Subject subject; @BeforeEach void mockInstaller() { lenient().when(installer.install(any())).then(ic -> { AvailablePlugin plugin = ic.getArgument(0); return new PendingPluginInstallation(plugin.install(), null); }); } @Nested class WithAdminPermissions { @BeforeEach void setUpSubject() { ThreadContext.bind(subject); } @AfterEach void clearThreadContext() { ThreadContext.unbindSubject(); } @Test void shouldReturnInstalledPlugins() { InstalledPlugin review = createInstalled("scm-review-plugin", "1"); InstalledPlugin git = createInstalled("scm-git-plugin", "1"); when(loader.getInstalledPlugins()).thenReturn(ImmutableList.of(review, git)); List installed = manager.getInstalled(); assertThat(installed).containsOnly(review, git); } @Test void shouldReturnReviewPlugin() { InstalledPlugin review = createInstalled("scm-review-plugin", "1"); InstalledPlugin git = createInstalled("scm-git-plugin", "1"); when(loader.getInstalledPlugins()).thenReturn(ImmutableList.of(review, git)); Optional plugin = manager.getInstalled("scm-review-plugin"); assertThat(plugin).contains(review); } @Test void shouldReturnEmptyForNonInstalledPlugin() { when(loader.getInstalledPlugins()).thenReturn(ImmutableList.of()); Optional plugin = manager.getInstalled("scm-review-plugin"); assertThat(plugin).isEmpty(); } @Test void shouldReturnAvailablePlugins() { AvailablePlugin review = createAvailable("scm-review-plugin", "1"); AvailablePlugin git = createAvailable("scm-git-plugin", "1"); when(center.getAvailable()).thenReturn(ImmutableSet.of(review, git)); List available = manager.getAvailable(); assertThat(available).containsOnly(review, git); } @Test void shouldFilterOutAllInstalledWithSameVersion() { InstalledPlugin installedGit = createInstalled("scm-git-plugin", "1"); when(loader.getInstalledPlugins()).thenReturn(ImmutableList.of(installedGit)); AvailablePlugin review = createAvailable("scm-review-plugin", "1"); AvailablePlugin git = createAvailable("scm-git-plugin", "1"); when(center.getAvailable()).thenReturn(ImmutableSet.of(review, git)); List available = manager.getAvailable(); assertThat(available).containsOnly(review); } @Test void shouldKeepInstalledWithOlderVersion() { InstalledPlugin installedGit = createInstalled("scm-git-plugin", "1"); when(loader.getInstalledPlugins()).thenReturn(ImmutableList.of(installedGit)); AvailablePlugin review = createAvailable("scm-review-plugin", "1"); AvailablePlugin git = createAvailable("scm-git-plugin", "1.1"); when(center.getAvailable()).thenReturn(ImmutableSet.of(review, git)); List available = manager.getAvailable(); assertThat(available).contains(git, review); } @Test void shouldReturnAvailable() { AvailablePlugin review = createAvailable("scm-review-plugin", "1"); AvailablePlugin git = createAvailable("scm-git-plugin", "1"); when(center.getAvailable()).thenReturn(ImmutableSet.of(review, git)); Optional available = manager.getAvailable("scm-git-plugin"); assertThat(available).contains(git); } @Test void shouldReturnEmptyForNonExistingAvailable() { AvailablePlugin review = createAvailable("scm-review-plugin", "1"); when(center.getAvailable()).thenReturn(ImmutableSet.of(review)); Optional available = manager.getAvailable("scm-git-plugin"); assertThat(available).isEmpty(); } @Test void shouldReturnEmptyForInstalledPlugin() { InstalledPlugin installedGit = createInstalled("scm-git-plugin", "1"); when(loader.getInstalledPlugins()).thenReturn(ImmutableList.of(installedGit)); AvailablePlugin git = createAvailable("scm-git-plugin", "1"); when(center.getAvailable()).thenReturn(ImmutableSet.of(git)); Optional available = manager.getAvailable("scm-git-plugin"); assertThat(available).isEmpty(); } @Test void shouldInstallThePlugin() { AvailablePlugin git = createAvailable("scm-git-plugin", "1"); when(center.getAvailable()).thenReturn(ImmutableSet.of(git)); manager.install("scm-git-plugin", false); verify(installer).install(git); verify(eventBus, never()).post(any()); } @Test void shouldInstallDependingPlugins() { AvailablePlugin review = createAvailable("scm-review-plugin", "1"); when(review.getDescriptor().getDependencies()).thenReturn(ImmutableSet.of("scm-mail-plugin")); AvailablePlugin mail = createAvailable("scm-mail-plugin", "1"); when(center.getAvailable()).thenReturn(ImmutableSet.of(review, mail)); manager.install("scm-review-plugin", false); verify(installer).install(mail); verify(installer).install(review); } @Test void shouldNotInstallAlreadyInstalledDependencies() { AvailablePlugin review = createAvailable("scm-review-plugin", "1"); when(review.getDescriptor().getDependencies()).thenReturn(ImmutableSet.of("scm-mail-plugin")); AvailablePlugin mail = createAvailable("scm-mail-plugin", "1"); when(center.getAvailable()).thenReturn(ImmutableSet.of(review, mail)); InstalledPlugin installedMail = createInstalled("scm-mail-plugin", "1"); when(loader.getInstalledPlugins()).thenReturn(ImmutableList.of(installedMail)); manager.install("scm-review-plugin", false); ArgumentCaptor captor = ArgumentCaptor.forClass(AvailablePlugin.class); verify(installer).install(captor.capture()); assertThat(captor.getValue().getDescriptor().getInformation().getName()).isEqualTo("scm-review-plugin"); } @Test void shouldRollbackOnFailedInstallation() { AvailablePlugin review = createAvailable("scm-review-plugin", "1"); when(review.getDescriptor().getDependencies()).thenReturn(ImmutableSet.of("scm-mail-plugin")); AvailablePlugin mail = createAvailable("scm-mail-plugin", "1"); when(mail.getDescriptor().getDependencies()).thenReturn(ImmutableSet.of("scm-notification-plugin")); AvailablePlugin notification = createAvailable("scm-notification-plugin", "1"); when(center.getAvailable()).thenReturn(ImmutableSet.of(review, mail, notification)); PendingPluginInstallation pendingNotification = mock(PendingPluginInstallation.class); doReturn(pendingNotification).when(installer).install(notification); PendingPluginInstallation pendingMail = mock(PendingPluginInstallation.class); doReturn(pendingMail).when(installer).install(mail); doThrow(new PluginChecksumMismatchException("checksum does not match")).when(installer).install(review); assertThrows(PluginInstallException.class, () -> manager.install("scm-review-plugin", false)); verify(pendingNotification).cancel(); verify(pendingMail).cancel(); } @Test void shouldInstallNothingIfOneOfTheDependenciesIsNotAvailable() { AvailablePlugin review = createAvailable("scm-review-plugin", "1"); when(review.getDescriptor().getDependencies()).thenReturn(ImmutableSet.of("scm-mail-plugin")); AvailablePlugin mail = createAvailable("scm-mail-plugin", "1"); when(mail.getDescriptor().getDependencies()).thenReturn(ImmutableSet.of("scm-notification-plugin")); when(center.getAvailable()).thenReturn(ImmutableSet.of(review, mail)); assertThrows(NotFoundException.class, () -> manager.install("scm-review-plugin", false)); verify(installer, never()).install(any()); } @Test void shouldSendRestartEventAfterInstallation() { AvailablePlugin git = createAvailable("scm-git-plugin", "1"); when(center.getAvailable()).thenReturn(ImmutableSet.of(git)); manager.install("scm-git-plugin", true); verify(installer).install(git); verify(eventBus).post(any(RestartEvent.class)); } @Test void shouldNotSendRestartEventIfNoPluginWasInstalled() { InstalledPlugin gitInstalled = createInstalled("scm-git-plugin", "1"); when(loader.getInstalledPlugins()).thenReturn(ImmutableList.of(gitInstalled)); manager.install("scm-git-plugin", true); verify(eventBus, never()).post(any()); } @Test void shouldNotInstallAlreadyPendingPlugins() { AvailablePlugin review = createAvailable("scm-review-plugin", "1"); when(center.getAvailable()).thenReturn(ImmutableSet.of(review)); manager.install("scm-review-plugin", false); manager.install("scm-review-plugin", false); // only one interaction verify(installer).install(any()); } @Test void shouldSendRestartEvent() { AvailablePlugin review = createAvailable("scm-review-plugin", "1"); when(center.getAvailable()).thenReturn(ImmutableSet.of(review)); manager.install("scm-review-plugin", false); manager.installPendingAndRestart(); verify(eventBus).post(any(RestartEvent.class)); } @Test void shouldNotSendRestartEventWithoutPendingPlugins() { manager.installPendingAndRestart(); verify(eventBus, never()).post(any()); } @Test void shouldReturnSingleAvailableAsPending() { AvailablePlugin review = createAvailable("scm-review-plugin", "1"); when(center.getAvailable()).thenReturn(ImmutableSet.of(review)); manager.install("scm-review-plugin", false); Optional available = manager.getAvailable("scm-review-plugin"); assertThat(available.get().isPending()).isTrue(); } @Test void shouldReturnAvailableAsPending() { AvailablePlugin review = createAvailable("scm-review-plugin", "1"); when(center.getAvailable()).thenReturn(ImmutableSet.of(review)); manager.install("scm-review-plugin", false); List available = manager.getAvailable(); assertThat(available.get(0).isPending()).isTrue(); } } @Nested class WithoutReadPermissions { @BeforeEach void setUpSubject() { ThreadContext.bind(subject); doThrow(AuthorizationException.class).when(subject).checkPermission("plugin:read"); } @AfterEach void clearThreadContext() { ThreadContext.unbindSubject(); } @Test void shouldThrowAuthorizationExceptionsForReadMethods() { assertThrows(AuthorizationException.class, () -> manager.getInstalled()); assertThrows(AuthorizationException.class, () -> manager.getInstalled("test")); assertThrows(AuthorizationException.class, () -> manager.getAvailable()); assertThrows(AuthorizationException.class, () -> manager.getAvailable("test")); } } @Nested class WithoutManagePermissions { @BeforeEach void setUpSubject() { ThreadContext.bind(subject); doThrow(AuthorizationException.class).when(subject).checkPermission("plugin:manage"); } @AfterEach void clearThreadContext() { ThreadContext.unbindSubject(); } @Test void shouldThrowAuthorizationExceptionsForInstallMethod() { assertThrows(AuthorizationException.class, () -> manager.install("test", false)); } @Test void shouldThrowAuthorizationExceptionsForInstallPendingAndRestart() { assertThrows(AuthorizationException.class, () -> manager.installPendingAndRestart()); } } private AvailablePlugin createAvailable(String name, String version) { PluginInformation information = new PluginInformation(); information.setName(name); information.setVersion(version); return createAvailable(information); } private InstalledPlugin createInstalled(String name, String version) { PluginInformation information = new PluginInformation(); information.setName(name); information.setVersion(version); return createInstalled(information); } private InstalledPlugin createInstalled(PluginInformation information) { InstalledPlugin plugin = mock(InstalledPlugin.class, Answers.RETURNS_DEEP_STUBS); returnInformation(plugin, information); return plugin; } private AvailablePlugin createAvailable(PluginInformation information) { AvailablePluginDescriptor descriptor = mock(AvailablePluginDescriptor.class); lenient().when(descriptor.getInformation()).thenReturn(information); return new AvailablePlugin(descriptor); } private void returnInformation(Plugin mockedPlugin, PluginInformation information) { when(mockedPlugin.getDescriptor().getInformation()).thenReturn(information); } }