1 #!/bin/bash
   2 
   3 #
   4 # Script to run jpackage tests.
   5 #
   6 
   7 
   8 # Fail fast
   9 set -e; set -o pipefail;
  10 
  11 # $JT_BUNDLE_URL (Link can be obtained from https://openjdk.java.net/jtreg/ page)
  12 jtreg_bundle=$JT_BUNDLE_URL
  13 workdir=/tmp/jpackage_jtreg_testing
  14 jtreg_jar=$workdir/jtreg/lib/jtreg.jar
  15 jpackage_test_selector=test/jdk/tools/jpackage
  16 
  17 
  18 find_packaging_tests ()
  19 {
  20   (cd "$open_jdk_with_jpackage_jtreg_tests" && \
  21     find "$jpackage_test_selector/$1" -type f -name '*.java' \
  22     | xargs grep -E -l '@key[[:space:]]+jpackagePlatformPackage')
  23 }
  24 
  25 
  26 find_all_packaging_tests ()
  27 {
  28   find_packaging_tests share
  29   case "$(uname -s)" in
  30     Darwin)
  31       find_packaging_tests macosx;;
  32     Linux)
  33       find_packaging_tests linux;;
  34     CYGWIN*|MINGW32*|MSYS*)
  35       find_packaging_tests windows;;
  36     *)
  37       fatal Failed to detect OS type;;
  38   esac
  39 }
  40 
  41 
  42 help_usage ()
  43 {
  44   echo "Usage: `basename $0` [options] [--] [jtreg_options|test_names]"
  45   echo "Options:"
  46   echo "  -h              - print this message"
  47   echo "  -v              - verbose output"
  48   echo "  -c              - keep jtreg cache"
  49   echo "  -a              - run all, not only SQE tests"
  50   echo "  -d              - dry run. Print jtreg command line, but don't execute it"
  51   echo "  -t <jdk>        - path to JDK to be tested [ mandatory ]"
  52   echo "  -j <openjdk>    - path to local copy of openjdk repo with jpackage jtreg tests"
  53   echo "                    Optional, default is openjdk repo where this script resides"
  54   echo "  -o <outputdir>  - path to folder where to copy artifacts for testing."
  55   echo "                    Optional, default is the current directory."
  56   echo '  -r <runtimedir> - value for `jpackage.test.runtime-image` property.'
  57   echo "                    Optional, for jtreg tests debug purposes only."
  58   echo '  -l <logfile>    - value for `jpackage.test.logfile` property.'
  59   echo "                    Optional, for jtreg tests debug purposes only."
  60   echo "  -m <mode>       - mode to run jtreg tests."
  61   echo '                    Should be one of `create`, `update` or `print-default-tests`.'
  62   echo '                    Optional, default mode is `update`.'
  63   echo '                    - `create`'
  64   echo '                      Remove all package bundles from the output directory before running jtreg tests.'
  65   echo '                    - `update`'
  66   echo '                      Run jtreg tests and overrite existing package bundles in the output directory.'
  67   echo '                    - `print-default-tests`'
  68   echo '                      Print default list of packaging tests and exit.'
  69 }
  70 
  71 error ()
  72 {
  73   echo "$@" > /dev/stderr
  74 }
  75 
  76 fatal ()
  77 {
  78   error "$@"
  79   exit 1
  80 }
  81 
  82 fatal_with_help_usage ()
  83 {
  84   error "$@"
  85   help_usage
  86   exit 1
  87 }
  88 
  89 if command -v cygpath &> /dev/null; then
  90 to_native_path ()
  91 {
  92   cygpath -m "$@"
  93 }
  94 else
  95 to_native_path ()
  96 {
  97   echo "$@"
  98 }
  99 fi
 100 
 101 exec_command ()
 102 {
 103   if [ -n "$dry_run" ]; then
 104     echo "$@"
 105   else
 106     eval "$@"
 107   fi
 108 }
 109 
 110 
 111 # Path to JDK to be tested.
 112 test_jdk=
 113 
 114 # Path to local copy of open jdk repo with jpackage jtreg tests
 115 # hg clone http://hg.openjdk.java.net/jdk/sandbox
 116 # cd sandbox; hg update -r JDK-8200758-branch
 117 open_jdk_with_jpackage_jtreg_tests=$(dirname $0)/../../../../
 118 
 119 # Directory where to save artifacts for testing.
 120 output_dir=$PWD
 121 
 122 # Script and jtreg debug.
 123 verbose=
 124 jtreg_verbose="-verbose:fail,error,summary"
 125 
 126 keep_jtreg_cache=
 127 
 128 # Mode in which to run jtreg tests
 129 mode=update
 130 
 131 # jtreg extra arguments
 132 declare -a jtreg_args
 133 
 134 # Create packages only
 135 jtreg_args+=("-Djpackage.test.action=create")
 136 
 137 # run all tests
 138 run_all_tests=
 139 
 140 mapfile -t tests < <(find_all_packaging_tests)
 141 
 142 while getopts "vahdct:j:o:r:m:l:" argname; do
 143   case "$argname" in
 144     v) verbose=yes;;
 145     a) run_all_tests=yes;;
 146     d) dry_run=yes;;
 147     c) keep_jtreg_cache=yes;;
 148     t) test_jdk="$OPTARG";;
 149     j) open_jdk_with_jpackage_jtreg_tests="$OPTARG";;
 150     o) output_dir="$OPTARG";;
 151     r) runtime_dir="$OPTARG";;
 152     l) logfile="$OPTARG";;
 153     m) mode="$OPTARG";;
 154     h) help_usage; exit 0;;
 155     ?) help_usage; exit 1;;
 156   esac
 157 done
 158 shift $(( OPTIND - 1 ))
 159 
 160 [ -z "$verbose" ] || { set -x; jtreg_verbose=-va; }
 161 
 162 if [ -z "$open_jdk_with_jpackage_jtreg_tests" ]; then
 163   fatal_with_help_usage "Path to openjdk repo with jpackage jtreg tests not specified"
 164 fi
 165 
 166 if [ "$mode" = "print-default-tests" ]; then
 167   exec_command for t in ${tests[@]}";" do echo '$t;' done
 168   exit
 169 fi
 170 
 171 if [ -z "$test_jdk" ]; then
 172   fatal_with_help_usage Path to test JDK not specified
 173 fi
 174 
 175 if [ -z "$JAVA_HOME" ]; then
 176   echo JAVA_HOME environment variable not set, will use java from test JDK [$test_jdk] to run jtreg
 177   JAVA_HOME="$test_jdk"
 178 fi
 179 if [ ! -e "$JAVA_HOME/bin/java" ]; then
 180   fatal JAVA_HOME variable is set to [$JAVA_HOME] value, but $JAVA_HOME/bin/java not found.
 181 fi
 182 
 183 if [ -z "$JT_HOME" ]; then
 184   if [ -z "$JT_BUNDLE_URL" ]; then
 185     fatal 'JT_HOME or JT_BUNDLE_URL environment variable is not set. Link to JTREG bundle can be found at https://openjdk.java.net/jtreg/'.
 186   fi
 187 fi
 188 
 189 if [ -n "$runtime_dir" ]; then
 190   if [ ! -d "$runtime_dir" ]; then
 191     fatal 'Value of `-r` option is set to non-existing directory'.
 192   fi
 193   jtreg_args+=("-Djpackage.test.runtime-image=$(to_native_path "$(cd "$runtime_dir" && pwd)")")
 194 fi
 195 
 196 if [ -n "$logfile" ]; then
 197   if [ ! -d "$(dirname "$logfile")" ]; then
 198     fatal 'Value of `-l` option specified a file in non-existing directory'.
 199   fi
 200   logfile="$(cd "$(dirname "$logfile")" && pwd)/$(basename "$logfile")"
 201   jtreg_args+=("-Djpackage.test.logfile=$(to_native_path "$logfile")")
 202 fi
 203 
 204 if [ "$mode" = create ]; then
 205   true
 206 elif [ "$mode" = update ]; then
 207   true
 208 else
 209   fatal_with_help_usage 'Invalid value of -m option:' [$mode]
 210 fi
 211 
 212 if [ -z "$run_all_tests" ]; then
 213   jtreg_args+=(-Djpackage.test.SQETest=yes)
 214 fi
 215 
 216 # Drop arguments separator
 217 [ "$1" != "--" ] || shift
 218 
 219 # All remaining command line arguments are tests to run
 220 # that should override the defaults and explicit jtreg arguments
 221 [ $# -eq 0 ] || tests=($@)
 222 
 223 
 224 installJtreg ()
 225 {
 226   # Install jtreg if missing
 227   if [ -z "$JT_HOME" ]; then
 228     if [ ! -f "$jtreg_jar" ]; then
 229       exec_command mkdir -p "$workdir"
 230       if [[ ${jtreg_bundle: -7} == ".tar.gz" ]]; then
 231         exec_command "(" cd "$workdir" "&&" wget "$jtreg_bundle" "&&" tar -xzf "$(basename $jtreg_bundle)" ";" rm -f "$(basename $jtreg_bundle)" ")"
 232       else
 233         if [[ ${jtreg_bundle: -4} == ".zip" ]]; then
 234           exec_command "(" cd "$workdir" "&&" wget "$jtreg_bundle" "&&" unzip "$(basename $jtreg_bundle)" ";" rm -f "$(basename $jtreg_bundle)" ")"
 235         else
 236           fatal 'Unsupported extension of JREG bundle ['$JT_BUNDLE_URL']. Only *.zip or *.tar.gz is supported.'
 237         fi
 238       fi
 239     fi
 240   else
 241     # use jtreg provided via JT_HOME
 242     jtreg_jar=$JT_HOME/lib/jtreg.jar
 243   fi
 244 
 245   echo 'jtreg jar file: '$jtreg_jar
 246 }
 247 
 248 
 249 preRun ()
 250 {
 251   local xargs_args=(-t --no-run-if-empty rm)
 252   if [ -n "$dry_run" ]; then
 253     xargs_args=(--no-run-if-empty echo rm)
 254   fi
 255 
 256   if [ ! -d "$output_dir" ]; then
 257     exec_command mkdir -p "$output_dir"
 258   fi
 259   [ ! -d "$output_dir" ] || output_dir=$(cd "$output_dir" && pwd)
 260 
 261   # Clean output directory
 262   [ "$mode" != "create" ] || find $output_dir -maxdepth 1 -type f -name '*.exe' -or -name '*.msi' -or -name '*.rpm' -or -name '*.deb' | xargs "${xargs_args[@]}"
 263 }
 264 
 265 
 266 run ()
 267 {
 268   local jtreg_cmdline=(\
 269     $JAVA_HOME/bin/java -jar $(to_native_path "$jtreg_jar") \
 270     "-Djpackage.test.output=$(to_native_path "$output_dir")" \
 271     "${jtreg_args[@]}" \
 272     -nr \
 273     "$jtreg_verbose" \
 274     -retain:all \
 275     -automatic \
 276     -ignore:run \
 277     -testjdk:"$(to_native_path $test_jdk)" \
 278     -dir:"$(to_native_path $open_jdk_with_jpackage_jtreg_tests)" \
 279     -reportDir:"$(to_native_path $workdir/run/results)" \
 280     -workDir:"$(to_native_path $workdir/run/support)" \
 281     "${tests[@]}" \
 282   )
 283 
 284   # Clear previous results
 285   [ -n "$keep_jtreg_cache" ] || exec_command rm -rf "$workdir"/run
 286 
 287   # Run jpackage jtreg tests to create artifacts for testing
 288   exec_command ${jtreg_cmdline[@]}
 289 }
 290 
 291 
 292 installJtreg
 293 preRun
 294 run