#!/bin/sh

#
# Copyright (c) 2003, 2016, 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.
#

#
# @test
# @bug 4758537 4809833 8149599
# @summary Test that javac and java find files in similar ways
# @author Martin Buchholz
#
# @run shell/timeout=600 MineField.sh

# To run this test manually, simply do ./MineField.sh

#----------------------------------------------------------------
# The search order for classes used by both java and javac is:
#
# -Xbootclasspath/p:<path>
# -endorseddirs <dirs> or -Djava.endorsed.dirs=<dirs> (search for jar/zip only)
# -bootclasspath <path> or -Xbootclasspath:<path>
# -Xbootclasspath/a:<path>
# -extdirs <dirs> or -Djava.ext.dirs=<dirs> (search for jar/zip only)
# -classpath <path>, -cp <path>, env CLASSPATH=<path>
#
# Peculiarities of the class file search:
# - Empty elements of the (user) classpath default to ".",
#   while empty elements of other paths are ignored.
# - Only for the user classpath is an empty string value equivalent to "."
# - Specifying a bootclasspath on the command line obliterates any
#   previous -Xbootclasspath/p: or -Xbootclasspath/a: command line flags.
#
# JDK 9 update:
#   java: The java launcher does not support any of the following:
#       * -Xbootclasspath/p: -Xbootclasspath:
#       * -endorseddirs -Djava.endorsed.dirs
#       * -extdirs -Djava.ext.dirs
#       All test cases exercising these features have been removed.
#   javac: The following features are only supported when compiling
#       for older releases:
#       * -Xbootclasspath/p: -Xbootclasspath: -bootclasspath -Xbootclasspath/a:
#       * -endorseddirs -Djava.endorsed.dirs
#       * -extdirs -Djava.ext.dirs
#       All test cases exercising these features have been modified to
#       use -source 8 -target 8.  In addition, javac test cases involving
#       use of the runtime properties java.endorsed.dirs and java.extdirs
#       (by means of -J-Dname=value) have been removed.
#       Although the primary purpose of the test cases in this file is to
#       compare javac and java behavior, some tests remain for javac for
#       which there is no java equivalent. However, the cases remain as useful
#       test cases for javac handling of the paths involved.

#----------------------------------------------------------------

. ${TESTSRC-.}/Util.sh

set -u

#----------------------------------------------------------------
# Prepare the "Minefield"
#----------------------------------------------------------------
Cleanup() {
    Sys rm -rf GooSrc GooJar GooZip GooClass
    Sys rm -rf BadSrc BadJar BadZip BadClass
    Sys rm -rf OneDir *.class Main.java MANIFEST.MF
    Sys rm -f java-lang.jar
}

Cleanup
Sys mkdir  GooSrc GooJar GooZip GooClass
Sys mkdir  BadSrc BadJar BadZip BadClass

echo 'public class Lib {public static void f(){}}' > Lib.java
Sys "$javac" ${TESTTOOLVMOPTS} Lib.java
Sys "$jar" cf GooJar/Lib.jar Lib.class
Sys "$jar" cf GooZip/Lib.zip Lib.class
Sys mv Lib.class GooClass/.
Sys mv Lib.java GooSrc/.
CheckFiles GooZip/Lib.zip GooJar/Lib.jar GooSrc/Lib.java

echo 'public class Lib {/* Bad */}' > Lib.java
Sys "$javac" ${TESTTOOLVMOPTS} Lib.java
Sys "$jar" cf BadJar/Lib.jar Lib.class
Sys "$jar" cf BadZip/Lib.zip Lib.class
Sys mv Lib.class BadClass/.
Sys mv Lib.java BadSrc/.
CheckFiles BadZip/Lib.zip BadJar/Lib.jar BadSrc/Lib.java

echo 'public class Main {public static void main(String[] a) {Lib.f();}}' > Main.java

# Create a jar file that is good enough to put on the javac boot class path (i.e. contains java.lang.**)
if [ -r ${TESTJAVA}/lib/modules ]; then
  Sys "$jimage" extract --dir modules ${TESTJAVA}/lib/modules
  Sys "$jar" cf java-lang.jar -C modules/java.base java/lang
  Sys rm -rf modules
elif [ -d ${TESTJAVA}/modules ]; then
  Sys "$jar" cf java-lang.jar -C ${TESTJAVA}/modules/java.base java/lang
else
  echo 'cannot create java-lang.jar' ; exit 1
fi

#----------------------------------------------------------------
# Verify that javac class search order is the same as java's
#----------------------------------------------------------------
Failure "$javac" -source 8 -target 8 ${TESTTOOLVMOPTS} \
    -Xbootclasspath/p:"GooClass" \
    -bootclasspath "java-lang.jar${PS}BadZip/Lib.zip" \
    Main.java
Success "$javac" -source 8 -target 8 ${TESTTOOLVMOPTS} \
    -Xbootclasspath/p:"BadClass${PS}GooClass" \
    -bootclasspath "java-lang.jar${PS}GooZip/Lib.zip${PS}BadClass" \
    Main.java
Success "$javac" -source 8 -target 8 ${TESTTOOLVMOPTS} \
    -Xbootclasspath/p:"BadJar/Lib.jar" \
    -Xbootclasspath:"java-lang.jar${PS}GooClass" \
    Main.java

#----------------------------------------------------------------
Failure "$javac" -source 8 -target 8 ${TESTTOOLVMOPTS} \
    -bootclasspath "java-lang.jar${PS}GooZip/Lib.zip" \
    -Xbootclasspath/p:"BadClass" \
    Main.java
Success "$javac" -source 8 -target 8 ${TESTTOOLVMOPTS} \
    -bootclasspath "java-lang.jar${PS}BadZip/Lib.zip" \
    -Xbootclasspath/p:"GooClass${PS}BadJar/Lib.jar" \
    Main.java

#----------------------------------------------------------------
Failure "$javac" -source 8 -target 8 ${TESTTOOLVMOPTS} \
    -Xbootclasspath/p:"BadClass" \
    -Xbootclasspath/a:"GooClass" \
    Main.java
Success "$javac" -source 8 -target 8 ${TESTTOOLVMOPTS} \
    -Xbootclasspath/p:"GooClass${PS}BadClass" \
    -Xbootclasspath/a:"BadClass" \
    Main.java
Success "$java" ${TESTVMOPTS} \
    -Xbootclasspath/a:"GooClass" \
    Main

#----------------------------------------------------------------
Failure "$javac" -source 8 -target 8 ${TESTTOOLVMOPTS} \
    -Xbootclasspath/p:"GooClass" \
    -Xbootclasspath:"BadClass${PS}java-lang.jar" \
    -Xbootclasspath/a:"GooClass" \
    Main.java
Success "$javac" -source 8 -target 8 ${TESTTOOLVMOPTS} \
    -Xbootclasspath/p:"BadClass" \
    -Xbootclasspath:"GooClass${PS}BadClass${PS}java-lang.jar" \
    -Xbootclasspath/a:"BadClass" \
    Main.java

#----------------------------------------------------------------
Success "$javac" -source 8 -target 8 ${TESTTOOLVMOPTS} \
    -endorseddirs "BadClass${PS}GooZip${PS}BadJar" \
    -Xbootclasspath:"BadClass${PS}java-lang.jar" \
    Main.java
Success "$javac" -source 8 -target 8 ${TESTTOOLVMOPTS} \
    -Djava.endorsed.dirs="BadClass${PS}GooZip${PS}BadJar" \
    -Xbootclasspath:"BadClass${PS}java-lang.jar" \
    Main.java

#----------------------------------------------------------------
Failure "$javac" -source 8 -target 8 ${TESTTOOLVMOPTS} \
    -Xbootclasspath/a:"BadClass" \
    -extdirs "GooZip" \
    Main.java
Success "$javac" -source 8 -target 8 ${TESTTOOLVMOPTS} \
    -Xbootclasspath/a:"GooClass${PS}BadClass" \
    -extdirs "BadZip" \
    Main.java

#----------------------------------------------------------------
Failure "$javac" -source 8 -target 8 ${TESTTOOLVMOPTS} \
    -extdirs "GooClass${PS}BadZip" \
    -cp "GooZip/Lib.zip" \
    Main.java
Success "$javac" -source 8 -target 8 ${TESTTOOLVMOPTS} \
    -extdirs "BadClass${PS}GooZip${PS}BadJar" \
    -cp "BadZip/Lib.zip" \
    Main.java
Success "$javac" -source 8 -target 8 ${TESTTOOLVMOPTS} \
    -Djava.ext.dirs="GooZip${PS}BadJar" \
    -classpath "BadZip/Lib.zip" \
    Main.java

#----------------------------------------------------------------
Failure "$javac" ${TESTTOOLVMOPTS} -classpath "BadClass${PS}GooClass" Main.java
Success "$javac" ${TESTTOOLVMOPTS} -classpath "GooClass${PS}BadClass" Main.java
Failure "$java" ${TESTVMOPTS}  -classpath "BadClass${PS}GooClass${PS}." Main
Success "$java" ${TESTVMOPTS}  -classpath "GooClass${PS}BadClass${PS}." Main

Failure "$javac" ${TESTTOOLVMOPTS} -cp "BadJar/Lib.jar${PS}GooZip/Lib.zip" Main.java
Success "$javac" ${TESTTOOLVMOPTS} -cp "GooJar/Lib.jar${PS}BadZip/Lib.zip" Main.java
Failure "$java" ${TESTVMOPTS}  -cp "BadJar/Lib.jar${PS}${PS}GooZip/Lib.zip" Main
Success "$java" ${TESTVMOPTS}  -cp "GooJar/Lib.jar${PS}${PS}BadZip/Lib.zip" Main

Failure env CLASSPATH="BadZip/Lib.zip${PS}GooJar/Lib.jar" "$javac" ${TESTTOOLVMOPTS} Main.java
Success env CLASSPATH="GooZip/Lib.zip${PS}BadJar/Lib.jar" "$javac" ${TESTTOOLVMOPTS} Main.java
Failure env CLASSPATH="${PS}BadZip/Lib.zip${PS}GooJar/Lib.jar" "$java" ${TESTVMOPTS} Main
Success env CLASSPATH="${PS}GooZip/Lib.zip${PS}BadJar/Lib.jar" "$java" ${TESTVMOPTS} Main

#----------------------------------------------------------------
# Check behavior of empty paths and empty path elements
#----------------------------------------------------------------
In() { cd "$1"; shift; "$@"; cd ..; }

In GooClass Failure "$javac" ${TESTTOOLVMOPTS} -cp ".." ../Main.java
In GooClass Failure "$java" ${TESTVMOPTS}  -cp ".." Main

# Unspecified classpath defaults to "."
Sys mkdir OneDir; Sys cp Main.java GooClass/Lib.class OneDir/.
In OneDir Success "$javac" ${TESTTOOLVMOPTS} Main.java
In OneDir Success "$java" ${TESTVMOPTS}  Main

# Empty classpath elements mean "."
In GooClass Success "$javac" ${TESTTOOLVMOPTS} -cp "${PS}.." ../Main.java
In GooClass Success "$java" ${TESTVMOPTS}  -cp "${PS}.." Main

In GooClass Success "$javac" ${TESTTOOLVMOPTS} -cp "..${PS}" ../Main.java
In GooClass Success "$java" ${TESTVMOPTS}  -cp "..${PS}" Main

In GooClass Success "$javac" ${TESTTOOLVMOPTS} -cp "..${PS}${PS}/xyzzy" ../Main.java
In GooClass Success "$java" ${TESTVMOPTS}  -cp "..${PS}${PS}/xyzzy" Main

# All other empty path elements are ignored.
In GooJar Failure "$javac" -source 8 -target 8 ${TESTTOOLVMOPTS} -extdirs "" -cp ".." ../Main.java

In GooJar Failure "$javac" -source 8 -targt 8 ${TESTTOOLVMOPTS} -extdirs        "${PS}" -cp ".." ../Main.java
In GooJar Failure "$javac" -source 8 -target 8 ${TESTTOOLVMOPTS} -Djava.ext.dirs="${PS}" -cp ".." ../Main.java

In GooJar Success "$javac" -source 8 -target 8 ${TESTTOOLVMOPTS} -extdirs        "." -cp ".." ../Main.java
In GooJar Success "$javac" -source 8 -target 8 ${TESTTOOLVMOPTS} -Djava.ext.dirs="." -cp ".." ../Main.java

In GooJar Failure "$javac" -source 8 -target 8 ${TESTTOOLVMOPTS}   -Djava.endorsed.dirs="" -cp ".." ../Main.java

In GooJar Failure "$javac" -source 8 -target 8 ${TESTTOOLVMOPTS}   -endorseddirs        "${PS}" -cp ".." ../Main.java

In GooJar Success "$javac" -source 8 -target 8 ${TESTTOOLVMOPTS}   -Djava.endorsed.dirs="." -cp ".." ../Main.java

In GooClass Failure "$javac" -source 8 -target 8 ${TESTTOOLVMOPTS} -Xbootclasspath/p: -cp ".." ../Main.java

In GooClass Success "$javac" -source 8 -target 8 ${TESTTOOLVMOPTS} -Xbootclasspath/p:. -cp ".." ../Main.java

In GooClass Failure "$javac" -source 8 -target 8 ${TESTTOOLVMOPTS} -Xbootclasspath:"../java-lang.jar" -cp ".." ../Main.java

In GooClass Success "$javac" -source 8 -target 8 ${TESTTOOLVMOPTS} -Xbootclasspath:"../java-lang.jar${PS}." -cp ".." ../Main.java

In GooClass Failure "$javac" -source 8 -target 8 ${TESTTOOLVMOPTS} -Xbootclasspath/a: -cp ".." ../Main.java
In GooClass Failure "$java" ${TESTVMOPTS}  -Xbootclasspath/a: -cp ".." Main

In GooClass Success "$javac" -source 8 -target 8 ${TESTTOOLVMOPTS} -Xbootclasspath/a:. -cp ".." ../Main.java
In GooClass Success "$java" ${TESTVMOPTS}  -Xbootclasspath/a:. -cp ".." Main

Cleanup

Bottom Line