diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..340cee3 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,27 @@ +name: Build + +on: + push: + branches: [main] + pull_request: + branches: [main] + +permissions: + contents: read + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Configure git + run: | + git config --global user.name "CI" + git config --global user.email "ci@clanker.zone" + git config --global init.defaultBranch main + - uses: actions/setup-java@v4 + with: + distribution: jetbrains + java-version: 17 + - uses: gradle/actions/setup-gradle@v4 + - run: ./gradlew build diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..4f5a394 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,41 @@ +name: Release + +on: + release: + types: [published] + +permissions: + contents: write + +jobs: + release: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Configure git + run: | + git config --global user.name "CI" + git config --global user.email "ci@clanker.zone" + git config --global init.defaultBranch main + - name: Extract version from tag + id: version + run: | + VERSION="${{ github.event.release.tag_name }}" + VERSION="${VERSION#v}" + echo "version=$VERSION" >> "$GITHUB_OUTPUT" + - uses: actions/setup-java@v4 + with: + distribution: jetbrains + java-version: 17 + - uses: gradle/actions/setup-gradle@v4 + - name: Build and test + run: ./gradlew build -PVERSION_NAME=${{ steps.version.outputs.version }} + - name: Publish to Maven Central + run: ./gradlew publishAndReleaseToMavenCentral -PVERSION_NAME=${{ steps.version.outputs.version }} + env: + ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.SONATYPE_USERNAME }} + ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.SONATYPE_PASSWORD }} + ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.GPG_SIGNING_KEY }} + ORG_GRADLE_PROJECT_signingInMemoryKeyId: ${{ secrets.GPG_KEY_ID }} + ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.GPG_PASSPHRASE }} + ORG_GRADLE_PROJECT_RELEASE_SIGNING_ENABLED: true diff --git a/build-logic/build.gradle.kts b/build-logic/build.gradle.kts new file mode 100644 index 0000000..e349291 --- /dev/null +++ b/build-logic/build.gradle.kts @@ -0,0 +1,26 @@ +plugins { + `kotlin-dsl` +} + +repositories { + mavenCentral() + gradlePluginPortal() +} + +dependencies { + implementation("org.jetbrains.kotlin:kotlin-gradle-plugin:${embeddedKotlinVersion}") + implementation("com.vanniktech:gradle-maven-publish-plugin:0.32.0") + implementation("org.gradle.toolchains:foojay-resolver:1.0.0") + implementation("org.jetbrains.kotlinx:kover-gradle-plugin:0.9.1") + implementation("io.gitlab.arturbosch.detekt:detekt-gradle-plugin:1.23.8") + implementation("org.jlleitschuh.gradle:ktlint-gradle:12.2.0") +} + +gradlePlugin { + plugins { + register("clkx-settings") { + id = "clkx-settings" + implementationClass = "zone.clanker.gradle.conventions.ClkxSettingsPlugin" + } + } +} diff --git a/build-logic/settings.gradle.kts b/build-logic/settings.gradle.kts new file mode 100644 index 0000000..daf286d --- /dev/null +++ b/build-logic/settings.gradle.kts @@ -0,0 +1,7 @@ +dependencyResolutionManagement { + repositories { + mavenCentral() + gradlePluginPortal() + } +} +rootProject.name = "build-logic" diff --git a/build-logic/src/main/kotlin/clkx-conventions.gradle.kts b/build-logic/src/main/kotlin/clkx-conventions.gradle.kts new file mode 100644 index 0000000..77e11a1 --- /dev/null +++ b/build-logic/src/main/kotlin/clkx-conventions.gradle.kts @@ -0,0 +1,11 @@ +plugins { + id("clkx-module") + id("clkx-toolchain") + id("clkx-plugin") + id("clkx-publish") + id("clkx-testing") + id("clkx-cover") + id("clkx-konsist") + id("clkx-detekt") + id("clkx-ktlint") +} diff --git a/build-logic/src/main/kotlin/clkx-cover.gradle.kts b/build-logic/src/main/kotlin/clkx-cover.gradle.kts new file mode 100644 index 0000000..a288fd4 --- /dev/null +++ b/build-logic/src/main/kotlin/clkx-cover.gradle.kts @@ -0,0 +1,21 @@ +plugins { + id("org.jetbrains.kotlinx.kover") +} + +kover { + reports { + filters { + excludes { + // @TaskAction run() methods delegate to Cli.execAndPrint — untestable without real CLIs + annotatedBy("org.gradle.api.tasks.TaskAction") + // Settings plugin apply() requires real Gradle Settings — tested via registerTasks + classes("*\$SettingsPlugin", "*\$SettingsPlugin\$*") + } + } + verify { + rule { + minBound(90) + } + } + } +} diff --git a/build-logic/src/main/kotlin/clkx-detekt.gradle.kts b/build-logic/src/main/kotlin/clkx-detekt.gradle.kts new file mode 100644 index 0000000..d6555df --- /dev/null +++ b/build-logic/src/main/kotlin/clkx-detekt.gradle.kts @@ -0,0 +1,9 @@ +plugins { + id("io.gitlab.arturbosch.detekt") +} + +detekt { + config.setFrom(rootProject.file("config/detekt.yml")) + buildUponDefaultConfig = true + parallel = true +} diff --git a/build-logic/src/main/kotlin/clkx-konsist.gradle.kts b/build-logic/src/main/kotlin/clkx-konsist.gradle.kts new file mode 100644 index 0000000..3f292b5 --- /dev/null +++ b/build-logic/src/main/kotlin/clkx-konsist.gradle.kts @@ -0,0 +1,31 @@ +plugins { + `java-base` +} + +val sourceSets = the() + +val slopTest by sourceSets.creating { + compileClasspath += sourceSets["main"].output + runtimeClasspath += sourceSets["main"].output +} + +configurations[slopTest.implementationConfigurationName].extendsFrom(configurations["testImplementation"]) +configurations[slopTest.runtimeOnlyConfigurationName].extendsFrom(configurations["testRuntimeOnly"]) + +dependencies { + "slopTestImplementation"("com.lemonappdev:konsist:0.17.3") + "slopTestImplementation"("io.kotest:kotest-runner-junit5:5.9.1") + "slopTestImplementation"("io.kotest:kotest-assertions-core:5.9.1") +} + +val slopTask = tasks.register("slopTest") { + description = "Run slop taste tests — architecture, naming, boundaries, style" + group = "verification" + testClassesDirs = slopTest.output.classesDirs + classpath = slopTest.runtimeClasspath + useJUnitPlatform() +} + +tasks.named("check") { + dependsOn(slopTask) +} diff --git a/build-logic/src/main/kotlin/clkx-ktlint.gradle.kts b/build-logic/src/main/kotlin/clkx-ktlint.gradle.kts new file mode 100644 index 0000000..2b5ba4e --- /dev/null +++ b/build-logic/src/main/kotlin/clkx-ktlint.gradle.kts @@ -0,0 +1,7 @@ +plugins { + id("org.jlleitschuh.gradle.ktlint") +} + +ktlint { + version.set("1.5.0") +} diff --git a/build-logic/src/main/kotlin/clkx-library.gradle.kts b/build-logic/src/main/kotlin/clkx-library.gradle.kts new file mode 100644 index 0000000..0c8e623 --- /dev/null +++ b/build-logic/src/main/kotlin/clkx-library.gradle.kts @@ -0,0 +1,17 @@ +import com.vanniktech.maven.publish.JavaLibrary +import com.vanniktech.maven.publish.JavadocJar + +plugins { + id("clkx-module") + id("clkx-toolchain") + id("clkx-testing") + id("clkx-cover") + id("clkx-konsist") + id("clkx-detekt") + id("clkx-ktlint") + id("com.vanniktech.maven.publish") +} + +mavenPublishing { + configure(JavaLibrary(javadocJar = JavadocJar.Empty())) +} diff --git a/build-logic/src/main/kotlin/clkx-module.gradle.kts b/build-logic/src/main/kotlin/clkx-module.gradle.kts new file mode 100644 index 0000000..8f4384f --- /dev/null +++ b/build-logic/src/main/kotlin/clkx-module.gradle.kts @@ -0,0 +1,18 @@ +plugins { + `java-library` + kotlin("jvm") +} + +group = "zone.clanker" + +dependencies { + "implementation"(gradleApi()) +} + +tasks.withType { + useJUnitPlatform() +} + +tasks.withType().configureEach { + dependsOn(tasks.withType()) +} diff --git a/build-logic/src/main/kotlin/clkx-plugin.gradle.kts b/build-logic/src/main/kotlin/clkx-plugin.gradle.kts new file mode 100644 index 0000000..9f0a748 --- /dev/null +++ b/build-logic/src/main/kotlin/clkx-plugin.gradle.kts @@ -0,0 +1,5 @@ +plugins { + id("clkx-module") + `java-gradle-plugin` + id("com.vanniktech.maven.publish") +} diff --git a/build-logic/src/main/kotlin/clkx-publish.gradle.kts b/build-logic/src/main/kotlin/clkx-publish.gradle.kts new file mode 100644 index 0000000..3de9020 --- /dev/null +++ b/build-logic/src/main/kotlin/clkx-publish.gradle.kts @@ -0,0 +1,10 @@ +import com.vanniktech.maven.publish.GradlePlugin +import com.vanniktech.maven.publish.JavadocJar + +plugins { + id("com.vanniktech.maven.publish") +} + +mavenPublishing { + configure(GradlePlugin(javadocJar = JavadocJar.Empty())) +} diff --git a/build-logic/src/main/kotlin/clkx-testing.gradle.kts b/build-logic/src/main/kotlin/clkx-testing.gradle.kts new file mode 100644 index 0000000..2053c70 --- /dev/null +++ b/build-logic/src/main/kotlin/clkx-testing.gradle.kts @@ -0,0 +1,10 @@ +plugins { + `java-base` +} + +dependencies { + "testImplementation"("io.kotest:kotest-runner-junit5:5.9.1") + "testImplementation"("io.kotest:kotest-assertions-core:5.9.1") + "testImplementation"("io.kotest:kotest-framework-datatest:5.9.1") + "testImplementation"(gradleTestKit()) +} diff --git a/build-logic/src/main/kotlin/clkx-toolchain.gradle.kts b/build-logic/src/main/kotlin/clkx-toolchain.gradle.kts new file mode 100644 index 0000000..c9e8858 --- /dev/null +++ b/build-logic/src/main/kotlin/clkx-toolchain.gradle.kts @@ -0,0 +1,10 @@ +plugins { + `java-base` +} + +java { + toolchain { + languageVersion.set(JavaLanguageVersion.of(17)) + vendor.set(JvmVendorSpec.JETBRAINS) + } +} diff --git a/build-logic/src/main/kotlin/zone/clanker/gradle/conventions/ClkxSettingsPlugin.kt b/build-logic/src/main/kotlin/zone/clanker/gradle/conventions/ClkxSettingsPlugin.kt new file mode 100644 index 0000000..30095db --- /dev/null +++ b/build-logic/src/main/kotlin/zone/clanker/gradle/conventions/ClkxSettingsPlugin.kt @@ -0,0 +1,20 @@ +package zone.clanker.gradle.conventions + +import org.gradle.api.Plugin +import org.gradle.api.initialization.Settings +import org.gradle.api.initialization.resolve.RepositoriesMode + +class ClkxSettingsPlugin : Plugin { + override fun apply(settings: Settings) { + settings.pluginManager.apply("org.gradle.toolchains.foojay-resolver-convention") + + @Suppress("UnstableApiUsage") + settings.dependencyResolutionManagement { + repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS) + repositories { + mavenCentral() + gradlePluginPortal() + } + } + } +} diff --git a/config/detekt.yml b/config/detekt.yml new file mode 100644 index 0000000..d316f3d --- /dev/null +++ b/config/detekt.yml @@ -0,0 +1,131 @@ +# Detekt Configuration for ClankerGuru projects +# https://detekt.dev/docs/rules/ + +build: + maxIssues: 0 + excludeCorrectable: false + +config: + validation: true + warningsAsErrors: true + +processors: + active: true + +console-reports: + active: true + +comments: + active: true + CommentOverPrivateProperty: + active: false + UndocumentedPublicClass: + active: false + UndocumentedPublicFunction: + active: false + +complexity: + active: true + ComplexCondition: + active: true + threshold: 4 + CyclomaticComplexMethod: + active: true + threshold: 15 + LargeClass: + active: true + threshold: 600 + LongMethod: + active: true + threshold: 60 + LongParameterList: + active: true + functionThreshold: 6 + constructorThreshold: 7 + NestedBlockDepth: + active: true + threshold: 4 + TooManyFunctions: + active: true + thresholdInFiles: 15 + thresholdInClasses: 15 + thresholdInInterfaces: 15 + thresholdInObjects: 15 + thresholdInEnums: 15 + +coroutines: + active: true + GlobalCoroutineUsage: + active: true + SuspendFunWithFlowReturnType: + active: true + +empty-blocks: + active: true + +exceptions: + active: true + NotImplementedDeclaration: + active: true + PrintStackTrace: + active: true + ThrowingExceptionsWithoutMessageOrCause: + active: true + +naming: + active: true + FunctionNaming: + active: true + functionPattern: '[a-z][a-zA-Z0-9]*' + VariableNaming: + active: true + variablePattern: '[a-z][A-Za-z0-9]*' + +performance: + active: true + SpreadOperator: + active: false + +potential-bugs: + active: true + DoubleMutabilityForCollection: + active: true + HasPlatformType: + active: true + IgnoredReturnValue: + active: true + +style: + active: true + ForbiddenComment: + active: true + comments: + - 'TODO:' + - 'FIXME:' + - 'HACK:' + allowedPatterns: 'TODO\(.*\):' + MagicNumber: + active: true + ignoreNumbers: + - '-1' + - '0' + - '1' + - '2' + ignoreHashCodeFunction: true + ignorePropertyDeclaration: true + ignoreLocalVariableDeclaration: true + ignoreAnnotation: true + ignoreEnums: true + MaxLineLength: + active: true + maxLineLength: 120 + NewLineAtEndOfFile: + active: true + ReturnCount: + active: true + max: 3 + ThrowsCount: + active: true + max: 2 + WildcardImport: + active: true diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..223a3df --- /dev/null +++ b/gradle.properties @@ -0,0 +1,23 @@ +GROUP=zone.clanker +VERSION_NAME=0.0.0-dev + +POM_ARTIFACT_ID=android-cli +POM_NAME=Android CLI Plugin (android-cli) +POM_DESCRIPTION=Gradle plugin wrapping Google's agent-first `android` CLI + +POM_INCEPTION_YEAR=2026 +POM_URL=https://github.com/ClankerGuru/android-cli + +POM_LICENSE_NAME=MIT License +POM_LICENSE_URL=https://opensource.org/licenses/MIT +POM_LICENSE_DIST=repo + +POM_SCM_URL=https://github.com/ClankerGuru/android-cli +POM_SCM_CONNECTION=scm:git:https://github.com/ClankerGuru/android-cli.git +POM_SCM_DEV_CONNECTION=scm:git:git@github.com:ClankerGuru/android-cli.git + +POM_DEVELOPER_ID=ClankerGuru +POM_DEVELOPER_NAME=ClankerGuru +POM_DEVELOPER_URL=https://github.com/ClankerGuru + +SONATYPE_HOST=CENTRAL_PORTAL diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..d997cfc Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..c61a118 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-9.4.1-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..0262dcb --- /dev/null +++ b/gradlew @@ -0,0 +1,248 @@ +#!/bin/sh + +# +# Copyright © 2015 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# SPDX-License-Identifier: Apache-2.0 +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/b631911858264c0b6e4d6603d677ff5218766cee/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..e509b2d --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,93 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem +@rem SPDX-License-Identifier: Apache-2.0 +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:execute +@rem Setup the command line + + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/plugin/build.gradle.kts b/plugin/build.gradle.kts new file mode 100644 index 0000000..2a18c5e --- /dev/null +++ b/plugin/build.gradle.kts @@ -0,0 +1,12 @@ +plugins { id("clkx-conventions") } + +gradlePlugin { + plugins { + register("android-cli") { + id = "zone.clanker.gradle.android-cli" + implementationClass = "zone.clanker.gradle.androidcli.AndroidCli\$SettingsPlugin" + displayName = "Android CLI Plugin" + description = "Gradle tasks wrapping Google's agent-first `android` CLI" + } + } +} diff --git a/plugin/gradle.properties b/plugin/gradle.properties new file mode 100644 index 0000000..e2ddc8a --- /dev/null +++ b/plugin/gradle.properties @@ -0,0 +1,3 @@ +POM_ARTIFACT_ID=android-cli +POM_NAME=Android CLI Gradle Plugin +POM_DESCRIPTION=Gradle settings plugin wrapping Google's agent-first `android` CLI diff --git a/plugin/src/main/kotlin/zone/clanker/gradle/androidcli/AndroidCli.kt b/plugin/src/main/kotlin/zone/clanker/gradle/androidcli/AndroidCli.kt new file mode 100644 index 0000000..15848b7 --- /dev/null +++ b/plugin/src/main/kotlin/zone/clanker/gradle/androidcli/AndroidCli.kt @@ -0,0 +1,96 @@ +package zone.clanker.gradle.androidcli + +import org.gradle.api.Action +import org.gradle.api.Plugin +import org.gradle.api.Project +import org.gradle.api.initialization.Settings +import zone.clanker.gradle.androidcli.task.AndroidDescribeTask +import zone.clanker.gradle.androidcli.task.AndroidRunTask +import zone.clanker.gradle.androidcli.task.AndroidVersionTask +import zone.clanker.gradle.androidcli.task.screen.AndroidScreenCaptureTask +import zone.clanker.gradle.androidcli.task.skills.AndroidSkillsAddTask +import zone.clanker.gradle.androidcli.task.skills.AndroidSkillsFindTask +import zone.clanker.gradle.androidcli.task.skills.AndroidSkillsListTask +import zone.clanker.gradle.androidcli.task.skills.AndroidSkillsRemoveTask + +data object AndroidCli { + const val BINARY = "android" + const val GROUP = "android-cli" + const val EXTENSION_NAME = "androidCli" + + const val TASK_VERSION = "android-version" + const val TASK_DESCRIBE = "android-describe" + const val TASK_SCREEN_CAPTURE = "android-screen-capture" + const val TASK_SKILLS_LIST = "android-skills-list" + const val TASK_SKILLS_FIND = "android-skills-find" + const val TASK_SKILLS_ADD = "android-skills-add" + const val TASK_SKILLS_REMOVE = "android-skills-remove" + const val TASK_RUN = "android-run" + + const val PROP_SKILL = "zone.clanker.android-cli.skill" + const val PROP_QUERY = "zone.clanker.android-cli.query" + const val PROP_ARGS = "zone.clanker.android-cli.args" + const val PROP_JSON = "zone.clanker.android-cli.json" + + open class SettingsExtension { + var binary: String = BINARY + var extraArgs: List = emptyList() + } + + class SettingsPlugin : Plugin { + override fun apply(settings: Settings) { + val extension = settings.extensions.create(EXTENSION_NAME, SettingsExtension::class.java) + settings.gradle.rootProject( + Action { rootProject -> + registerTasks(rootProject, extension) + }, + ) + } + } + + internal fun registerTasks( + rootProject: Project, + extension: SettingsExtension, + ) { + rootProject.tasks.register(TASK_VERSION, AndroidVersionTask::class.java) { + it.group = GROUP + it.description = "Show `android` CLI version" + it.extension = extension + } + rootProject.tasks.register(TASK_DESCRIBE, AndroidDescribeTask::class.java) { + it.group = GROUP + it.description = "Describe the Android project context (pass -P$PROP_JSON=true for JSON)" + it.extension = extension + } + rootProject.tasks.register(TASK_SCREEN_CAPTURE, AndroidScreenCaptureTask::class.java) { + it.group = GROUP + it.description = "Capture a screenshot of the connected device" + it.extension = extension + } + rootProject.tasks.register(TASK_SKILLS_LIST, AndroidSkillsListTask::class.java) { + it.group = GROUP + it.description = "List installed Android CLI skills" + it.extension = extension + } + rootProject.tasks.register(TASK_SKILLS_FIND, AndroidSkillsFindTask::class.java) { + it.group = GROUP + it.description = "Find available skills (pass -P$PROP_QUERY=)" + it.extension = extension + } + rootProject.tasks.register(TASK_SKILLS_ADD, AndroidSkillsAddTask::class.java) { + it.group = GROUP + it.description = "Install a skill (pass -P$PROP_SKILL=)" + it.extension = extension + } + rootProject.tasks.register(TASK_SKILLS_REMOVE, AndroidSkillsRemoveTask::class.java) { + it.group = GROUP + it.description = "Uninstall a skill (pass -P$PROP_SKILL=)" + it.extension = extension + } + rootProject.tasks.register(TASK_RUN, AndroidRunTask::class.java) { + it.group = GROUP + it.description = "Run `android` with arbitrary args (pass -P$PROP_ARGS=\"a b c\")" + it.extension = extension + } + } +} diff --git a/plugin/src/main/kotlin/zone/clanker/gradle/androidcli/task/AndroidDescribeTask.kt b/plugin/src/main/kotlin/zone/clanker/gradle/androidcli/task/AndroidDescribeTask.kt new file mode 100644 index 0000000..f87b204 --- /dev/null +++ b/plugin/src/main/kotlin/zone/clanker/gradle/androidcli/task/AndroidDescribeTask.kt @@ -0,0 +1,20 @@ +package zone.clanker.gradle.androidcli.task + +import org.gradle.api.tasks.UntrackedTask +import zone.clanker.gradle.androidcli.AndroidCli + +@UntrackedTask(because = "Executes external CLI") +abstract class AndroidDescribeTask : AndroidExecTask() { + init { + doFirst { commandLine(listOf(extension.binary) + buildArgs()) } + } + + internal fun buildArgs(): List { + val json = project.findProperty(AndroidCli.PROP_JSON)?.toString()?.toBoolean() ?: false + return buildList { + add("describe") + if (json) add("--json") + addAll(extension.extraArgs) + } + } +} diff --git a/plugin/src/main/kotlin/zone/clanker/gradle/androidcli/task/AndroidExecTask.kt b/plugin/src/main/kotlin/zone/clanker/gradle/androidcli/task/AndroidExecTask.kt new file mode 100644 index 0000000..ce55766 --- /dev/null +++ b/plugin/src/main/kotlin/zone/clanker/gradle/androidcli/task/AndroidExecTask.kt @@ -0,0 +1,24 @@ +package zone.clanker.gradle.androidcli.task + +import org.gradle.api.tasks.Exec +import org.gradle.api.tasks.Internal +import org.gradle.api.tasks.UntrackedTask +import zone.clanker.gradle.androidcli.AndroidCli + +@UntrackedTask(because = "Executes external CLI") +abstract class AndroidExecTask : Exec() { + @Internal + lateinit var extension: AndroidCli.SettingsExtension + + init { + doFirst { checkBinaryInstalled() } + } + + internal fun checkBinaryInstalled() { + val check = ProcessBuilder("which", extension.binary).redirectErrorStream(true).start() + check.waitFor() + if (check.exitValue() != 0) { + error("'${extension.binary}' not found on PATH. Install Google's Android CLI first.") + } + } +} diff --git a/plugin/src/main/kotlin/zone/clanker/gradle/androidcli/task/AndroidRunTask.kt b/plugin/src/main/kotlin/zone/clanker/gradle/androidcli/task/AndroidRunTask.kt new file mode 100644 index 0000000..5c15668 --- /dev/null +++ b/plugin/src/main/kotlin/zone/clanker/gradle/androidcli/task/AndroidRunTask.kt @@ -0,0 +1,17 @@ +package zone.clanker.gradle.androidcli.task + +import org.gradle.api.tasks.UntrackedTask +import zone.clanker.gradle.androidcli.AndroidCli + +@UntrackedTask(because = "Executes external CLI") +abstract class AndroidRunTask : AndroidExecTask() { + init { + doFirst { commandLine(listOf(extension.binary) + buildArgs()) } + } + + internal fun buildArgs(): List { + val raw = project.findProperty(AndroidCli.PROP_ARGS)?.toString().orEmpty() + val parsed = raw.split(' ').filter { it.isNotBlank() } + return parsed + extension.extraArgs + } +} diff --git a/plugin/src/main/kotlin/zone/clanker/gradle/androidcli/task/AndroidVersionTask.kt b/plugin/src/main/kotlin/zone/clanker/gradle/androidcli/task/AndroidVersionTask.kt new file mode 100644 index 0000000..dc28dbf --- /dev/null +++ b/plugin/src/main/kotlin/zone/clanker/gradle/androidcli/task/AndroidVersionTask.kt @@ -0,0 +1,12 @@ +package zone.clanker.gradle.androidcli.task + +import org.gradle.api.tasks.UntrackedTask + +@UntrackedTask(because = "Executes external CLI") +abstract class AndroidVersionTask : AndroidExecTask() { + init { + doFirst { commandLine(listOf(extension.binary) + buildArgs()) } + } + + internal fun buildArgs(): List = listOf("version") +} diff --git a/plugin/src/main/kotlin/zone/clanker/gradle/androidcli/task/screen/AndroidScreenCaptureTask.kt b/plugin/src/main/kotlin/zone/clanker/gradle/androidcli/task/screen/AndroidScreenCaptureTask.kt new file mode 100644 index 0000000..2400ba1 --- /dev/null +++ b/plugin/src/main/kotlin/zone/clanker/gradle/androidcli/task/screen/AndroidScreenCaptureTask.kt @@ -0,0 +1,13 @@ +package zone.clanker.gradle.androidcli.task.screen + +import org.gradle.api.tasks.UntrackedTask +import zone.clanker.gradle.androidcli.task.AndroidExecTask + +@UntrackedTask(because = "Executes external CLI") +abstract class AndroidScreenCaptureTask : AndroidExecTask() { + init { + doFirst { commandLine(listOf(extension.binary) + buildArgs()) } + } + + internal fun buildArgs(): List = listOf("screen", "capture") + extension.extraArgs +} diff --git a/plugin/src/main/kotlin/zone/clanker/gradle/androidcli/task/skills/AndroidSkillsAddTask.kt b/plugin/src/main/kotlin/zone/clanker/gradle/androidcli/task/skills/AndroidSkillsAddTask.kt new file mode 100644 index 0000000..fb9e935 --- /dev/null +++ b/plugin/src/main/kotlin/zone/clanker/gradle/androidcli/task/skills/AndroidSkillsAddTask.kt @@ -0,0 +1,22 @@ +package zone.clanker.gradle.androidcli.task.skills + +import org.gradle.api.tasks.UntrackedTask +import zone.clanker.gradle.androidcli.AndroidCli +import zone.clanker.gradle.androidcli.task.AndroidExecTask + +@UntrackedTask(because = "Executes external CLI") +abstract class AndroidSkillsAddTask : AndroidExecTask() { + init { + doFirst { commandLine(listOf(extension.binary) + buildArgs()) } + } + + internal fun buildArgs(): List { + val skill = + project.findProperty(AndroidCli.PROP_SKILL)?.toString() + ?: error( + "Required property '${AndroidCli.PROP_SKILL}' not set. " + + "Use -P${AndroidCli.PROP_SKILL}=", + ) + return listOf("skills", "add", skill) + } +} diff --git a/plugin/src/main/kotlin/zone/clanker/gradle/androidcli/task/skills/AndroidSkillsFindTask.kt b/plugin/src/main/kotlin/zone/clanker/gradle/androidcli/task/skills/AndroidSkillsFindTask.kt new file mode 100644 index 0000000..10793e9 --- /dev/null +++ b/plugin/src/main/kotlin/zone/clanker/gradle/androidcli/task/skills/AndroidSkillsFindTask.kt @@ -0,0 +1,21 @@ +package zone.clanker.gradle.androidcli.task.skills + +import org.gradle.api.tasks.UntrackedTask +import zone.clanker.gradle.androidcli.AndroidCli +import zone.clanker.gradle.androidcli.task.AndroidExecTask + +@UntrackedTask(because = "Executes external CLI") +abstract class AndroidSkillsFindTask : AndroidExecTask() { + init { + doFirst { commandLine(listOf(extension.binary) + buildArgs()) } + } + + internal fun buildArgs(): List { + val query = project.findProperty(AndroidCli.PROP_QUERY)?.toString() + return buildList { + add("skills") + add("find") + if (!query.isNullOrBlank()) add(query) + } + } +} diff --git a/plugin/src/main/kotlin/zone/clanker/gradle/androidcli/task/skills/AndroidSkillsListTask.kt b/plugin/src/main/kotlin/zone/clanker/gradle/androidcli/task/skills/AndroidSkillsListTask.kt new file mode 100644 index 0000000..4cb43c1 --- /dev/null +++ b/plugin/src/main/kotlin/zone/clanker/gradle/androidcli/task/skills/AndroidSkillsListTask.kt @@ -0,0 +1,13 @@ +package zone.clanker.gradle.androidcli.task.skills + +import org.gradle.api.tasks.UntrackedTask +import zone.clanker.gradle.androidcli.task.AndroidExecTask + +@UntrackedTask(because = "Executes external CLI") +abstract class AndroidSkillsListTask : AndroidExecTask() { + init { + doFirst { commandLine(listOf(extension.binary) + buildArgs()) } + } + + internal fun buildArgs(): List = listOf("skills", "list") +} diff --git a/plugin/src/main/kotlin/zone/clanker/gradle/androidcli/task/skills/AndroidSkillsRemoveTask.kt b/plugin/src/main/kotlin/zone/clanker/gradle/androidcli/task/skills/AndroidSkillsRemoveTask.kt new file mode 100644 index 0000000..a143524 --- /dev/null +++ b/plugin/src/main/kotlin/zone/clanker/gradle/androidcli/task/skills/AndroidSkillsRemoveTask.kt @@ -0,0 +1,22 @@ +package zone.clanker.gradle.androidcli.task.skills + +import org.gradle.api.tasks.UntrackedTask +import zone.clanker.gradle.androidcli.AndroidCli +import zone.clanker.gradle.androidcli.task.AndroidExecTask + +@UntrackedTask(because = "Executes external CLI") +abstract class AndroidSkillsRemoveTask : AndroidExecTask() { + init { + doFirst { commandLine(listOf(extension.binary) + buildArgs()) } + } + + internal fun buildArgs(): List { + val skill = + project.findProperty(AndroidCli.PROP_SKILL)?.toString() + ?: error( + "Required property '${AndroidCli.PROP_SKILL}' not set. " + + "Use -P${AndroidCli.PROP_SKILL}=", + ) + return listOf("skills", "remove", skill) + } +} diff --git a/plugin/src/slopTest/kotlin/zone/clanker/gradle/androidcli/ForbiddenPatternTest.kt b/plugin/src/slopTest/kotlin/zone/clanker/gradle/androidcli/ForbiddenPatternTest.kt new file mode 100644 index 0000000..dda4a24 --- /dev/null +++ b/plugin/src/slopTest/kotlin/zone/clanker/gradle/androidcli/ForbiddenPatternTest.kt @@ -0,0 +1,36 @@ +package zone.clanker.gradle.androidcli + +import com.lemonappdev.konsist.api.Konsist +import com.lemonappdev.konsist.api.verify.assertFalse +import io.kotest.core.spec.style.BehaviorSpec + +class ForbiddenPatternTest : + BehaviorSpec({ + given("main source set") { + val scope = Konsist.scopeFromProduction(moduleName = "plugin") + + then("no println calls") { + scope.files.assertFalse { + it.text.contains("println(") + } + } + + then("no System.err usage") { + scope.files.assertFalse { + it.text.contains("System.err") + } + } + + then("no System.out usage") { + scope.files.assertFalse { + it.text.contains("System.out") + } + } + + then("no wildcard imports") { + scope.imports.assertFalse { + it.name.endsWith(".*") + } + } + } + }) diff --git a/plugin/src/test/kotlin/zone/clanker/gradle/androidcli/AndroidCliPluginTest.kt b/plugin/src/test/kotlin/zone/clanker/gradle/androidcli/AndroidCliPluginTest.kt new file mode 100644 index 0000000..93f292e --- /dev/null +++ b/plugin/src/test/kotlin/zone/clanker/gradle/androidcli/AndroidCliPluginTest.kt @@ -0,0 +1,160 @@ +package zone.clanker.gradle.androidcli + +import io.kotest.core.spec.style.BehaviorSpec +import io.kotest.matchers.nulls.shouldNotBeNull +import io.kotest.matchers.shouldBe +import io.kotest.matchers.types.shouldBeInstanceOf +import org.gradle.testfixtures.ProjectBuilder +import zone.clanker.gradle.androidcli.task.AndroidDescribeTask +import zone.clanker.gradle.androidcli.task.AndroidRunTask +import zone.clanker.gradle.androidcli.task.AndroidVersionTask +import zone.clanker.gradle.androidcli.task.screen.AndroidScreenCaptureTask +import zone.clanker.gradle.androidcli.task.skills.AndroidSkillsAddTask +import zone.clanker.gradle.androidcli.task.skills.AndroidSkillsFindTask +import zone.clanker.gradle.androidcli.task.skills.AndroidSkillsListTask +import zone.clanker.gradle.androidcli.task.skills.AndroidSkillsRemoveTask + +class AndroidCliPluginTest : + BehaviorSpec({ + given("AndroidCli constants") { + then("BINARY is android") { + AndroidCli.BINARY shouldBe "android" + } + then("GROUP is android-cli") { + AndroidCli.GROUP shouldBe "android-cli" + } + then("EXTENSION_NAME is androidCli") { + AndroidCli.EXTENSION_NAME shouldBe "androidCli" + } + then("task names are correct") { + AndroidCli.TASK_VERSION shouldBe "android-version" + AndroidCli.TASK_DESCRIBE shouldBe "android-describe" + AndroidCli.TASK_SCREEN_CAPTURE shouldBe "android-screen-capture" + AndroidCli.TASK_SKILLS_LIST shouldBe "android-skills-list" + AndroidCli.TASK_SKILLS_FIND shouldBe "android-skills-find" + AndroidCli.TASK_SKILLS_ADD shouldBe "android-skills-add" + AndroidCli.TASK_SKILLS_REMOVE shouldBe "android-skills-remove" + AndroidCli.TASK_RUN shouldBe "android-run" + } + then("property keys are namespaced") { + AndroidCli.PROP_SKILL shouldBe "zone.clanker.android-cli.skill" + AndroidCli.PROP_QUERY shouldBe "zone.clanker.android-cli.query" + AndroidCli.PROP_ARGS shouldBe "zone.clanker.android-cli.args" + AndroidCli.PROP_JSON shouldBe "zone.clanker.android-cli.json" + } + } + + given("AndroidCli.SettingsExtension") { + `when`("created with defaults") { + val ext = AndroidCli.SettingsExtension() + then("binary defaults to android") { + ext.binary shouldBe "android" + } + then("extraArgs defaults to empty") { + ext.extraArgs shouldBe emptyList() + } + } + + `when`("properties are set") { + val ext = AndroidCli.SettingsExtension() + then("binary is mutable") { + ext.binary = "/opt/android/bin/android" + ext.binary shouldBe "/opt/android/bin/android" + } + then("extraArgs is mutable") { + ext.extraArgs = listOf("--verbose") + ext.extraArgs shouldBe listOf("--verbose") + } + } + } + + given("AndroidCli.registerTasks") { + val project = ProjectBuilder.builder().build() + val ext = + project.extensions.create( + AndroidCli.EXTENSION_NAME, + AndroidCli.SettingsExtension::class.java, + ) + AndroidCli.registerTasks(project, ext) + + `when`("tasks are registered") { + then("all tasks exist") { + project.tasks.findByName(AndroidCli.TASK_VERSION).shouldNotBeNull() + project.tasks.findByName(AndroidCli.TASK_DESCRIBE).shouldNotBeNull() + project.tasks.findByName(AndroidCli.TASK_SCREEN_CAPTURE).shouldNotBeNull() + project.tasks.findByName(AndroidCli.TASK_SKILLS_LIST).shouldNotBeNull() + project.tasks.findByName(AndroidCli.TASK_SKILLS_FIND).shouldNotBeNull() + project.tasks.findByName(AndroidCli.TASK_SKILLS_ADD).shouldNotBeNull() + project.tasks.findByName(AndroidCli.TASK_SKILLS_REMOVE).shouldNotBeNull() + project.tasks.findByName(AndroidCli.TASK_RUN).shouldNotBeNull() + } + + then("tasks have correct group") { + project.tasks.findByName(AndroidCli.TASK_VERSION)!!.group shouldBe AndroidCli.GROUP + project.tasks.findByName(AndroidCli.TASK_DESCRIBE)!!.group shouldBe AndroidCli.GROUP + project.tasks.findByName(AndroidCli.TASK_SKILLS_ADD)!!.group shouldBe AndroidCli.GROUP + } + + then("tasks have correct types") { + project.tasks + .findByName(AndroidCli.TASK_VERSION)!! + .shouldBeInstanceOf() + project.tasks + .findByName(AndroidCli.TASK_DESCRIBE)!! + .shouldBeInstanceOf() + project.tasks + .findByName(AndroidCli.TASK_SCREEN_CAPTURE)!! + .shouldBeInstanceOf() + project.tasks + .findByName(AndroidCli.TASK_SKILLS_LIST)!! + .shouldBeInstanceOf() + project.tasks + .findByName(AndroidCli.TASK_SKILLS_FIND)!! + .shouldBeInstanceOf() + project.tasks + .findByName(AndroidCli.TASK_SKILLS_ADD)!! + .shouldBeInstanceOf() + project.tasks + .findByName(AndroidCli.TASK_SKILLS_REMOVE)!! + .shouldBeInstanceOf() + project.tasks + .findByName(AndroidCli.TASK_RUN)!! + .shouldBeInstanceOf() + } + + then("tasks have extension wired") { + val versionTask = project.tasks.findByName(AndroidCli.TASK_VERSION) as AndroidVersionTask + versionTask.extension shouldBe ext + val addTask = project.tasks.findByName(AndroidCli.TASK_SKILLS_ADD) as AndroidSkillsAddTask + addTask.extension shouldBe ext + } + + then("extension is registered") { + project.extensions + .findByType(AndroidCli.SettingsExtension::class.java) + .shouldNotBeNull() + } + } + } + + given("AndroidCli.SettingsPlugin") { + `when`("instantiated") { + then("it is not null") { + AndroidCli.SettingsPlugin().shouldNotBeNull() + } + } + } + + given("AndroidCli architecture") { + then("AndroidCli is a data object") { + AndroidCli::class.isData shouldBe true + AndroidCli::class.objectInstance.shouldNotBeNull() + } + then("SettingsPlugin is inside AndroidCli") { + AndroidCli.SettingsPlugin::class.java.enclosingClass shouldBe AndroidCli::class.java + } + then("SettingsExtension is inside AndroidCli") { + AndroidCli.SettingsExtension::class.java.enclosingClass shouldBe AndroidCli::class.java + } + } + }) diff --git a/plugin/src/test/kotlin/zone/clanker/gradle/androidcli/AndroidTasksTest.kt b/plugin/src/test/kotlin/zone/clanker/gradle/androidcli/AndroidTasksTest.kt new file mode 100644 index 0000000..252b9ca --- /dev/null +++ b/plugin/src/test/kotlin/zone/clanker/gradle/androidcli/AndroidTasksTest.kt @@ -0,0 +1,222 @@ +package zone.clanker.gradle.androidcli + +import io.kotest.assertions.throwables.shouldThrow +import io.kotest.core.spec.style.BehaviorSpec +import io.kotest.matchers.collections.shouldContain +import io.kotest.matchers.shouldBe +import io.kotest.matchers.string.shouldContain +import org.gradle.api.Project +import org.gradle.testfixtures.ProjectBuilder +import zone.clanker.gradle.androidcli.task.AndroidDescribeTask +import zone.clanker.gradle.androidcli.task.AndroidRunTask +import zone.clanker.gradle.androidcli.task.AndroidVersionTask +import zone.clanker.gradle.androidcli.task.screen.AndroidScreenCaptureTask +import zone.clanker.gradle.androidcli.task.skills.AndroidSkillsAddTask +import zone.clanker.gradle.androidcli.task.skills.AndroidSkillsFindTask +import zone.clanker.gradle.androidcli.task.skills.AndroidSkillsListTask +import zone.clanker.gradle.androidcli.task.skills.AndroidSkillsRemoveTask + +private fun newProject(): Pair { + val project = ProjectBuilder.builder().build() + val ext = + project.extensions.create( + AndroidCli.EXTENSION_NAME, + AndroidCli.SettingsExtension::class.java, + ) + AndroidCli.registerTasks(project, ext) + return project to ext +} + +class AndroidTasksTest : + BehaviorSpec({ + given("AndroidVersionTask") { + val (project, _) = newProject() + val task = project.tasks.getByName(AndroidCli.TASK_VERSION) as AndroidVersionTask + + then("buildArgs returns [version]") { + task.buildArgs() shouldBe listOf("version") + } + } + + given("AndroidDescribeTask") { + `when`("PROP_JSON not set") { + val (project, _) = newProject() + val task = project.tasks.getByName(AndroidCli.TASK_DESCRIBE) as AndroidDescribeTask + + then("buildArgs is [describe]") { + task.buildArgs() shouldBe listOf("describe") + } + } + `when`("PROP_JSON=true") { + val (project, _) = newProject() + project.extensions.extraProperties.set(AndroidCli.PROP_JSON, "true") + val task = project.tasks.getByName(AndroidCli.TASK_DESCRIBE) as AndroidDescribeTask + + then("buildArgs appends --json") { + task.buildArgs() shouldBe listOf("describe", "--json") + } + } + `when`("PROP_JSON=false explicitly") { + val (project, _) = newProject() + project.extensions.extraProperties.set(AndroidCli.PROP_JSON, "false") + val task = project.tasks.getByName(AndroidCli.TASK_DESCRIBE) as AndroidDescribeTask + + then("buildArgs omits --json") { + task.buildArgs() shouldBe listOf("describe") + } + } + `when`("extraArgs is set") { + val (project, ext) = newProject() + ext.extraArgs = listOf("--verbose") + val task = project.tasks.getByName(AndroidCli.TASK_DESCRIBE) as AndroidDescribeTask + + then("buildArgs appends extraArgs") { + task.buildArgs() shouldBe listOf("describe", "--verbose") + } + } + } + + given("AndroidScreenCaptureTask") { + val (project, ext) = newProject() + ext.extraArgs = listOf("--output", "/tmp/s.png") + val task = project.tasks.getByName(AndroidCli.TASK_SCREEN_CAPTURE) as AndroidScreenCaptureTask + + then("buildArgs is [screen, capture, ...extraArgs]") { + task.buildArgs() shouldBe listOf("screen", "capture", "--output", "/tmp/s.png") + } + } + + given("AndroidSkillsListTask") { + val (project, _) = newProject() + val task = project.tasks.getByName(AndroidCli.TASK_SKILLS_LIST) as AndroidSkillsListTask + + then("buildArgs is [skills, list]") { + task.buildArgs() shouldBe listOf("skills", "list") + } + } + + given("AndroidSkillsFindTask") { + `when`("PROP_QUERY not set") { + val (project, _) = newProject() + val task = project.tasks.getByName(AndroidCli.TASK_SKILLS_FIND) as AndroidSkillsFindTask + + then("buildArgs is [skills, find]") { + task.buildArgs() shouldBe listOf("skills", "find") + } + } + `when`("PROP_QUERY set to blank") { + val (project, _) = newProject() + project.extensions.extraProperties.set(AndroidCli.PROP_QUERY, " ") + val task = project.tasks.getByName(AndroidCli.TASK_SKILLS_FIND) as AndroidSkillsFindTask + + then("blank query is ignored") { + task.buildArgs() shouldBe listOf("skills", "find") + } + } + `when`("PROP_QUERY set to a value") { + val (project, _) = newProject() + project.extensions.extraProperties.set(AndroidCli.PROP_QUERY, "compose") + val task = project.tasks.getByName(AndroidCli.TASK_SKILLS_FIND) as AndroidSkillsFindTask + + then("buildArgs appends query") { + task.buildArgs() shouldBe listOf("skills", "find", "compose") + } + } + } + + given("AndroidSkillsAddTask") { + `when`("PROP_SKILL not set") { + val (project, _) = newProject() + val task = project.tasks.getByName(AndroidCli.TASK_SKILLS_ADD) as AndroidSkillsAddTask + + then("buildArgs throws with helpful message") { + val ex = shouldThrow { task.buildArgs() } + ex.message!! shouldContain AndroidCli.PROP_SKILL + } + } + `when`("PROP_SKILL set") { + val (project, _) = newProject() + project.extensions.extraProperties.set(AndroidCli.PROP_SKILL, "navigation") + val task = project.tasks.getByName(AndroidCli.TASK_SKILLS_ADD) as AndroidSkillsAddTask + + then("buildArgs is [skills, add, ]") { + task.buildArgs() shouldBe listOf("skills", "add", "navigation") + } + } + } + + given("AndroidSkillsRemoveTask") { + `when`("PROP_SKILL not set") { + val (project, _) = newProject() + val task = project.tasks.getByName(AndroidCli.TASK_SKILLS_REMOVE) as AndroidSkillsRemoveTask + + then("buildArgs throws") { + val ex = shouldThrow { task.buildArgs() } + ex.message!! shouldContain AndroidCli.PROP_SKILL + } + } + `when`("PROP_SKILL set") { + val (project, _) = newProject() + project.extensions.extraProperties.set(AndroidCli.PROP_SKILL, "navigation") + val task = project.tasks.getByName(AndroidCli.TASK_SKILLS_REMOVE) as AndroidSkillsRemoveTask + + then("buildArgs is [skills, remove, ]") { + task.buildArgs() shouldBe listOf("skills", "remove", "navigation") + } + } + } + + given("AndroidRunTask") { + `when`("PROP_ARGS not set and no extraArgs") { + val (project, _) = newProject() + val task = project.tasks.getByName(AndroidCli.TASK_RUN) as AndroidRunTask + + then("buildArgs is empty") { + task.buildArgs() shouldBe emptyList() + } + } + `when`("PROP_ARGS set with multiple tokens") { + val (project, _) = newProject() + project.extensions.extraProperties.set(AndroidCli.PROP_ARGS, "skills add compose") + val task = project.tasks.getByName(AndroidCli.TASK_RUN) as AndroidRunTask + + then("buildArgs splits on spaces ignoring blanks") { + task.buildArgs() shouldBe listOf("skills", "add", "compose") + } + } + `when`("extraArgs is set") { + val (project, ext) = newProject() + ext.extraArgs = listOf("--verbose") + project.extensions.extraProperties.set(AndroidCli.PROP_ARGS, "version") + val task = project.tasks.getByName(AndroidCli.TASK_RUN) as AndroidRunTask + + then("extraArgs is appended") { + task.buildArgs() shouldContain "--verbose" + task.buildArgs() shouldBe listOf("version", "--verbose") + } + } + } + + given("AndroidExecTask.checkBinaryInstalled") { + `when`("binary exists on PATH") { + val (project, ext) = newProject() + ext.binary = "which" + val task = project.tasks.getByName(AndroidCli.TASK_VERSION) as AndroidVersionTask + + then("it does not throw") { + task.checkBinaryInstalled() + } + } + `when`("binary missing") { + val (project, ext) = newProject() + ext.binary = "zz-definitely-not-installed-zz" + val task = project.tasks.getByName(AndroidCli.TASK_VERSION) as AndroidVersionTask + + then("it throws with install hint") { + val ex = shouldThrow { task.checkBinaryInstalled() } + ex.message!! shouldContain "not found on PATH" + ex.message!! shouldContain "zz-definitely-not-installed-zz" + } + } + } + }) diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..a17a4e7 --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,11 @@ +pluginManagement { + includeBuild("build-logic") { name = "android-cli-build-logic" } +} + +plugins { + id("clkx-settings") +} + +rootProject.name = "android-cli" + +include(":plugin")