Separate Android & Java modules (#152)

I’m giving up trying to mix them both in a single project.
Instead, two subfolders become the root for the individual modules;
open “plugin” with IntelliJ IDEA, and “instrumentation” with Android Studio.

Author: Marcel Schnelle

.circleci/config.yml

@@ -7,7 +7,7 @@ defaults: &defaults
         GRADLE_OPTS: '-Dorg.gradle.jvmargs="-Xmx4g -XX:+HeapDumpOnOutOfMemoryError"'
 
 cache_key: &cache_key
-  key: jars-{{ checksum "build.gradle.kts" }}-{{ checksum "android-junit5/build.gradle.kts" }}-{{ checksum "android-junit5-tests/build.gradle.kts" }}-{{ checksum "instrumentation/build.gradle.kts" }}-{{ checksum "instrumentation-runner/build.gradle.kts" }}-{{ checksum "sample/build.gradle.kts" }}-{{ checksum "gradle/wrapper/gradle-wrapper.properties" }}
+  key: jars-{{ checksum "build.gradle.kts" }}-{{ checksum "plugin/android-junit5/build.gradle.kts" }}-{{ checksum "plugin/android-junit5-tests/build.gradle.kts" }}-{{ checksum "instrumentation/api/build.gradle.kts" }}-{{ checksum "instrumentation/runner/build.gradle.kts" }}-{{ checksum "instrumentation/sample/build.gradle.kts" }}-{{ checksum "gradle/wrapper/gradle-wrapper.properties" }}
 
 version: 2
 jobs:
@@ -17,23 +17,24 @@ jobs:
       - checkout
       - restore_cache:
           <<: *cache_key
-      - run:
-          name: Download Dependencies
-          command: ./gradlew androidDependencies --no-daemon
 
       - run:
-          name: Build Plugin
-          command: ./gradlew :android-junit5:assemble --stacktrace --no-daemon
+          name: (Plugin) Build
+          command: cd plugin && ./gradlew :android-junit5:assemble --stacktrace --no-daemon
       - run:
-          name: Test Plugin
-          command: ./gradlew :android-junit5-tests:check --stacktrace --no-daemon
-
+          name: (Plugin) Test
+          command: cd plugin && ./gradlew :android-junit5-tests:check --stacktrace --no-daemon
+      
+      - run:
+          name: (Instrumentation) Download Dependencies
+          command: cd instrumentation && ./gradlew androidDependencies --no-daemon
       - run:
-          name: Build Instrumentation
-          command: ./gradlew :instrumentation:assemble :instrumentation-runner:assemble --stacktrace --no-daemon
+          name: (Instrumentation) Build
+          command: cd instrumentation && ./gradlew :api:assemble :runner:assemble --stacktrace --no-daemon
       - run:
-          name: Test Instrumentation
-          command: ./gradlew :instrumentation:check :instrumentation-runner:check --stacktrace --no-daemon
+          name: (Instrumentation) Test
+          command: cd instrumentation && ./gradlew :api:check :runner:check --stacktrace --no-daemon
+
       - save_cache:
           <<: *cache_key
           paths:
@@ -44,13 +45,13 @@ jobs:
           paths:
             - project
       - store_artifacts:
-          path: android-junit5-tests/build/reports/tests/test
+          path: plugin/android-junit5-tests/build/reports/tests/test
           destination: plugin
       - store_artifacts:
-          path: instrumentation/build/reports
-          destination: instrumentation
+          path: instrumentation/api/build/reports
+          destination: instrumentation-api
       - store_artifacts:
-          path: instrumentation-runner/build/reports
+          path: instrumentation/runner/build/reports
           destination: instrumentation-runner
 
   deploy_snapshots:
@@ -61,8 +62,11 @@ jobs:
       - restore_cache:
           <<: *cache_key
       - run:
-          name: Deploy SNAPSHOTs
-          command: ./gradlew publishLibraryPublicationToSnapshotRepository --stacktrace --no-daemon
+          name: (Plugin) Deploy SNAPSHOTs
+          command: cd plugin && ./gradlew publishLibraryPublicationToSnapshotRepository --stacktrace --no-daemon
+      - run:
+          name: (Instrumentation) Deploy SNAPSHOTs
+          command: cd instrumentation && ./gradlew publishLibraryPublicationToSnapshotRepository --stacktrace --no-daemon
 
   deploy_plugin_release:
     <<: *defaults
@@ -72,8 +76,8 @@ jobs:
       - restore_cache:
           <<: *cache_key
       - run:
-          name: Deploy plugin
-          command: ./gradlew generatePomFileForLibraryPublication publish :android-junit5:bintrayUpload --stacktrace --no-daemon
+          name: (Plugin) Deploy
+          command: cd plugin && ./gradlew generatePomFileForLibraryPublication publish :android-junit5:bintrayUpload --stacktrace --no-daemon
 
 #  deploy_instrumentation_release:
 #    <<: *defaults
@@ -83,8 +87,8 @@ jobs:
 #      - restore_cache:
 #          <<: *cache_key
 #      - run:
-#          name: Deploy instrumentation
-#          command: ./gradlew generatePomFileForLibraryPublication publish :instrumentation:bintrayUpload :instrumentation-runner:bintrayUpload --stacktrace --no-daemon
+#          name: (Instrumentation) Deploy
+#          command: cd instrumentation && ./gradlew generatePomFileForLibraryPublication publish :api:bintrayUpload :runner:bintrayUpload --stacktrace --no-daemon
 
 workflows:
   version: 2

.gitignore

@@ -1,9 +1,9 @@
 *.iml
 .gradle
 local.properties
-.idea/*
-!.idea/runConfigurations
-!.idea/codeStyleSettings.xml
+*/.idea/*
+!*/.idea/runConfigurations
+!*/.idea/codeStyleSettings.xml
 .DS_Store
 build/
 out/

README.md

@@ -192,6 +192,13 @@ Currently, Google hasn't shared any immediate plans to bring first-party support
 - [Add support for JUnit 5 (issuetracker.google.com)](https://issuetracker.google.com/issues/127100532)
 - [JUnit 5 support (github.com/android/android-test)](https://github.com/android/android-test/issues/224)
 
+# Building Locally
+
+This repository contains multiple modules, divided into two sub-projects. The repository's root directory contains build logic shared across the sub-projects, which in turn use symlinks to connect to the common build scripts in their parent folder.
+
+- `instrumentation`: The root folder for Android-based modules, namely the instrumentation libraries & a sample application. After cloning, open this project in Android Studio.
+- `plugin`: The root folder for Java-based modules, namely the Gradle plugin for JUnit 5 on Android, as well as its test module. After cloning, open this project in IntelliJ IDEA.
+
 ## License
 
 ```
@@ -216,7 +223,7 @@ See also the [full License text](LICENSE).
  [junit5ug]: https://junit.org/junit5/docs/current/user-guide
  [circleci]: https://circleci.com/gh/mannodermaus/android-junit5
  [sonatyperepo]: https://oss.sonatype.org/content/repositories/snapshots
- [sampletests]: sample/src/test
+ [sampletests]: instrumentation/sample
  [wiki-dsl]: https://github.com/mannodermaus/android-junit5/wiki/Configuration-DSL
  [wiki-migration]: https://github.com/mannodermaus/android-junit5/wiki/Migrating-from-1.0.x
  [wiki-gettingstarted]: https://github.com/mannodermaus/android-junit5/wiki/Getting-Started

buildSrc/src/main/kotlin/Versions.kt

@@ -13,7 +13,7 @@ object Versions {
 
     const val aapt2: String = "3.2.1-4818971" 
 
-    const val com_android_tools_build_gradle: String = "3.2.1" 
+    const val com_android_tools_build_gradle: String = "3.4.0-rc02"
 
     const val lint_gradle: String = "26.2.1" 
 
@@ -45,7 +45,7 @@ object Versions {
 
     const val assertj_core: String = "3.11.1" 
 
-    const val org_jetbrains_kotlin: String = "1.3.11" 
+    const val org_jetbrains_kotlin: String = "1.3.21"
 
     const val org_jetbrains_spek: String = "1.2.1"
 

gradle/wrapper/gradle-wrapper.jar

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-5.0-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-5.2.1-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,113 @@
+import org.gradle.api.tasks.testing.logging.TestExceptionFormat
+import org.gradle.api.tasks.testing.logging.TestLogEvent
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+
+plugins {
+  id("com.android.library")
+  kotlin("android")
+}
+
+android {
+  compileSdkVersion(Android.compileSdkVersion)
+
+  dexOptions {
+    javaMaxHeapSize = Android.javaMaxHeapSize
+  }
+
+  defaultConfig {
+    minSdkVersion(Android.instrumentationMinSdkVersion)
+    targetSdkVersion(Android.targetSdkVersion)
+    versionCode = 1
+    versionName = "1.0"
+    multiDexEnabled = true
+
+    // Usually, this is automatically applied through the Gradle Plugin
+    testInstrumentationRunner = "android.support.test.runner.AndroidJUnitRunner"
+    testInstrumentationRunnerArgument("runnerBuilder",
+        "de.mannodermaus.junit5.AndroidJUnit5Builder")
+  }
+
+  sourceSets {
+    getByName("main").java.srcDir("src/main/kotlin")
+    getByName("test").java.srcDir("src/test/kotlin")
+    getByName("androidTest").java.srcDir("src/androidTest/kotlin")
+  }
+
+  compileOptions {
+    setSourceCompatibility(JavaVersion.VERSION_1_8)
+    setTargetCompatibility(JavaVersion.VERSION_1_8)
+  }
+
+  lintOptions {
+    // JUnit 4 refers to java.lang.management APIs, which are absent on Android.
+    warning("InvalidPackage")
+  }
+
+  packagingOptions {
+    exclude("META-INF/LICENSE.md")
+    exclude("META-INF/LICENSE-notice.md")
+  }
+
+  testOptions {
+    unitTests.apply {
+      isReturnDefaultValues = true
+    }
+  }
+}
+
+tasks.withType<KotlinCompile> {
+  kotlinOptions.jvmTarget = "1.8"
+}
+
+tasks.withType<Test> {
+  failFast = true
+  testLogging {
+    events = setOf(TestLogEvent.PASSED, TestLogEvent.SKIPPED, TestLogEvent.FAILED)
+    exceptionFormat = TestExceptionFormat.FULL
+  }
+}
+
+val commonTestImplementation = configurations.create("commonTestImplementation")
+configurations {
+  getByName("androidTestImplementation").extendsFrom(commonTestImplementation)
+  getByName("testImplementation").extendsFrom(commonTestImplementation)
+}
+
+dependencies {
+  implementation(Libs.kotlin_stdlib)
+  implementation(Libs.com_android_support_test_runner)
+  implementation(Libs.junit_jupiter_api)
+
+  // This is required by the "instrumentation-runner" companion library,
+  // since it can't provide any JUnit 5 runtime libraries itself
+  // due to fear of prematurely incrementing the minSdkVersion requirement.
+  runtimeOnly(Libs.junit_platform_runner)
+
+  commonTestImplementation(Libs.assertj_core)
+  commonTestImplementation(Libs.mockito_core)
+  commonTestImplementation(Libs.junit_jupiter_api)
+  commonTestImplementation(Libs.junit_jupiter_engine)
+
+  androidTestImplementation(Libs.assertj_android)
+  androidTestImplementation(Libs.espresso_core)
+
+  androidTestRuntimeOnly(project(":runner"))
+
+  // Obviously, these dependencies should be mostly "runtimeOnly",
+  // but we have to override bundled APIs from the IDE as much as possible for Android Studio.
+  testImplementation(Libs.junit_platform_engine)
+  testImplementation(Libs.junit_platform_launcher)
+  testImplementation(Libs.junit_jupiter_api)
+  testImplementation(Libs.junit_jupiter_engine)
+  testImplementation(Libs.junit_vintage_engine)
+}
+
+// ------------------------------------------------------------------------------------------------
+// Deployment Setup
+//
+// Releases are pushed to jcenter via Bintray, while snapshots are pushed to Sonatype OSS.
+// This section defines the necessary tasks to push new releases and snapshots using Gradle tasks.
+// ------------------------------------------------------------------------------------------------
+
+val deployConfig by extra<Deployed> { Artifacts.Instrumentation.Library }
+apply(from = "$rootDir/gradle/deployment.gradle")