| #!/bin/bash | |
| # Copyright (c) 2020, 2022, Oracle and/or its affiliates. All rights reserved. | |
| # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. | |
| # | |
| # This code is free software; you can redistribute it and/or modify it | |
| # under the terms of the GNU General Public License version 2 only, as | |
| # published by the Free Software Foundation. | |
| # | |
| # This code is distributed in the hope that it will be useful, but WITHOUT | |
| # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| # version 2 for more details (a copy is included in the LICENSE file that | |
| # accompanied this code). | |
| # | |
| # You should have received a copy of the GNU General Public License version | |
| # 2 along with this work; if not, write to the Free Software Foundation, | |
| # Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. | |
| # | |
| # Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA | |
| # or visit www.oracle.com if you need additional information or have any | |
| # questions. | |
| # | |
| # Script to run jpackage tests. | |
| # | |
| # Fail fast | |
| set -e; set -o pipefail; | |
| # $JT_BUNDLE_URL (Link can be obtained from https://openjdk.org/jtreg/ page) | |
| jtreg_bundle=$JT_BUNDLE_URL | |
| workdir=/tmp/jpackage_jtreg_testing | |
| jtreg_jar=$workdir/jtreg/lib/jtreg.jar | |
| jpackage_test_selector=test/jdk/tools/jpackage | |
| find_packaging_tests () | |
| { | |
| (cd "$open_jdk_with_jpackage_jtreg_tests" && \ | |
| find "$jpackage_test_selector/$1" -type f -name '*.java' \ | |
| | xargs grep -E -l '@key[[:space:]]+jpackagePlatformPackage') | |
| } | |
| find_all_packaging_tests () | |
| { | |
| find_packaging_tests share | |
| case "$(uname -s)" in | |
| Darwin) | |
| find_packaging_tests macosx;; | |
| Linux) | |
| find_packaging_tests linux;; | |
| CYGWIN*|MINGW32*|MSYS*) | |
| find_packaging_tests windows;; | |
| *) | |
| fatal Failed to detect OS type;; | |
| esac | |
| } | |
| help_usage () | |
| { | |
| echo "Usage: `basename $0` [options] [--] [jtreg_options|test_names]" | |
| echo "Options:" | |
| echo " -h - print this message" | |
| echo " -v - verbose output" | |
| echo " -c - keep jtreg cache" | |
| echo " -a - run all, not only SQE tests" | |
| echo " -d - dry run. Print jtreg command line, but don't execute it" | |
| echo " -t <jdk> - path to JDK to be tested [ mandatory ]" | |
| echo " -j <openjdk> - path to local copy of openjdk repo with jpackage jtreg tests" | |
| echo " Optional, default is openjdk repo where this script resides" | |
| echo " -o <outputdir> - path to folder where to copy artifacts for testing." | |
| echo " Optional, default is the current directory." | |
| echo ' -r <runtimedir> - value for `jpackage.test.runtime-image` property.' | |
| echo " Optional, for jtreg tests debug purposes only." | |
| echo ' -l <logfile> - value for `jpackage.test.logfile` property.' | |
| echo " Optional, for jtreg tests debug purposes only." | |
| echo " -m <mode> - mode to run jtreg tests. Supported values:" | |
| echo ' - `create`' | |
| echo ' Remove all package bundles from the output directory before running jtreg tests.' | |
| echo ' - `update`' | |
| echo ' Run jtreg tests and overrite existing package bundles in the output directory.' | |
| echo ' - `print-default-tests`' | |
| echo ' Print default list of packaging tests and exit.' | |
| echo ' - `create-small-runtime`' | |
| echo ' Create small Java runtime using <jdk>/bin/jlink command in the output directory.' | |
| echo ' - `create-packages`' | |
| echo ' Create packages.' | |
| echo ' The script will set `jpackage.test.action` property.' | |
| echo ' - `test-packages`' | |
| echo ' Create and fully test packages. Will create, unpack, install, and uninstall packages.' | |
| echo ' The script will set `jpackage.test.action` property.' | |
| echo ' - `do-packages`' | |
| echo " Create, unpack and verify packages." | |
| echo ' The script will not set `jpackage.test.action` property.' | |
| echo ' Optional, defaults are `update` and `create-packages`.' | |
| } | |
| error () | |
| { | |
| echo "$@" > /dev/stderr | |
| } | |
| fatal () | |
| { | |
| error "$@" | |
| exit 1 | |
| } | |
| fatal_with_help_usage () | |
| { | |
| error "$@" | |
| help_usage | |
| exit 1 | |
| } | |
| if command -v cygpath &> /dev/null; then | |
| to_native_path () | |
| { | |
| cygpath -m "$@" | |
| } | |
| else | |
| to_native_path () | |
| { | |
| echo "$@" | |
| } | |
| fi | |
| exec_command () | |
| { | |
| if [ -n "$dry_run" ]; then | |
| echo "$@" | |
| else | |
| eval "$@" | |
| fi | |
| } | |
| # Path to JDK to be tested. | |
| test_jdk= | |
| # Path to local copy of open jdk repo with jpackage jtreg tests | |
| open_jdk_with_jpackage_jtreg_tests=$(dirname $0)/../../../../ | |
| # Directory where to save artifacts for testing. | |
| output_dir=$PWD | |
| # Script and jtreg debug. | |
| verbose= | |
| jtreg_verbose="-verbose:fail,error,summary" | |
| keep_jtreg_cache= | |
| # Mode in which to run jtreg tests | |
| mode=update | |
| # jtreg extra arguments | |
| declare -a jtreg_args | |
| # run all tests | |
| run_all_tests= | |
| test_actions= | |
| set_mode () | |
| { | |
| case "$1" in | |
| create-packages) test_actions='-Djpackage.test.action=create';; | |
| test-packages) test_actions='-Djpackage.test.action=uninstall,create,unpack,verify-install,install,verify-install,uninstall,verify-uninstall,purge';; | |
| do-packages) test_actions=;; | |
| create-small-runtime) mode=$1;; | |
| print-default-tests) mode=$1;; | |
| create) mode=$1;; | |
| update) mode=$1;; | |
| *) fatal_with_help_usage 'Invalid value of -m option:' [$1];; | |
| esac | |
| } | |
| set_mode 'create-packages' | |
| mapfile -t tests < <(find_all_packaging_tests) | |
| while getopts "vahdct:j:o:r:m:l:" argname; do | |
| case "$argname" in | |
| v) verbose=yes;; | |
| a) run_all_tests=yes;; | |
| d) dry_run=yes;; | |
| c) keep_jtreg_cache=yes;; | |
| t) test_jdk="$OPTARG";; | |
| j) open_jdk_with_jpackage_jtreg_tests="$OPTARG";; | |
| o) output_dir="$OPTARG";; | |
| r) runtime_dir="$OPTARG";; | |
| l) logfile="$OPTARG";; | |
| m) set_mode "$OPTARG";; | |
| h) help_usage; exit 0;; | |
| ?) help_usage; exit 1;; | |
| esac | |
| done | |
| shift $(( OPTIND - 1 )) | |
| [ -z "$verbose" ] || { set -x; jtreg_verbose=-va; } | |
| if [ -z "$open_jdk_with_jpackage_jtreg_tests" ]; then | |
| fatal_with_help_usage "Path to openjdk repo with jpackage jtreg tests not specified" | |
| fi | |
| if [ "$mode" = "print-default-tests" ]; then | |
| exec_command for t in ${tests[@]}";" do echo '$t;' done | |
| exit | |
| fi | |
| if [ -z "$test_jdk" ]; then | |
| fatal_with_help_usage Path to test JDK not specified | |
| fi | |
| if [ -z "$JAVA_HOME" ]; then | |
| echo JAVA_HOME environment variable not set, will use java from test JDK [$test_jdk] to run jtreg | |
| JAVA_HOME="$test_jdk" | |
| fi | |
| if [ ! -e "$JAVA_HOME/bin/java" ]; then | |
| fatal JAVA_HOME variable is set to [$JAVA_HOME] value, but $JAVA_HOME/bin/java not found. | |
| fi | |
| if [ "$mode" = "create-small-runtime" ]; then | |
| exec_command "$test_jdk/bin/jlink" --add-modules java.base,java.datatransfer,java.xml,java.prefs,java.desktop --compress=2 --no-header-files --no-man-pages --strip-debug --output "$output_dir" | |
| exit | |
| fi | |
| if [ -z "$JT_HOME" ]; then | |
| if [ -z "$JT_BUNDLE_URL" ]; then | |
| fatal 'JT_HOME or JT_BUNDLE_URL environment variable is not set. Link to JTREG bundle can be found at https://openjdk.org/jtreg/'. | |
| fi | |
| fi | |
| if [ -n "$runtime_dir" ]; then | |
| if [ ! -d "$runtime_dir" ]; then | |
| fatal 'Value of `-r` option is set to non-existing directory'. | |
| fi | |
| jtreg_args+=("-Djpackage.test.runtime-image=$(to_native_path "$(cd "$runtime_dir" && pwd)")") | |
| fi | |
| if [ -n "$logfile" ]; then | |
| if [ ! -d "$(dirname "$logfile")" ]; then | |
| fatal 'Value of `-l` option specified a file in non-existing directory'. | |
| fi | |
| logfile="$(cd "$(dirname "$logfile")" && pwd)/$(basename "$logfile")" | |
| jtreg_args+=("-Djpackage.test.logfile=$(to_native_path "$logfile")") | |
| fi | |
| if [ -z "$run_all_tests" ]; then | |
| jtreg_args+=(-Djpackage.test.SQETest=yes) | |
| fi | |
| if [ -n "$APPDATA" ]; then | |
| # Looks like this is Windows. | |
| # Explicitly add LOCALAPPDATA and APPDATA environment variables to the list | |
| # of environment variables jtreg will pass to tests as by default it will not. | |
| # This is needed for PerUserCfgTest test. | |
| jtreg_args+=("-e:LOCALAPPDATA,APPDATA") | |
| fi | |
| jtreg_args+=("$test_actions") | |
| # Drop arguments separator | |
| [ "$1" != "--" ] || shift | |
| # All remaining command line arguments are tests to run | |
| # that should override the defaults and explicit jtreg arguments | |
| [ $# -eq 0 ] || tests=($@) | |
| installJtreg () | |
| { | |
| # Install jtreg if missing | |
| if [ -z "$JT_HOME" ]; then | |
| if [ ! -f "$jtreg_jar" ]; then | |
| exec_command mkdir -p "$workdir" | |
| if [[ ${jtreg_bundle: -7} == ".tar.gz" ]]; then | |
| exec_command "(" cd "$workdir" "&&" wget --no-check-certificate "$jtreg_bundle" "&&" tar -xzf "$(basename $jtreg_bundle)" ";" rm -f "$(basename $jtreg_bundle)" ")" | |
| else | |
| if [[ ${jtreg_bundle: -4} == ".zip" ]]; then | |
| exec_command "(" cd "$workdir" "&&" wget --no-check-certificate "$jtreg_bundle" "&&" unzip "$(basename $jtreg_bundle)" ";" rm -f "$(basename $jtreg_bundle)" ")" | |
| else | |
| fatal 'Unsupported extension of JREG bundle ['$JT_BUNDLE_URL']. Only *.zip or *.tar.gz is supported.' | |
| fi | |
| fi | |
| fi | |
| else | |
| # use jtreg provided via JT_HOME | |
| jtreg_jar=$JT_HOME/lib/jtreg.jar | |
| fi | |
| echo 'jtreg jar file: '$jtreg_jar | |
| } | |
| preRun () | |
| { | |
| if [ ! -d "$output_dir" ]; then | |
| exec_command mkdir -p "$output_dir" | |
| fi | |
| [ ! -d "$output_dir" ] || output_dir=$(cd "$output_dir" && pwd) | |
| # Clean output directory | |
| if [ "$mode" == "create" ]; then | |
| for f in $(find $output_dir -maxdepth 1 -type f -name '*.exe' -or -name '*.msi' -or -name '*.rpm' -or -name '*.deb'); do | |
| echo rm "$f" | |
| [ -n "$dry_run" ] || rm "$f" | |
| done | |
| fi | |
| } | |
| run () | |
| { | |
| local jtreg_cmdline=(\ | |
| $JAVA_HOME/bin/java -jar $(to_native_path "$jtreg_jar") \ | |
| "-Djpackage.test.output=$(to_native_path "$output_dir")" \ | |
| "${jtreg_args[@]}" \ | |
| -nr \ | |
| "$jtreg_verbose" \ | |
| -retain:all \ | |
| -automatic \ | |
| -ignore:run \ | |
| -testjdk:"$(to_native_path $test_jdk)" \ | |
| -dir:"$(to_native_path $open_jdk_with_jpackage_jtreg_tests)" \ | |
| -reportDir:"$(to_native_path $workdir/run/results)" \ | |
| -workDir:"$(to_native_path $workdir/run/support)" \ | |
| "${tests[@]}" \ | |
| ) | |
| # Clear previous results | |
| [ -n "$keep_jtreg_cache" ] || exec_command rm -rf "$workdir"/run | |
| # Run jpackage jtreg tests to create artifacts for testing | |
| exec_command ${jtreg_cmdline[@]} | |
| } | |
| installJtreg | |
| preRun | |
| run |