Fix/unknown Android classes

.github/workflows/gradle_task.yml

@@ -47,6 +47,9 @@ jobs:
           distribution: temurin
           java-version: 11
 
+      - name: Setup Android SDK # required for integration tests
+        uses: android-actions/setup-android@v2
+
       - uses: gradle/gradle-build-action@v2
         with:
           gradle-home-cache-cleanup: true

build.gradle.kts

@@ -22,6 +22,7 @@ idea {
         ".gradle",
         "build",
         "gradle/wrapper",
+        "ANDROID_SDK",
       )
       addAll(
         projectDir.walk().filter { file ->

buildSrc/src/main/kotlin/buildsrc/conventions/android-setup.gradle.kts

@@ -0,0 +1,98 @@
+package buildsrc.conventions
+
+import buildsrc.tasks.SetupDokkaProjects
+import java.io.File
+import java.time.Duration
+import org.gradle.api.provider.Provider
+import org.gradle.kotlin.dsl.*
+import buildsrc.utils.skipTestFixturesPublications
+import org.gradle.api.tasks.testing.logging.TestLogEvent
+import org.jetbrains.kotlin.util.suffixIfNot
+
+
+/**
+ * Utilities for preparing Android projects
+ */
+
+plugins {
+  base
+  id("buildsrc.conventions.base")
+}
+
+
+val androidSdkDir: Provider<File> = providers
+  // first try getting the SDK installed on via GitHub step setup-android
+  .environmentVariable("ANDROID_SDK_ROOT").map(::File)
+  // else get the project-local SDK
+  .orElse(layout.projectDirectory.file("projects/ANDROID_SDK").asFile)
+
+
+
+val createAndroidLocalPropertiesFile by tasks.registering {
+
+  val localPropertiesFile = temporaryDir.resolve("local.properties")
+  outputs.file(localPropertiesFile).withPropertyName("localPropertiesFile")
+
+  val androidSdkDir = androidSdkDir
+  // add the relative path as a property for Gradle up-to-date checks (the directory contents don't matter)
+  inputs.property(
+    "androidSdkDirPath",
+    androidSdkDir.map { it.relativeTo(projectDir).invariantSeparatorsPath }
+  )
+
+  doLast {
+    val androidSdkPath = androidSdkDir.get().invariantSeparatorsPath
+
+    localPropertiesFile.apply {
+      parentFile.mkdirs()
+      createNewFile()
+      writeText(
+        """
+          |# DO NOT EDIT - Generated by $path
+          |
+          |sdk.dir=$androidSdkPath
+          |
+        """.trimMargin()
+      )
+    }
+  }
+}
+
+
+val updateAndroidLocalProperties by tasks.registering {
+
+  // find all local.properties files
+  val localPropertiesFiles = layout.projectDirectory.dir("projects").asFileTree
+    .matching {
+      include("**/local.properties")
+    }.files
+
+  outputs.files(localPropertiesFiles).withPropertyName("localPropertiesFiles")
+
+  val androidSdkDir = androidSdkDir
+
+  // add the relative path as a property for Gradle up-to-date checks (the directory contents don't matter)
+  inputs.property(
+    "androidSdkDirPath",
+    androidSdkDir.map { it.relativeTo(projectDir).invariantSeparatorsPath }
+  )
+
+  doLast {
+    val androidSdkDirPath = androidSdkDir.get().invariantSeparatorsPath
+
+    localPropertiesFiles.forEach { file ->
+      if (file.exists()) {
+        file.writeText(
+          file.useLines { lines ->
+            lines.joinToString("\n") { line ->
+              when {
+                line.startsWith("sdk.dir=") -> "sdk.dir=$androidSdkDirPath"
+                else                        -> line
+              }
+            }.suffixIfNot("\n")
+          }
+        )
+      }
+    }
+  }
+}

gradle/libs.versions.toml

@@ -6,7 +6,7 @@ kotlinx-serialization = "1.5.0"
 
 kotest = "5.6.0"
 
-gradlePlugin-android = "4.0.1"
+gradlePlugin-android = "4.2.2"
 gradlePlugin-dokkatoo = "1.1.1"
 gradlePlugin-gradlePublishPlugin = "1.1.0"
 gradlePlugin-bcvMu = "0.0.4"

modules/dokkatoo-plugin-integration-tests/build.gradle.kts

@@ -1,5 +1,6 @@
 @file:Suppress("UnstableApiUsage") // jvm test suites & test report aggregation are incubating
 
+import buildsrc.tasks.SetupDokkaProjects
 import buildsrc.utils.skipTestFixturesPublications
 import org.gradle.api.tasks.testing.logging.TestLogEvent
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
@@ -15,6 +16,7 @@ plugins {
   buildsrc.conventions.`java-base`
   buildsrc.conventions.`maven-publish-test`
   buildsrc.conventions.`dokkatoo-example-projects`
+  buildsrc.conventions.`android-setup`
 }
 
 description = """
@@ -38,7 +40,6 @@ dependencies {
   // don't define test dependencies here, instead define them in the testing.suites {} configuration below
 }
 
-
 tasks.withType<KotlinCompile>().configureEach {
   kotlinOptions {
     freeCompilerArgs += listOf(
@@ -48,6 +49,7 @@ tasks.withType<KotlinCompile>().configureEach {
   }
 }
 
+//region Test suites and task configuration
 testing.suites {
 
   withType<JvmTestSuite>().configureEach {
@@ -91,13 +93,11 @@ testing.suites {
     }
   }
 
-
   /** Examples tests suite */
   val testExamples by registering(JvmTestSuite::class) {
     description = "Test the example projects, from the 'examples' directory in the project root"
   }
 
-
   /** Integration tests suite */
   val testIntegration by registering(JvmTestSuite::class) {
     description =
@@ -109,6 +109,12 @@ testing.suites {
 
 
 tasks.withType<Test>().configureEach {
+  // this seems to help OOM errors in the Worker Daemons
+  //setForkEvery(1)
+  jvmArgs(
+    "-Xmx1g",
+    "-XX:MaxMetaspaceSize=512m",
+  )
 
   mustRunAfter(tasks.withType<AbstractPublishToMaven>())
 
@@ -127,14 +133,29 @@ tasks.withType<Test>().configureEach {
     showStackTraces = true
   }
 }
+//endregion
 
-skipTestFixturesPublications()
+//region Example & Template projects setup
+dokkatooExampleProjects {
+  exampleProjects {
+    projectsItAndroid0Dokkatoo {
+      gradlePropertiesContent.add("android.useAndroidX=true")
+    }
+  }
+}
 
 dokkaTemplateProjects {
+
+  val androidLocalPropertiesFile = tasks.createAndroidLocalPropertiesFile.map {
+    it.outputs.files
+  }
+
   register(
     source = "integration-tests/gradle/projects/it-android-0",
     destination = "projects/it-android-0/dokka",
-  )
+  ) {
+    additionalFiles.from(androidLocalPropertiesFile)
+  }
   register(
     source = "integration-tests/gradle/projects/it-basic",
     destination = "projects/it-basic/dokka",
@@ -172,7 +193,6 @@ dokkaTemplateProjects {
 //    register("projects/serialization/dokka") { }
 //    register("projects/stdlib/dokka") { }
 
-
   configureEach {
     additionalPaths.addAll(
       "integration-tests/gradle/projects/template.root.gradle.kts",
@@ -188,11 +208,8 @@ tasks.setupDokkaTemplateProjects.configure {
 
   doLast {
     outputs.files.asFileTree.files.forEach { file ->
-      println("copied file $file")
-
       when (file.name) {
         "build.gradle.kts"             -> {
-          println("re-writing $file")
           file.writeText(
             file.readText()
               .replace(
@@ -206,7 +223,6 @@ tasks.setupDokkaTemplateProjects.configure {
         }
 
         "settings.gradle.kts"          -> {
-          println("re-writing $file")
           file.writeText(
             file.readText()
               .replace(
@@ -217,7 +233,6 @@ tasks.setupDokkaTemplateProjects.configure {
         }
 
         "template.settings.gradle.kts" -> {
-          println("re-writing $file")
           file.writeText(
             file.readText()
               .replace(
@@ -231,15 +246,17 @@ tasks.setupDokkaTemplateProjects.configure {
   }
 }
 
-tasks.withType<Test>().configureEach {
-  // this seems to help OOM errors in the Worker Daemons
-  //setForkEvery(1)
-  jvmArgs(
-    "-Xmx1g",
-    "-XX:MaxMetaspaceSize=512m",
-  )
-}
-
 dokkaSourceDownload {
   dokkaVersion.set(libs.versions.kotlin.dokka)
 }
+
+tasks.updateAndroidLocalProperties {
+  mustRunAfter(tasks.withType<SetupDokkaProjects>())
+}
+
+tasks.updateDokkatooExamples {
+  dependsOn(tasks.updateAndroidLocalProperties)
+}
+//endregion
+
+skipTestFixturesPublications()

modules/dokkatoo-plugin-integration-tests/projects/ANDROID_SDK/licenses/android-googletv-license

@@ -0,0 +1,2 @@
+
+601085b94cd77f0b54ff86406957099ebe79c4d6

modules/dokkatoo-plugin-integration-tests/projects/ANDROID_SDK/licenses/android-sdk-arm-dbt-license

@@ -0,0 +1,2 @@
+
+859f317696f67ef3d7f30a50a5560e7834b43903

modules/dokkatoo-plugin-integration-tests/projects/ANDROID_SDK/licenses/android-sdk-license

@@ -0,0 +1,2 @@
+
+24333f8a63b6825ea9c5514f83c2829b004d1fee

modules/dokkatoo-plugin-integration-tests/projects/ANDROID_SDK/licenses/android-sdk-preview-license

@@ -0,0 +1,2 @@
+
+84831b9409646a918e30573bab4c9c91346d8abd

modules/dokkatoo-plugin-integration-tests/projects/ANDROID_SDK/licenses/google-gdk-license

@@ -0,0 +1,2 @@
+
+33b6a2b64607f11b759f320ef9dff4ae5c47d97a

modules/dokkatoo-plugin-integration-tests/projects/ANDROID_SDK/licenses/intel-android-extra-license

@@ -0,0 +1,2 @@
+
+d975f751698a77b662f1254ddbeed3901e976f5a

modules/dokkatoo-plugin-integration-tests/projects/ANDROID_SDK/licenses/mips-android-sysimage-license

@@ -0,0 +1,2 @@
+
+e9acab5b5fbb560a72cfaecce8946896ff6aab9d