Merge pull request #1088 from scm-manager/feature/add_events_for_landingpage

Feature/add events for landingpage

CHANGELOG.md

@@ -6,6 +6,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 ### Added
+- Fire various plugin events ([#1088](https://github.com/scm-manager/scm-manager/pull/1088))
 - Display version for plugins ([#1089](https://github.com/scm-manager/scm-manager/pull/1089)
 
 ### Changed

scm-core/src/main/java/sonia/scm/plugin/PluginCenterErrorEvent.java

@@ -0,0 +1,30 @@
+/*
+ * 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 sonia.scm.event.Event;
+
+@Event
+public class PluginCenterErrorEvent {}

scm-core/src/main/java/sonia/scm/plugin/PluginEvent.java

@@ -0,0 +1,43 @@
+/*
+ * 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 lombok.Getter;
+import sonia.scm.event.Event;
+
+@Getter
+@Event
+public class PluginEvent {
+  private final PluginEventType eventType;
+  private final AvailablePlugin plugin;
+  public PluginEvent(PluginEventType eventType, AvailablePlugin plugin) {
+    this.eventType = eventType;
+    this.plugin = plugin;
+  }
+
+  public enum PluginEventType {
+    INSTALLED, INSTALLATION_FAILED
+  }
+}

scm-webapp/pom.xml

@@ -24,7 +24,8 @@
     SOFTWARE.
 
 -->
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
 
   <modelVersion>4.0.0</modelVersion>
 
@@ -462,7 +463,6 @@
       <version>2.1.1</version>
       <scope>provided</scope>
     </dependency>
-
   </dependencies>
 
   <build>

scm-webapp/src/main/java/sonia/scm/plugin/DefaultPluginManager.java

@@ -21,7 +21,7 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-    
+
 package sonia.scm.plugin;
 
 import com.google.common.annotations.VisibleForTesting;
@@ -31,7 +31,6 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import sonia.scm.NotFoundException;
 import sonia.scm.event.ScmEventBus;
-import sonia.scm.lifecycle.RestartEvent;
 import sonia.scm.lifecycle.Restarter;
 import sonia.scm.version.Version;
 
@@ -52,7 +51,6 @@ import static sonia.scm.ScmConstraintViolationException.Builder.doThrow;
 //~--- JDK imports ------------------------------------------------------------
 
 /**
- *
  * @author Sebastian Sdorra
  */
 @Singleton
@@ -64,17 +62,19 @@ public class DefaultPluginManager implements PluginManager {
   private final PluginCenter center;
   private final PluginInstaller installer;
   private final Restarter restarter;
+  private final ScmEventBus eventBus;
 
   private final Collection<PendingPluginInstallation> pendingInstallQueue = new ArrayList<>();
   private final Collection<PendingPluginUninstallation> pendingUninstallQueue = new ArrayList<>();
   private final PluginDependencyTracker dependencyTracker = new PluginDependencyTracker();
 
   @Inject
-  public DefaultPluginManager(PluginLoader loader, PluginCenter center, PluginInstaller installer, Restarter restarter) {
+  public DefaultPluginManager(PluginLoader loader, PluginCenter center, PluginInstaller installer, Restarter restarter, ScmEventBus eventBus) {
     this.loader = loader;
     this.center = center;
     this.installer = installer;
     this.restarter = restarter;
+    this.eventBus = eventBus;
 
     this.computeInstallationDependencies();
   }
@@ -172,8 +172,10 @@ public class DefaultPluginManager implements PluginManager {
         PendingPluginInstallation pending = installer.install(plugin);
         dependencyTracker.addInstalled(plugin.getDescriptor());
         pendingInstallations.add(pending);
+        eventBus.post(new PluginEvent(PluginEvent.PluginEventType.INSTALLED, plugin));
       } catch (PluginInstallException ex) {
         cancelPending(pendingInstallations);
+        eventBus.post(new PluginEvent(PluginEvent.PluginEventType.INSTALLATION_FAILED, plugin));
         throw ex;
       }
     }
@@ -255,7 +257,7 @@ public class DefaultPluginManager implements PluginManager {
 
       Set<String> dependencies = plugin.getDescriptor().getDependencies();
       if (dependencies != null) {
-        for (String dependency: dependencies){
+        for (String dependency : dependencies) {
           collectPluginsToInstall(plugins, dependency, false);
         }
       }

scm-webapp/src/main/java/sonia/scm/plugin/PluginCenterLoader.java

@@ -27,10 +27,10 @@ package sonia.scm.plugin;
 import com.google.common.annotations.VisibleForTesting;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import sonia.scm.event.ScmEventBus;
 import sonia.scm.net.ahc.AdvancedHttpClient;
 
 import javax.inject.Inject;
-import java.io.IOException;
 import java.util.Collections;
 import java.util.Set;
 
@@ -40,16 +40,18 @@ class PluginCenterLoader {
 
   private final AdvancedHttpClient client;
   private final PluginCenterDtoMapper mapper;
+  private final ScmEventBus eventBus;
 
   @Inject
-  public PluginCenterLoader(AdvancedHttpClient client) {
-    this(client, PluginCenterDtoMapper.INSTANCE);
+  public PluginCenterLoader(AdvancedHttpClient client, ScmEventBus eventBus) {
+    this(client, PluginCenterDtoMapper.INSTANCE, eventBus);
   }
 
   @VisibleForTesting
-  PluginCenterLoader(AdvancedHttpClient client, PluginCenterDtoMapper mapper) {
+  PluginCenterLoader(AdvancedHttpClient client, PluginCenterDtoMapper mapper, ScmEventBus eventBus) {
     this.client = client;
     this.mapper = mapper;
+    this.eventBus = eventBus;
   }
 
   Set<AvailablePlugin> load(String url) {
@@ -59,8 +61,8 @@ class PluginCenterLoader {
       return mapper.map(pluginCenterDto);
     } catch (Exception ex) {
       LOG.error("failed to load plugins from plugin center, returning empty list", ex);
+      eventBus.post(new PluginCenterErrorEvent());
       return Collections.emptySet();
     }
   }
-
 }

scm-webapp/src/test/java/sonia/scm/api/v2/resources/PluginDtoMapperTest.java

@@ -31,22 +31,18 @@ import org.junit.jupiter.api.AfterEach;
 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.InjectMocks;
 import org.mockito.Mock;
 import org.mockito.junit.jupiter.MockitoExtension;
 import sonia.scm.lifecycle.Restarter;
 import sonia.scm.plugin.AvailablePlugin;
-import sonia.scm.plugin.AvailablePluginDescriptor;
 import sonia.scm.plugin.InstalledPlugin;
 import sonia.scm.plugin.PluginInformation;
 
 import java.net.URI;
-import java.util.Collections;
 
 import static java.util.Collections.emptyList;
 import static org.assertj.core.api.Assertions.assertThat;
-import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.when;
 import static sonia.scm.plugin.PluginTestHelper.createAvailable;
 import static sonia.scm.plugin.PluginTestHelper.createInstalled;

scm-webapp/src/test/java/sonia/scm/plugin/DefaultPluginManagerTest.java

@@ -36,16 +36,19 @@ import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
 import org.junitpioneer.jupiter.TempDirectory;
 import org.mockito.ArgumentCaptor;
+import org.mockito.Captor;
 import org.mockito.InjectMocks;
 import org.mockito.Mock;
 import org.mockito.junit.jupiter.MockitoExtension;
 import sonia.scm.NotFoundException;
 import sonia.scm.ScmConstraintViolationException;
+import sonia.scm.event.ScmEventBus;
 import sonia.scm.lifecycle.Restarter;
 
 import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.util.Collections;
 import java.util.List;
 import java.util.Optional;
 
@@ -53,6 +56,7 @@ import static java.util.Arrays.asList;
 import static java.util.Collections.singleton;
 import static java.util.Collections.singletonList;
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.in;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.mockito.Mockito.any;
 import static org.mockito.Mockito.doNothing;
@@ -83,6 +87,12 @@ class DefaultPluginManagerTest {
   @Mock
   private Restarter restarter;
 
+  @Mock
+  private ScmEventBus eventBus;
+
+  @Captor
+  private ArgumentCaptor<PluginEvent> eventCaptor;
+
   @InjectMocks
   private DefaultPluginManager manager;
 
@@ -537,8 +547,36 @@ class DefaultPluginManagerTest {
 
       verify(installer, never()).install(oldScriptPlugin);
     }
+
+    @Test
+    void shouldFirePluginEventOnInstallation() {
+      AvailablePlugin review = createAvailable("scm-review-plugin");
+      when(center.getAvailable()).thenReturn(ImmutableSet.of(review));
+
+      manager.install("scm-review-plugin", false);
+
+      verify(eventBus).post(eventCaptor.capture());
+
+      assertThat(eventCaptor.getValue().getEventType()).isEqualTo(PluginEvent.PluginEventType.INSTALLED);
+      assertThat(eventCaptor.getValue().getPlugin()).isEqualTo(review);
+    }
+
+    @Test
+    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);
+
+      assertThrows(PluginDownloadException.class, () -> manager.install("scm-review-plugin", false));
+
+      verify(eventBus).post(eventCaptor.capture());
+      assertThat(eventCaptor.getValue().getEventType()).isEqualTo(PluginEvent.PluginEventType.INSTALLATION_FAILED);
+      assertThat(eventCaptor.getValue().getPlugin()).isEqualTo(review);
+    }
+
   }
 
+
   @Nested
   class WithoutReadPermissions {
 

scm-webapp/src/test/java/sonia/scm/plugin/PluginCenterLoaderTest.java

@@ -21,7 +21,7 @@
  * 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;
@@ -30,6 +30,7 @@ import org.mockito.Answers;
 import org.mockito.InjectMocks;
 import org.mockito.Mock;
 import org.mockito.junit.jupiter.MockitoExtension;
+import sonia.scm.event.ScmEventBus;
 import sonia.scm.net.ahc.AdvancedHttpClient;
 
 import java.io.IOException;
@@ -37,6 +38,8 @@ import java.util.Collections;
 import java.util.Set;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 
 @ExtendWith(MockitoExtension.class)
@@ -50,6 +53,9 @@ class PluginCenterLoaderTest {
   @Mock
   private PluginCenterDtoMapper mapper;
 
+  @Mock
+  private ScmEventBus eventBus;
+
   @InjectMocks
   private PluginCenterLoader loader;
 
@@ -71,4 +77,13 @@ class PluginCenterLoaderTest {
     Set<AvailablePlugin> fetch = loader.load(PLUGIN_URL);
     assertThat(fetch).isEmpty();
   }
+
+  @Test
+  void shouldFirePluginCenterErrorEvent() throws IOException {
+    when(client.get(PLUGIN_URL).request()).thenThrow(new IOException("failed to fetch"));
+
+    loader.load(PLUGIN_URL);
+
+    verify(eventBus).post(any(PluginCenterErrorEvent.class));
+  }
 }