feat: failure-on-cycles option (#7)

Author: heowc

.github/workflows/ci.yml

@@ -35,7 +35,7 @@ jobs:
       - name: Plugin Test
         run: |
           ./gradlew :heo-gradle-plugin:publishToMavenLocal
-          ./gradlew -PlocalPlugin :it:gradle-plugin:heoReport
+          ./gradlew -PlocalPlugin pluginTest
       - name: Create self report file
         if: success()
         run: |

README.md

@@ -12,7 +12,8 @@ This tool relies on [graphviz](https://graphviz.org/). Please install graphviz f
 
 - `d`: Enter the directory path.
 - `p`: Enter the package path.
-- `o`: Enter the destination file path.
+- `o`: (optional) Enter the destination file path.
+- `failure-on-cycles`: (optional) Enter whether to fail if a cycle occurs between modules.
 
 ```bash
 java -jar heo-cli-0.0.2.jar -d /Users/heowc/Projects/heo -p dev.heowc.heo
@@ -52,6 +53,8 @@ heo {
     directoryPath = "${rootDir}/heo-core" // The default is to use the root path.
     prefixPackage = "dev.heowc.heo.core" // The default is group.
     // destination // By default, the `reports/heo/index.png` image file is created under the build path.
+    // failure-on-cycles // The default option is disabled, 
+                         // and if enabled the task will fail if a cycle occurs.
 }
 ```
 

heo-cli/src/main/java/dev/heowc/heo/cli/HeoCliService.java

@@ -2,6 +2,8 @@
 
 import java.util.List;
 
+import dev.heowc.heo.core.HeoException;
+
 import org.springframework.stereotype.Service;
 
 import dev.heowc.heo.core.Module;
@@ -29,11 +31,14 @@ public HeoCliService(ModuleLoaderService moduleLoaderService,
         this.reportVisualizationService = reportVisualizationService;
     }
 
-    public void command(String directory, String rootPackage, String destination) {
+    public void command(String directory, String rootPackage, String destination, HeoConfig heoConfig) {
         final List<Module> modules = moduleLoaderService.loads(directory, rootPackage);
         final DependencyAnalysisResult result =
                 dependencyAnalysisService.analyzeProjectDependencies(modules, rootPackage);
         final String report = analysisReportService.createReport(result);
         reportVisualizationService.createFile(report, destination);
+        if (heoConfig.failureOnCycles() && result.hasCycle()) {
+            throw new HeoException("Cycles occurred");
+        }
     }
 }

heo-cli/src/main/java/dev/heowc/heo/cli/HeoCommand.java

@@ -18,10 +18,11 @@ public HeoCommand(HeoCliService service) {
     @Command(command = "heo")
     public void doHeo(@Option(shortNames = 'd', required = true) String directory,
                       @Option(shortNames = 'p', required = true) String prefixPackage,
-                      @Option(shortNames = 'o') String destination) {
+                      @Option(shortNames = 'o') String destination,
+                      @Option(longNames = "failure-on-cycles", defaultValue = "false") boolean failureOnCycles) {
         if (StringUtils.isBlank(destination)) {
             destination = String.format("result-%s.png", System.currentTimeMillis());
         }
-        service.command(directory, prefixPackage, destination);
+        service.command(directory, prefixPackage, destination, new HeoConfig(failureOnCycles));
     }
 }

heo-cli/src/main/java/dev/heowc/heo/cli/HeoConfig.java

@@ -0,0 +1,5 @@
+package dev.heowc.heo.cli;
+
+public record HeoConfig(boolean failureOnCycles) {
+
+}

heo-core/src/main/java/dev/heowc/heo/core/HeoException.java

@@ -0,0 +1,8 @@
+package dev.heowc.heo.core;
+
+public class HeoException extends RuntimeException {
+
+    public HeoException(String message) {
+        super(message);
+    }
+}

heo-core/src/main/java/dev/heowc/heo/core/analysis/domain/DependencyAnalysisResult.java

@@ -19,4 +19,8 @@ public DomainGraph getDomainGraph() {
     public CycleDetector<String, DomainEdge> getCycleDetector() {
         return cycleDetector;
     }
+
+    public boolean hasCycle() {
+        return cycleDetector.detectCycles();
+    }
 }

heo-gradle-plugin/src/main/java/dev/heowc/heo/gradle/HeoPlugin.java

@@ -7,19 +7,19 @@
 import java.nio.file.StandardCopyOption;
 import java.util.List;
 
+import javax.annotation.Nullable;
+
 import org.gradle.api.Plugin;
 import org.gradle.api.Project;
 import org.gradle.api.tasks.JavaExec;
 
-import javax.annotation.Nullable;
-
 public class HeoPlugin implements Plugin<Project> {
 
     private static final String REPORT_PATH = "build/reports/heo";
 
     @Override
     public void apply(Project project) {
-        final HeoConfig config = project.getExtensions().create("heo", HeoConfig.class);
+        final HeoPluginConfig config = project.getExtensions().create("heo", HeoPluginConfig.class);
         project.getTasks().register("heoReport", JavaExec.class, task -> {
             task.setGroup("heo");
             task.setDescription("Execute heo-cli");
@@ -37,24 +37,33 @@ public void apply(Project project) {
 
             task.setMain("-jar");
             task.args(tempJar.getAbsolutePath());
-            task.args(List.of("-d", determineDirectory(project, config.getDirectoryPath()),
-                              "-p", determinePrefixPackage(project, config.getPrefixPackage()),
-                              "-o", determineDestination(project, config.getDestination())));
+            task.args(List.of(
+                    "-d", determineDirectory(project, config.getDirectoryPath()),
+                    "-p", determinePrefixPackage(project, config.getPrefixPackage()),
+                    "-o", determineDestination(project, config.getDestination()),
+                    "--failure-on-cycles", config.isFailureOnCycles()
+            ));
 
             tempJar.deleteOnExit();
         });
     }
 
     private static String determineDirectory(Project project, @Nullable String directoryPath) {
-        return StringUtils.isBlank(directoryPath) ? project.getProjectDir().getAbsolutePath() : directoryPath;
+        return StringUtils.isBlank(directoryPath)
+               ? project.getProjectDir().getAbsolutePath()
+               : directoryPath;
     }
 
     private static String determinePrefixPackage(Project project, @Nullable String prefixPackage) {
-        return StringUtils.isBlank(prefixPackage) ? project.getGroup().toString() : prefixPackage;
+        return StringUtils.isBlank(prefixPackage)
+               ? project.getGroup().toString()
+               : prefixPackage;
     }
 
     private static String determineDestination(Project project, @Nullable String destination) {
-        return StringUtils.isBlank(destination) ? Path.of(project.getProjectDir().getAbsolutePath(), REPORT_PATH, "index.png").toString() : destination;
+        return StringUtils.isBlank(destination)
+               ? Path.of(project.getProjectDir().getAbsolutePath(), REPORT_PATH, "index.png").toString()
+               : destination;
     }
 
 }

heo-gradle-plugin/src/main/java/dev/heowc/heo/gradle/HeoConfig.java heo-gradle-plugin/src/main/java/dev/heowc/heo/gradle/HeoPluginConfig.java

@@ -1,10 +1,11 @@
 package dev.heowc.heo.gradle;
 
-public class HeoConfig {
+public class HeoPluginConfig {
 
     private String directoryPath;
     private String prefixPackage;
     private String destination;
+    private boolean failureOnCycles;
 
     public String getDirectoryPath() {
         return directoryPath;
@@ -29,4 +30,12 @@ public String getDestination() {
     public void setDestination(String destination) {
         this.destination = destination;
     }
+
+    public boolean isFailureOnCycles() {
+        return failureOnCycles;
+    }
+
+    public void setFailureOnCycles(boolean failureOnCycles) {
+        this.failureOnCycles = failureOnCycles;
+    }
 }

it/cycled-gradle-plugin/build.gradle

@@ -0,0 +1,40 @@
+buildscript {
+    repositories {
+        mavenLocal()
+    }
+    dependencies {
+        if (project.hasProperty('localPlugin')) {
+            classpath "dev.heowc.heo:heo-gradle-plugin:${version}"
+        }
+    }
+}
+
+if (project.hasProperty('localPlugin')) {
+    apply plugin: 'dev.heowc.heo'
+    apply plugin: 'java'
+
+    heo {
+        directoryPath = "${rootDir}/it/cycled-gradle-plugin"
+        prefixPackage = "dev.heowc.heo.it.cycled"
+        failureOnCycles = true
+    }
+
+    test {
+        dependsOn 'pluginTest'
+    }
+
+    tasks.register('pluginTest')  {
+        doLast {
+            var failure = false
+            try {
+                tasks.heoReport.exec()
+            } catch (Exception e) {
+                failure = true
+            }
+            if (!failure) {
+                throw new IllegalStateException("The task did not fail")
+            }
+        }
+    }
+
+}

it/cycled-gradle-plugin/src/main/java/dev/heowc/heo/it/cycled/CycledMain.java

@@ -0,0 +1,7 @@
+package dev.heowc.heo.it.cycled;
+
+public class CycledMain {
+
+    public static void main(String[] args) {
+    }
+}

it/cycled-gradle-plugin/src/main/java/dev/heowc/heo/it/cycled/a/A.java

@@ -0,0 +1,8 @@
+package dev.heowc.heo.it.cycled.a;
+
+import dev.heowc.heo.it.cycled.b.B;
+
+public class A {
+
+    private B b;
+}

it/cycled-gradle-plugin/src/main/java/dev/heowc/heo/it/cycled/b/B.java

@@ -0,0 +1,8 @@
+package dev.heowc.heo.it.cycled.b;
+
+import dev.heowc.heo.it.cycled.c.C;
+
+public class B {
+
+    private C c;
+}

it/cycled-gradle-plugin/src/main/java/dev/heowc/heo/it/cycled/c/C.java

@@ -0,0 +1,8 @@
+package dev.heowc.heo.it.cycled.c;
+
+import dev.heowc.heo.it.cycled.a.A;
+
+public class C {
+
+    private A a;
+}

it/gradle-plugin/build.gradle

@@ -11,10 +11,29 @@ buildscript {
 
 if (project.hasProperty('localPlugin')) {
     apply plugin: 'dev.heowc.heo'
+    apply plugin: 'java'
 
     heo {
         directoryPath = "${rootDir}/heo-core"
         prefixPackage = "dev.heowc.heo.core"
     }
+
+    test {
+        dependsOn 'pluginTest'
+    }
+
+    tasks.register('pluginTest') {
+        doLast {
+            var failure = false
+            try {
+                tasks.heoReport.exec()
+            } catch (Exception e) {
+                failure = true
+            }
+            if (failure) {
+                throw new IllegalStateException("The task did not succeed")
+            }
+        }
+    }
 }
 

settings.gradle

@@ -11,4 +11,4 @@ include 'heo-cli'
 include 'heo-gradle-plugin'
 
 include 'it:gradle-plugin'
-
+include 'it:cycled-gradle-plugin'