diff --git a/examples/java-app-groovy-dsl/README.md b/examples/java-app-groovy-dsl/README.md new file mode 100644 index 00000000..f5b63013 --- /dev/null +++ b/examples/java-app-groovy-dsl/README.md @@ -0,0 +1,39 @@ +# Gradle OCI Plugin Example: Java Application + +> [!NOTE] +> This example is the same as [java-app](../java-app). +> The only difference is the use of the Groovy DSL in Gradle build scripts. +> The Kotlin DSL is recommended if you use the Gradle OCI Plugin as the focus lies on providing the best user experience with the Kotlin DSL. +> It is possible to use the Groovy DSL though, there are only a few differences where the Groovy DSL needs a few more characters. + +This example project produces a Java application that prints "Hello World!" and the Java version. + +The application is bundled as an OCI/Docker image by using the Gradle OCI Plugin. +Look at the OCI image definition in [build.gradle.kts](build.gradle). + +This example gives you two options to use the created OCI image: +- Run the image as a test container in a JUnit test (Look at the code [here](src/test/java/org/example/java/app/ImageTest.java)): + ```shell + ./gradlew test + ``` +- Push the image to a registry: + - To push to DockerHub, set the `dockerHubUsername` and `dockerHubPassword` Gradle properties to your DockerHub credentials (for example in `~/.gradle.properties`) and replace `` in the following command: + ```shell + ./gradlew pushOciImage --registry dockerHub --name /example-java-app + ``` + - To push to any registry, specify the `-url` option: + ```shell + ./gradlew pushOciImage --url https://my-registry.example.org + ``` + - To push to any registry that requires credentials, also specify the `--credentials` option and setup the required Gradle properties (`myRegUsername` and `myRegPassword` in this example): + ```shell + ./gradlew pushOciImage --url https://my-registry.example.org --credentials myReg + ``` + - You can specify the OCI image's name and tag in the registry with the `--name` and `--tag` options: + ```shell + ./gradlew pushOciImage --url https://my-registry.example.org --name oci-demo-app --tag 123 --tag latest + ``` + - Run the following to get an overview and a description of all available options: + ```shell + ./gradlew help --task pushOciImage + ``` diff --git a/examples/java-app-groovy-dsl/build.gradle b/examples/java-app-groovy-dsl/build.gradle new file mode 100644 index 00000000..51f62adc --- /dev/null +++ b/examples/java-app-groovy-dsl/build.gradle @@ -0,0 +1,65 @@ +import java.time.Instant + +plugins { + id("java") + alias(libs.plugins.oci) +} + +group = "org.example" +version = "1.0.0" + +java { + toolchain { + languageVersion = JavaLanguageVersion.of(11) + } +} + +tasks.named("jar") { + manifest.attributes["Main-Class"] = "org.example.java.app.Main" +} + +repositories { + mavenCentral() +} + +oci { + registries { + dockerHub { + optionalCredentials() + } + } + imageDefinitions.register("main") { + allPlatforms { + parentImages { + add("library:eclipse-temurin:21.0.2_13-jre-jammy") + } + config { + creationTime = Instant.EPOCH + entryPoint = ["java", "-jar"] + entryPoint.add(tasks.named("jar").flatMap { it.archiveFileName }) + } + layers { + layer("app") { + contents { + from(tasks.named("jar")) + } + } + } + } + } +} + +testing { + suites { + test { + useJUnitJupiter() + dependencies { + implementation(libs.testcontainers) + implementation(libs.gradleOci.junitJupiter) + } + ociDependencies.forTestSuite(it) { + image.add(project).tag("latest") + } + } + } +} diff --git a/examples/java-app-groovy-dsl/gradle/libs.versions.toml b/examples/java-app-groovy-dsl/gradle/libs.versions.toml new file mode 100644 index 00000000..ec55e6f7 --- /dev/null +++ b/examples/java-app-groovy-dsl/gradle/libs.versions.toml @@ -0,0 +1,10 @@ +[versions] +gradleOci-junitJupiter = "0.4.0" +testcontainers = "1.19.7" + +[libraries] +gradleOci-junitJupiter = { module = "io.github.sgtsilvio:gradle-oci-junit-jupiter", version.ref = "gradleOci-junitJupiter" } +testcontainers = { module = "org.testcontainers:testcontainers", version.ref = "testcontainers" } + +[plugins] +oci = { id = "io.github.sgtsilvio.gradle.oci", version = "0.8.0" } diff --git a/examples/java-app-groovy-dsl/gradle/wrapper/gradle-wrapper.jar b/examples/java-app-groovy-dsl/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 00000000..d64cd491 Binary files /dev/null and b/examples/java-app-groovy-dsl/gradle/wrapper/gradle-wrapper.jar differ diff --git a/examples/java-app-groovy-dsl/gradle/wrapper/gradle-wrapper.properties b/examples/java-app-groovy-dsl/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 00000000..a80b22ce --- /dev/null +++ b/examples/java-app-groovy-dsl/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.6-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/examples/java-app-groovy-dsl/gradlew b/examples/java-app-groovy-dsl/gradlew new file mode 100755 index 00000000..1aa94a42 --- /dev/null +++ b/examples/java-app-groovy-dsl/gradlew @@ -0,0 +1,249 @@ +#!/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. +# + +############################################################################## +# +# 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/subprojects/plugins/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 "${APP_HOME:-./}" > /dev/null && pwd -P ) || 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=$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 + 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, 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" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# 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/java-app-groovy-dsl/gradlew.bat b/examples/java-app-groovy-dsl/gradlew.bat new file mode 100644 index 00000000..25da30db --- /dev/null +++ b/examples/java-app-groovy-dsl/gradlew.bat @@ -0,0 +1,92 @@ +@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 + +@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=%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 %* + +: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/java-app-groovy-dsl/settings.gradle b/examples/java-app-groovy-dsl/settings.gradle new file mode 100644 index 00000000..4175e69b --- /dev/null +++ b/examples/java-app-groovy-dsl/settings.gradle @@ -0,0 +1,5 @@ +pluginManagement { + includeBuild("../..") +} + +rootProject.name = "example-java-app" diff --git a/examples/java-app-groovy-dsl/src/main/java/org/example/java/app/Main.java b/examples/java-app-groovy-dsl/src/main/java/org/example/java/app/Main.java new file mode 100644 index 00000000..f964537c --- /dev/null +++ b/examples/java-app-groovy-dsl/src/main/java/org/example/java/app/Main.java @@ -0,0 +1,8 @@ +package org.example.java.app; + +public class Main { + public static void main(String[] args) { + System.out.println("Hello World!"); + System.out.println(System.getProperty("java.version")); + } +} diff --git a/examples/java-app-groovy-dsl/src/test/java/org/example/java/app/ImageTest.java b/examples/java-app-groovy-dsl/src/test/java/org/example/java/app/ImageTest.java new file mode 100644 index 00000000..874b210c --- /dev/null +++ b/examples/java-app-groovy-dsl/src/test/java/org/example/java/app/ImageTest.java @@ -0,0 +1,18 @@ +package org.example.java.app; + +import io.github.sgtsilvio.gradle.oci.junit.jupiter.OciImages; +import org.junit.jupiter.api.Test; +import org.testcontainers.containers.GenericContainer; +import org.testcontainers.containers.wait.strategy.Wait; + +class ImageTest { + + @Test + void start() { + try (final GenericContainer container = new GenericContainer(OciImages.getImageName("example/example-java-app"))) { + container.waitingFor(Wait.forLogMessage("Hello World!\n", 1)); + container.withLogConsumer(outputFrame -> System.out.println(outputFrame.getUtf8StringWithoutLineEnding())); + container.start(); + } + } +} diff --git a/examples/java-app/README.md b/examples/java-app/README.md new file mode 100644 index 00000000..e4347ecc --- /dev/null +++ b/examples/java-app/README.md @@ -0,0 +1,33 @@ +# Gradle OCI Plugin Example: Java Application + +This example project produces a Java application that prints "Hello World!" and the Java version. + +The application is bundled as an OCI/Docker image by using the Gradle OCI Plugin. +Look at the OCI image definition in [build.gradle.kts](build.gradle.kts). + +This example gives you two options to use the created OCI image: +- Run the image as a test container in a JUnit test (Look at the code [here](src/test/java/org/example/java/app/ImageTest.java)): + ```shell + ./gradlew test + ``` +- Push the image to a registry: + - To push to DockerHub, set the `dockerHubUsername` and `dockerHubPassword` Gradle properties to your DockerHub credentials (for example in `~/.gradle.properties`) and replace `` in the following command: + ```shell + ./gradlew pushOciImage --registry dockerHub --name /example-java-app + ``` + - To push to any registry, specify the `-url` option: + ```shell + ./gradlew pushOciImage --url https://my-registry.example.org + ``` + - To push to any registry that requires credentials, also specify the `--credentials` option and setup the required Gradle properties (`myRegUsername` and `myRegPassword` in this example): + ```shell + ./gradlew pushOciImage --url https://my-registry.example.org --credentials myReg + ``` + - You can specify the OCI image's name and tag in the registry with the `--name` and `--tag` options: + ```shell + ./gradlew pushOciImage --url https://my-registry.example.org --name oci-demo-app --tag 123 --tag latest + ``` + - Run the following to get an overview and a description of all available options: + ```shell + ./gradlew help --task pushOciImage + ``` diff --git a/examples/java-app/build.gradle.kts b/examples/java-app/build.gradle.kts new file mode 100644 index 00000000..74738381 --- /dev/null +++ b/examples/java-app/build.gradle.kts @@ -0,0 +1,65 @@ +import java.time.Instant + +plugins { + java + alias(libs.plugins.oci) +} + +group = "org.example" +version = "1.0.0" + +java { + toolchain { + languageVersion = JavaLanguageVersion.of(11) + } +} + +tasks.jar { + manifest.attributes["Main-Class"] = "org.example.java.app.Main" +} + +repositories { + mavenCentral() +} + +oci { + registries { + dockerHub { + optionalCredentials() + } + } + imageDefinitions.register("main") { + allPlatforms { + parentImages { + add("library:eclipse-temurin:21.0.2_13-jre-jammy") + } + config { + creationTime = Instant.EPOCH + entryPoint = listOf("java", "-jar") + entryPoint.add(tasks.jar.flatMap { it.archiveFileName }) + } + layers { + layer("app") { + contents { + from(tasks.jar) + } + } + } + } + } +} + +testing { + suites { + "test"(JvmTestSuite::class) { + useJUnitJupiter() + dependencies { + implementation(libs.testcontainers) + implementation(libs.gradleOci.junitJupiter) + } + ociDependencies { + image(project).tag("latest") + } + } + } +} diff --git a/examples/java-app/gradle/libs.versions.toml b/examples/java-app/gradle/libs.versions.toml new file mode 100644 index 00000000..ec55e6f7 --- /dev/null +++ b/examples/java-app/gradle/libs.versions.toml @@ -0,0 +1,10 @@ +[versions] +gradleOci-junitJupiter = "0.4.0" +testcontainers = "1.19.7" + +[libraries] +gradleOci-junitJupiter = { module = "io.github.sgtsilvio:gradle-oci-junit-jupiter", version.ref = "gradleOci-junitJupiter" } +testcontainers = { module = "org.testcontainers:testcontainers", version.ref = "testcontainers" } + +[plugins] +oci = { id = "io.github.sgtsilvio.gradle.oci", version = "0.8.0" } diff --git a/examples/java-app/gradle/wrapper/gradle-wrapper.jar b/examples/java-app/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 00000000..d64cd491 Binary files /dev/null and b/examples/java-app/gradle/wrapper/gradle-wrapper.jar differ diff --git a/examples/java-app/gradle/wrapper/gradle-wrapper.properties b/examples/java-app/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 00000000..a80b22ce --- /dev/null +++ b/examples/java-app/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.6-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/examples/java-app/gradlew b/examples/java-app/gradlew new file mode 100755 index 00000000..1aa94a42 --- /dev/null +++ b/examples/java-app/gradlew @@ -0,0 +1,249 @@ +#!/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. +# + +############################################################################## +# +# 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/subprojects/plugins/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 "${APP_HOME:-./}" > /dev/null && pwd -P ) || 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=$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 + 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, 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" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# 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/java-app/gradlew.bat b/examples/java-app/gradlew.bat new file mode 100644 index 00000000..25da30db --- /dev/null +++ b/examples/java-app/gradlew.bat @@ -0,0 +1,92 @@ +@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 + +@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=%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 %* + +: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/java-app/settings.gradle.kts b/examples/java-app/settings.gradle.kts new file mode 100644 index 00000000..4175e69b --- /dev/null +++ b/examples/java-app/settings.gradle.kts @@ -0,0 +1,5 @@ +pluginManagement { + includeBuild("../..") +} + +rootProject.name = "example-java-app" diff --git a/examples/java-app/src/main/java/org/example/java/app/Main.java b/examples/java-app/src/main/java/org/example/java/app/Main.java new file mode 100644 index 00000000..f964537c --- /dev/null +++ b/examples/java-app/src/main/java/org/example/java/app/Main.java @@ -0,0 +1,8 @@ +package org.example.java.app; + +public class Main { + public static void main(String[] args) { + System.out.println("Hello World!"); + System.out.println(System.getProperty("java.version")); + } +} diff --git a/examples/java-app/src/test/java/org/example/java/app/ImageTest.java b/examples/java-app/src/test/java/org/example/java/app/ImageTest.java new file mode 100644 index 00000000..874b210c --- /dev/null +++ b/examples/java-app/src/test/java/org/example/java/app/ImageTest.java @@ -0,0 +1,18 @@ +package org.example.java.app; + +import io.github.sgtsilvio.gradle.oci.junit.jupiter.OciImages; +import org.junit.jupiter.api.Test; +import org.testcontainers.containers.GenericContainer; +import org.testcontainers.containers.wait.strategy.Wait; + +class ImageTest { + + @Test + void start() { + try (final GenericContainer container = new GenericContainer(OciImages.getImageName("example/example-java-app"))) { + container.waitingFor(Wait.forLogMessage("Hello World!\n", 1)); + container.withLogConsumer(outputFrame -> System.out.println(outputFrame.getUtf8StringWithoutLineEnding())); + container.start(); + } + } +}