Access to compiler internal APIs will fail starting with JDK 16

[eamonnmcmanus]

JDK 16 will change the default for the --illegal-access flag from permit to deny. This means that, by default, compile-testing tests will fail with messages like this:

class com.google.testing.compile.Parser (in unnamed module @0x4114d843) cannot access class
com.sun.tools.javac.api.JavacTool (in module jdk.compiler) because module jdk.compiler does not export
com.sun.tools.javac.api to unnamed module @0x4114d843

That can be worked around either by explicitly specifying, on the command line of the JVM running the tests, either --illegal-access=permit or --add-opens=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED. We should document that, and perhaps later find a way to make it unnecessary.

[ZacSweers]

Just mentioning that the --illegal-access flag was removed in JDK 17, so any solution for this would likely need to use --add-opens

[h908714124]

Consider deprecating methods containsElementsIn and hasSourceEquivalentTo in class JavaFileObjectSubject. These use Parser internally, which depends on forbidden Sun APIs. With some effort, it should be possible to rewrite affected tests and use method generatedSourceFile in class Compilation instead. This is the future-proof way to compare the generated source with expectations. See this commit for example.

[almogtavor]

@h908714124 is right, but as a workaround:

test {
    jvmArgs "--add-opens=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED"
    useJUnitPlatform()
}

would work

[mikewacker]

@almogtavor Here's an updated workaround for Gradle:

test {
    useJUnitPlatform()

    // See: https://github.com/google/compile-testing/issues/222
    jvmArgs '--add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED'
    jvmArgs '--add-exports=jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED'
    jvmArgs '--add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED'
}

Notes:

• You only need to use --add-exports, --add-opens is overkill.
• As of release 0.20, two additional --add-exports are needed. See: cd2c0a8

[xenoterracide]

looks like I just hit this

    java.lang.IllegalAccessError: class com.google.testing.compile.Parser (in unnamed module @0x15bbf42f) cannot access class com.sun.tools.javac.util.Context (in module jdk.compiler) because module jdk.compiler does not export com.sun.tools.javac.util to unnamed module @0x15bbf42f
        at com.google.testing.compile.Parser.parse(Parser.java:63)
        at com.google.testing.compile.JavaFileObjectSubject.performTreeDifference(JavaFileObjectSubject.java:173)
        at com.google.testing.compile.JavaFileObjectSubject.hasSourceEquivalentTo(JavaFileObjectSubject.java:126)
        at com.xenoterracide.bygger.ClassAnnotationTest.testImmutable(ClassAnnotationTest.java:53)

[xenoterracide]

Here's the kotlin dsl (which is now the default) equivalent of the above

tasks.test.configure {
  useJUnitPlatform()

  // See: https://github.com/google/compile-testing/issues/222
  jvmArgs =listOf(
    "--add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED",
    "--add-exports=jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED",
    "--add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED"
  )

[ChristophLoy]

Here's the kotlin dsl (which is now the default) equivalent of the above

tasks.test.configure {
  useJUnitPlatform()

  // See: https://github.com/google/compile-testing/issues/222
  jvmArgs =listOf(
    "--add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED",
    "--add-exports=jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED",
    "--add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED"
  )

@xenoterracide This is not the same! By assigning the jvmArgs via the = operator, you remove all existing jvmArgs. The actual equivalent would be:

    jvmArgs("--add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED")
    jvmArgs("--add-exports=jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED")
    jvmArgs("--add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED")