Clean up tests (#36)

Author: vanniktech

src/test/groovy/com/vanniktech/android/junit/jacoco/GenerationTest.groovy

@@ -9,219 +9,154 @@ import org.junit.Test
 import static com.vanniktech.android.junit.jacoco.ProjectHelper.ProjectType.*
 
 public class GenerationTest {
-
     @Test
     public void addJacocoAndroidAppWithFlavors() {
-
-        // Given
         def androidAppProject = ProjectHelper.prepare(ANDROID_APPLICATION).withRedBlueFlavors().get()
 
-        // When
         Generation.addJacoco(androidAppProject, new JunitJacocoExtension())
 
-        // Then
         assertJacocoAndroidWithFlavors(androidAppProject)
     }
 
     @Test
     public void addJacocoAndroidLibraryWithFlavors() {
-
-        // Given
         def androidLibraryProject = ProjectHelper.prepare(ANDROID_LIBRARY).withRedBlueFlavors().get()
 
-        // When
         Generation.addJacoco(androidLibraryProject, new JunitJacocoExtension())
 
-        // Then
         assertJacocoAndroidWithFlavors(androidLibraryProject)
     }
 
     @Test
     public void addJacocoAndroidApp() {
-
-        // Given
         def androidAppProject = ProjectHelper.prepare(ANDROID_APPLICATION).get()
 
-        // When
         Generation.addJacoco(androidAppProject, new JunitJacocoExtension())
 
-        // Then
         assertJacocoAndroidWithoutFlavors(androidAppProject)
     }
 
     @Test
     public void addJacocoAndroidLibrary() {
-
-        // Given
         def androidLibraryProject = ProjectHelper.prepare(ANDROID_LIBRARY).get()
 
-        // When
         Generation.addJacoco(androidLibraryProject, new JunitJacocoExtension())
 
-        // Then
         assertJacocoAndroidWithoutFlavors(androidLibraryProject)
     }
 
     @Test
     public void addJacocoJava() {
-
-        // Given
         def javaProject = ProjectHelper.prepare(JAVA).get()
 
-        // When
         Generation.addJacoco(javaProject, new JunitJacocoExtension())
 
-        // Then
         assertJacocoJava(javaProject)
     }
 
     @Test
     public void jacocoVersion() {
-
-        // Given
         final def extension = new JunitJacocoExtension()
         extension.jacocoVersion = '0.7.6.201602180812'
         def androidAppProject = ProjectHelper.prepare(ANDROID_APPLICATION).get()
         def androidLibraryProject = ProjectHelper.prepare(ANDROID_LIBRARY).get()
         def javaProject = ProjectHelper.prepare(JAVA).get()
 
-        // When
         Generation.addJacoco(androidAppProject, extension)
         Generation.addJacoco(androidLibraryProject, extension)
         Generation.addJacoco(javaProject, extension)
 
-        // Then
         assert androidAppProject.jacoco.toolVersion == '0.7.6.201602180812'
         assert androidLibraryProject.jacoco.toolVersion == '0.7.6.201602180812'
         assert javaProject.jacoco.toolVersion == '0.7.6.201602180812'
     }
 
     @Test
     public void ignoreProjects() {
-        // Given
         final def extension = new JunitJacocoExtension()
         final def projects = [
                 ProjectHelper.prepare(ANDROID_APPLICATION).get(),
                 ProjectHelper.prepare(ANDROID_LIBRARY).get(),
                 ProjectHelper.prepare(JAVA).get()] as Project[]
 
         for (final def project : projects) {
-            // When
             extension.ignoreProjects = [project.name]
 
-            // Then
             assert !Generation.addJacoco(project, extension)
             assert !project.plugins.hasPlugin(JacocoPlugin)
         }
     }
 
     @Test
     public void androidAppBuildExecutesJacocoTask() {
-
-        // Given
         def androidAppProject = ProjectHelper.prepare(ANDROID_APPLICATION).get()
 
-        // When
         Generation.addJacoco(androidAppProject, new JunitJacocoExtension())
 
-        // Then
         assert taskDependsOn(androidAppProject.check, 'jacocoTestReportDebug')
         assert taskDependsOn(androidAppProject.check, 'jacocoTestReportRelease')
     }
 
     @Test
     public void androidLibraryBuildExecutesJacocoTask() {
-
-        // Given
         def androidLibraryProject = ProjectHelper.prepare(ANDROID_LIBRARY).get()
 
-        // When
         Generation.addJacoco(androidLibraryProject, new JunitJacocoExtension())
 
-        // Then
         assert taskDependsOn(androidLibraryProject.check, 'jacocoTestReportDebug')
         assert taskDependsOn(androidLibraryProject.check, 'jacocoTestReportRelease')
     }
 
     @Test
     public void javaBuildExecutesJacocoTask() {
-
-        // Given
         def javaProject = ProjectHelper.prepare(JAVA).get()
 
-        // When
         Generation.addJacoco(javaProject, new JunitJacocoExtension())
 
-        // Then
         assert taskDependsOn(javaProject.check, 'jacocoTestReport')
     }
 
-    // TODO some cleanup needed code is almost the same for with and without flavors variants
     private void assertJacocoAndroidWithFlavors(final Project project) {
         assert project.plugins.hasPlugin(JacocoPlugin)
 
         assert project.jacoco.toolVersion == '0.7.2.201409121644'
 
-        final def redDebugTask = project.tasks.findByName('jacocoTestReportRedDebug')
-
-        assert redDebugTask instanceof JacocoReport
-
-        redDebugTask.with {
-            assert description == 'Generate Jacoco coverage reports after running redDebug tests.'
-            assert group == 'Reporting'
-
-            assert executionData.singleFile == project.file("${project.buildDir}/jacoco/testRedDebugUnitTest.exec")
-
-            assert additionalSourceDirs.size() == 3
-            assert additionalSourceDirs.contains(project.file('src/main/java'))
-            assert additionalSourceDirs.contains(project.file('src/debug/java'))
-            assert additionalSourceDirs.contains(project.file('src/red/java'))
-
-            assert sourceDirectories.size() == 3
-            assert sourceDirectories.contains(project.file('src/main/java'))
-            assert sourceDirectories.contains(project.file('src/debug/java'))
-            assert sourceDirectories.contains(project.file('src/red/java'))
-
-            assert reports.xml.enabled
-            assert reports.xml.destination.toString() == project.buildDir.absolutePath + '/reports/jacoco/redDebug/jacoco.xml'
-            assert reports.html.enabled
-            assert reports.html.destination.toString() == project.buildDir.absolutePath + '/reports/jacoco/redDebug'
-
-            assert classDirectories.dir == project.file('build/intermediates/classes/red/debug')
-
-            assert taskDependsOn(redDebugTask, 'testRedDebugUnitTest')
-            assert taskDependsOn(project.tasks.findByName('check'), 'jacocoTestReportRedDebug')
-        }
+        assertTask(project, 'red', 'debug')
+        assertTask(project, 'red', 'release')
+        assertTask(project, 'blue', 'debug')
+        assertTask(project, 'blue', 'release')
+    }
 
-        final def blueReleaseTask = project.tasks.findByName('jacocoTestReportBlueRelease')
+    private void assertTask(final Project project, final String flavor, final String buildType) {
+        final def task = project.tasks.findByName("jacocoTestReport${flavor.capitalize()}${buildType.capitalize()}")
 
-        assert blueReleaseTask instanceof JacocoReport
+        assert task instanceof JacocoReport
 
-        blueReleaseTask.with {
-            assert description == 'Generate Jacoco coverage reports after running blueRelease tests.'
+        task.with {
+            assert description == "Generate Jacoco coverage reports after running ${flavor}${buildType.capitalize()} tests."
             assert group == 'Reporting'
 
-            assert executionData.singleFile == project.file("${project.buildDir}/jacoco/testBlueReleaseUnitTest.exec")
+            assert executionData.singleFile == project.file("${project.buildDir}/jacoco/test${flavor.capitalize()}${buildType.capitalize()}UnitTest.exec")
 
             assert additionalSourceDirs.size() == 3
             assert additionalSourceDirs.contains(project.file('src/main/java'))
-            assert additionalSourceDirs.contains(project.file('src/release/java'))
-            assert additionalSourceDirs.contains(project.file('src/blue/java'))
+            assert additionalSourceDirs.contains(project.file("src/${buildType}/java"))
+            assert additionalSourceDirs.contains(project.file("src/${flavor}/java"))
 
             assert sourceDirectories.size() == 3
             assert sourceDirectories.contains(project.file('src/main/java'))
-            assert sourceDirectories.contains(project.file('src/release/java'))
-            assert sourceDirectories.contains(project.file('src/blue/java'))
+            assert sourceDirectories.contains(project.file("src/${buildType}/java"))
+            assert sourceDirectories.contains(project.file("src/${flavor}/java"))
 
             assert reports.xml.enabled
-            assert reports.xml.destination.toString() == project.buildDir.absolutePath + '/reports/jacoco/blueRelease/jacoco.xml'
+            assert reports.xml.destination.toString() == project.buildDir.absolutePath + "/reports/jacoco/${flavor}${buildType.capitalize()}/jacoco.xml"
             assert reports.html.enabled
-            assert reports.html.destination.toString() == project.buildDir.absolutePath + '/reports/jacoco/blueRelease'
+            assert reports.html.destination.toString() == project.buildDir.absolutePath + "/reports/jacoco/${flavor}${buildType.capitalize()}"
 
-            assert classDirectories.dir == project.file('build/intermediates/classes/blue/release')
+            assert classDirectories.dir == project.file("build/intermediates/classes/${flavor}/${buildType}")
 
-            assert taskDependsOn(blueReleaseTask, 'testBlueReleaseUnitTest')
-            assert taskDependsOn(project.tasks.findByName('check'), 'jacocoTestReportBlueRelease')
+            assert taskDependsOn(task, "test${flavor.capitalize()}${buildType.capitalize()}UnitTest")
+            assert taskDependsOn(project.tasks.findByName('check'), "jacocoTestReport${flavor.capitalize()}${buildType.capitalize()}")
         }
     }
 
@@ -289,11 +224,6 @@ public class GenerationTest {
         }
     }
 
-    /**
-     * Assert proper JAva project construction
-     *
-     * @param project
-     */
     private void assertJacocoJava(final Project project) {
         assert project.plugins.hasPlugin(JacocoPlugin)
 

src/test/groovy/com/vanniktech/android/junit/jacoco/ProjectHelper.groovy

@@ -1,56 +1,48 @@
 package com.vanniktech.android.junit.jacoco
 
-import org.gradle.api.Project;
-import org.gradle.testfixtures.ProjectBuilder;
+import org.gradle.api.Project
+import org.gradle.testfixtures.ProjectBuilder
 
-/**
- * Provides projects for testing
- */
-public class ProjectHelper {
+/** Provides projects for testing */
+final class ProjectHelper {
+    public static ProjectHelper prepare(ProjectType projectType) {
+        return new ProjectHelper(projectType)
+    }
 
     private final ProjectType projectType;
     private final Project project;
 
     private ProjectHelper(ProjectType projectType) {
         this.projectType = projectType;
 
-        switch (projectType){
+        switch (projectType) {
             case ProjectType.JAVA:
-                def rootProject = ProjectBuilder.builder().withName('root').build()
-                project = ProjectBuilder.builder().withName('java').withParent(rootProject).build()
-                project.plugins.apply('java')
+                project = ProjectBuilder.builder().withName('java').build()
                 break
-
             case ProjectType.ANDROID_APPLICATION:
                 project = ProjectBuilder.builder().withName('android app').build()
-                project.plugins.apply('com.android.application')
                 break
-
             case ProjectType.ANDROID_LIBRARY:
                 project = ProjectBuilder.builder().withName('android library').build()
-                project.plugins.apply('com.android.library')
                 break
         }
+
+        project.plugins.apply(projectType.pluginName)
     }
 
-    /**
-     * Adds flavors to project, only for Android based projects
-     *
-     * @return ProjectHelper instance
-     */
-    public ProjectHelper withRedBlueFlavors(){
+    /** Adds flavors to project, only for Android based projects */
+    public ProjectHelper withRedBlueFlavors() {
+        if (projectType == ProjectType.JAVA) {
+            throw new UnsupportedOperationException('Not supported with Java project')
+        }
 
         def customFlavors = [
-                red: [
-                        applicationId: "com.example.red"
-                ],
-                blue: [
-                        applicationId: "com.example.blue"
-                ]
+                red : [applicationId: 'com.example.red'],
+                blue: [applicationId: 'com.example.blue']
         ]
 
         project.android.productFlavors {
-            customFlavors.each {name, config ->
+            customFlavors.each { name, config ->
                 "$name" {
                     applicationId config.applicationId
                 }
@@ -60,32 +52,14 @@ public class ProjectHelper {
         return this
     }
 
-    /**
-     * Access configured project
-     *
-     * @return
-     */
-    public Project get(){
+    public Project get() {
         return project
     }
 
-    /**
-     * 
-     *
-     * @param projectType
-     * @return
-     */
-    public static ProjectHelper prepare(ProjectType projectType){
-        return new ProjectHelper(projectType)
-    }
-
-    /**
-     * Type of project
-     */
     public enum ProjectType {
-        ANDROID_APPLICATION("com.android.application"),
-        ANDROID_LIBRARY("com.android.library"),
-        JAVA("java");
+        ANDROID_APPLICATION('com.android.application'),
+        ANDROID_LIBRARY('com.android.library'),
+        JAVA('java');
 
         private final String pluginName;