✨ Android compatibility

Add experimental support for android source sets

Fixes #49

Author: obecker

plugin-gradle/src/main/groovy/de/obqo/decycle/gradle/DecyclePlugin.groovy

@@ -6,6 +6,7 @@ import org.gradle.api.Project
 import org.gradle.api.Task
 import org.gradle.api.artifacts.Configuration
 import org.gradle.api.plugins.JavaBasePlugin
+
 /**
  * @author Oliver Becker
  */
@@ -16,9 +17,10 @@ class DecyclePlugin implements Plugin<Project> {
     @Override
     void apply(final Project project) {
         Properties props = new Properties()
-        getClass().classLoader.getResource("META-INF/gradle-plugins/de.obqo.decycle.properties").withInputStream { stream ->
-            props.load(stream)
-        }
+        getClass().classLoader.getResource("META-INF/gradle-plugins/de.obqo.decycle.properties")
+                .withInputStream { stream ->
+                    props.load(stream)
+                }
 
         // create a runner task that runs all single decycle tasks
         final Task decycleRunnerTask = project.tasks.create(TASK_NAME)
@@ -39,35 +41,64 @@ class DecyclePlugin implements Plugin<Project> {
                 decycle "de.obqo.decycle:decycle-lib:${toolVersion}"
             }
 
-            def sources = configuration.sourceSets
+            def isAndroidProject = project.hasProperty("android")
+
+            def sources = isAndroidProject ? configuration.androidSourceSets : configuration.sourceSets
             if (sources.empty) {
-                def projectSources = project.findProperty("sourceSets")
-                if (projectSources == null) {
-                    throw new GradleException("No source sets found. Did you forget to apply the 'java' plugin?")
+                def projectSources
+                if (isAndroidProject) {
+                    projectSources = project.android.sourceSets
+                } else {
+                    projectSources = project.findProperty("sourceSets")
+                    if (projectSources == null) {
+                        throw new GradleException("No source sets found. Did you forget to apply the 'java' plugin?")
+                    }
                 }
                 sources = projectSources.asMap.values()
             }
 
             // create decycle work tasks, one for each source set
             sources.forEach { source ->
-                def name = source.name
-
-                DecycleTask decycleWorkTask = project.tasks.create(TASK_NAME + name.capitalize(), DecycleTask)
-                decycleWorkTask.
-                        description = "Checks the ${name} sources for package cycles and other custom constraints"
-                decycleWorkTask.group = JavaBasePlugin.VERIFICATION_GROUP
-                decycleWorkTask.configuration.set(configuration)
-                decycleWorkTask.classpath.set(source.output)
-                decycleWorkTask.reportFile.set(new File(project.buildDir, "reports/decycle/${name}.html"))
-                decycleWorkTask.reportTitle.set(project.name + " | " + name);
-                decycleWorkTask.workerClasspath.set(workerClasspath)
+                def name = isAndroidProject ? adjustSourceSetName(source.name) : source.name
+                def output = isAndroidProject
+                        // TODO is there a better way to resolve the output (classes) directory in android projects?
+                        ? project.files(project.layout.buildDirectory.dir("tmp/kotlin-classes/$name"),
+                                        project.layout.buildDirectory.dir("intermediates/javac/$name"))
+                        : source.output
+                def compileTaskName = isAndroidProject
+                        // TODO is there a better way to determine the compile task for each source set in android projects?
+                        ? "compile" + name.capitalize() + "JavaWithJavac"
+                        : source.classesTaskName
+                def compileTask = project.tasks.findByPath(compileTaskName)
+                if (compileTask != null) { // ignore android source sets without compile task
+                    DecycleTask decycleWorkTask = project.tasks.create(TASK_NAME + name.capitalize(), DecycleTask)
+                    decycleWorkTask.
+                            description = "Checks the ${name} sources for package cycles and other custom constraints"
+                    decycleWorkTask.group = JavaBasePlugin.VERIFICATION_GROUP
+                    decycleWorkTask.configuration.set(configuration)
+                    decycleWorkTask.classpath.set(output)
+                    decycleWorkTask.reportFile.set(new File(project.buildDir, "reports/decycle/${name}.html"))
+                    decycleWorkTask.reportTitle.set(project.name + " | " + name)
+                    decycleWorkTask.workerClasspath.set(workerClasspath)
 
-                // set task dependencies, e.g. decycle -> decycleTest -> testClasses
-                decycleRunnerTask.dependsOn(decycleWorkTask.dependsOn(project.tasks[source.classesTaskName]))
+                    // set task dependencies, e.g. decycle -> decycleTest -> testClasses
+                    decycleRunnerTask.dependsOn(decycleWorkTask.dependsOn(compileTask))
+                } else {
+                    project.getLogger().info(
+                            "Decycle : Ignore sourceSet $name – cannot determine the corresponding compile task")
+                }
             }
 
             // finally make task 'check' depend on the runner task
             project.tasks[JavaBasePlugin.CHECK_TASK_NAME].dependsOn decycleRunnerTask
         }
     }
+
+    private static String adjustSourceSetName(String sourceSetName) {
+        switch (sourceSetName) {
+        case "testDebug": return "debugUnitTest"
+        case "testRelease": return "releaseUnitTest"
+        default: return sourceSetName
+        }
+    }
 }

plugin-gradle/src/main/java/de/obqo/decycle/gradle/DecycleConfiguration.java

@@ -4,6 +4,7 @@
 import java.util.ArrayList;
 import java.util.List;
 
+import org.gradle.api.Named;
 import org.gradle.api.tasks.SourceSet;
 
 /**
@@ -16,6 +17,7 @@ class DecycleConfiguration implements Serializable {
     private static final long serialVersionUID = 10L;
 
     private final transient List<SourceSet> sourceSets = new ArrayList<>();
+    private final transient List<Named> androidSourceSets = new ArrayList<>();
     private final List<String> includings = new ArrayList<>();
     private final List<String> excludings = new ArrayList<>();
     private final List<IgnoreConfig> ignoredDeps = new ArrayList<>();
@@ -27,10 +29,18 @@ List<SourceSet> getSourceSets() {
         return this.sourceSets;
     }
 
+    public List<Named> getAndroidSourceSets() {
+        return this.androidSourceSets;
+    }
+
     void addSourceSet(final SourceSet sourceSet) {
         this.sourceSets.add(sourceSet);
     }
 
+    void addAndroidSourceSet(final Named sourceSet) {
+        this.androidSourceSets.add(sourceSet);
+    }
+
     List<String> getIncludings() {
         return this.includings;
     }

plugin-gradle/src/main/java/de/obqo/decycle/gradle/DecycleExtension.java

@@ -6,6 +6,7 @@
 
 import org.gradle.api.Action;
 import org.gradle.api.GradleException;
+import org.gradle.api.Named;
 import org.gradle.api.NamedDomainObjectContainer;
 import org.gradle.api.NamedDomainObjectProvider;
 import org.gradle.api.Project;
@@ -59,6 +60,22 @@ public void sourceSets(final NamedDomainObjectProvider<?>... sourceSets) {
         }
     }
 
+    /**
+     * Declare the source sets to checked by decycle. Will be used for android source sets.
+     *
+     * @param sourceSets the source sets to be checked
+     */
+    public void sourceSets(final Named... sourceSets) {
+        for (final Named sourceSet : sourceSets) {
+            if (!sourceSet.getClass().getName().contains("com.android.build.gradle.internal.api.DefaultAndroidSourceSet")) {
+                throw new GradleException(String.format(
+                        "decycle: passed value to sourceSets is not a SourceSet, encountered %s",
+                        sourceSet));
+            }
+            this.configuration.addAndroidSourceSet(sourceSet);
+        }
+    }
+
     public void including(final String... includings) {
         for (final String including : includings) {
             this.configuration.addIncluding(including);