Fix failing graph height check on root project (#62)

* Fix failing graph height check on root project * Fix typo
jraska · Aug 3, 2020 · de7f247 · de7f247
1 parent 72de66b
commit de7f247
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 3 deletions.
diff --git a/example/build.gradle b/example/build.gradle
@@ -14,5 +14,6 @@ task clean(type: Delete) {
 }
 
 moduleGraphAssert {
+  maxHeight = 3
   configurations = ['api', 'implementation', 'testImplementation']
 }
diff --git a/plugin/src/main/kotlin/com/jraska/module/graph/assertion/ModuleGraphAssertionsPlugin.kt b/plugin/src/main/kotlin/com/jraska/module/graph/assertion/ModuleGraphAssertionsPlugin.kt
@@ -61,7 +61,7 @@ class ModuleGraphAssertionsPlugin : Plugin<Project> {
     }
 
     val task = tasks.register(Tasks.ASSERT_MAX_HEIGHT, AssertGraphTask::class.java) {
-      it.assertion = ModuleTreeHeightAssert(moduleDisplayName(), graphRules.maxHeight)
+      it.assertion = ModuleTreeHeightAssert(moduleNameForHeightAssert(), graphRules.maxHeight)
       it.configurationsToLook = graphRules.configurations
       it.group = VERIFICATION_GROUP
     }
@@ -115,6 +115,14 @@ class ModuleGraphAssertionsPlugin : Plugin<Project> {
   }
 }
 
+private fun Project.moduleNameForHeightAssert(): String? {
+  if (this == rootProject) {
+    return null
+  } else {
+    return moduleDisplayName()
+  }
+}
+
 fun Project.moduleDisplayName(): String {
   return displayName.replace("project", "")
     .replace("'", "")

diff --git a/plugin/src/main/kotlin/com/jraska/module/graph/assertion/ModuleTreeHeightAssert.kt b/plugin/src/main/kotlin/com/jraska/module/graph/assertion/ModuleTreeHeightAssert.kt
@@ -4,14 +4,30 @@ import com.jraska.module.graph.DependencyGraph
 import org.gradle.api.GradleException
 
 class ModuleTreeHeightAssert(
-  private val moduleName: String,
+  private val moduleName: String?,
   private val maxHeight: Int
 ) : GraphAssert {
   override fun assert(dependencyGraph: DependencyGraph) {
+    if (moduleName == null) {
+      assertWholeGraphHeight(dependencyGraph)
+    } else {
+      assertModuleHeight(dependencyGraph, moduleName)
+    }
+  }
+
+  private fun assertModuleHeight(dependencyGraph: DependencyGraph, moduleName: String) {
     val height = dependencyGraph.heightOf(moduleName)
     if (height > maxHeight) {
       val longestPath = dependencyGraph.longestPath(moduleName)
       throw GradleException("Module $moduleName is allowed to have maximum height of $maxHeight, but has $height, problematic dependencies: ${longestPath.pathString()}")
     }
   }
+
+  private fun assertWholeGraphHeight(dependencyGraph: DependencyGraph) {
+    val height = dependencyGraph.height()
+    if (height > maxHeight) {
+      val longestPath = dependencyGraph.longestPath()
+      throw GradleException("Module Graph is allowed to have maximum height of $maxHeight, but has $height, problematic dependencies: ${longestPath.pathString()}")
+    }
+  }
 }
diff --git a/plugin/src/test/kotlin/com/jraska/module/graph/assertion/ModuleTreeHeightAssertTest.kt b/plugin/src/test/kotlin/com/jraska/module/graph/assertion/ModuleTreeHeightAssertTest.kt
@@ -13,12 +13,26 @@ class ModuleTreeHeightAssertTest {
   }
 
   @Test(expected = GradleException::class)
-  fun failsOnUnknownLayer() {
+  fun failsOnTooLargeHeight() {
     val dependencyGraph = testGraph()
 
     ModuleTreeHeightAssert("app", 2).assert(dependencyGraph)
   }
 
+  @Test
+  fun passesOnCorrectRoot() {
+    val dependencyGraph = testGraph()
+
+    ModuleTreeHeightAssert(null, 3).assert(dependencyGraph)
+  }
+
+  @Test(expected = GradleException::class)
+  fun failsOnTooHighGraphHeight() {
+    val dependencyGraph = testGraph()
+
+    ModuleTreeHeightAssert(null, 2).assert(dependencyGraph)
+  }
+
   @Test(expected = NoSuchElementException::class)
   fun failsOnUnknownModule() {
     val dependencyGraph = testGraph()