SONAR-6056 API: closeable components must be closed when stopping picocontainer

2 files changed, 56 insertions, 2 deletions

diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/platform/ComponentContainer.java b/sonar-plugin-api/src/main/java/org/sonar/api/platform/ComponentContainer.java
index daf6a1e12d7..d92592678eb 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/platform/ComponentContainer.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/platform/ComponentContainer.java
@@ -32,7 +32,6 @@ import org.sonar.api.ServerComponent;
 import org.sonar.api.config.PropertyDefinitions;
 
 import javax.annotation.Nullable;
-
 import java.util.Collection;
 import java.util.List;
 
@@ -122,6 +121,7 @@ public class ComponentContainer implements BatchComponent, ServerComponent {
   public ComponentContainer stopComponents(boolean swallowException) {
     try {
       pico.stop();
+      pico.dispose();
 
     } catch (RuntimeException e) {
       if (!swallowException) {
@@ -230,7 +230,7 @@ public class ComponentContainer implements BatchComponent, ServerComponent {
   }
 
   static MutablePicoContainer createPicoContainer() {
-    ReflectionLifecycleStrategy lifecycleStrategy = new ReflectionLifecycleStrategy(new NullComponentMonitor(), "start", "stop", "dispose");
+    ReflectionLifecycleStrategy lifecycleStrategy = new ReflectionLifecycleStrategy(new NullComponentMonitor(), "start", "stop", "close");
     return new DefaultPicoContainer(new OptInCaching(), lifecycleStrategy, null);
   }
 
diff --git a/sonar-plugin-api/src/test/java/org/sonar/api/platform/ComponentContainerTest.java b/sonar-plugin-api/src/test/java/org/sonar/api/platform/ComponentContainerTest.java
index 4135639a877..44660bf61c7 100644
--- a/sonar-plugin-api/src/test/java/org/sonar/api/platform/ComponentContainerTest.java
+++ b/sonar-plugin-api/src/test/java/org/sonar/api/platform/ComponentContainerTest.java
@@ -288,6 +288,37 @@ public class ComponentContainerTest {
     assertThat(component.stopped).isTrue();
   }
 
+  /**
+   * Method close() must be called even if the methods start() or stop()
+   * are not defined.
+   */
+  @Test
+  public void should_close_components_without_lifecycle() throws Exception {
+    ComponentContainer container = new ComponentContainer();
+    CloseableComponent component = new CloseableComponent();
+    container.add(component);
+
+    container.execute();
+
+    assertThat(component.isClosed).isTrue();
+  }
+
+  /**
+   * Method close() must be executed after stop()
+   */
+  @Test
+  public void should_close_components_with_lifecycle() throws Exception {
+    ComponentContainer container = new ComponentContainer();
+    StartableCloseableComponent component = new StartableCloseableComponent();
+    container.add(component);
+
+    container.execute();
+
+    assertThat(component.isStopped).isTrue();
+    assertThat(component.isClosed).isTrue();
+    assertThat(component.isClosedAfterStop).isTrue();
+  }
+
   public static class StartableComponent {
     public boolean started = false, stopped = false;
 
@@ -333,4 +364,27 @@ public class ComponentContainerTest {
       return new SimpleComponent();
     }
   }
+
+  public static class CloseableComponent implements AutoCloseable {
+    public boolean isClosed = false;
+
+    @Override
+    public void close() throws Exception {
+      isClosed = true;
+    }
+  }
+
+  public static class StartableCloseableComponent implements AutoCloseable {
+    public boolean isClosed = false, isStopped = false, isClosedAfterStop = false;
+
+    public void stop() {
+      isStopped = true;
+    }
+
+    @Override
+    public void close() throws Exception {
+      isClosed = true;
+      isClosedAfterStop = isStopped;
+    }
+  }
 }