Merge pull request #4 from mtrakal/feature/sync-with-root

Feature/sync with root

Author: mtrakal

README.md

@@ -55,12 +55,13 @@ moduleGraphAssert {
 Apply the plugin to a module, which dependencies graph you want to assert.
 ```groovy
 plugins {
-  id "cz.mtrakal.module.graph.assertion" version "2.5.0"
+  id "cz.mtrakal.module.graph.assertion" version "3.0.0"
 }
 ```
 
 - You can run `./gradlew assertModuleGraph` to execute configured checks or `./gradlew check` where `assertModuleGraph` will be included.
 - Alternative option is using `assertOnAnyBuild = true` configuration to run the checks on every single Gradle build without need for running explicit tasks - see https://github.com/jraska/modules-graph-assert/pull/184 for more details.
+- Hint: Gradle [Configuration On Demand](https://docs.gradle.org/current/userguide/multi_project_configuration_and_execution.html) may hide some modules from the plugin visibility. If you notice some modules are missing, try the `--no-configure-on-demand` flag.
 
 ### Configuration
 Rules are applied on the Gradle module and its `api` and `implementation` dependencies by default. Typically you would want to apply this in your final app module, however configuration for any module is possible. [Example](https://github.com/jraska/github-client/blob/master/app/build.gradle#L141)
@@ -162,11 +163,9 @@ Please feel free to create PR or issue with any suggestions or ideas. No special
 
 ### Debugging
 
-**Setting up a composite build:**
+**Setting up a composite build**
 
-This case is helpful when you need to debug in a real project.
-Composite builds are consumed directly without publishing a snapshot version.  
-This is done already in `example` project, but you can do the same in any other project:
+[Composite builds](https://docs.gradle.org/current/userguide/composite_builds.html#settings_defined_composite) are consumed directly without publishing a version.  
 
 settings.gradle:
 ```groovy

gradle/wrapper/gradle-wrapper.jar

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.9-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

gradle/wrapper/gradle-wrapper.properties

@@ -21,7 +21,7 @@ gradlePlugin {
   plugins {
     create("modulesGraphAssert") {
       id = "cz.mtrakal.module.graph.assertion"
-      version = "3.0.0"
+      version = "3.0.1"
       displayName = "Modules Graph Assert Mermaid"
       description = "Gradle plugin to keep your modules graph healthy and lean with Mermaid output."
       implementationClass = "com.jraska.module.graph.assertion.ModuleGraphAssertionsPlugin"

plugin/build.gradle.kts

@@ -1,10 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <baseline version="1.0">
-    <file name="src/main/kotlin/com/jraska/module/graph/assertion/ModuleTreeHeightAssert.kt">
-        <error line="27" column="141" source="standard:max-line-length" />
-        <error line="37" column="141" source="standard:max-line-length" />
-    </file>
-    <file name="src/test/kotlin/com/jraska/module/graph/assertion/OnAnyBuildAssertTest.kt">
-        <error line="128" column="141" source="standard:max-line-length" />
+    <file name="src/test/kotlin/com/jraska/module/graph/assertion/FullProjectRootGradleTest.kt">
+        <error line="95" column="141" source="standard:max-line-length" />
     </file>
 </baseline>

plugin/config/ktlint/baseline.xml

@@ -3,6 +3,8 @@
   <ManuallySuppressedIssues></ManuallySuppressedIssues>
   <CurrentIssues>
     <ID>LongMethod:DependencyGraphTest.kt$DependencyGraphTest$@Test fun countsStatisticsWell()</ID>
+    <ID>MaxLineLength:FullProjectMultipleAppliedGradleTest.kt$FullProjectMultipleAppliedGradleTest$"GraphStatistics(modulesCount=3, edgesCount=3, height=2, longestPath=':app -&gt; :core -&gt; :core-api')${System.lineSeparator()}"</ID>
+    <ID>MaxLineLength:FullProjectRootGradleTest.kt$FullProjectRootGradleTest$"GraphStatistics\\(modulesCount=1, edgesCount=0, height=0, longestPath=\'root.*\'\\)${System.lineSeparator()}${System.lineSeparator()}"</ID>
     <ID>MaxLineLength:ModuleTreeHeightAssert.kt$ModuleTreeHeightAssert$"Module $moduleName is allowed to have maximum height of $maxHeight, but has $height, problematic dependencies: ${longestPath.pathString()}"</ID>
     <ID>MaxLineLength:ModuleTreeHeightAssert.kt$ModuleTreeHeightAssert$"Module Graph is allowed to have maximum height of $maxHeight, but has $height, problematic dependencies: ${longestPath.pathString()}"</ID>
     <ID>MaxLineLength:OnAnyBuildAssertTest.kt$OnAnyBuildAssertTest$"""["App"(':app') -&gt; "Implementation"(':core'), "App"(':app') -&gt; "Implementation"(':feature')] not allowed by any of ['Implementation -&gt; Api', 'App -&gt; Api']"""</ID>

plugin/detekt-baseline.xml

@@ -59,7 +59,7 @@ class DependencyGraph private constructor() {
     require(nodes.contains(key)) { "Dependency Tree doesn't contain module: $key" }
 
     val connections = mutableListOf<Pair<String, String>>()
-    addConnections(nodes.getValue(key), connections)
+    addConnections(nodes.getValue(key), connections, mutableSetOf(), mutableSetOf())
 
     return if (connections.isEmpty()) {
       createSingular(key)
@@ -77,11 +77,28 @@ class DependencyGraph private constructor() {
   private fun addConnections(
     node: Node,
     into: MutableList<Pair<String, String>>,
+    path: MutableSet<Node>,
+    visited: MutableSet<Node>,
   ) {
-    node.dependsOn.forEach {
-      into.add(node.key to it.key)
-      addConnections(it, into)
+    if (visited.contains(node)) {
+      return
+    } else {
+      visited.add(node)
+    }
+
+    path.add(node)
+    node.dependsOn.forEach { dependant ->
+      into.add(node.key to dependant.key)
+
+      val nodeInCurrentPath = path.contains(dependant)
+      if (nodeInCurrentPath) {
+        val pathText = path.joinToString(separator = ", ") { it.key }
+        error("Dependency cycle detected! Cycle in nodes: '$pathText'.")
+      }
+      addConnections(dependant, into, path, visited)
     }
+
+    path.remove(node)
   }
 
   private fun countEdges(): Int = nodes().flatMap { node -> node.dependsOn }.count()

plugin/src/main/kotlin/com/jraska/module/graph/DependencyGraph.kt

@@ -29,4 +29,28 @@ class DependencyGraphPerformanceTest {
     assert(statistics.edgesCount == 15259)
     assert(statistics.longestPath.pathString().startsWith("23 -> 31 -> 36 -> 57 -> 61 -> 72 -> 74 -> 75"))
   }
+
+  @Test(timeout = 1_000)
+  fun whenTheGraphIsLarge_statisticsOfSubgraphMatchFast() {
+    val subGraphStatistics = dependencyGraph.subTree("31").statistics()
+
+    assert(subGraphStatistics.height == 58)
+    assert(subGraphStatistics.longestPath.pathString().startsWith("31 -> 36 -> 57 -> 61 -> 72 -> 74 -> 75"))
+  }
+
+  @Test(timeout = 1_000)
+  fun whenTheGraphIsLarge_statisticsCreatedFast() {
+    val subGraphStatistics = dependencyGraph.subTree("500").statistics()
+    assert(subGraphStatistics.modulesCount == 281)
+  }
+
+  @Test(timeout = 1_000) // was running out of heap before optimisation
+  fun whenTheGraphIsLarge_statisticsLargeCreatedFast() {
+    val subGraphStatistics = dependencyGraph.subTree("2").statistics()
+
+    assert(subGraphStatistics.modulesCount == 870)
+    assert(subGraphStatistics.edgesCount == 11650)
+    assert(subGraphStatistics.height == 55)
+    assert(subGraphStatistics.longestPath.pathString().startsWith("2 -> 30 -> 76 -> 105 -> 119 -> "))
+  }
 }

plugin/src/test/kotlin/com/jraska/module/graph/DependencyGraphPerformanceTest.kt

@@ -165,4 +165,63 @@ class DependencyGraphTest {
         ),
     )
   }
+
+  @Test(expected = IllegalStateException::class)
+  fun cyclesDoNotOverflow() {
+    val dependencyTree =
+      DependencyGraph.create(
+        "feature" to "lib",
+        "lib" to "core",
+        "lib" to "feature",
+        "feature" to "core",
+        "app" to "feature",
+      )
+
+    dependencyTree.subTree("app")
+  }
+
+  @Test
+  fun doesNotDetectCycleOnMultiEntry() {
+    val dependencyTree =
+      DependencyGraph.create(
+        "feature" to "lib",
+        "app" to "lib",
+        "app" to "feature",
+      )
+
+    assert(dependencyTree.subTree("app").findRoot().key == "app")
+  }
+
+  @Test(expected = IllegalStateException::class)
+  fun detectsTwoNodesCycle() {
+    val dependencyTree =
+      DependencyGraph.create(
+        "feature" to "app",
+        "app" to "feature",
+      )
+
+    dependencyTree.subTree("app")
+  }
+
+  @Test(expected = IllegalStateException::class)
+  fun detectsThreeNodesCycle() {
+    val dependencyTree =
+      DependencyGraph.create(
+        "feature" to "app",
+        "app" to "lib",
+        "lib" to "feature",
+      )
+
+    dependencyTree.subTree("app")
+  }
+
+  @Test(expected = IllegalStateException::class)
+  fun detectsSingleNodeCycle() {
+    val dependencyTree =
+      DependencyGraph.create(
+        "app" to "app",
+      )
+
+    dependencyTree.subTree("app")
+  }
 }

plugin/src/test/kotlin/com/jraska/module/graph/DependencyGraphTest.kt

@@ -1,7 +1,5 @@
 package com.jraska.module.graph.assertion
 
-import org.hamcrest.CoreMatchers
-import org.hamcrest.MatcherAssert
 import org.junit.Before
 import org.junit.Rule
 import org.junit.Test
@@ -129,9 +127,8 @@ class FullProjectGradleTest {
         "-Pmodules.graph.of.module=:feature",
       ).output
 
-    MatcherAssert.assertThat(
-      output,
-      CoreMatchers.containsString(
+    assert(
+      output.contains(
         "digraph G {\n" +
           "\":feature('Implementation')\" -> \":core-api('Api')\" [color=red style=bold]\n" +
           "}",
@@ -148,9 +145,8 @@ class FullProjectGradleTest {
         "-Pmodules.graph.of.module=:feature",
       ).output
 
-    MatcherAssert.assertThat(
-      output,
-      CoreMatchers.containsString(
+    assert(
+      output.contains(
         "GraphStatistics(modulesCount=2, edgesCount=1, height=1, longestPath=':feature -> :core-api')",
       ),
     )