add possibilty to exclude test classes folder from check

Author: davidburkhart

src/main/java/de/andrena/tools/nopackagecycles/DirectoriesWithClasses.java

@@ -17,9 +17,11 @@ public class DirectoriesWithClasses implements Iterable<File>{
 
 	private final List<File> directories = new LinkedList<File>();
 
-	public DirectoriesWithClasses(EnforcerRuleHelper helper) throws ExpressionEvaluationException {
+	public DirectoriesWithClasses(EnforcerRuleHelper helper, boolean includeTests) throws ExpressionEvaluationException {
 		addDirectoryIfExists(helper, MAVEN_PROJECT_BUILD_OUTPUT_DIRECTORY_VAR);
-		addDirectoryIfExists(helper, MAVEN_PROJECT_BUILD_TEST_OUTPUT_DIRECTORY_VAR);
+		if (includeTests) {
+			addDirectoryIfExists(helper, MAVEN_PROJECT_BUILD_TEST_OUTPUT_DIRECTORY_VAR);
+		}
 	}
 
 	private void addDirectoryIfExists(EnforcerRuleHelper helper, String variable)
@@ -37,6 +39,7 @@ public boolean directoriesWithClassesFound() {
 		return !directories.isEmpty();
 	}
 
+	@Override
 	public Iterator<File> iterator() {
 		return unmodifiableList(directories).iterator();
 	}

src/main/java/de/andrena/tools/nopackagecycles/NoPackageCyclesRule.java

@@ -15,6 +15,8 @@
 
 public class NoPackageCyclesRule implements EnforcerRule {
 
+	private boolean includeTests = true;
+
 	public void execute(EnforcerRuleHelper helper) throws EnforcerRuleException {
 		try {
 			executePackageCycleCheckIfNecessary(helper);
@@ -25,9 +27,9 @@ public void execute(EnforcerRuleHelper helper) throws EnforcerRuleException {
 		}
 	}
 
-	private void executePackageCycleCheckIfNecessary(EnforcerRuleHelper helper) throws ExpressionEvaluationException,
-			IOException, EnforcerRuleException {
-		DirectoriesWithClasses directories = new DirectoriesWithClasses(helper);
+	private void executePackageCycleCheckIfNecessary(EnforcerRuleHelper helper)
+			throws ExpressionEvaluationException, IOException, EnforcerRuleException {
+		DirectoriesWithClasses directories = new DirectoriesWithClasses(helper, includeTests);
 		if (directories.directoriesWithClassesFound()) {
 			executePackageCycleCheck(directories);
 		} else {
@@ -66,4 +68,8 @@ public boolean isCacheable() {
 	public boolean isResultValid(EnforcerRule arg0) {
 		return false;
 	}
+
+	public void setIncludeTests(boolean includeTests) {
+		this.includeTests = includeTests;
+	}
 }

src/test/java/de/andrena/tools/nopackagecycles/NoPackageCyclesRuleTest.java

@@ -72,8 +72,8 @@ public void execute_checkNotNecessary_ClassesDirNotFound() throws Exception {
 		rule.execute(helper);
 		List<String> infoLogs = helper.getLogMock().getInfo();
 		assertThat(infoLogs, hasSize(3));
-		assertThat(infoLogs.get(0), is("Directory " + nonExistentClassesFolder.getAbsolutePath() + " could not be found."));
-		assertThat(infoLogs.get(1), is("Directory " + nonExistentTestClassesFolder.getAbsolutePath() + " could not be found."));
+		assertThat(infoLogs.get(0),	is("Directory " + nonExistentClassesFolder.getAbsolutePath() + " could not be found."));
+		assertThat(infoLogs.get(1),	is("Directory " + nonExistentTestClassesFolder.getAbsolutePath() + " could not be found."));
 		assertThat(infoLogs.get(2), is("No directories with classes to check for cycles found."));
 	}
 
@@ -98,8 +98,17 @@ public void execute_ContainsNoCycles() throws Exception {
 		rule.execute(helper);
 		List<String> infoLogs = helper.getLogMock().getInfo();
 		assertThat(infoLogs, hasSize(2));
-		assertThat(infoLogs.get(0), is("Adding directory " + new File(temporaryFolder.getRoot(), "classes").getAbsolutePath() + " for package cycles search."));
-		assertThat(infoLogs.get(1), is("Adding directory " + new File(temporaryFolder.getRoot(), "test-classes").getAbsolutePath() + " for package cycles search."));
+		assertThat(infoLogs.get(0), is("Adding directory " + classesFolder().getAbsolutePath() + " for package cycles search."));
+		assertThat(infoLogs.get(1), is("Adding directory " + testClassesFolder().getAbsolutePath() + " for package cycles search."));
+	}
+
+	@Test
+	public void execute_CanExcludeTests() throws Exception {
+		rule.setIncludeTests(false);
+		rule.execute(helper);
+		List<String> infoLogs = helper.getLogMock().getInfo();
+		assertThat(infoLogs, hasSize(1));
+		assertThat(infoLogs.get(0), is("Adding directory " + classesFolder().getAbsolutePath() + " for package cycles search."));
 	}
 
 	@Test
@@ -109,7 +118,7 @@ public void execute_ContainsNoCyclesWithoutTestClasses() throws Exception {
 		rule.execute(helper);
 		List<String> infoLogs = helper.getLogMock().getInfo();
 		assertThat(infoLogs, hasSize(2));
-		assertThat(infoLogs.get(0), is("Adding directory " + new File(temporaryFolder.getRoot(), "classes").getAbsolutePath() + " for package cycles search."));
+		assertThat(infoLogs.get(0), is("Adding directory " + classesFolder().getAbsolutePath() + " for package cycles search."));
 		assertThat(infoLogs.get(1), is("Directory " + nonExistentTestClassesDir.getAbsolutePath() + " could not be found."));
 	}
 
@@ -120,4 +129,12 @@ public void execute_ContainsCycles() throws Exception {
 		expectedException.expectMessage(containsString("There are package cycles"));
 		rule.execute(helper);
 	}
+
+	private File testClassesFolder() {
+		return new File(temporaryFolder.getRoot(), "test-classes");
+	}
+
+	private File classesFolder() {
+		return new File(temporaryFolder.getRoot(), "classes");
+	}
 }