feat: add test for api ref doc analytics

dokka-aws/build.gradle.kts

@@ -4,12 +4,14 @@
  */
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+import java.time.LocalDate
 
 /*
  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  * SPDX-License-Identifier: Apache-2.0
  */
 plugins {
+    alias(libs.plugins.dokka)
     alias(libs.plugins.kotlin.jvm)
 }
 
@@ -18,6 +20,15 @@ description = "Custom Dokka plugin for AWS Kotlin SDK API docs"
 dependencies {
     compileOnly(libs.dokka.base)
     compileOnly(libs.dokka.core)
+
+    testImplementation(libs.jsoup)
+    testImplementation(libs.junit.jupiter)
+    testImplementation(libs.kotest.assertions.core.jvm)
+    testImplementation(libs.kotlin.test.junit5)
+}
+
+tasks.test {
+    useJUnitPlatform()
 }
 
 tasks.withType<KotlinCompile> {
@@ -31,3 +42,29 @@ tasks.withType<JavaCompile> {
     sourceCompatibility = JavaVersion.VERSION_1_8.toString()
     targetCompatibility = JavaVersion.VERSION_1_8.toString()
 }
+
+tasks.withType<org.jetbrains.dokka.gradle.AbstractDokkaTask>().configureEach {
+    val sdkVersion: String by project
+    moduleVersion.set(sdkVersion)
+
+    val year = LocalDate.now().year
+    val pluginConfigMap = mapOf(
+        "org.jetbrains.dokka.base.DokkaBase" to """
+                {
+                    "customStyleSheets": [
+                        "${rootProject.file("docs/dokka-presets/css/logo-styles.css")}",
+                        "${rootProject.file("docs/dokka-presets/css/aws-styles.css")}"
+                    ],
+                    "customAssets": [
+                        "${rootProject.file("docs/dokka-presets/assets/logo-icon.svg")}",
+                        "${rootProject.file("docs/dokka-presets/assets/aws_logo_white_59x35.png")}",
+                        "${rootProject.file("docs/dokka-presets/scripts/accessibility.js")}"
+                    ],
+                    "footerMessage": "© $year, Amazon Web Services, Inc. or its affiliates. All rights reserved.",
+                    "separateInheritedMembers" : true,
+                    "templatesDir": "${rootProject.file("docs/dokka-presets/templates")}"
+                }
+            """,
+    )
+    pluginsMapConfiguration.set(pluginConfigMap)
+}

dokka-aws/src/test/kotlin/aws/sdk/kotlin/dokka/DokkaAwsTest.kt

@@ -0,0 +1,70 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+package aws.sdk.kotlin.dokka
+
+import org.jsoup.Jsoup
+import org.junit.jupiter.api.AfterEach
+import org.junit.jupiter.api.Assumptions.assumeTrue
+import org.junit.jupiter.api.BeforeEach
+import org.junit.jupiter.api.Test
+import java.io.File
+import kotlin.test.assertTrue
+
+class DokkaAwsTest {
+    val dokkaOutputDir = File("build/dokka")
+
+    @BeforeEach
+    fun generateDocs() {
+        val process = ProcessBuilder(
+            "./gradlew",
+            ":dokka-aws:dokkaHtml",
+        ).directory(File(".."))
+            .redirectErrorStream(true)
+            .start()
+
+        val exitCode = process.waitFor()
+        assumeTrue(
+            exitCode == 0,
+            "Dokka generation failed with exit code $exitCode",
+        )
+    }
+
+    @AfterEach
+    fun cleanup() {
+        if (dokkaOutputDir.exists()) {
+            try {
+                dokkaOutputDir.deleteRecursively()
+                println("Successfully deleted dokka folder")
+            } catch (e: Exception) {
+                println("Failed to delete dokka folder: ${e.message}")
+            }
+        }
+    }
+
+    @Test
+    fun testLoadScripts() {
+        val testFile = File("build/dokka/html/index.html")
+
+        assumeTrue(
+            testFile.exists(),
+            "Skipping test: test file does not exist",
+        )
+
+        val document = Jsoup.parse(testFile, "UTF-8")
+
+        val expectedScripts = listOf(
+            "awshome_s_code.js",
+        )
+
+        val scripts = document.head().select("script[src]")
+
+        expectedScripts.forEach { expectedScript ->
+            assertTrue(
+                scripts.any { it.attr("src").endsWith(expectedScript) },
+                "Expected script $expectedScript not found",
+            )
+        }
+    }
+}

gradle/libs.versions.toml

@@ -26,6 +26,7 @@ kotlinx-benchmark-version = "0.4.12"
 kotlinx-serialization-version = "1.7.3"
 mockk-version = "1.13.13"
 slf4j-version = "2.0.16"
+jsoup-version = "1.19.1"
 
 [libraries]
 aws-kotlin-repo-tools-build-support = { module="aws.sdk.kotlin.gradle:build-support", version.ref = "aws-kotlin-repo-tools-version" }
@@ -111,6 +112,8 @@ smithy-aws-smoke-test-model = { module = "software.amazon.smithy:smithy-aws-smok
 junit-jupiter = { module = "org.junit.jupiter:junit-jupiter", version.ref = "junit-version" }
 junit-jupiter-params = { module = "org.junit.jupiter:junit-jupiter-params", version.ref = "junit-version" }
 
+jsoup = { module = "org.jsoup:jsoup", version.ref = "jsoup-version" }
+
 kotest-assertions-core = { module = "io.kotest:kotest-assertions-core", version.ref = "kotest-version" }
 kotest-assertions-core-jvm = { module = "io.kotest:kotest-assertions-core-jvm", version.ref = "kotest-version" }
 kotest-framework-datatest = { module = "io.kotest:kotest-framework-datatest", version.ref = "kotest-version" }