Partially fix #2844: force Gradle tests to run on JDK 9 in CI #2845

BenHenning · 2021-03-06T21:17:57Z

Fixes part of #2844.

This aims to fix the OpenJDK flakes happening for Gradle tests (per #2844) by forcing the CI environment to use JDK 9 instead of JDK 8 for runtime, since it seems that JDK 8 may have an issue where the JVM can crash when managing many forks (we updated Gradle tests to use forks a while back). However, making the CI environment properly use JDK 9 for Gradle involved a few steps:

Adding additional steps to add environment diagnostics to ensure that Gradle is actually using JDK 9 (since it seems to use JDK 8 as configured by settings despite 9 being setup). Unfortunately, setup-java doesn't yet seem to support this directly: Log the version of JDK installed actions/setup-java#92, and it's important to verify that Gradle itself is using the correct version.
Note that moving to JDK 9+ requires a compile-time only dependency for some of the annotations needed by Dagger: error: cannot find symbol @Generated( ^ google/dagger#1449 (comment). It's not clear to me why this wasn't an issue in the JDK 8 world.
Similarly, JDK 9+ deprecate and eventually remove (JDK 11+) some Java EE libraries that Gradle itself seems to depend on. More compile-only dependencies resolve this issue: https://stackoverflow.com/a/43574427.

Some things to note:

The build still sets source/target compatibility versions to Java 8 since we don't actually want to use Java 9+ dependencies, we just want to be able to use JDK 9+ to build and run the tests
I haven't verified this locally to still work with JDK 8, but I'm not expecting there to be issues since the changes are mostly just adding redundancy
I removed the workaround for the kapt bug since per error: cannot find symbol @Generated( ^ google/dagger#1449 (comment) this should be fixed in the version of Kotlin that we're now using (though the other fixes above regarding the compile-time dependencies were discovered shortly after & are necessary to make everything work as expected)

We will not actually be able to verify if the issue is fixed until we see no new instances of the crash crop up over the next few weeks. Given that the issue seems to only reproduce occasionally when running the whole batch of tests, it's difficult to make the issue commonplace enough to gain certainty it's been fixed. Given the low volume of the flake, though, waiting a few weeks to ensure it's gone should be reasonable.

Remove kapt workaround since per google/dagger#1449 (comment) this should be fixed in the version of Kotlin that we're now using.

Add check for Java versions for Gradle CI workflows.

Add more diagnostics for verifying Java environment, and try further to force Gradle to use the one that's installed.

Add explicit javax annotations dependency per google/dagger#1449 (comment).

app/build.gradle

data/build.gradle

domain/build.gradle

testing/build.gradle

utility/build.gradle

Add additional dependencies due to Java EE libraries being deprecated/removed JDK 9+ per: https://stackoverflow.com/a/43574427.

anandwana001

LGTM

BenHenning · 2021-03-08T17:55:51Z

Thanks!

…ppia#2845) * Update build.gradle Remove kapt workaround since per google/dagger#1449 (comment) this should be fixed in the version of Kotlin that we're now using. * Update main.yml Add check for Java versions for Gradle CI workflows. * Update main.yml Add more diagnostics for verifying Java environment, and try further to force Gradle to use the one that's installed. * Update app/build.gradle Add explicit javax annotations dependency per google/dagger#1449 (comment). * Update data/build.gradle Add explicit javax annotations dependency per google/dagger#1449 (comment). * Update domain/build.gradle Add explicit javax annotations dependency per google/dagger#1449 (comment). * Update testing/build.gradle Add explicit javax annotations dependency per google/dagger#1449 (comment). * Update utility/build.gradle Add explicit javax annotations dependency per google/dagger#1449 (comment). * Apply suggestions from code review Add additional dependencies due to Java EE libraries being deprecated/removed JDK 9+ per: https://stackoverflow.com/a/43574427.

…in CI (oppia#2845)" This reverts commit 15e928f.

…ppia#2845) * Update build.gradle Remove kapt workaround since per google/dagger#1449 (comment) this should be fixed in the version of Kotlin that we're now using. * Update main.yml Add check for Java versions for Gradle CI workflows. * Update main.yml Add more diagnostics for verifying Java environment, and try further to force Gradle to use the one that's installed. * Update app/build.gradle Add explicit javax annotations dependency per google/dagger#1449 (comment). * Update data/build.gradle Add explicit javax annotations dependency per google/dagger#1449 (comment). * Update domain/build.gradle Add explicit javax annotations dependency per google/dagger#1449 (comment). * Update testing/build.gradle Add explicit javax annotations dependency per google/dagger#1449 (comment). * Update utility/build.gradle Add explicit javax annotations dependency per google/dagger#1449 (comment). * Apply suggestions from code review Add additional dependencies due to Java EE libraries being deprecated/removed JDK 9+ per: https://stackoverflow.com/a/43574427.

BenHenning · 2021-03-10T02:09:18Z

Just hit this issue again in #2871. :(

BenHenning added 8 commits March 6, 2021 13:17

Update build.gradle

887f9f3

Remove kapt workaround since per google/dagger#1449 (comment) this should be fixed in the version of Kotlin that we're now using.

Update main.yml

2feedca

Add check for Java versions for Gradle CI workflows.

Update main.yml

57cab7a

Add more diagnostics for verifying Java environment, and try further to force Gradle to use the one that's installed.

Update app/build.gradle

b61ebf5

Add explicit javax annotations dependency per google/dagger#1449 (comment).

Update data/build.gradle

653254e

Add explicit javax annotations dependency per google/dagger#1449 (comment).

Update domain/build.gradle

3af1af5

Add explicit javax annotations dependency per google/dagger#1449 (comment).

Update testing/build.gradle

db2339a

Add explicit javax annotations dependency per google/dagger#1449 (comment).

Update utility/build.gradle

2617f2b

Add explicit javax annotations dependency per google/dagger#1449 (comment).