diff --git a/samples/composite-build-logic/README.md b/samples/composite-build-logic/README.md new file mode 100644 index 000000000..1d2a83d7b --- /dev/null +++ b/samples/composite-build-logic/README.md @@ -0,0 +1,17 @@ +composite-build-logic +===================== + +Demonstrates how to use [Composite Builds](https://docs.gradle.org/current/userguide/composite_builds.html) +for build logic. + +The outer build includes two other builds: +- `gradle/shared` +- `gradle/plugins` + +Both the outer build and `gradle/plugins` depend on `gradle/shared` in several ways. + +Run with: + + ./gradlew sample + +See [settings.gradle.kts](./settings.gradle.kts) to see how to include builds and do dependency substitution. diff --git a/samples/composite-build-logic/build.gradle.kts b/samples/composite-build-logic/build.gradle.kts new file mode 100644 index 000000000..ea52ef875 --- /dev/null +++ b/samples/composite-build-logic/build.gradle.kts @@ -0,0 +1,15 @@ +import shared.* + +plugins { + id("plugins.sample-plugin") +} + +tasks { + sample { + message.set("Hello included build logic!") + } +} + +dependencies { + implementation(DependencyVersions.javax.measure.ri.notation) +} diff --git a/samples/composite-build-logic/gradle/plugins/build.gradle.kts b/samples/composite-build-logic/gradle/plugins/build.gradle.kts new file mode 100644 index 000000000..528b4f74f --- /dev/null +++ b/samples/composite-build-logic/gradle/plugins/build.gradle.kts @@ -0,0 +1,23 @@ +import shared.* + +plugins { + `kotlin-dsl` +} + +buildscript { + dependencies { + classpath("composite-build-logic:shared:latest-integration") + } +} + +group = "org.gradle.kotlin.dsl.samples.composite-build-logic" +version = "1.0" + +repositories { + jcenter() +} + +dependencies { + implementation(DependencyVersions.javax.measure.ri.notation) + implementation("composite-build-logic:shared:latest-integration") +} diff --git a/samples/composite-build-logic/gradle/plugins/settings.gradle.kts b/samples/composite-build-logic/gradle/plugins/settings.gradle.kts new file mode 100644 index 000000000..e69de29bb diff --git a/samples/composite-build-logic/gradle/plugins/src/main/kotlin/plugins/SampleTask.kt b/samples/composite-build-logic/gradle/plugins/src/main/kotlin/plugins/SampleTask.kt new file mode 100644 index 000000000..4703ed2ed --- /dev/null +++ b/samples/composite-build-logic/gradle/plugins/src/main/kotlin/plugins/SampleTask.kt @@ -0,0 +1,17 @@ +package plugins + +import org.gradle.api.* +import org.gradle.api.tasks.* +import org.gradle.kotlin.dsl.* + + +open class SampleTask : DefaultTask() { + + @Input + val message = project.objects.property() + + @TaskAction + fun sample() { + logger.lifecycle(message.get()) + } +} diff --git a/samples/composite-build-logic/gradle/plugins/src/main/kotlin/plugins/sample-plugin.gradle.kts b/samples/composite-build-logic/gradle/plugins/src/main/kotlin/plugins/sample-plugin.gradle.kts new file mode 100644 index 000000000..850185d46 --- /dev/null +++ b/samples/composite-build-logic/gradle/plugins/src/main/kotlin/plugins/sample-plugin.gradle.kts @@ -0,0 +1,19 @@ +package plugins + +import shared.* + +plugins { + `java-library` +} + +dependencies { + "api"(DependencyVersions.javax.measure.api.notation) +} + +repositories { + jcenter() +} + +tasks.register("sample") { + message.set("SampleTask executed!") +} diff --git a/samples/composite-build-logic/gradle/shared/build.gradle.kts b/samples/composite-build-logic/gradle/shared/build.gradle.kts new file mode 100644 index 000000000..881309632 --- /dev/null +++ b/samples/composite-build-logic/gradle/shared/build.gradle.kts @@ -0,0 +1,10 @@ +plugins { + `kotlin-dsl` +} + +group = "org.gradle.kotlin.dsl.samples.composite-build-logic" +version = "1.0" + +repositories { + jcenter() +} diff --git a/samples/composite-build-logic/gradle/shared/settings.gradle.kts b/samples/composite-build-logic/gradle/shared/settings.gradle.kts new file mode 100644 index 000000000..e69de29bb diff --git a/samples/composite-build-logic/gradle/shared/src/main/kotlin/shared/DependencyVersions.kt b/samples/composite-build-logic/gradle/shared/src/main/kotlin/shared/DependencyVersions.kt new file mode 100644 index 000000000..249eaedc6 --- /dev/null +++ b/samples/composite-build-logic/gradle/shared/src/main/kotlin/shared/DependencyVersions.kt @@ -0,0 +1,16 @@ +package shared + +object DependencyVersions { + + object javax { + object measure { + val api = DependencyVersion("javax.measure", "unit-api", "1.0") + val ri = DependencyVersion("tec.units", "unit-ri", "1.0.3") + } + } +} + +data class DependencyVersion(val group: String, val name: String, val version: String) { + val notation: String + get() = "$group:$name:$version" +} diff --git a/samples/composite-build-logic/gradle/wrapper/gradle-wrapper.jar b/samples/composite-build-logic/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 000000000..d4046a663 Binary files /dev/null and b/samples/composite-build-logic/gradle/wrapper/gradle-wrapper.jar differ diff --git a/samples/composite-build-logic/gradle/wrapper/gradle-wrapper.properties b/samples/composite-build-logic/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 000000000..24bb691c7 --- /dev/null +++ b/samples/composite-build-logic/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists +distributionUrl=https\://repo.gradle.org/gradle/kotlin-dsl-snapshots-local/gradle-kotlin-dsl-5.0-20181019093416+0000-all.zip diff --git a/samples/composite-build-logic/gradlew b/samples/composite-build-logic/gradlew new file mode 100755 index 000000000..9aa616c27 --- /dev/null +++ b/samples/composite-build-logic/gradlew @@ -0,0 +1,169 @@ +#!/usr/bin/env bash + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS="" + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn ( ) { + echo "$*" +} + +die ( ) { + echo + echo "$*" + echo + exit 1 +} + +# 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 + ;; + MINGW* ) + msys=true + ;; + NONSTOP* ) + nonstop=true + ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + +# 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" + which java >/dev/null 2>&1 || 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 + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin, switch paths to Windows format before running java +if $cygwin ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=$((i+1)) + done + case $i in + (0) set -- ;; + (1) set -- "$args0" ;; + (2) set -- "$args0" "$args1" ;; + (3) set -- "$args0" "$args1" "$args2" ;; + (4) set -- "$args0" "$args1" "$args2" "$args3" ;; + (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules +function splitJvmOpts() { + JVM_OPTS=("$@") +} +eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS +JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME" + +# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong +if [[ "$(uname)" == "Darwin" ]] && [[ "$HOME" == "$PWD" ]]; then + cd "$(dirname "$0")" +fi + +exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@" diff --git a/samples/composite-build-logic/gradlew.bat b/samples/composite-build-logic/gradlew.bat new file mode 100644 index 000000000..f9553162f --- /dev/null +++ b/samples/composite-build-logic/gradlew.bat @@ -0,0 +1,84 @@ +@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=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@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= + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windows variants + +if not "%OS%" == "Windows_NT" goto win9xME_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="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! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/samples/composite-build-logic/settings.gradle.kts b/samples/composite-build-logic/settings.gradle.kts new file mode 100644 index 000000000..ad2282993 --- /dev/null +++ b/samples/composite-build-logic/settings.gradle.kts @@ -0,0 +1,20 @@ +val buildLogicGroup = "composite-build-logic" + +listOf("shared", "plugins").forEach { included -> + includeBuild("gradle/$included") { + dependencySubstitution { + substitute(module("$buildLogicGroup:$included")).with(project(":")) + } + } +} + +// Work around for https://github.com/gradle/gradle-native/issues/522 +pluginManagement { + resolutionStrategy { + eachPlugin { + when (requested.id.id) { + "plugins.sample-plugin" -> useModule("$buildLogicGroup:plugins:latest-integration") + } + } + } +} diff --git a/subprojects/samples-tests/src/test/kotlin/org/gradle/kotlin/dsl/samples/CompositeBuildLogicSampleTest.kt b/subprojects/samples-tests/src/test/kotlin/org/gradle/kotlin/dsl/samples/CompositeBuildLogicSampleTest.kt new file mode 100644 index 000000000..6cde686aa --- /dev/null +++ b/subprojects/samples-tests/src/test/kotlin/org/gradle/kotlin/dsl/samples/CompositeBuildLogicSampleTest.kt @@ -0,0 +1,34 @@ +/* + * Copyright 2018 the original author or 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 + * + * http://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. + */ + +package org.gradle.kotlin.dsl.samples + +import org.hamcrest.CoreMatchers.containsString +import org.junit.Assert.assertThat +import org.junit.Test + + +class CompositeBuildLogicSampleTest : AbstractSampleTest("composite-build-logic") { + + @Test + fun `can apply and configure plugin from included build`() { + + assertThat( + build(":sample").output, + containsString("Hello included build logic!") + ) + } +}