diff --git a/.gitignore b/.gitignore index ecdeb4f10..bcdd5d193 100644 --- a/.gitignore +++ b/.gitignore @@ -8,8 +8,7 @@ profile-out* build !.github/actions/build -!*/src/**/build -!*/*/src/**/build +!**/src/**/build .ipynb_checkpoints .venv diff --git a/README.md b/README.md index 3b098bece..8e279b347 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ A Kotlin library to access the [Develocity API][1], easy to use from: - [Jupyter notebooks with the Kotlin kernel][29] - [Kotlin scripts (`kts`)][27] - [Kotlin projects][28] +- [Gradle tasks][36] ```kotlin val api = DevelocityApi.newInstance() @@ -232,3 +233,4 @@ For general discussions or questions, feel free to reach out to maintainers on t [33]: https://github.com/gradle/develocity-api-samples [34]: https://github.com/gabrielfeo/develocity-api-kotlin/blob/main/build-logic/src/functionalTest/kotlin/com/gabrielfeo/task/PostProcessGeneratedApiTest.kt#L21 [35]: https://community.gradle.org/#community-channels +[36]: ./examples/example-gradle-task/ diff --git a/build-logic/src/main/kotlin/com/gabrielfeo/examples-test-suite.gradle.kts b/build-logic/src/main/kotlin/com/gabrielfeo/examples-test-suite.gradle.kts index 1be0fd179..41bdc1116 100644 --- a/build-logic/src/main/kotlin/com/gabrielfeo/examples-test-suite.gradle.kts +++ b/build-logic/src/main/kotlin/com/gabrielfeo/examples-test-suite.gradle.kts @@ -24,7 +24,11 @@ kotlin { val examples = fileTree(rootDir) { include("examples/**") - exclude("**/build", "**/.*") + exclude { + it.isDirectory + && (it.name == "build" || it.name.startsWith(".")) + && !it.path.endsWith("build-logic/src/main/kotlin/build") + } } tasks.named("processExamplesTestResources", ProcessResources::class) { diff --git a/examples/example-gradle-task/README.md b/examples/example-gradle-task/README.md new file mode 100644 index 000000000..4334325db --- /dev/null +++ b/examples/example-gradle-task/README.md @@ -0,0 +1,20 @@ + + +# Example usage in build logic + +This example shows how to create a reusable Gradle plugin that adds a `userBuildPerformanceMetrics` task to fetch and print build performance metrics for a specific user, using the Develocity API Kotlin client. + +## Core files + +- [`build-logic/src/main/kotlin/build/logic/PerformanceMetricsTask.kt`](./build-logic/src/main/kotlin/build/logic/PerformanceMetricsTask.kt): Implements a custom Gradle task that fetches and prints build performance metrics of a given user. +- [`build-logic/src/main/kotlin/build/logic/DevelocityApiService.kt`](./build-logic/src/main/kotlin/build/logic/DevelocityApiService.kt): Defines a shared build service containing the Develocity API client, which could be used by multiple tasks while ensuring a singleton client per build. +- [`build-logic/performance-metrics-plugin.gradle.kts`](./build-logic/performance-metrics-plugin.gradle.kts): A plugin which registers the task where it's applied. +- [`build.gradle.kts`](./build.gradle.kts): Applies `performance-metrics-plugin`, making the task available for this build. + +## Usage + +Run: + +```sh +./gradlew userBuildPerformanceMetrics [--user=foo] --period=[-1d|-7d|-14d|-30d|...] +``` diff --git a/examples/example-gradle-task/build-logic/build.gradle.kts b/examples/example-gradle-task/build-logic/build.gradle.kts new file mode 100644 index 000000000..f9063b2c7 --- /dev/null +++ b/examples/example-gradle-task/build-logic/build.gradle.kts @@ -0,0 +1,8 @@ +plugins { + `kotlin-dsl` +} + +dependencies { + implementation("com.gabrielfeo:develocity-api-kotlin:2024.3.0") + implementation("org.apache.commons:commons-math3:3.6.1") +} diff --git a/examples/example-gradle-task/build-logic/settings.gradle.kts b/examples/example-gradle-task/build-logic/settings.gradle.kts new file mode 100644 index 000000000..0e142a083 --- /dev/null +++ b/examples/example-gradle-task/build-logic/settings.gradle.kts @@ -0,0 +1,8 @@ +rootProject.name = "dak-example-gradle-task-build-logic" + +dependencyResolutionManagement { + repositories { + mavenCentral() + gradlePluginPortal() + } +} diff --git a/examples/example-gradle-task/build-logic/src/main/kotlin/build/logic/DevelocityApiService.kt b/examples/example-gradle-task/build-logic/src/main/kotlin/build/logic/DevelocityApiService.kt new file mode 100644 index 000000000..60670f0cd --- /dev/null +++ b/examples/example-gradle-task/build-logic/src/main/kotlin/build/logic/DevelocityApiService.kt @@ -0,0 +1,24 @@ +package build.logic + +import com.gabrielfeo.develocity.api.Config +import com.gabrielfeo.develocity.api.DevelocityApi +import org.gradle.api.services.BuildService +import org.gradle.api.services.BuildServiceParameters +import okhttp3.OkHttpClient + +abstract class DevelocityApiService + : DevelocityApi by DevelocityApi.newInstance(config()), + BuildService, + AutoCloseable { + + override fun close() { + shutdown() + } +} + +private fun config() = Config( + // Necessary to accomodate Gradle's build service lifecycle because library + // uses a singleton OkHttpClient.Builder unless one is provided. + // See https://github.com/gabrielfeo/develocity-api-kotlin/issues/451 + clientBuilder = OkHttpClient.Builder(), +) diff --git a/examples/example-gradle-task/build-logic/src/main/kotlin/build/logic/PerformanceMetricsTask.kt b/examples/example-gradle-task/build-logic/src/main/kotlin/build/logic/PerformanceMetricsTask.kt new file mode 100644 index 000000000..88102c868 --- /dev/null +++ b/examples/example-gradle-task/build-logic/src/main/kotlin/build/logic/PerformanceMetricsTask.kt @@ -0,0 +1,92 @@ +package build.logic + +import com.gabrielfeo.develocity.api.DevelocityApi +import kotlinx.coroutines.runBlocking +import com.gabrielfeo.develocity.api.model.BuildModelName +import com.gabrielfeo.develocity.api.model.Build +import com.gabrielfeo.develocity.api.model.GradleBuildCachePerformance +import org.apache.commons.math3.stat.descriptive.DescriptiveStatistics +import org.gradle.api.DefaultTask +import org.gradle.api.provider.Property +import org.gradle.api.tasks.Input +import org.gradle.api.tasks.Optional +import org.gradle.api.tasks.TaskAction +import org.gradle.api.tasks.options.Option +import org.gradle.api.services.ServiceReference +import java.time.Duration + + +abstract class PerformanceMetricsTask( + +) : DefaultTask() { + + @get:Optional + @get:Input + @get:Option( + option = "user", + description = "The user to query builds for. Defaults to the current OS username." + ) + abstract val user: Property + + @get:Optional + @get:Input + @get:Option( + option = "period", + description = "The period to query builds for (e.g. -14d, -30d, etc). Default: -14d." + ) + abstract val period: Property + + @get:ServiceReference + abstract val api: Property + + @TaskAction + fun run() { + val user = user.getOrElse(System.getProperty("user.name")) + val startTime = period.getOrElse("-14d") + val metrics = runBlocking { + getUserBuildsPerformanceMetrics(api.get(), user, startTime) + } + logger.quiet(metrics) + } + + suspend fun getUserBuildsPerformanceMetrics( + api: DevelocityApi, + user: String, + startTime: String, + ): String { + val query = """user:"$user" buildStartTime>$startTime""" + val buildsPerformanceData = fetchBuildsPerformanceData(api, query) + val serializationFactors = buildsPerformanceData + .map { it.serializationFactor } + .let { DescriptiveStatistics(it.toDoubleArray()) } + val avoidanceSavings = buildsPerformanceData + .map { it.workUnitAvoidanceSavingsSummary.ratio } + .let { DescriptiveStatistics(it.toDoubleArray()) } + val heading = "Build performance overview for $user since $startTime (powered by Develocity®)" + return """ + | + |${"\u001B[1;36m"}$heading${"\u001B[0m"} + | ▶︎ Serialization factor: %.1fx + | (Gradle's parallel execution) + | ⏩︎ Avoidance savings: %.1f%% (mean) ~ %.1f%% (p95) + | (Gradle and Develocity's mechanisms, incl. incremental build and remote cache) + """.trimMargin().format( + serializationFactors.mean, + avoidanceSavings.mean, + avoidanceSavings.getPercentile(95.0), + ) + } + + private suspend fun fetchBuildsPerformanceData( + api: DevelocityApi, + query: String, + ): List { + return api.buildsApi.getBuilds( + fromInstant = 0, + query = query, + models = listOf(BuildModelName.gradleBuildCachePerformance), + ).mapNotNull { build -> + build.models?.gradleBuildCachePerformance?.model + } + } +} diff --git a/examples/example-gradle-task/build-logic/src/main/kotlin/build/logic/performance-metrics-plugin.gradle.kts b/examples/example-gradle-task/build-logic/src/main/kotlin/build/logic/performance-metrics-plugin.gradle.kts new file mode 100644 index 000000000..0d9382e84 --- /dev/null +++ b/examples/example-gradle-task/build-logic/src/main/kotlin/build/logic/performance-metrics-plugin.gradle.kts @@ -0,0 +1,8 @@ +package build.logic + +gradle.sharedServices.registerIfAbsent("develocityApiService", DevelocityApiService::class) + +tasks.register("userBuildPerformanceMetrics") { + group = "Develocity" + description = "Retrieves performance metrics for the user's builds from Develocity API." +} diff --git a/examples/example-gradle-task/build.gradle.kts b/examples/example-gradle-task/build.gradle.kts new file mode 100644 index 000000000..b68820646 --- /dev/null +++ b/examples/example-gradle-task/build.gradle.kts @@ -0,0 +1,3 @@ +plugins { + id("build.logic.performance-metrics-plugin") +} diff --git a/examples/example-gradle-task/gradle/wrapper/gradle-wrapper.jar b/examples/example-gradle-task/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 000000000..1b33c55ba Binary files /dev/null and b/examples/example-gradle-task/gradle/wrapper/gradle-wrapper.jar differ diff --git a/examples/example-gradle-task/gradle/wrapper/gradle-wrapper.properties b/examples/example-gradle-task/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 000000000..78cb6e16a --- /dev/null +++ b/examples/example-gradle-task/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,8 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionSha256Sum=bd71102213493060956ec229d946beee57158dbd89d0e62b91bca0fa2c5f3531 +distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.3-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/examples/example-gradle-task/gradlew b/examples/example-gradle-task/gradlew new file mode 100755 index 000000000..23d15a936 --- /dev/null +++ b/examples/example-gradle-task/gradlew @@ -0,0 +1,251 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 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/HEAD/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 + +CLASSPATH="\\\"\\\"" + + +# 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" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + 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" \ + -classpath "$CLASSPATH" \ + -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/examples/example-gradle-task/gradlew.bat b/examples/example-gradle-task/gradlew.bat new file mode 100644 index 000000000..db3a6ac20 --- /dev/null +++ b/examples/example-gradle-task/gradlew.bat @@ -0,0 +1,94 @@ +@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 + +set CLASSPATH= + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" -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/examples/example-gradle-task/settings.gradle.kts b/examples/example-gradle-task/settings.gradle.kts new file mode 100644 index 000000000..3783ff797 --- /dev/null +++ b/examples/example-gradle-task/settings.gradle.kts @@ -0,0 +1,5 @@ +pluginManagement { + includeBuild("build-logic") +} + +rootProject.name = "dak-example-gradle-task-main-build" diff --git a/library/src/examplesTest/kotlin/ExampleGradleTaskTest.kt b/library/src/examplesTest/kotlin/ExampleGradleTaskTest.kt new file mode 100644 index 000000000..92a4822e5 --- /dev/null +++ b/library/src/examplesTest/kotlin/ExampleGradleTaskTest.kt @@ -0,0 +1,52 @@ + + + +import org.junit.jupiter.api.Assertions.assertTrue +import org.junit.jupiter.api.BeforeEach +import org.junit.jupiter.api.Test +import org.junit.jupiter.api.io.TempDir +import java.nio.file.Path +import com.gabrielfeo.develocity.api.example.copyFromResources +import com.gabrielfeo.develocity.api.example.runInShell +import kotlin.io.path.div + +class ExampleGradleTaskTest { + + @TempDir + lateinit var tempDir: Path + + private val projectDir + get() = tempDir / "examples/example-gradle-task" + + @BeforeEach + fun setup() { + copyFromResources("/examples", tempDir) + } + + @Test + fun testBuildPerformanceMetricsTaskWithDefaults() { + val user = System.getProperty("user.name") + val output = runBuild("userBuildPerformanceMetrics") + assertPerformanceMetricsOutput(output, user = user, period = "-14d") + } + + private fun runBuild(gradleArgs: String) = + runInShell(projectDir, "./gradlew --stacktrace --no-daemon $gradleArgs") + + private fun assertPerformanceMetricsOutput( + output: String, + user: String, + period: String, + ) { + val expectedHeading = "Build performance overview for $user since $period (powered by Develocity®)" + assertTrue(output.contains(expectedHeading)) + assertTrue(output.contains("▶︎ Serialization factor:")) + assertTrue(output.contains("⏩︎ Avoidance savings:")) + } + + @Test + fun testBuildPerformanceMetricsTaskWithOptions() { + val output = runBuild("userBuildPerformanceMetrics --user runner --period=-1d") + assertPerformanceMetricsOutput(output, user = "runner", period = "-1d") + } +}