jdk-24/test/jdk/java/foreign/enablenativeaccess/TestEnableNativeAccess.java
Maurizio Cimadamore 20d8f58c92 8331671: Implement JEP 472: Prepare to Restrict the Use of JNI
Reviewed-by: jpai, prr, ihse, kcr, alanb
2024-08-26 09:17:45 +00:00

185 lines
9.6 KiB
Java

/*
* Copyright (c) 2022, 2023, 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
* @requires !vm.musl
*
* @library /test/lib
* @build TestEnableNativeAccess
* panama_module/*
* panama_jni_load_module/*
* panama_jni_def_module/*
* panama_jni_use_module/*
*
* org.openjdk.foreigntest.unnamed.PanamaMainUnnamedModule
* @run testng/othervm/timeout=180 TestEnableNativeAccess
* @summary Basic test for java --enable-native-access
*/
import java.util.List;
import java.util.stream.Stream;
import jdk.test.lib.process.ProcessTools;
import jdk.test.lib.process.OutputAnalyzer;
import org.testng.annotations.DataProvider;
import org.testng.annotations.Test;
import static org.testng.Assert.*;
/**
* Basic test of --enable-native-access with expected behaviour:
*
* if flag present: - permit access to modules that are specified
* - deny access to modules that are not specified
* (throw IllegalCallerException)
* if flag not present: - permit access to all modules and omit a warning
* (on first access per module only)
*/
@Test
public class TestEnableNativeAccess extends TestEnableNativeAccessBase {
@DataProvider(name = "succeedCases")
public Object[][] succeedCases() {
return new Object[][] {
{ "panama_enable_native_access", PANAMA_MAIN, successNoWarning(), new String[]{"--enable-native-access=panama_module"} },
{ "panama_enable_native_access_reflection", PANAMA_REFLECTION, successNoWarning(), new String[]{"--enable-native-access=panama_module"} },
{ "panama_enable_native_access_invoke", PANAMA_INVOKE, successNoWarning(), new String[]{"--enable-native-access=panama_module"} },
{ "panama_comma_separated_enable", PANAMA_MAIN, successNoWarning(), new String[]{"--enable-native-access=java.base,panama_module"} },
{ "panama_comma_separated_enable_reflection", PANAMA_REFLECTION, successNoWarning(), new String[]{"--enable-native-access=java.base,panama_module"} },
{ "panama_comma_separated_enable_invoke", PANAMA_INVOKE, successNoWarning(), new String[]{"--enable-native-access=java.base,panama_module"} },
{ "panama_comma_separated_enable_jni", PANAMA_JNI, successNoWarning(), new String[]{"--enable-native-access=panama_jni_load_module,panama_jni_def_module,ALL-UNNAMED"} },
{ "panama_enable_native_access_warn", PANAMA_MAIN, successWithWarning("panama"), new String[]{} },
{ "panama_enable_native_access_warn_reflection", PANAMA_REFLECTION, successWithWarning("panama"), new String[]{} },
{ "panama_enable_native_access_warn_invoke", PANAMA_INVOKE, successWithWarning("panama"), new String[]{} },
{ "panama_enable_native_access_warn_jni", PANAMA_JNI, successWithWarnings("panama_jni_load_module", "panama_jni_def_module", "ALL-UNNAMED"), new String[]{} },
{ "panama_enable_native_access_allow", PANAMA_MAIN, successNoWarning(), new String[]{"--illegal-native-access=allow"} },
{ "panama_enable_native_access_allow_reflection", PANAMA_REFLECTION, successNoWarning(), new String[]{"--illegal-native-access=allow"} },
{ "panama_enable_native_access_allow_invoke", PANAMA_INVOKE, successNoWarning(), new String[]{"--illegal-native-access=allow"} },
{ "panama_enable_native_access_allow_jni", PANAMA_JNI, successNoWarning(), new String[]{"--illegal-native-access=allow"} },
{ "panama_no_unnamed_module_native_access", UNNAMED, successWithWarning("ALL-UNNAMED"), new String[]{} },
{ "panama_all_unnamed_module_native_access", UNNAMED, successNoWarning(), new String[]{"--enable-native-access=ALL-UNNAMED"} },
{ "panama_allow_unnamed_module_native_access", UNNAMED, successNoWarning(), new String[]{"--illegal-native-access=allow"} },
};
}
/**
* Runs the test to execute the given test action. The VM is run with the
* given VM options and the output checked to see that it matches the
* expected result.
*/
OutputAnalyzer run(String action, String cls, Result expectedResult, String... vmopts)
throws Exception
{
Stream<String> s1 = Stream.concat(
Stream.of(vmopts),
Stream.of("-Djava.library.path=" + System.getProperty("java.library.path")));
Stream<String> s2 = cls.equals(UNNAMED) ? Stream.of("-p", MODULE_PATH, cls, action)
: Stream.of("-p", MODULE_PATH, "-m", cls, action);
String[] opts = Stream.concat(s1, s2).toArray(String[]::new);
OutputAnalyzer outputAnalyzer = ProcessTools
.executeTestJava(opts)
.outputTo(System.out)
.errorTo(System.out);
checkResult(expectedResult, outputAnalyzer);
return outputAnalyzer;
}
@Test(dataProvider = "succeedCases")
public void testSucceed(String action, String cls, Result expectedResult, String... vmopts) throws Exception {
run(action, cls, expectedResult, vmopts);
}
/**
* Tests that without --enable-native-access, a multi-line warning is printed
* on first access of a module.
*/
public void testWarnFirstAccess() throws Exception {
List<String> output1 = run("panama_enable_native_access_first", PANAMA_MAIN,
successWithWarning("panama")).asLines();
assertTrue(count(output1, "WARNING") == 4); // 4 on first access, none on subsequent access
}
/**
* Specifies --enable-native-access more than once, each list of module names
* is appended.
*/
public void testRepeatedOption() throws Exception {
run("panama_enable_native_access_last_one_wins", PANAMA_MAIN,
success(), "--enable-native-access=java.base", "--enable-native-access=panama_module");
run("panama_enable_native_access_last_one_wins", PANAMA_MAIN,
success(), "--enable-native-access=panama_module", "--enable-native-access=java.base");
}
/**
* Specifies bad value to --enable-native-access.
*/
public void testBadValue() throws Exception {
run("panama_deny_bad_unknown_module", PANAMA_MAIN,
failWithWarning("WARNING: Unknown module: BAD specified to --enable-native-access"),
"--illegal-native-access=deny", "--enable-native-access=BAD");
run("panama_deny_bad_all_module_path_module", PANAMA_MAIN,
failWithWarning("WARNING: Unknown module: ALL-MODULE-PATH specified to --enable-native-access"),
"--illegal-native-access=deny", "--enable-native-access=ALL-MODULE-PATH" );
run("panama_deny_no_module_main", PANAMA_MAIN,
failWithError("module panama_module"),
"--illegal-native-access=deny");
run("panama_deny_no_module_invoke", PANAMA_INVOKE,
failWithError("module panama_module"),
"--illegal-native-access=deny");
run("panama_deny_no_module_reflection", PANAMA_REFLECTION,
failWithError("module panama_module"),
"--illegal-native-access=deny");
run("panama_deny_no_module_jni", PANAMA_JNI,
failWithError("module panama_jni_load_module"),
"--illegal-native-access=deny");
}
public void testDetailedWarningMessage() throws Exception {
run("panama_enable_native_access_warn_jni", PANAMA_JNI,
success()
// call to System::loadLibrary from panama_jni_load_module
.expect("WARNING: A restricted method in java.lang.System has been called")
.expect("WARNING: java.lang.System::loadLibrary has been called by org.openjdk.jni.PanamaMainJNI in module panama_jni_load_module")
// JNI native method binding in panama_jni_def_module
.expect("WARNING: A native method in org.openjdk.jni.def.PanamaJNIDef has been bound")
.expect("WARNING: org.openjdk.jni.def.PanamaJNIDef::nativeLinker0 is declared in module panama_jni_def_module")
// upcall to Linker::downcallHandle from JNI code
.expect("WARNING: A restricted method in java.lang.foreign.Linker has been called")
.expect("WARNING: java.lang.foreign.Linker::downcallHandle has been called by code in an unnamed module"));
}
private int count(Iterable<String> lines, CharSequence cs) {
int count = 0;
for (String line : lines) {
if (line.contains(cs)) count++;
}
return count;
}
}