Add detection of circular dependencies

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

@@ -51,7 +51,7 @@ import java.util.Set;
  *
  * @author Sebastian Sdorra
  */
-public final class ExplodedSmp implements Comparable<ExplodedSmp>
+public final class ExplodedSmp
 {
 
   private static final Logger logger = LoggerFactory.getLogger(ExplodedSmp.class);
@@ -90,60 +90,6 @@ public final class ExplodedSmp implements Comparable<ExplodedSmp>
     return new ExplodedSmp(directory, Plugins.parsePluginDescriptor(desc));
   }
 
-  /**
-   * {@inheritDoc}
-   */
-  @Override
-  public int compareTo(ExplodedSmp o)
-  {
-    int result;
-
-    Set<String> depends = plugin.getDependenciesInclusiveOptionals();
-    Set<String> odepends = o.plugin.getDependenciesInclusiveOptionals();
-
-    if (depends.isEmpty() && odepends.isEmpty())
-    {
-      result = 0;
-    }
-    else if (depends.isEmpty() &&!odepends.isEmpty())
-    {
-      result = -1;
-    }
-    else if (!depends.isEmpty() && odepends.isEmpty())
-    {
-      result = 1;
-    }
-    else
-    {
-      String id = plugin.getInformation().getName(false);
-      String oid = o.plugin.getInformation().getName(false);
-
-      if (depends.contains(oid) && odepends.contains(id))
-      {
-        StringBuilder b = new StringBuilder("circular dependency detected: ");
-
-        b.append(id).append(" depends on ").append(oid).append(" and ");
-        b.append(oid).append(" depends on ").append(id);
-
-        throw new PluginCircularDependencyException(b.toString());
-      }
-      else if (depends.contains(oid))
-      {
-        result = 999;
-      }
-      else if (odepends.contains(id))
-      {
-        result = -999;
-      }
-      else
-      {
-        result = 0;
-      }
-    }
-
-    return result;
-  }
-
   //~--- get methods ----------------------------------------------------------
 
   /**

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

@@ -29,6 +29,8 @@ class SmpNodeBuilder {
           otherNode.addChild(node);
         }
       });
+
+      nodes.forEach(this::checkForCircle);
     });
 
     return nodes;
@@ -47,4 +49,18 @@ class SmpNodeBuilder {
       }
     });
   }
+
+  private void checkForCircle(PluginNode pluginNode) {
+    pluginNode.getChildren().forEach(child -> assertDoesNotContainsDependency(pluginNode, child));
+  }
+
+  private void assertDoesNotContainsDependency(PluginNode pluginNode, PluginNode childNode) {
+    if (childNode == pluginNode) {
+      throw new PluginCircularDependencyException("circular dependency detected: " +
+        childNode.getId() + " depends on " + pluginNode.getId() + " and " +
+        pluginNode.getId() + " depends on " + childNode.getId()
+      );
+    }
+    childNode.getChildren().forEach(child -> assertDoesNotContainsDependency(pluginNode, child));
+  }
 }

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

@@ -1,173 +0,0 @@
-/**
- * Copyright (c) 2010, Sebastian Sdorra All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * 1. Redistributions of source code must retain the above copyright notice,
- * this list of conditions and the following disclaimer. 2. Redistributions in
- * binary form must reproduce the above copyright notice, this list of
- * conditions and the following disclaimer in the documentation and/or other
- * materials provided with the distribution. 3. Neither the name of SCM-Manager;
- * nor the names of its contributors may be used to endorse or promote products
- * derived from this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR
- * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- * http://bitbucket.org/sdorra/scm-manager
- *
- */
-
-
-
-package sonia.scm.plugin;
-
-//~--- non-JDK imports --------------------------------------------------------
-
-import com.google.common.collect.Lists;
-
-import org.junit.Test;
-
-import org.mockito.internal.util.collections.Sets;
-
-import static org.junit.Assert.*;
-
-//~--- JDK imports ------------------------------------------------------------
-
-import java.util.Collections;
-import java.util.List;
-
-/**
- *
- * @author Sebastian Sdorra
- */
-public class ExplodedSmpTest
-{
-
-  /**
-   * Method description
-   *
-   */
-  @Test
-  public void testCompareTo()
-  {
-    ExplodedSmp e1 = create("a", "c", "1", "a");
-    ExplodedSmp e3 = create("a", "a", "1");
-    ExplodedSmp e2 = create("a", "b", "1");
-    List<ExplodedSmp> es = list(e1, e2, e3);
-
-    is(es, 2, "a");
-  }
-
-  /**
-   * Method description
-   *
-   */
-  @Test(expected = PluginCircularDependencyException.class)
-  public void testCompareToCyclicDependency()
-  {
-    ExplodedSmp e1 = create("a", "1", "c");
-    ExplodedSmp e2 = create("b", "1");
-    ExplodedSmp e3 = create("c", "1", "a");
-
-    list(e1, e2, e3);
-  }
-
-  /**
-   * Method description
-   *
-   */
-  @Test
-  public void testCompareToTransitiveDependencies()
-  {
-    ExplodedSmp e1 = create("a", "1", "b");
-    ExplodedSmp e2 = create("b", "1");
-    ExplodedSmp e3 = create("c", "1", "a");
-
-    List<ExplodedSmp> es = list(e1, e2, e3);
-
-    is(es, 0, "b");
-    is(es, 1, "a");
-    is(es, 2, "c");
-  }
-
-  /**
-   * Method description
-   *
-   */
-  @Test
-  public void testMultipleDependencies()
-  {
-    ExplodedSmp e1 = create("a", "1", "b", "c");
-    ExplodedSmp e2 = create("b", "1", "c");
-    ExplodedSmp e3 = create("c", "1");
-    List<ExplodedSmp> es = list(e1, e2, e3);
-
-    is(es, 2, "a");
-  }
-
-  /**
-   * Method description
-   *
-   *
-   * @param name
-   * @param version
-   * @param dependencies
-   *
-   * @return
-   */
-  private ExplodedSmp create(String name, String version,
-    String... dependencies)
-  {
-    PluginInformation info = new PluginInformation();
-
-    info.setName(name);
-    info.setVersion(version);
-
-    InstalledPluginDescriptor plugin = new InstalledPluginDescriptor(2, info, null, null, false,
-                      Sets.newSet(dependencies), null);
-
-    return new ExplodedSmp(null, plugin);
-  }
-
-  /**
-   * Method description
-   *
-   *
-   * @param e
-   *
-   * @return
-   */
-  private List<ExplodedSmp> list(ExplodedSmp... e)
-  {
-    List<ExplodedSmp> es = Lists.newArrayList(e);
-
-    Collections.sort(es);
-
-    return es;
-  }
-
-  //~--- get methods ----------------------------------------------------------
-
-  /**
-   * Method description
-   *
-   *
-   * @param es
-   * @param p
-   * @param a
-   */
-  private void is(List<ExplodedSmp> es, int p, String a)
-  {
-    assertEquals(a, es.get(p).getPlugin().getInformation().getName());
-  }
-}

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

@@ -60,6 +60,17 @@ public class SmpNodeBuilderTest {
     new SmpNodeBuilder().buildNodeTree(smps);
   }
 
+  @Test(expected = PluginCircularDependencyException.class)
+  public void shouldFailForCircularDependency() throws IOException {
+    ExplodedSmp[] smps = new ExplodedSmp[]{
+      createSmpWithDependency("scm-pathwp-plugin", "scm-editor-plugin"),
+      createSmpWithDependency("scm-editor-plugin", "scm-review-plugin"),
+      createSmpWithDependency("scm-review-plugin", "scm-pathwp-plugin")
+    };
+
+    new SmpNodeBuilder().buildNodeTree(smps);
+  }
+
   private PluginNode findNode(List<PluginNode> nodes, String id) {
     return nodes.stream().filter(node -> node.getId().equals(id)).findAny().orElseThrow(() -> new AssumptionViolatedException("node not found"));
   }