#109 Excluding tests from analysis by default

jimbethancourt · jimbethancourt · commit 8ff790407d6c · 2025-03-14T06:01:37.000-05:00
Excluding tests from analysis by default.  User can also specify the test directory.  Test directory defaults to "src/test" or "src\test" based on the operating system.
diff --git a/cli/src/main/java/org/hjug/refactorfirst/ReportCommand.java b/cli/src/main/java/org/hjug/refactorfirst/ReportCommand.java
@@ -43,6 +43,20 @@ public class ReportCommand implements Callable<Integer> {
             description = "Minify HTML output")
     private boolean minifiyHtml;
 
+    @Option(
+            names = {"-xt", "--exclude-tests"},
+            defaultValue = "true",
+            description = "Exclude tests from analysis")
+    private boolean excludeTests;
+
+    /**
+     * The test source directory containing test class sources.
+     */
+    @Option(
+            names = {"-tsd", "--output"},
+            description = "Test source directory.  Defaults to test/src or test\\src based on your OS")
+    private String testSourceDirectory;
+
     @Option(
             names = {"-p", "--project"},
             description = "Project name")
@@ -85,6 +99,8 @@ public Integer call() {
                         analyzeCycles,
                         showDetails,
                         minifiyHtml,
+                        excludeTests,
+                        testSourceDirectory,
                         projectName,
                         projectVersion,
                         baseDir,
@@ -97,6 +113,8 @@ public Integer call() {
                         analyzeCycles,
                         showDetails,
                         minifiyHtml,
+                        excludeTests,
+                        testSourceDirectory,
                         projectName,
                         projectVersion,
                         baseDir,
diff --git a/codebase-graph-builder/src/main/java/org/hjug/graphbuilder/JavaGraphBuilder.java b/codebase-graph-builder/src/main/java/org/hjug/graphbuilder/JavaGraphBuilder.java
@@ -29,18 +29,21 @@ public class JavaGraphBuilder {
      * @return
      * @throws IOException
      */
-    public Graph<String, DefaultWeightedEdge> getClassReferences(String srcDirectory) throws IOException {
+    public Graph<String, DefaultWeightedEdge> getClassReferences(
+            String srcDirectory, boolean excludeTests, String testSourceDirectory) throws IOException {
         Graph<String, DefaultWeightedEdge> classReferencesGraph;
         if (srcDirectory == null || srcDirectory.isEmpty()) {
             throw new IllegalArgumentException();
         } else {
-            classReferencesGraph = processWithOpenRewrite(srcDirectory).getClassReferencesGraph();
+            classReferencesGraph = processWithOpenRewrite(srcDirectory, excludeTests, testSourceDirectory)
+                    .getClassReferencesGraph();
         }
 
         return classReferencesGraph;
     }
 
-    private CodebaseGraphDTO processWithOpenRewrite(String srcDir) throws IOException {
+    private CodebaseGraphDTO processWithOpenRewrite(
+            String srcDir, boolean excludeTests, String testSourceDirectory) throws IOException {
         File srcDirectory = new File(srcDir);
 
         JavaParser javaParser = JavaParser.fromJavaVersion().build();
@@ -59,8 +62,16 @@ private CodebaseGraphDTO processWithOpenRewrite(String srcDir) throws IOExceptio
         final JavaMethodDeclarationVisitor<ExecutionContext> javaMethodDeclarationVisitor =
                 new JavaMethodDeclarationVisitor<>(classReferencesGraph, packageReferencesGraph);
 
-        try (Stream<Path> walk = Files.walk(Paths.get(srcDirectory.getAbsolutePath()))) {
-            List<Path> list = walk.collect(Collectors.toList());
+        try (Stream<Path> pathStream = Files.walk(Paths.get(srcDirectory.getAbsolutePath()))) {
+            List<Path> list;
+            if (excludeTests) {
+                list = pathStream
+                        .filter(file -> !file.toString().contains(testSourceDirectory))
+                        .collect(Collectors.toList());
+            } else {
+                list = pathStream.collect(Collectors.toList());
+            }
+
             javaParser
                     .parse(list, Paths.get(srcDirectory.getAbsolutePath()), ctx)
                     .forEach(cu -> {
diff --git a/codebase-graph-builder/src/test/java/org/hjug/graphbuilder/JavaGraphBuilderTest.java b/codebase-graph-builder/src/test/java/org/hjug/graphbuilder/JavaGraphBuilderTest.java
@@ -19,16 +19,18 @@ class JavaGraphBuilderTest {
     @DisplayName("When source directory input param is empty or null throw IllegalArgumentException.")
     @Test
     void parseSourceDirectoryEmptyTest() {
-        Assertions.assertThrows(IllegalArgumentException.class, () -> javaGraphBuilder.getClassReferences(""));
-        Assertions.assertThrows(IllegalArgumentException.class, () -> javaGraphBuilder.getClassReferences(null));
+        Assertions.assertThrows(
+                IllegalArgumentException.class, () -> javaGraphBuilder.getClassReferences("", false, ""));
+        Assertions.assertThrows(
+                IllegalArgumentException.class, () -> javaGraphBuilder.getClassReferences(null, false, ""));
     }
 
     @DisplayName("Given a valid source directory input parameter return a valid graph.")
     @Test
     void parseSourceDirectoryTest() throws IOException {
         File srcDirectory = new File("src/test/resources/javaSrcDirectory");
         Graph<String, DefaultWeightedEdge> classReferencesGraph =
-                javaGraphBuilder.getClassReferences(srcDirectory.getAbsolutePath());
+                javaGraphBuilder.getClassReferences(srcDirectory.getAbsolutePath(), false, "");
         assertNotNull(classReferencesGraph);
         assertEquals(5, classReferencesGraph.vertexSet().size());
         assertEquals(7, classReferencesGraph.edgeSet().size());
@@ -76,7 +78,7 @@ private static double getEdgeWeight(
     void removeClassesNotInCodebase() throws IOException {
         File srcDirectory = new File("src/test/resources/javaSrcDirectory");
         Graph<String, DefaultWeightedEdge> classReferencesGraph =
-                javaGraphBuilder.getClassReferences(srcDirectory.getAbsolutePath());
+                javaGraphBuilder.getClassReferences(srcDirectory.getAbsolutePath(), false, "");
 
         classReferencesGraph.addVertex("org.favioriteoss.FunClass");
         classReferencesGraph.addVertex("org.favioriteoss.AnotherFunClass");
diff --git a/cost-benefit-calculator/src/main/java/org/hjug/cbc/CostBenefitCalculator.java b/cost-benefit-calculator/src/main/java/org/hjug/cbc/CostBenefitCalculator.java
@@ -53,23 +53,49 @@ public void runPmdAnalysis() throws IOException {
         PMDConfiguration configuration = new PMDConfiguration();
 
         try (PmdAnalysis pmd = PmdAnalysis.create(configuration)) {
-            RuleSetLoader rulesetLoader = pmd.newRuleSetLoader();
-            pmd.addRuleSets(rulesetLoader.loadRuleSetsWithoutException(List.of("category/java/design.xml")));
+            loadRules(pmd);
 
-            Rule cboClassRule = new CBORule();
-            cboClassRule.setLanguage(LanguageRegistry.PMD.getLanguageByFullName("Java"));
-            pmd.addRuleSet(RuleSet.forSingleRule(cboClassRule));
+            try (Stream<Path> files = Files.walk(Paths.get(repositoryPath))) {
+                files.filter(Files::isRegularFile).forEach(file -> pmd.files().addFile(file));
+            }
+
+            report = pmd.performAnalysisAndCollectReport();
+        }
+    }
 
-            log.info("files to be scanned: " + Paths.get(repositoryPath));
+    public void runPmdAnalysis(boolean excludeTests, String testSourceDirectory) throws IOException {
+        PMDConfiguration configuration = new PMDConfiguration();
+
+        try (PmdAnalysis pmd = PmdAnalysis.create(configuration)) {
+            loadRules(pmd);
 
             try (Stream<Path> files = Files.walk(Paths.get(repositoryPath))) {
-                files.filter(Files::isRegularFile).forEach(file -> pmd.files().addFile(file));
+                Stream<Path> pathStream;
+                if (excludeTests) {
+                    pathStream = files.filter(Files::isRegularFile)
+                            .filter(file -> !file.toString().contains(testSourceDirectory));
+                } else {
+                    pathStream = files.filter(Files::isRegularFile);
+                }
+
+                pathStream.forEach(file -> pmd.files().addFile(file));
             }
 
             report = pmd.performAnalysisAndCollectReport();
         }
     }
 
+    private void loadRules(PmdAnalysis pmd) {
+        RuleSetLoader rulesetLoader = pmd.newRuleSetLoader();
+        pmd.addRuleSets(rulesetLoader.loadRuleSetsWithoutException(List.of("category/java/design.xml")));
+
+        Rule cboClassRule = new CBORule();
+        cboClassRule.setLanguage(LanguageRegistry.PMD.getLanguageByFullName("Java"));
+        pmd.addRuleSet(RuleSet.forSingleRule(cboClassRule));
+
+        log.info("files to be scanned: " + Paths.get(repositoryPath));
+    }
+
     public List<RankedDisharmony> calculateGodClassCostBenefitValues() {
         List<GodClass> godClasses = getGodClasses();
 
diff --git a/cost-benefit-calculator/src/main/java/org/hjug/cbc/CycleRanker.java b/cost-benefit-calculator/src/main/java/org/hjug/cbc/CycleRanker.java
@@ -24,19 +24,20 @@ public class CycleRanker {
     @Getter
     private Graph<String, DefaultWeightedEdge> classReferencesGraph;
 
-    public void generateClassReferencesGraph() {
+    public void generateClassReferencesGraph(boolean excludeTests, String testSourceDirectory) {
         try {
-            classReferencesGraph = javaGraphBuilder.getClassReferences(repositoryPath);
+            classReferencesGraph =
+                    javaGraphBuilder.getClassReferences(repositoryPath, excludeTests, testSourceDirectory);
         } catch (IOException e) {
             throw new RuntimeException(e);
         }
     }
 
-    public List<RankedCycle> performCycleAnalysis() {
+    public List<RankedCycle> performCycleAnalysis(boolean excludeTests, String testSourceDirectory) {
         List<RankedCycle> rankedCycles = new ArrayList<>();
         try {
             boolean calculateCycleChurn = false;
-            generateClassReferencesGraph();
+            generateClassReferencesGraph(excludeTests, testSourceDirectory);
             identifyRankedCycles(rankedCycles);
             sortRankedCycles(rankedCycles, calculateCycleChurn);
             setPriorities(rankedCycles);
diff --git a/refactor-first-maven-plugin/src/main/java/org/hjug/mavenreport/RefactorFirstHtmlReport.java b/refactor-first-maven-plugin/src/main/java/org/hjug/mavenreport/RefactorFirstHtmlReport.java
@@ -32,6 +32,15 @@ public class RefactorFirstHtmlReport extends AbstractMojo {
     @Parameter(property = "minifyHtml")
     private boolean minifyHtml = true;
 
+    @Parameter(property = "excludeTests")
+    private boolean excludeTests = true;
+
+    /**
+     * The test source directory containing test class sources.
+     */
+    @Parameter(property = "testSourceDirectory")
+    private String testSourceDirectory;
+
     @Parameter(defaultValue = "${project.name}")
     private String projectName;
 
@@ -54,6 +63,8 @@ public void execute() {
                 analyzeCycles,
                 showDetails,
                 minifyHtml,
+                excludeTests,
+                testSourceDirectory,
                 projectName,
                 projectVersion,
                 project.getBasedir(),
diff --git a/refactor-first-maven-plugin/src/main/java/org/hjug/mavenreport/RefactorFirstMavenReport.java b/refactor-first-maven-plugin/src/main/java/org/hjug/mavenreport/RefactorFirstMavenReport.java
@@ -32,6 +32,15 @@ public class RefactorFirstMavenReport extends AbstractMavenReport {
     @Parameter(property = "analyzeCycles")
     private boolean analyzeCycles = true;
 
+    @Parameter(property = "excludeTests")
+    private boolean excludeTests = true;
+
+    /**
+     * The test source directory containing test class sources.
+     */
+    @Parameter(property = "testSourceDirectory")
+    private String testSourceDirectory;
+
     @Parameter(defaultValue = "${project.name}")
     private String projectName;
 
@@ -63,12 +72,14 @@ public void executeReport(Locale locale) {
         String report = htmlReport
                 .generateReport(
                         showDetails,
+                        backEdgeAnalysisCount,
+                        analyzeCycles,
+                        excludeTests,
+                        testSourceDirectory,
                         projectName,
                         projectVersion,
                         project.getBasedir(),
-                        300,
-                        backEdgeAnalysisCount,
-                        analyzeCycles)
+                        300)
                 .toString();
 
         mainSink.rawText(report);
diff --git a/refactor-first-maven-plugin/src/main/java/org/hjug/mavenreport/RefactorFirstSimpleHtmlReport.java b/refactor-first-maven-plugin/src/main/java/org/hjug/mavenreport/RefactorFirstSimpleHtmlReport.java
@@ -32,6 +32,15 @@ public class RefactorFirstSimpleHtmlReport extends AbstractMojo {
     @Parameter(property = "minifyHtml")
     private boolean minifyHtml = true;
 
+    @Parameter(property = "excludeTests")
+    private boolean excludeTests = true;
+
+    /**
+     * The test source directory containing test class sources.
+     */
+    @Parameter(property = "testSourceDirectory")
+    private String testSourceDirectory;
+
     @Parameter(defaultValue = "${project.name}")
     private String projectName;
 
@@ -54,6 +63,8 @@ public void execute() {
                 analyzeCycles,
                 showDetails,
                 minifyHtml,
+                excludeTests,
+                testSourceDirectory,
                 projectName,
                 projectVersion,
                 project.getBasedir(),
diff --git a/report/src/main/java/org/hjug/refactorfirst/report/SimpleHtmlReport.java b/report/src/main/java/org/hjug/refactorfirst/report/SimpleHtmlReport.java
@@ -92,6 +92,8 @@ public void execute(
             boolean analyzeCycles,
             boolean showDetails,
             boolean minifyHtml,
+            boolean excludeTests,
+            String testSourceDirectory,
             String projectName,
             String projectVersion,
             File baseDir,
@@ -107,8 +109,15 @@ public void execute(
         stringBuilder.append(printTitle(projectName, projectVersion));
         stringBuilder.append(printHead());
         stringBuilder.append("</head>");
-        stringBuilder.append(
-                generateReport(showDetails, projectName, projectVersion, baseDir, edgeAnalysisCount, analyzeCycles));
+        stringBuilder.append(generateReport(
+                showDetails,
+                edgeAnalysisCount,
+                analyzeCycles,
+                excludeTests,
+                testSourceDirectory,
+                projectName,
+                projectVersion,
+                baseDir));
 
         stringBuilder.append(printProjectFooter());
         stringBuilder.append(THE_END);
@@ -125,23 +134,41 @@ public void execute(
 
     public StringBuilder generateReport(
             boolean showDetails,
+            int edgeAnalysisCount,
+            boolean analyzeCycles,
+            boolean excludeTests,
+            String testSourceDirectory,
             String projectName,
             String projectVersion,
-            File baseDir,
-            int edgeAnalysisCount,
-            boolean analyzeCycles) {
-        return generateReport(showDetails, projectName, projectVersion, baseDir, 200, edgeAnalysisCount, analyzeCycles);
+            File baseDir) {
+        return generateReport(
+                showDetails,
+                edgeAnalysisCount,
+                analyzeCycles,
+                excludeTests,
+                testSourceDirectory,
+                projectName,
+                projectVersion,
+                baseDir,
+                200);
     }
 
     // pixels param is for SVG image pixel padding
     public StringBuilder generateReport(
             boolean showDetails,
+            int edgeAnalysisCount,
+            boolean analyzeCycles,
+            boolean excludeTests,
+            String testSourceDirectory,
             String projectName,
             String projectVersion,
             File baseDir,
-            int pixels,
-            int edgeAnalysisCount,
-            boolean analyzeCycles) {
+            int pixels) {
+
+        if (testSourceDirectory == null || testSourceDirectory.isEmpty()) {
+            testSourceDirectory = "src" + File.separator + "test";
+        }
+
         this.pixels = pixels;
         StringBuilder stringBuilder = new StringBuilder();
         stringBuilder.append(printOpenBodyTag());
@@ -204,9 +231,9 @@ public StringBuilder generateReport(
         List<RankedCycle> rankedCycles = List.of();
         if (analyzeCycles) {
             log.info("Analyzing Cycles");
-            rankedCycles = cycleRanker.performCycleAnalysis();
+            rankedCycles = cycleRanker.performCycleAnalysis(excludeTests, testSourceDirectory);
         } else {
-            cycleRanker.generateClassReferencesGraph();
+            cycleRanker.generateClassReferencesGraph(excludeTests, testSourceDirectory);
         }
 
         classGraph = cycleRanker.getClassReferencesGraph();
