diff --git a/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/build.gradle.kts b/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/build.gradle.kts new file mode 100644 index 000000000..7295af8fd --- /dev/null +++ b/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/build.gradle.kts @@ -0,0 +1,40 @@ +plugins { + id("java-gradle-plugin") + id("maven-publish") +} + +// CHANGE ME: change to your organization's group ID +group = "com.myorg" +version = "1.0" + +repositories { + gradlePluginPortal() +} + +dependencies { + compileOnly("com.gradle:develocity-gradle-plugin:4.2.1") + compileOnly("com.gradle:common-custom-user-data-gradle-plugin:2.4.0") +} + +java { + toolchain { + languageVersion = JavaLanguageVersion.of(8) + } +} + +gradlePlugin { + plugins { + create("develocityConventions") { + // CHANGE ME: change for your organization + id = "com.myorg.convention-develocity-gradle-5-or-newer" + displayName = "Develocity Convention Plugin for Gradle 5.0 and higher" + description = "A Gradle plugin to apply and configure the Develocity Gradle plugin for com.myorg" + implementationClass = "com.myorg.ConventionDevelocityGradlePlugin" + } + } +} + +tasks.withType().configureEach { + failOnWarning = true + enableStricterValidation = true +} diff --git a/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/gradle.properties b/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/gradle.properties new file mode 100644 index 000000000..17dfbd1c3 --- /dev/null +++ b/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/gradle.properties @@ -0,0 +1,8 @@ +org.gradle.vfs.watch=true +org.gradle.daemon=true +org.gradle.caching=true +org.gradle.configuration-cache=true +org.gradle.parallel=true + +# due to https://github.com/gradle/gradle/issues/19750 be sure to include both `-Xmx` and `-XX:MaxMetaspaceSize` settings +org.gradle.jvmargs=-Duser.language=en -Duser.country=US -Dfile.encoding=UTF-8 -Xmx512m -XX:MaxMetaspaceSize=256m diff --git a/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/gradle/wrapper/gradle-wrapper.jar b/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 000000000..8bdaf60c7 Binary files /dev/null and b/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/gradle/wrapper/gradle-wrapper.jar differ diff --git a/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/gradle/wrapper/gradle-wrapper.properties b/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 000000000..6a38a8cea --- /dev/null +++ b/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,8 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionSha256Sum=a17ddd85a26b6a7f5ddb71ff8b05fc5104c0202c6e64782429790c933686c806 +distributionUrl=https\://services.gradle.org/distributions/gradle-9.1.0-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/gradlew b/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/gradlew new file mode 100755 index 000000000..adff685a0 --- /dev/null +++ b/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/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/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 + + + +# 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/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/gradlew.bat b/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/gradlew.bat new file mode 100644 index 000000000..c4bdd3ab8 --- /dev/null +++ b/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/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/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/settings.gradle.kts b/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/settings.gradle.kts new file mode 100644 index 000000000..22528c611 --- /dev/null +++ b/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/settings.gradle.kts @@ -0,0 +1,5 @@ +plugins { + id("org.gradle.toolchains.foojay-resolver-convention") version "1.0.0" +} + +rootProject.name = "convention-develocity-gradle-plugin-gradle-5-or-newer-dynamic" diff --git a/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/src/main/java/com/myorg/ConventionDevelocityGradlePlugin.java b/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/src/main/java/com/myorg/ConventionDevelocityGradlePlugin.java new file mode 100644 index 000000000..8125253ea --- /dev/null +++ b/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/src/main/java/com/myorg/ConventionDevelocityGradlePlugin.java @@ -0,0 +1,107 @@ +package com.myorg; + +import com.gradle.CommonCustomUserDataGradlePlugin; +import com.gradle.develocity.agent.gradle.DevelocityConfiguration; +import com.gradle.develocity.agent.gradle.DevelocityPlugin; +import org.gradle.api.Plugin; +import org.gradle.api.Project; +import org.gradle.api.initialization.Settings; +import org.gradle.api.plugins.ExtensionContainer; +import org.gradle.api.plugins.PluginManager; +import org.gradle.api.provider.ProviderFactory; +import org.gradle.caching.configuration.BuildCacheConfiguration; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import javax.inject.Inject; +import java.util.ArrayList; +import java.util.List; + +import static com.myorg.GradleUtils.isGradle5OrNewer; +import static com.myorg.GradleUtils.isGradle6OrNewer; + +/** + * An example Gradle plugin for enabling and configuring Develocity features for + * Gradle versions 5.x and higher. + */ +@SuppressWarnings("LoggingSimilarMessage") +final class ConventionDevelocityGradlePlugin implements Plugin { + + private static final String develocityPluginVersion = "4.2"; + private static final String commonCustomUserDataPluginVersion = "2.4.0"; + + private static final Logger logger = LoggerFactory.getLogger(ConventionDevelocityGradlePlugin.class); + + private final ProviderFactory providers; + + @Inject + public ConventionDevelocityGradlePlugin(ProviderFactory providers) { + this.providers = providers; + } + + @Override + public void apply(Object target) { + try { + if (target instanceof Settings) { + applySettings((Settings) target); + } else if (target instanceof Project) { + applyProject((Project) target); + } + } catch (RuntimeException e) { + logger.warn("Could not apply Develocity: {}", e.getMessage()); + } + } + + private void applySettings(Settings settings) { + if (!isGradle6OrNewer()) { + logger.warn("For Gradle versions prior to 6.0, the Convention Develocity plugin must be applied to the Root project"); + } + configureGradle6OrNewer(settings); + } + + private void applyProject(Project project) { + if (isGradle6OrNewer()) { + logger.warn("For Gradle versions 6.0 and newer, the Convention Develocity plugin must be applied to Settings"); + } else if (isGradle5OrNewer()) { + if (!project.equals(project.getRootProject())) { + logger.warn("For Gradle versions prior to 6.0, the Convention Develocity plugin must be applied to the Root project"); + } + configureGradle5(project); + } else { + logger.warn("For Gradle versions prior to 5.0, the Convention Develocity plugin is not supported"); + } + } + + private void configureGradle6OrNewer(Settings settings) { + PluginLoader.resolveAndLoadIntoClassPath(getPluginsToResolve()); + applyPlugins(settings.getPluginManager()); + configureDevelocity(settings.getExtensions(), settings.getBuildCache()); + } + + private void configureGradle5(Project project) { + PluginLoader.resolveAndLoadIntoClassPath(getPluginsToResolve()); + applyPlugins(project.getPluginManager()); + // build cache is null because it cannot be configured via a plugin prior to Gradle 6.0 + configureDevelocity(project.getExtensions(), null); + } + + private void configureDevelocity(ExtensionContainer extensions, BuildCacheConfiguration buildCache) { + DevelocityConfiguration develocity = extensions.getByType(DevelocityConfiguration.class); + new DevelocityConventions(providers).configureDevelocity(develocity, buildCache); + } + + private static List getPluginsToResolve() { + String develocityPluginJarUrl = String.format("https://plugins.gradle.org/m2/com/gradle/develocity-gradle-plugin/%1$s/develocity-gradle-plugin-%1$s.jar", develocityPluginVersion); + String commonCustomUserDataPluginJarUrl = String.format("https://plugins.gradle.org/m2/com/gradle/common-custom-user-data-gradle-plugin/%1$s/common-custom-user-data-gradle-plugin-%1$s.jar", commonCustomUserDataPluginVersion); + List pluginsToResolve = new ArrayList<>(); + pluginsToResolve.add(new GradlePluginPortalPluginResolver(develocityPluginJarUrl)); + pluginsToResolve.add(new GradlePluginPortalPluginResolver(commonCustomUserDataPluginJarUrl)); + return pluginsToResolve; + } + + private static void applyPlugins(PluginManager pluginManager) { + pluginManager.apply(DevelocityPlugin.class); + pluginManager.apply(CommonCustomUserDataGradlePlugin.class); + } + +} diff --git a/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/src/main/java/com/myorg/DevelocityConventions.java b/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/src/main/java/com/myorg/DevelocityConventions.java new file mode 100644 index 000000000..d26553772 --- /dev/null +++ b/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/src/main/java/com/myorg/DevelocityConventions.java @@ -0,0 +1,50 @@ +package com.myorg; + +import com.gradle.develocity.agent.gradle.DevelocityConfiguration; +import com.gradle.develocity.agent.gradle.scan.BuildScanConfiguration; +import com.gradle.develocity.agent.gradle.scan.BuildScanPublishingConfiguration.PublishingContext; +import org.gradle.api.provider.ProviderFactory; +import org.gradle.caching.configuration.BuildCacheConfiguration; + +import static com.myorg.GradleUtils.environmentVariable; + +@SuppressWarnings({"BooleanMethodIsAlwaysInverted", "SameParameterValue"}) +final class DevelocityConventions { + + private final ProviderFactory providers; + + DevelocityConventions(ProviderFactory providers) { + this.providers = providers; + } + + void configureDevelocity(DevelocityConfiguration develocity, BuildCacheConfiguration buildCache) { + develocity.getServer().set("https://ge.solutions-team.gradle.com"); + configureBuildScan(develocity.getBuildScan()); + configureBuildCache(develocity, buildCache); + } + + private void configureBuildScan(BuildScanConfiguration buildScan) { + buildScan.getUploadInBackground().set(!isCi()); + buildScan.publishing(it -> it.onlyIf(PublishingContext::isAuthenticated)); + } + + private void configureBuildCache(DevelocityConfiguration develocity, BuildCacheConfiguration buildCache) { + if (buildCache == null) { + return; + } + + buildCache.remote(develocity.getBuildCache(), remote -> { + remote.setEnabled(true); + remote.setPush(isCi()); + }); + buildCache.local(local -> { + local.setEnabled(true); + local.setPush(true); + }); + } + + private boolean isCi() { + return environmentVariable("CI", providers).isPresent(); + } + +} diff --git a/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/src/main/java/com/myorg/GradlePluginPortalPluginResolver.java b/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/src/main/java/com/myorg/GradlePluginPortalPluginResolver.java new file mode 100644 index 000000000..c164bcdae --- /dev/null +++ b/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/src/main/java/com/myorg/GradlePluginPortalPluginResolver.java @@ -0,0 +1,74 @@ +package com.myorg; + +import java.io.File; +import java.io.IOException; +import java.io.InputStream; +import java.net.MalformedURLException; +import java.net.URI; +import java.net.URL; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; + +final class GradlePluginPortalPluginResolver implements PluginResolver { + + private static final Path pluginJarCacheDirectory = Paths.get(System.getProperty("user.home"), ".develocity-jars"); + + private final String pluginJarUrl; + + public GradlePluginPortalPluginResolver(String pluginJarUrl) { + this.pluginJarUrl = pluginJarUrl; + } + + @Override + public File resolve() { + Path destinationPath = getDestinationPath(); + createParentDirectories(destinationPath); + if (!Files.exists(destinationPath)) { + performDownload(destinationPath); + } + return destinationPath.toFile(); + } + + private Path getDestinationPath() { + URL url = toURL(pluginJarUrl); + String urlPath = url.getPath(); + String filePath = trimM2Prefix(urlPath); + return Paths.get(pluginJarCacheDirectory.toString(), filePath); + } + + private static String trimM2Prefix(String path) { + if (path.startsWith("/m2")) { + return path.substring(3); + } + return path; + } + + private static void createParentDirectories(Path path) { + Path parent = path.getParent(); + try { + Files.createDirectories(parent); + } catch (IOException e) { + throw new RuntimeException("Could not create parent directory: " + parent, e); + } + } + + private void performDownload(Path destinationPath) { + try { + try (InputStream in = new URL(pluginJarUrl).openStream()) { + Files.copy(in, destinationPath); + } + } catch (IOException e) { + throw new RuntimeException("Could not download plugin JAR file: " + pluginJarUrl, e); + } + } + + private static URL toURL(String url) { + try { + return URI.create(url).toURL(); + } catch (MalformedURLException e) { + throw new RuntimeException(e); + } + } + +} diff --git a/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/src/main/java/com/myorg/GradleUtils.java b/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/src/main/java/com/myorg/GradleUtils.java new file mode 100644 index 000000000..c00744d6c --- /dev/null +++ b/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/src/main/java/com/myorg/GradleUtils.java @@ -0,0 +1,54 @@ +package com.myorg; + +import org.gradle.api.provider.Provider; +import org.gradle.api.provider.ProviderFactory; +import org.gradle.util.GradleVersion; + +import java.lang.reflect.Method; +import java.util.Optional; + +@SuppressWarnings({"JavaReflectionMemberAccess", "unchecked", "BooleanMethodIsAlwaysInverted"}) +final class GradleUtils { + + private GradleUtils() { + } + + static Optional environmentVariable(String name, ProviderFactory providers) { + if (isGradle65OrNewer() && !isGradle74OrNewer()) { + Provider variable = forUseAtConfigurationTime(providers.environmentVariable(name)); + return Optional.ofNullable(variable.getOrNull()); + } + return Optional.ofNullable(System.getenv(name)); + } + + private static Provider forUseAtConfigurationTime(Provider provider) { + if (isGradle65OrNewer() && !isGradle74OrNewer()) { + try { + // Use reflection to access the forUseAtConfigurationTime method as it was removed in Gradle 9. + Method method = Provider.class.getMethod("forUseAtConfigurationTime"); + return (Provider) method.invoke(provider); + } catch (Exception e) { + throw new RuntimeException("Failed to invoke forUseAtConfigurationTime via reflection", e); + } + } else { + return provider; + } + } + + static boolean isGradle74OrNewer() { + return GradleVersion.current().compareTo(GradleVersion.version("7.4")) >= 0; + } + + static boolean isGradle65OrNewer() { + return GradleVersion.current().compareTo(GradleVersion.version("6.5")) >= 0; + } + + static boolean isGradle6OrNewer() { + return GradleVersion.current().compareTo(GradleVersion.version("6.0")) >= 0; + } + + static boolean isGradle5OrNewer() { + return GradleVersion.current().compareTo(GradleVersion.version("5.0")) >= 0; + } + +} diff --git a/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/src/main/java/com/myorg/PluginLoader.java b/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/src/main/java/com/myorg/PluginLoader.java new file mode 100644 index 000000000..ce1f95323 --- /dev/null +++ b/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/src/main/java/com/myorg/PluginLoader.java @@ -0,0 +1,45 @@ +package com.myorg; + +import org.gradle.internal.classloader.VisitableURLClassLoader; + +import java.io.File; +import java.net.MalformedURLException; +import java.net.URL; +import java.util.ArrayList; +import java.util.List; + +/** + * An example Gradle plugin for enabling and configuring Develocity features for + * Gradle versions 5.x and higher. + */ +@SuppressWarnings({"NullableProblems"}) +final class PluginLoader { + + private PluginLoader() { + } + + static void resolveAndLoadIntoClassPath(List pluginsToResolve) { + List pluginJarFiles = resolveAllPlugins(pluginsToResolve); + modifyPluginClassLoader(pluginJarFiles); + } + + private static List resolveAllPlugins(List pluginsToResolve) { + List resolvedPluginFiles = new ArrayList<>(); + pluginsToResolve.forEach(plugin -> resolvedPluginFiles.add(plugin.resolve())); + return resolvedPluginFiles; + } + + private static void modifyPluginClassLoader(List pluginJarFiles) { + VisitableURLClassLoader classLoader = (VisitableURLClassLoader) PluginLoader.class.getClassLoader(); + pluginJarFiles.stream().map(PluginLoader::toURL).forEach(classLoader::addURL); + } + + private static URL toURL(File file) { + try { + return file.toURI().toURL(); + } catch (MalformedURLException e) { + throw new RuntimeException(e); + } + } + +} diff --git a/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/src/main/java/com/myorg/PluginResolver.java b/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/src/main/java/com/myorg/PluginResolver.java new file mode 100644 index 000000000..4e9684aba --- /dev/null +++ b/convention-develocity-gradle-plugin/plugins/gradle-5-or-newer-dynamic/src/main/java/com/myorg/PluginResolver.java @@ -0,0 +1,8 @@ +package com.myorg; + +import java.io.File; + +interface PluginResolver { + + File resolve(); +}