Include the Scripts into the Gradle Build (#2076)

* Use gradle for the scripts.

* Build the scripts as part of the tests

.github/workflows/voice.yml

@@ -41,7 +41,7 @@ jobs:
         run: ./ci_signing_setup.sh
 
       - name: Test
-        run: ./gradlew testDebugUnitTest lintKotlin app:lintDebug app:assembleDebug
+        run: ./gradlew testDebugUnitTest lintKotlin :app:lintDebug :app:assembleDebug :scripts:build
 
       - uses: actions/upload-artifact@v3
         if: always()

build.gradle.kts

@@ -2,6 +2,7 @@
 
 plugins {
   alias(libs.plugins.kotlin.android) apply false
+  alias(libs.plugins.kotlin.jvm) apply false
   alias(libs.plugins.android.app) apply false
   alias(libs.plugins.android.library) apply false
   id("voice.ktlint")

gradle/libs.versions.toml

@@ -55,6 +55,7 @@ uiautomator = "androidx.test.uiautomator:uiautomator:2.2.0"
 okhttp = "com.squareup.okhttp3:okhttp:4.11.0"
 review = "com.google.android.play:review-ktx:2.0.1"
 lottie = "com.airbnb.android:lottie-compose:6.1.0"
+clikt = "com.github.ajalt.clikt:clikt:4.2.0"
 
 coroutines-core = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "coroutines" }
 coroutines-guava = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-guava", version.ref = "coroutines" }

new_module.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+./scripts/run.sh new-feature-module "$@"

populate_test_files.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+./scripts/run.sh populate-test-files "$@"

scripts/build.gradle.kts

@@ -0,0 +1,12 @@
+plugins {
+  alias(libs.plugins.kotlin.jvm)
+  application
+}
+
+application {
+  mainClass.set("voice.scripts.ScriptKt")
+}
+
+dependencies {
+  implementation(libs.clikt)
+}

scripts/run.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+set -e
+./gradlew :scripts:installDist --quiet --console=plain
+./scripts/build/install/scripts/bin/scripts "$@"

new_module.main.kts → scripts/src/main/kotlin/voice/scripts/NewFeatureModule.kt

@@ -1,13 +1,11 @@
-#!/usr/bin/env kotlin
-@file:DependsOn("com.github.ajalt.clikt:clikt-jvm:4.2.0")
-@file:CompilerOptions("-Xopt-in=kotlin.RequiresOptIn")
+package voice.scripts
 
 import com.github.ajalt.clikt.core.CliktCommand
 import com.github.ajalt.clikt.parameters.arguments.argument
 import com.github.ajalt.clikt.parameters.arguments.validate
 import java.io.File
 
-class NewFeatureModule : CliktCommand(name = "Creates a new feature module") {
+class NewFeatureModule : CliktCommand(help = "Creates a new feature module") {
 
   private val name: String by argument("The new module name, i.e. :unicorn:wings")
     .validate { name ->
@@ -46,12 +44,6 @@ class NewFeatureModule : CliktCommand(name = "Creates a new feature module") {
     settingsGradle.writeText(lines.joinToString(separator = "\n"))
   }
 
-  private fun String.toSnakeCase(): String {
-    return "([a-z])([A-Z]+)".toRegex()
-      .replace(this, "$1_$2")
-      .lowercase()
-  }
-
   private fun gradleContent(): String {
     val plugins = buildList {
       add("voice.library")
@@ -75,5 +67,3 @@ class NewFeatureModule : CliktCommand(name = "Creates a new feature module") {
     }
   }
 }
-
-NewFeatureModule().main(args)

populate_test_files.main.kts → scripts/src/main/kotlin/voice/scripts/PopulateTestFiles.kt

@@ -1,11 +1,9 @@
-#!/usr/bin/env kotlin
-@file:DependsOn("com.github.ajalt.clikt:clikt-jvm:4.2.0")
-@file:CompilerOptions("-Xopt-in=kotlin.RequiresOptIn")
+package voice.scripts
 
 import com.github.ajalt.clikt.core.CliktCommand
 import java.io.File
 
-class PopulateTestFiles : CliktCommand(name = "Populates test files using adb") {
+class PopulateTestFiles : CliktCommand(help = "Populates test files using adb") {
 
   private val testFilesRoot = File("build/testfiles/")
 
@@ -80,18 +78,4 @@ class PopulateTestFiles : CliktCommand(name = "Populates test files using adb")
       output.absolutePath,
     )
   }
-
-  private fun runCommand(vararg command: String) {
-    println("runCommand=${command.toList()}")
-    val process = ProcessBuilder(command.toList())
-      .redirectOutput(ProcessBuilder.Redirect.INHERIT)
-      .start()
-    process.waitFor().also {
-      check(it == 0) {
-        "output=${process.errorStream.bufferedReader().readText()}"
-      }
-    }
-  }
 }
-
-PopulateTestFiles().main(args)

scripts/src/main/kotlin/voice/scripts/RunCommand.kt

@@ -0,0 +1,12 @@
+package voice.scripts
+
+fun runCommand(vararg command: String) {
+  val process = ProcessBuilder(command.toList())
+    .redirectOutput(ProcessBuilder.Redirect.INHERIT)
+    .start()
+  process.waitFor().also {
+    check(it == 0) {
+      "output=${process.errorStream.bufferedReader().readText()}"
+    }
+  }
+}

scripts/src/main/kotlin/voice/scripts/Script.kt

@@ -0,0 +1,18 @@
+package voice.scripts
+
+import com.github.ajalt.clikt.core.CliktCommand
+import com.github.ajalt.clikt.core.subcommands
+
+class Script : CliktCommand() {
+  override fun run() {}
+}
+
+fun main(args: Array<String>) {
+  Script()
+    .subcommands(
+      UpdateScreenshots(),
+      NewFeatureModule(),
+      PopulateTestFiles(),
+    )
+    .main(args)
+}

scripts/src/main/kotlin/voice/scripts/UpdateScreenshots.kt

@@ -0,0 +1,43 @@
+package voice.scripts
+
+import com.github.ajalt.clikt.core.CliktCommand
+import java.io.File
+
+class UpdateScreenshots : CliktCommand() {
+
+  override fun run() {
+    // https://issuetracker.google.com/issues/193118030
+    runCommand("./gradlew", ":app:packageDebugAndroidTest")
+    runCommand(
+      "./gradlew",
+      ":app:screenshotDevicesGroupDebugAndroidTest",
+      "-Pandroid.testInstrumentationRunnerArguments.class=voice.app.misc.ScreenshotCapture",
+      "-Dorg.gradle.workers.max=1",
+    )
+
+    mapOf(
+      "pixel5" to "phone",
+      "nexus7" to "tablet",
+      "nexus10" to "large-tablet",
+    )
+      .flatMap { (device, qualifier) ->
+        val deviceOutput = File("app/build/outputs/managed_device_android_test_additional_output", device)
+        listOf(
+          "book_overview_grid",
+          "book_overview_list",
+          "settings",
+          "folder_picker",
+        )
+          .mapIndexed { index, screenshotName ->
+            val sourceFile = File(deviceOutput, "$screenshotName.png")
+            val qualifierFolder = File("app/src/main/play/listings/en-US/graphics", "$qualifier-screenshots")
+            val targetFile = File(qualifierFolder, "${index + 1}.png")
+            sourceFile to targetFile
+          }
+      }
+      .forEach { (sourceFile, targetFile) ->
+        println("copy $sourceFile to $targetFile")
+        sourceFile.copyTo(targetFile, overwrite = true)
+      }
+  }
+}

settings.gradle.kts

@@ -58,6 +58,7 @@ include(":datastore")
 include(":folderPicker")
 include(":bookOverview")
 include(":migration")
+include(":scripts")
 include(":logging:core")
 include(":logging:debug")
 include(":logging:crashlytics")

update_screenshots.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+./scripts/run.sh update-screenshots "$@"