Reduce examplesTest execution time (#481)

Halves execution time of examplesTest in CI by ensuring the tests use
faster API queries and by removing one test case of example-gradle-task
(particularly slow as it tested the example default of a `-14d` query).

Author: gabrielfeo

examples/example-project/src/main/kotlin/com/gabrielfeo/develocity/api/example/Main.kt

@@ -13,15 +13,16 @@ import okhttp3.OkHttpClient
 
 val clientBuilder = OkHttpClient.Builder()
 
-suspend fun main() {
+suspend fun main(args: Array<String>) {
     val newConfig = Config(
         clientBuilder = clientBuilder,
     )
     val develocityApi = DevelocityApi.newInstance(newConfig)
-    runAllAnalysis(develocityApi)
+    val query = args.getOrElse(0) { "buildStartTime>-1d buildTool:gradle" }
+    runAllAnalysis(develocityApi, query)
     develocityApi.shutdown()
 }
 
-private suspend fun runAllAnalysis(develocityApi: DevelocityApi) {
-    mostFrequentBuilds(api = develocityApi.buildsApi)
+private suspend fun runAllAnalysis(develocityApi: DevelocityApi, query: String) {
+    mostFrequentBuilds(api = develocityApi.buildsApi, query)
 }

examples/example-project/src/main/kotlin/com/gabrielfeo/develocity/api/example/analysis/MostFrequentBuilds.kt

@@ -22,12 +22,12 @@ import java.util.LinkedList
  */
 suspend fun mostFrequentBuilds(
     api: BuildsApi,
-    startTime: String = "-7d",
+    query: String,
 ) {
     // Fetch builds from the API
     val builds: List<GradleAttributes> = api.getBuildsFlow(
         fromInstant = 0,
-        query = """buildStartTime>$startTime buildTool:gradle""",
+        query = query,
         models = listOf(BuildModelName.gradleAttributes),
     ).map {
         it.models!!.gradleAttributes!!.model!!

examples/example-scripts/example-script.main.kts

@@ -14,7 +14,7 @@
  * - "Some are doing check builds locally, which we set up to trigger our notably slow
  *   legacy tests. We should suggest they run test instead, leaving check for CI to run."
  *
- * Run this with at least 1GB of heap to accomodate the fetched data: JAVA_OPTS=-Xmx1g
+ * Run this with at least 1GB of heap to accommodate the fetched data: JAVA_OPTS=-Xmx1g
  */
 
 @file:DependsOn("com.gabrielfeo:develocity-api-kotlin:2024.3.0")
@@ -24,21 +24,17 @@ import com.gabrielfeo.develocity.api.model.*
 import com.gabrielfeo.develocity.api.extension.*
 import kotlinx.coroutines.*
 import kotlinx.coroutines.flow.*
-import java.time.*
 import java.util.LinkedList
 
 // Parameters
-val startDate = LocalDate.now().minusWeeks(1)
-val buildFilter: (GradleAttributes) -> Boolean = { build ->
-    "LOCAL" in build.tags
-}
+val query = args.getOrElse(0) { "buildStartTime>-7d buildTool:gradle" }
 
 // Fetch builds from the API
 val api = DevelocityApi.newInstance()
 val builds: List<GradleAttributes> = runBlocking {
     api.buildsApi.getBuildsFlow(
         fromInstant = 0,
-        query = """buildStartTime>-7d buildTool:gradle""",
+        query = query,
         models = listOf(BuildModelName.gradleAttributes),
     ).map {
         it.models!!.gradleAttributes!!.model!!

library/src/examplesTest/kotlin/com/gabrielfeo/develocity/api/example/Queries.kt

@@ -0,0 +1,9 @@
+package com.gabrielfeo.develocity.api.example
+
+object BuildStartTime {
+    const val RECENT = "-10h"
+}
+
+object Queries {
+    const val FAST = "buildStartTime>${BuildStartTime.RECENT} buildTool:gradle"
+}

library/src/examplesTest/kotlin/com/gabrielfeo/develocity/api/example/gradle/ExampleGradleTaskTest.kt

@@ -1,5 +1,6 @@
 package com.gabrielfeo.develocity.api.example.gradle
 
+import com.gabrielfeo.develocity.api.example.BuildStartTime
 import org.junit.jupiter.api.Assertions.assertTrue
 import org.junit.jupiter.api.BeforeEach
 import org.junit.jupiter.api.MethodOrderer.OrderAnnotation
@@ -43,10 +44,10 @@ class ExampleGradleTaskTest {
     }
 
     @Test
-    fun testBuildPerformanceMetricsTaskWithDefaults() {
-        val user = System.getProperty("user.name")
-        val output = runBuild("userBuildPerformanceMetrics").stdout
-        assertPerformanceMetricsOutput(output, user = user, period = "-14d")
+    fun testBuildPerformanceMetricsTask() {
+        val args = "--user runner --period=${BuildStartTime.RECENT}"
+        val output = runBuild("userBuildPerformanceMetrics $args").stdout
+        assertPerformanceMetricsOutput(output, user = "runner", period = BuildStartTime.RECENT)
     }
 
     private fun runBuild(gradleArgs: String) =
@@ -67,10 +68,4 @@ class ExampleGradleTaskTest {
         assertTrue(output.contains("▶︎ Serialization factor:"))
         assertTrue(output.contains("⏩︎ Avoidance savings:"))
     }
-
-    @Test
-    fun testBuildPerformanceMetricsTaskWithOptions() {
-        val output = runBuild("userBuildPerformanceMetrics --user runner --period=-1d").stdout
-        assertPerformanceMetricsOutput(output, user = "runner", period = "-1d")
-    }
 }

library/src/examplesTest/kotlin/com/gabrielfeo/develocity/api/example/gradle/ExampleProjectTest.kt

@@ -1,5 +1,6 @@
 package com.gabrielfeo.develocity.api.example.gradle
 
+import com.gabrielfeo.develocity.api.example.Queries
 import org.junit.jupiter.api.Assertions.assertTrue
 import org.junit.jupiter.api.BeforeEach
 import org.junit.jupiter.api.MethodOrderer.OrderAnnotation
@@ -43,7 +44,7 @@ class ExampleProjectTest {
 
     @Test
     fun testExampleProject() {
-        val output = runBuild("run").stdout
+        val output = runBuild("""run --args '"${Queries.FAST}"'""").stdout
         val tableRegex = Regex("""(?ms)^[-]+\nMost frequent builds:\n\s*\n(.+\|\s*\d+\s*\n?)+""")
         assertTrue(tableRegex.containsMatchIn(output)) {
             "Expected match for pattern '$tableRegex' in output '$output'"

library/src/examplesTest/kotlin/com/gabrielfeo/develocity/api/example/notebook/Jupyter.kt

@@ -12,7 +12,6 @@ class Jupyter(
     val workDir: Path,
     val venv: Path,
 ) {
-
     class Execution(
         val outputStreams: OutputStreams,
         val outputNotebook: Path,
@@ -31,24 +30,24 @@ class Jupyter(
         return Execution(outputStreams, outputPath)
     }
 
-    fun replaceMagics(
+    fun replacePattern(
         path: Path,
-        replacePattern: Regex,
-        replacement: String
+        pattern: Regex,
+        replacement: String,
     ): Path {
         if ((workDir / "preprocessors.py").notExists()) {
             copyFromResources("/preprocessors.py", workDir)
         }
-        val outputPath = path.parent / "${path.nameWithoutExtension}-processed.ipynb"
+        val outputPath = path.parent / "${path.nameWithoutExtension}-replaced.ipynb"
         runInShell(
             workDir,
             "source '${venv / "bin/activate"}' &&",
             "jupyter nbconvert '$path'",
             "--to ipynb",
             "--output='$outputPath'",
-            "--NotebookExporter.preprocessors=preprocessors.ReplaceMagicsPreprocessor",
-            "--ReplaceMagicsPreprocessor.pattern='$replacePattern'",
-            "--ReplaceMagicsPreprocessor.replacement='$replacement'",
+            "--NotebookExporter.preprocessors=preprocessors.ReplacePatternPreprocessor",
+            "--ReplacePatternPreprocessor.pattern='$pattern'",
+            "--ReplacePatternPreprocessor.replacement='$replacement'",
         )
         return outputPath
     }

library/src/examplesTest/kotlin/com/gabrielfeo/develocity/api/example/notebook/NotebooksTest.kt

@@ -1,6 +1,7 @@
 package com.gabrielfeo.develocity.api.example.notebook
 
 import com.gabrielfeo.develocity.api.example.JsonAdapter
+import com.gabrielfeo.develocity.api.example.Queries
 import com.gabrielfeo.develocity.api.example.copyFromResources
 import org.junit.jupiter.api.Assertions.assertTrue
 import org.junit.jupiter.api.BeforeEach
@@ -38,7 +39,8 @@ class NotebooksTest {
     @Test
     fun testMostFrequentBuildsNotebook() {
         val sourceNotebook = tempDir / "examples/example-notebooks/MostFrequentBuilds.ipynb"
-        val snapshotNotebook = forceUseOfMavenLocalSnapshotArtifact(sourceNotebook)
+        val fasterNotebook = forceUseOfFasterQuery(sourceNotebook)
+        val snapshotNotebook = forceUseOfMavenLocalSnapshotArtifact(fasterNotebook)
         val executedNotebook = assertDoesNotThrow { jupyter.executeNotebook(snapshotNotebook) }
         with(JsonAdapter.fromJson(executedNotebook.outputNotebook).asNotebookJson()) {
             assertTrue(textOutputLines.any { Regex("""Collected \d+ builds from the API""").containsMatchIn(it) }) {
@@ -53,6 +55,12 @@ class NotebooksTest {
         }
     }
 
+    private fun forceUseOfFasterQuery(sourceNotebook: Path): Path = jupyter.replacePattern(
+        path = sourceNotebook,
+        pattern = Regex("""query\s*=.+,"""),
+        replacement = """query = "${Queries.FAST}",""",
+    )
+
     @Test
     fun testLoggingNotebook() {
         val sourceNotebook = tempDir / "examples/example-notebooks/Logging.ipynb"
@@ -67,12 +75,13 @@ class NotebooksTest {
         val libraryDescriptor = (tempDir / "develocity-api-kotlin.json").apply {
             writeText(buildLibraryDescriptor(version = "SNAPSHOT", repository = mavenLocal))
         }
-        return jupyter.replaceMagics(
+        return jupyter.replacePattern(
             path = sourceNotebook,
-            replacePattern = Regex("""(?:DependsOn|%use).*develocity-api-kotlin.*"""),
+            pattern = Regex("(?:DependsOn|%use).*develocity-api-kotlin.*"),
             replacement = """
                 %use develocity-api-kotlin@file[$libraryDescriptor]
                 %trackClasspath on
+                %logLevel debug
             """.trimIndent()
         )
     }

library/src/examplesTest/kotlin/com/gabrielfeo/develocity/api/example/notebook/ScriptsTest.kt

@@ -1,5 +1,6 @@
 package com.gabrielfeo.develocity.api.example.script
 
+import com.gabrielfeo.develocity.api.example.Queries
 import com.gabrielfeo.develocity.api.example.copyFromResources
 import com.gabrielfeo.develocity.api.example.runInShell
 import org.junit.jupiter.api.Assertions.assertTrue
@@ -12,18 +13,18 @@ import kotlin.io.path.div
 class ScriptsTest {
 
     @TempDir
-    lateinit var tempDir: Path
+    lateinit var dir: Path
 
     @BeforeEach
     fun setup() {
-        copyFromResources("/examples", tempDir)
+        copyFromResources("/examples", dir)
     }
 
     @Test
     fun testMostFrequentBuildsScript() {
-        val script = tempDir / "examples/example-scripts/example-script.main.kts"
+        val script = dir / "examples/example-scripts/example-script.main.kts"
         val replacedScript = forceUseOfMavenLocalSnapshotArtifact(script)
-        val output = runInShell(tempDir, "kotlin '$replacedScript'").stdout.trim()
+        val output = runInShell(dir, "kotlin '$replacedScript' '${Queries.FAST}'").stdout.trim()
         val tableRegex = Regex("""(?ms)^[-]+\nMost frequent builds:\n\s*\n(.+\|\s*\d+\s*\n?)+""")
         assertTrue(tableRegex.containsMatchIn(output)) {
             "Expected match for pattern '$tableRegex' in output '$output'"
@@ -43,7 +44,7 @@ class ScriptsTest {
                     @file:Repository("file://$mavenLocal")
                 """.trimIndent(),
         )
-        val replacedPath = tempDir.resolve("examples/example-scripts/example-script-SNAPSHOT.main.kts")
+        val replacedPath = dir.resolve("examples/example-scripts/example-script-SNAPSHOT.main.kts")
         replacedPath.toFile().writeText(replaced)
         return replacedPath
     }