close #6: add output to see analysed directory

Author: Ben Romberg

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

@@ -11,15 +11,12 @@
 import org.apache.maven.enforcer.rule.api.EnforcerRule;
 import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
 import org.apache.maven.enforcer.rule.api.EnforcerRuleHelper;
-import org.apache.maven.project.MavenProject;
 import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException;
 
 public class NoPackageCyclesRule implements EnforcerRule {
 
-	public static final String MAVEN_JAR_PACKAGING = "jar";
 	public static final String MAVEN_CLASSES_DIR = "classes";
 	public static final String MAVEN_PROJECT_BUILD_DIRECTORY_VAR = "${project.build.directory}";
-	public static final String MAVEN_PROJECT_VAR = "${project}";
 
 	public void execute(EnforcerRuleHelper helper) throws EnforcerRuleException {
 		try {
@@ -33,11 +30,13 @@ public void execute(EnforcerRuleHelper helper) throws EnforcerRuleException {
 
 	private void executePackageCycleCheckIfNecessary(EnforcerRuleHelper helper) throws ExpressionEvaluationException,
 			IOException, EnforcerRuleException {
-		MavenProject project = (MavenProject) helper.evaluate(MAVEN_PROJECT_VAR);
 		File targetDir = new File((String) helper.evaluate(MAVEN_PROJECT_BUILD_DIRECTORY_VAR));
 		File classesDir = new File(targetDir, MAVEN_CLASSES_DIR);
-		if (checkIsNecessary(project, classesDir)) {
+		helper.getLog().info("Searching directory " + classesDir.getAbsolutePath() + " for package cycles.");
+		if (checkIsNecessary(classesDir)) {
 			executePackageCycleCheck(classesDir);
+		} else {
+			helper.getLog().info("Directory " + classesDir.getAbsolutePath() + " could not be found.");
 		}
 	}
 
@@ -46,8 +45,7 @@ private void executePackageCycleCheck(File classesDir) throws IOException, Enfor
 		jdepend.addDirectory(classesDir.getAbsolutePath());
 		jdepend.analyze();
 		if (jdepend.containsCycles()) {
-			String packageCycles = getPackageCycles(jdepend);
-			throw new EnforcerRuleException("There are package cycles:" + packageCycles);
+			throw new EnforcerRuleException("There are package cycles:" + getPackageCycles(jdepend));
 		}
 	}
 
@@ -61,7 +59,7 @@ private String getPackageCycles(JDepend jdepend) {
 		return new PackageCycleOutput(new ArrayList<JavaPackage>(packages)).getOutput();
 	}
 
-	private boolean checkIsNecessary(MavenProject project, File classesDir) {
+	private boolean checkIsNecessary(File classesDir) {
 		return classesDir.exists();
 	}
 

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

@@ -2,7 +2,12 @@
 
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.containsString;
+import static org.hamcrest.Matchers.hasSize;
 import static org.hamcrest.Matchers.is;
+
+import java.io.File;
+import java.util.List;
+
 import jdepend.framework.JDepend;
 
 import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
@@ -24,8 +29,6 @@ protected JDepend createJDepend() {
 		}
 	}
 
-	private static final String MAVEN_WAR_PACKAGING = "war";
-
 	@Rule
 	public TemporaryFolder temporaryFolder = new TemporaryFolder();
 
@@ -62,18 +65,13 @@ public void result_IsNotValid() {
 
 	@Test
 	public void execute_checkNotNecessary_ClassesDirNotFound() throws Exception {
-		jdependMock.setContainsCycles(true);
-		helper.setTargetDir(temporaryFolder.newFolder());
-		rule.execute(helper);
-	}
-
-	@Test
-	public void execute_checkNotNecessary_PackagingNotJar() throws Exception {
-		jdependMock.setContainsCycles(true);
-		helper.setPackaging(MAVEN_WAR_PACKAGING);
-		expectedException.expect(EnforcerRuleException.class);
-		expectedException.expectMessage(containsString("There are package cycles"));
+		File newFolder = temporaryFolder.newFolder();
+		helper.setTargetDir(newFolder);
 		rule.execute(helper);
+		List<String> infoLogs = helper.getLogMock().getInfo();
+		assertThat(infoLogs, hasSize(2));
+		assertSearchingInfo(newFolder, infoLogs);
+		assertThat(infoLogs.get(1), is("Directory " + getTargetDirectory(newFolder) + " could not be found."));
 	}
 
 	@Test
@@ -95,6 +93,9 @@ public void execute_JdependAddDirectoryFailed_ThrowsException() throws Exception
 	@Test
 	public void execute_ContainsNoCycles() throws Exception {
 		rule.execute(helper);
+		List<String> infoLogs = helper.getLogMock().getInfo();
+		assertThat(infoLogs, hasSize(1));
+		assertSearchingInfo(temporaryFolder.getRoot(), infoLogs);
 	}
 
 	@Test
@@ -104,4 +105,13 @@ public void execute_ContainsCycles() throws Exception {
 		expectedException.expectMessage(containsString("There are package cycles"));
 		rule.execute(helper);
 	}
+
+	private void assertSearchingInfo(File projectDirectory, List<String> infoLogs) {
+		assertThat(infoLogs.get(0), is("Searching directory " + getTargetDirectory(projectDirectory)
+				+ " for package cycles."));
+	}
+
+	private String getTargetDirectory(File newFolder) {
+		return new File(newFolder, NoPackageCyclesRule.MAVEN_CLASSES_DIR).getAbsolutePath();
+	}
 }

src/test/java/de/andrena/tools/nopackagecycles/mock/EnforcerRuleHelperMock.java

@@ -6,7 +6,6 @@
 
 import org.apache.maven.enforcer.rule.api.EnforcerRuleHelper;
 import org.apache.maven.plugin.logging.Log;
-import org.apache.maven.project.MavenProject;
 import org.codehaus.plexus.PlexusContainer;
 import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException;
 import org.codehaus.plexus.component.repository.exception.ComponentLookupException;
@@ -15,9 +14,13 @@
 
 public class EnforcerRuleHelperMock implements EnforcerRuleHelper {
 
-	protected String packaging = NoPackageCyclesRule.MAVEN_JAR_PACKAGING;
 	private File targetDir;
 	private boolean evaluateThrowsException;
+	private final LogMock logMock = new LogMock();
+
+	public LogMock getLogMock() {
+		return logMock;
+	}
 
 	public void setEvaluateThrowsException(boolean evaluateThrowsException) {
 		this.evaluateThrowsException = evaluateThrowsException;
@@ -27,10 +30,6 @@ public void setTargetDir(File targetDir) {
 		this.targetDir = targetDir;
 	}
 
-	public void setPackaging(String packaging) {
-		this.packaging = packaging;
-	}
-
 	public File alignToBaseDirectory(File arg0) {
 		return null;
 	}
@@ -39,14 +38,7 @@ public Object evaluate(String variable) throws ExpressionEvaluationException {
 		if (evaluateThrowsException) {
 			throw new ExpressionEvaluationException("");
 		}
-		if (NoPackageCyclesRule.MAVEN_PROJECT_VAR.equals(variable)) {
-			return new MavenProject() {
-				@Override
-				public String getPackaging() {
-					return packaging;
-				}
-			};
-		} else if (NoPackageCyclesRule.MAVEN_PROJECT_BUILD_DIRECTORY_VAR.equals(variable)) {
+		if (NoPackageCyclesRule.MAVEN_PROJECT_BUILD_DIRECTORY_VAR.equals(variable)) {
 			return targetDir.getPath();
 		}
 		return null;
@@ -77,7 +69,7 @@ public PlexusContainer getContainer() {
 	}
 
 	public Log getLog() {
-		return null;
+		return logMock;
 	}
 
 }

src/test/java/de/andrena/tools/nopackagecycles/mock/LogMock.java

@@ -0,0 +1,68 @@
+package de.andrena.tools.nopackagecycles.mock;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.apache.maven.plugin.logging.Log;
+
+public class LogMock implements Log {
+	private final List<String> info = new ArrayList<String>();
+
+	public List<String> getInfo() {
+		return info;
+	}
+
+	public void debug(CharSequence arg0) {
+	}
+
+	public void debug(Throwable arg0) {
+	}
+
+	public void debug(CharSequence arg0, Throwable arg1) {
+	}
+
+	public void error(CharSequence arg0) {
+	}
+
+	public void error(Throwable arg0) {
+	}
+
+	public void error(CharSequence arg0, Throwable arg1) {
+	}
+
+	public void info(CharSequence arg0) {
+		info.add(arg0.toString());
+	}
+
+	public void info(Throwable arg0) {
+	}
+
+	public void info(CharSequence arg0, Throwable arg1) {
+	}
+
+	public boolean isDebugEnabled() {
+		return false;
+	}
+
+	public boolean isErrorEnabled() {
+		return false;
+	}
+
+	public boolean isInfoEnabled() {
+		return false;
+	}
+
+	public boolean isWarnEnabled() {
+		return false;
+	}
+
+	public void warn(CharSequence arg0) {
+	}
+
+	public void warn(Throwable arg0) {
+	}
+
+	public void warn(CharSequence arg0, Throwable arg1) {
+	}
+
+}