Skip to content

/ spotless

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support google-java-format 1.8+ #563

Merged
merged 13 commits into from May 3, 2020
Merged

Support google-java-format 1.8+ #563

merged 13 commits into from May 3, 2020

Conversation

@benkard
Copy link
Contributor

benkard commented May 2, 2020

In google-java-format 1.8, the signature of
RemoveUnusedImports#removeUnusedImports changed and the
RemoveUnusedImports$JavadocOnlyImports class was removed entirely.
With this patch, GoogleJavaFormatStep detects which version of the
method is available and calls the right one.

Fixes #562.
@benkard
Support google-java-format 1.8+.
Loading status checks…
dbc4762 
In google-java-format 1.8, the signature of
RemoveUnusedImports#removeUnusedImports changed and the
RemoveUnusedImports$JavadocOnlyImports class was removed entirely.
With this patch, GoogleJavaFormatStep detects which version of the
method is available and calls the right one.

Fixes #562.
@benkard benkard mentioned this pull request May 2, 2020
Closed
@benkard
Add change log entries for PR #563.
Loading status checks…
6f7aa17
@nedtwigg nedtwigg mentioned this pull request May 2, 2020
Closed
3 of 3 tasks complete
nedtwigg added 9 commits May 3, 2020
@nedtwigg
Add ability to detect what version of JRE we're running on, and use i…
Loading status checks…
2d4eeda 
…t to get the build to work on both JRE 8 and 11.
@nedtwigg
Fix extra tests in Travis.
8bfc8b3
@nedtwigg
Modifications to get `ErrorShouldRethrow` to pass on Gradle 5 (oldest…
6d47868 
… gradle version that supports Java 11).
@nedtwigg
Fixup - all tests should now pass on Java 8 and 11.
Loading status checks…
9ce3dff
@nedtwigg
Disable spotbugs on Java 11.
Loading status checks…
717b479
@nedtwigg
Add test for google-java-format 1.8+, which is skipped on JRE 8.
Loading status checks…
c0a8469
@nedtwigg
Disable javadoc on 11.
Loading status checks…
5af53aa
@nedtwigg
Disable the maven build for Java 11.
88ca46e
@nedtwigg
Fix the small behavior change in the latest google-java-format.
Loading status checks…
11f58d8
@nedtwigg
Copy link
Member

nedtwigg commented May 3, 2020

@diffplug/spotless Just FYI, this is the first PR we have received where the formatter requires Java 11+, and there are more coming (#547). As a result, we now need our tests to run on Java 11.

This PR represents the minimal effort needed to merge support for google-java-format 1.8 with tests. We now run the whole build on both 8 and 11. The only things I disabled on 11 are things which are broken there, namely

  • plugin-maven
  • javadoc generation
  • spotbugs (I think already fixed in newer spotbugs)

The trickier part is that now there are some tests which you can't run on 8, because they'll break. Also, Gradle 5.0 is the oldest that can run on Java 11, so you can't run old-gradle-tests on 11.

I'm very open to PRs for a more comprehensive solution, but I think it's fine to play whack-a-mole until a pattern merges. Here's the gist of the 8 / 11 test infrastructure I put in:

spotless/testlib/src/main/java/com/diffplug/spotless/JreVersion.java

Lines 20 to 23 in 11f58d8

public enum JreVersion {
_8, _11;
public static JreVersion thisVm() {

spotless/testlib/src/test/java/com/diffplug/spotless/java/GoogleJavaFormatStepTest.java

Lines 30 to 35 in 11f58d8

@Test
public void behavior18() throws Exception {
if (JreVersion.thisVm() == JreVersion._8) {
// google-java-format requires JRE 11+
return;
}

spotless/plugin-gradle/src/test/java/com/diffplug/gradle/spotless/GradleIntegrationTest.java

Lines 60 to 78 in 11f58d8

/**
* For Java 11+, Gradle 5 is the minimum.
* So if you ask for less than Gradle 5, you get it on Java 8, but on Java 11 you get promoted to Gradle 5.
* If you ask for more than Gradle 5, you'll definitely get it.
*/
protected static String requestGradleForJre8and11(String ver) {
JreVersion jre = JreVersion.thisVm();
// @formatter:off
switch (jre) {
case _8: return ver;
case _11: return Double.parseDouble(ver) < 5.0 ? "5.0" : ver;
default: throw new IllegalStateException("Spotless build is only supported on Java 8 and Java 11");
}
// @formatter:on
}
protected final GradleRunner gradleRunner() throws IOException {
return GradleRunner.create()
.withGradleVersion(requestGradleForJre8and11("2.14"))

nedtwigg added 2 commits May 3, 2020
@nedtwigg
Add Java 11 info to the changelogs.
7ebb481
@nedtwigg
Use the same mechanism to disable tasks on Java 11 throughout the build.
Loading status checks…
0104f6d
@nedtwigg nedtwigg merged commit de2d9b6 into diffplug:master May 3, 2020
2 checks passed
2 checks passed
Validation
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@RanadeepPolavarapu RanadeepPolavarapu mentioned this pull request May 4, 2020
Merged
@nedtwigg
Copy link
Member

nedtwigg commented May 5, 2020

Released in plugin-gradle 3.29.0, and plugin-maven 1.31.0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Linked issues

Successfully merging this pull request may close these issues.

ClassNotFoundException with google-java-format 1.8
2 participants
@benkard @nedtwigg
You can’t perform that action at this time.