Introduce TaskProvider API, Remove Symlinks, Allow Connection between Plugin & Sample (#235)

* Move location of "junitPlatform" extension to Project

Don't keep it on the AGP's internal TestOptions type since that seems
to cause problems with the latest iterations of that plugin. Instead,
move it to the Project level and update all references to it

* Migrate Jacoco task integration to new lazy Gradle API

* Migrate instrumentation test integration task to new lazy TaskProvider API

* Remove symlinks

* Remove symlinks, Part 2

Some build logic is now duplicated across plugin and instrumentation,
but it's kept to a minimum. The buildSrc & deployment logic remains
in a singular place and is imported into each of the child projects
on demand

* Add changelog for Plugin 1.7.0.0

* Allow building Fat JARs of the plugin

This is in preparation for using a local build of the plugin inside
the sample modules

* Allow sample module to use Fat JAR of plugin, if possible

* Remove workaround for KotlinJvmOptions (not needed anymore)

* Changelog

* Update CI file to point to new file locations

Author: mannodermaus

.circleci/config.yml

@@ -7,7 +7,7 @@ defaults: &defaults
         GRADLE_OPTS: -Xmx4096m -XX:+HeapDumpOnOutOfMemoryError -Dorg.gradle.caching=true -Dorg.gradle.configureondemand=true -Dkotlin.compiler.execution.strategy=in-process -Dkotlin.incremental=false
 
 cache_key: &cache_key
-  key: jars-{{ checksum "build.gradle.kts" }}-{{ checksum "plugin/android-junit5/build.gradle.kts" }}-{{ checksum "instrumentation/runner/build.gradle.kts" }}-{{ checksum "instrumentation/sample/build.gradle.kts" }}-{{ checksum "gradle/wrapper/gradle-wrapper.properties" }}-{{ checksum "buildSrc/src/main/kotlin/Artifacts.kt" }}-{{ checksum "buildSrc/src/main/kotlin/Dependencies.kt" }}
+  key: jars-{{ checksum "plugin/build.gradle.kts" }}-{{ checksum "plugin/android-junit5/build.gradle.kts" }}-{{ checksum "plugin/gradle/wrapper/gradle-wrapper.properties" }}-{{ checksum "instrumentation/build.gradle.kts" }}-{{ checksum "instrumentation/runner/build.gradle.kts" }}-{{ checksum "instrumentation/sample/build.gradle.kts" }}-{{ checksum "instrumentation/gradle/wrapper/gradle-wrapper.properties" }}-{{ checksum "buildSrc/src/main/kotlin/Artifacts.kt" }}-{{ checksum "buildSrc/src/main/kotlin/Dependencies.kt" }}
 
 version: 2
 jobs:

build.gradle.kts

@@ -98,7 +98,7 @@ class DeployedCredentials(private val project: Project) {
     // * CI Server:
     //      Stored in environment variables before launch
     val properties = Properties().apply {
-      val credentialsFile = File(project.rootDir, "local.properties")
+      val credentialsFile = File(project.rootDir.parentFile, "local.properties")
       if (credentialsFile.exists()) {
         load(credentialsFile.inputStream())
       }

buildSrc/src/main/kotlin/Artifacts.kt

@@ -12,6 +12,7 @@ object Plugins {
   // Maintenance & Build Environment
   const val versions: Lib = "com.github.ben-manes:gradle-versions-plugin:0.20.0"
   const val kotlin: Lib = "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlinVersion"
+  const val shadow: Lib = "com.github.jengelman.gradle.plugins:shadow:6.1.0"
 
   // Android Gradle Plugin
   val android35x: Agp = Agp("com.android.tools.build:gradle:3.5.4")

buildSrc/src/main/kotlin/Dependencies.kt

@@ -1,8 +1,14 @@
 import org.gradle.api.Action
 import org.gradle.api.Project
+import org.gradle.api.artifacts.dsl.DependencyHandler
 import org.gradle.api.artifacts.dsl.RepositoryHandler
 import org.gradle.api.artifacts.repositories.MavenArtifactRepository
+import org.gradle.api.file.FileCollection
 import org.gradle.api.tasks.compile.AbstractCompile
+import java.io.File
+import java.time.Instant
+import java.time.ZoneId
+import java.time.format.DateTimeFormatter
 
 /* RepositoryHandler */
 
@@ -55,3 +61,32 @@ private fun Project.setupCompileChain(sourceCompileName: String,
   // that the other way does not work!
   targetCompile.classpath += project.files(sourceCompile.destinationDir)
 }
+
+/**
+ * Provides a dependency object to the JUnit 5 plugin, if any can be found.
+ * This will look in the build folder of the sibling project to try and find
+ * a previously built "fat JAR", and return it in a format
+ * compatible to the Gradle dependency mechanism. If no file can be found,
+ * this method returns null instead.
+ */
+fun Project.findLocalPluginJar(): File? {
+  val localLibsFolder = rootDir.parentFile.toPath()
+      .resolve("plugin/android-junit5/build/libs")
+      .toFile()
+
+  val localPluginJar = (localLibsFolder.listFiles() ?: emptyArray<File>())
+      .sortedByDescending(File::lastModified)
+      .firstOrNull { "fat" in it.name && "javadoc" !in it.name && "sources" !in it.name }
+
+  return localPluginJar
+}
+
+/* File */
+
+/**
+ * Format the "last modified" timestamp of a file into a human readable string.
+ */
+fun File.lastModifiedDate(): String =
+    Instant.ofEpochMilli(lastModified())
+        .atZone(ZoneId.systemDefault())
+        .format(DateTimeFormatter.ISO_DATE_TIME)

buildSrc/src/main/kotlin/Utilities.kt

@@ -0,0 +1,40 @@
+buildscript {
+  repositories {
+    google()
+    jcenter()
+    jitpack()
+  }
+  dependencies {
+    classpath(Plugins.kotlin)
+    classpath(Plugins.android.dependency)
+    classpath(Plugins.androidMavenPublish)
+    classpath(Plugins.bintray)
+    classpath(Plugins.androidMavenGradle)
+    classpath(Plugins.versions)
+    classpath(Plugins.dokkaCore)
+    classpath(Plugins.dokkaAndroid)
+  }
+}
+
+subprojects {
+  repositories {
+    google()
+    jcenter()
+    sonatypeSnapshots()
+  }
+
+  // Configure publishing (if the project is eligible for publication)
+  configureDeployConfig()
+}
+
+fun Project.configureDeployConfig() {
+  // ------------------------------------------------------------------------------------------------
+  // 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 configuration = Artifacts.from(this) ?: return
+  ext["deployConfig"] = configuration
+  ext["deployCredentials"] = DeployedCredentials(this)
+}

gradle/deployment.gradle deployment.gradlegradle/deployment.gradle renamed to deployment.gradle

@@ -0,0 +1,13 @@
+plugins {
+  `kotlin-dsl`
+}
+
+repositories {
+  jcenter()
+}
+
+sourceSets {
+  main {
+    java.srcDir(file("../../buildSrc/src/main/kotlin"))
+  }
+}