diff --git a/.sdkmanrc b/.sdkmanrc new file mode 100644 index 0000000..d6ecb8c --- /dev/null +++ b/.sdkmanrc @@ -0,0 +1,2 @@ +java=25.0.1-amzn +gradle=9.4.0 diff --git a/README.md b/README.md index abd813f..1a06d54 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,9 @@ Clone this project in order to create your own jPOS based application. +The template ships with a `.sdkmanrc` file that pins Java 25.0.1-amzn and Gradle 9.4.0 so every shell can run `sdk env install && sdk env` to reproduce the toolchain. +It also applies the published `org.jpos.jposapp` Gradle plugin (v0.0.16), which replaces the legacy `jpos-app.gradle` helper and provides the `installApp`, `dist`, `distnc`, `zip`, and `run` tasks out of the box. + We recommend that you install [Gradle](http://gradle.org/) in order to build your jPOS projects, but if you don't have it installed, you can use the Gradle wrapper scripts `gradlew` and `gradlew.bat`. In the following instructions, when we say `gradle` we really mean either your installed Gradle or one of the wrapper scripts (depending if you are on Unix or DOS based platforms). ### Build an eclipse project diff --git a/build.gradle b/build.gradle index c479604..d38a80f 100644 --- a/build.gradle +++ b/build.gradle @@ -1,23 +1,30 @@ -apply plugin: 'java-library' -apply plugin: 'maven-publish' -apply plugin: 'idea' -apply plugin: 'eclipse' +plugins { + id 'java-library' + id 'maven-publish' + id 'idea' + id 'eclipse' + id 'org.jpos.jposapp' version '0.0.16' +} group = 'org.jpos.template' version = '3.0.1-SNAPSHOT' -sourceCompatibility = 25 -targetCompatibility = 25 + +java { + toolchain { + languageVersion = JavaLanguageVersion.of(25) + } +} repositories { mavenCentral() maven { url = uri('https://jpos.org/maven') } mavenLocal() - } dependencies { implementation 'org.jpos:jpos:3.0.1-SNAPSHOT' } -apply from: 'jpos-app.gradle' - +jpos { + distDir.set('src/dist') +} diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar index 41d9927..d997cfc 100644 Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index d6e308a..dbc3ce4 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,5 +1,7 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-8.12-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-9.4.0-bin.zip +networkTimeout=10000 +validateDistributionUrl=true zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew index 1b6c787..0262dcb 100755 --- a/gradlew +++ b/gradlew @@ -1,7 +1,7 @@ #!/bin/sh # -# Copyright © 2015-2021 the original authors. +# 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. @@ -15,6 +15,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +# SPDX-License-Identifier: Apache-2.0 +# ############################################################################## # @@ -55,7 +57,7 @@ # Darwin, MinGW, and NonStop. # # (3) This script is generated from the Groovy template -# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# https://github.com/gradle/gradle/blob/b631911858264c0b6e4d6603d677ff5218766cee/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt # within the Gradle project. # # You can find Gradle at https://github.com/gradle/gradle/. @@ -80,13 +82,11 @@ do esac done -APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit - -APP_NAME="Gradle" +# This is normally unused +# shellcheck disable=SC2034 APP_BASE_NAME=${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='"-Xmx64m" "-Xms64m"' +# 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 @@ -114,7 +114,6 @@ case "$( uname )" in #( NONSTOP* ) nonstop=true ;; esac -CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar # Determine the Java command to use to start the JVM. @@ -133,22 +132,29 @@ 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. + 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 @@ -165,7 +171,6 @@ fi # 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" ) @@ -193,18 +198,27 @@ if "$cygwin" || "$msys" ; then done fi -# Collect all arguments for the java command; -# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of -# shell script including quotes and variable substitutions, so put them in -# double quotes to make sure that they get re-expanded; and -# * put everything else in single quotes, so that it's not re-expanded. + +# 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" \ - org.gradle.wrapper.GradleWrapperMain \ + -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. diff --git a/gradlew.bat b/gradlew.bat index ac1b06f..e509b2d 100644 --- a/gradlew.bat +++ b/gradlew.bat @@ -13,8 +13,10 @@ @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 +@if "%DEBUG%"=="" @echo off @rem ########################################################################## @rem @rem Gradle startup script for Windows @@ -25,7 +27,8 @@ if "%OS%"=="Windows_NT" setlocal set DIRNAME=%~dp0 -if "%DIRNAME%" == "" set DIRNAME=. +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused set APP_BASE_NAME=%~n0 set APP_HOME=%DIRNAME% @@ -40,13 +43,13 @@ if defined JAVA_HOME goto findJavaFromJavaHome set JAVA_EXE=java.exe %JAVA_EXE% -version >NUL 2>&1 -if "%ERRORLEVEL%" == "0" goto execute +if %ERRORLEVEL% equ 0 goto execute -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. +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 @@ -56,32 +59,33 @@ set JAVA_EXE=%JAVA_HOME%/bin/java.exe if exist "%JAVA_EXE%" goto execute -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. +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 %* +"%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%"=="0" goto mainEnd +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! -if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 -exit /b 1 +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 diff --git a/jpos-app.gradle b/jpos-app.gradle deleted file mode 100644 index c26cf6f..0000000 --- a/jpos-app.gradle +++ /dev/null @@ -1,262 +0,0 @@ -String archiveJarName="${project.name}-${project.version}.jar" -String archiveWarName="${project.name}-${project.version}.war" -String installDir=file("${project.buildDir}/install/${project.name}") -project.ext { - def target = project.hasProperty('target') ? target : 'devel' - targetConfiguration = configure(new Properties()) { - jarname = archiveJarName - warname = archiveWarName - target = target - buildTimestamp = new Date().format("yyyy-MM-dd HH:mm:ss z") - } - File cfgFile = file("${rootProject.projectDir}/${target}.properties") - if (cfgFile.exists()) { - cfgFile.withInputStream{ - targetConfiguration.load(it); - } - } -} - -// We build a CopySpec for consistency -def jposCopySpec = copySpec { - from(file("src/dist")) { - exclude 'cfg/*.lmk' - exclude 'cfg/*.jks' - exclude 'cfg/*.ks' - exclude 'cfg/*.ser' - exclude 'cfg/authorized_keys' - exclude '**/*.jpg' - exclude '**/*.gif' - exclude '**/*.png' - exclude '**/*.pdf' - exclude '**/*.ico' - exclude '**/*.war' - exclude '**/*.dat' - filter( - org.apache.tools.ant.filters.ReplaceTokens, - tokens: targetConfiguration - ) - } - from(file("src/dist")) { - include 'cfg/*.lmk' - include 'cfg/*.ks' - include 'cfg/*.jks' - include 'cfg/*.ser' - include 'cfg/authorized_keys' - fileMode 0600 - } - from(file("src/dist")) { - include '**/*.jpg' - include '**/*.gif' - include '**/*.png' - include '**/*.pdf' - include '**/*.ico' - include '**/*.war' - include '**/*.dat' - } - from(jar) { - rename archiveJarName, "${targetConfiguration.jarname}" - } - into("lib") { - from(configurations.runtimeClasspath) - } - into("webapps") { - from(file("build/libs")) { - include '*.war' - } - } -} - -def jposNoConfigCopySpec = copySpec { - from(jar) { - rename archiveJarName, "${targetConfiguration.jarname}" - } - into("lib") { - from(configurations.runtimeClasspath) - } -} - -// Create the jar's manifest -jar.manifest { - attributes \ - 'Implementation-Title': project.name, - 'Implementation-Version': project.version, - 'Main-Class': 'org.jpos.q2.Q2', - 'Class-Path': configurations.runtimeClasspath.collect { "lib/" + it.getName() }.join(' ') -} - -task sourceJar( type: Jar ) { - archiveClassifier.set("sources") - from sourceSets.main.allSource -} - -task javadocJar (type: Jar, dependsOn: javadoc) { - archiveClassifier.set("javadoc") - from new File(project.buildDir, 'docs/javadoc') -} - -artifacts { - archives sourceJar, javadocJar -} - -processResources { - from(sourceSets.main.resources.srcDirs) { - include '**/*.properties' - include '**/*.xml' - include '**/*.cfg' - include '**/*.asc' - filter( - org.apache.tools.ant.filters.ReplaceTokens, - tokens: targetConfiguration - ) - duplicatesStrategy = DuplicatesStrategy.INCLUDE - } -} -//-------------------------------------------------- -// TASKS -//-------------------------------------------------- - -task version (type: JavaExec, dependsOn: classes) { - description = "Shows jPOS Version" - mainClass = 'org.jpos.q2.Q2' - args = ['--version'] - classpath = sourceSets.main.runtimeClasspath -} - -task dist(type: Tar) { - dependsOn 'assemble', 'sourceJar' - description 'Creates tar distribution' - compression = Compression.GZIP - includeEmptyDirs true - into "$project.name-$project.version" - with jposCopySpec - archiveExtension="tar.gz" -} - -task distnc (type: Tar) { - dependsOn 'assemble', 'sourceJar' - description 'Creates tar distribution without configuration' - compression = Compression.GZIP - includeEmptyDirs true - into "$project.name-$project.version" - with jposNoConfigCopySpec - archiveExtension="tar.gz" - archiveAppendix = "nc" -} - -task zip(type: Zip) { - dependsOn 'assemble', 'sourceJar' - description 'Creates zip distribution' - includeEmptyDirs true - into "$project.name-$project.version" - with jposCopySpec -} - -task installApp(type: Sync) { - description 'Installs jPOS based application' - into { installDir } - with jposCopySpec -} - -task installResources(dependsOn: 'classes', type: JavaExec) { - classpath = sourceSets.main.runtimeClasspath - mainClass = 'org.jpos.q2.install.Install' - args = ["--outputDir=src/dist"] -} - -task run( dependsOn: 'installApp', type: Exec ) { - workingDir installDir - commandLine 'java','-jar', archiveJarName -} - -/* -task genDocker(type: Docker, dependsOn: 'jar') { - def projectName = project.name - applicationName = "${projectName}" - workingDir "/app" - addFile { - into('/app') { - with(jposCopySpec) - } - } - defaultCommand = ["/app/bin/q2"] -} -*/ - -class GitRevisionTask extends DefaultTask -{ - @InputFile @Optional - File gitHead - - @Input - boolean gotHead - - @InputFile @Optional - File getRefFile() { - if (gitHead != null) { - File rf = new File(gitHead.parent,gitHead.text.replace('ref: ', '').trim()) - return rf.exists() ? rf : gitHead - } else { - return gitHead - } - } - - @OutputFile - File outputFile - - @TaskAction - public void writeFile() - { - Properties props=new Properties() - if (gotHead) { - File ref=getRefFile() - if (ref != null && ref.exists()) { - props.put("branch",ref.getName()) - props.put("revision",ref.text.substring(0,7)) - } else { - props.put("branch", "detached"); - props.put("revision", gitHead.text.substring(0,7)) - } - } else { - props.put("branch", "unknown"); - props.put("revision", "unknown"); - } - props.store(new FileOutputStream(outputFile),"Revision Properties") - } -} - -class BuildTimestampTask extends DefaultTask { - @OutputFile - File outputFile - - @TaskAction - public void writeFile() { - new File(outputFile.parent).mkdirs() - Properties props=new Properties() - props.put("version", project.version); - props.put("buildTimestamp", new Date().format("yyyy-MM-dd HH:mm:ss z")); - props.store(new FileOutputStream(outputFile),"Revision Properties") - } -} - -task createBuildTimestampPropertyFile(type: BuildTimestampTask) { - outputFile = "$sourceSets.main.output.resourcesDir/buildinfo.properties" as File -} - -task createRevisionPropertyFile(type: GitRevisionTask) { - gitHead = "$rootDir/.git/HEAD" as File - gotHead = gitHead.exists() - if (!gotHead) - gitHead = null; - outputFile = "$sourceSets.main.output.resourcesDir/revision.properties" as File -} - -processResources.dependsOn createBuildTimestampPropertyFile, createRevisionPropertyFile - -task viewTests (description: 'Open Test Reports') { - doLast { - Class.forName("java.awt.Desktop").newInstance().browse( - new File("${buildDir}/reports/tests/test", 'index.html').toURI()) - } -} -