Skip to content

lazily configure NullAway dependencies #2393

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.

Sign up for GitHub

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

Merged
bulldozer-bot merged 3 commits into from
Sep 19, 2022
Merged

lazily configure NullAway dependencies #2393

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1bd74e7
lazily configure NullAway dependencies
Sep 19, 2022
e8349c3
repro test
Sep 19, 2022
de63e29
Add generated changelog entries
svc-changelog Sep 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions changelog/@unreleased/pr-2393.v2.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
type: fix
fix:
description: lazily configure NullAway dependencies to successfully apply NullAway
without ordering issues
links:
- https://github.com/palantir/gradle-baseline/pull/2393
32 changes: 27 additions & 5 deletions gradle-baseline-java/src/main/groovy/com/palantir/baseline/plugins/BaselineNullAway.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,11 @@
import org.gradle.api.Action;
import org.gradle.api.Plugin;
import org.gradle.api.Project;
import org.gradle.api.artifacts.Configuration;
import org.gradle.api.logging.Logger;
import org.gradle.api.logging.Logging;
import org.gradle.api.plugins.ExtensionAware;
import org.gradle.api.specs.Spec;
import org.gradle.api.tasks.compile.JavaCompile;

public final class BaselineNullAway implements Plugin<Project> {
Expand All @@ -50,7 +52,20 @@ private void applyToProject(Project project) {
+ "beware this compromises build reproducibility");
return "latest.release";
});
project.getDependencies().add("errorprone", "com.palantir.baseline:baseline-null-away:" + version);
project.getConfigurations()
.matching(new Spec<Configuration>() {
@Override
public boolean isSatisfiedBy(Configuration config) {
return "errorprone".equals(config.getName());
}
})
.configureEach(new Action<Configuration>() {
@Override
public void execute(Configuration _files) {
project.getDependencies()
.add("errorprone", "com.palantir.baseline:baseline-null-away:" + version);
}
});
configureErrorProneOptions(project, new Action<ErrorProneOptions>() {
@Override
public void execute(ErrorProneOptions options) {
Expand All @@ -60,11 +75,18 @@ public void execute(ErrorProneOptions options) {
});
}

private static void configureErrorProneOptions(Project project, Action<ErrorProneOptions> action) {
project.getTasks().withType(JavaCompile.class).configureEach(new Action<JavaCompile>() {
private static void configureErrorProneOptions(Project proj, Action<ErrorProneOptions> action) {
proj.afterEvaluate(new Action<Project>() {
Copy link
Contributor Author

@carterkozak carterkozak Sep 19, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This matches our internal plugin configuration

@Override
public void execute(JavaCompile javaCompile) {
((ExtensionAware) javaCompile.getOptions()).getExtensions().configure(ErrorProneOptions.class, action);
public void execute(Project project) {
project.getTasks().withType(JavaCompile.class).configureEach(new Action<JavaCompile>() {
@Override
public void execute(JavaCompile javaCompile) {
((ExtensionAware) javaCompile.getOptions())
.getExtensions()
.configure(ErrorProneOptions.class, action);
}
});
}
});
}
Expand Down
53 changes: 26 additions & 27 deletions ...aseline-java/src/test/groovy/com/palantir/baseline/BaselineNullAwayIntegrationTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,29 +16,32 @@

package com.palantir.baseline

import nebula.test.IntegrationSpec
import nebula.test.functional.ExecutionResult

import org.gradle.testkit.runner.BuildResult
import org.gradle.testkit.runner.TaskOutcome
import spock.lang.Unroll

class BaselineNullAwayIntegrationTest extends AbstractPluginTest {
class BaselineNullAwayIntegrationTest extends IntegrationSpec {

def standardBuildFile = '''
plugins {
id 'java'
id 'com.palantir.baseline-error-prone'
id 'com.palantir.baseline-null-away'
id 'com.palantir.baseline-java-versions'
}
apply plugin: 'com.palantir.baseline-java-versions'
apply plugin: 'com.palantir.baseline-null-away'
apply plugin: 'com.palantir.baseline-error-prone'
apply plugin: 'java'
repositories {
mavenLocal()
mavenCentral()
}
javaVersions {
libraryTarget = 17
}
tasks.withType(JavaCompile).configureEach {
options.compilerArgs += ['-Werror']
allprojects {
afterEvaluate {
plugins.withId('net.ltgt.errorprone', {
tasks.withType(JavaCompile).configureEach({
options.errorprone.excludedPaths = null
options.compilerArgs += ['-Werror']
})
})
}
}
'''.stripIndent()

Expand All @@ -62,47 +65,43 @@ class BaselineNullAwayIntegrationTest extends AbstractPluginTest {
buildFile << standardBuildFile

then:
with('compileJava', '--info').build()
runTasksSuccessfully('compileJava', '--info')
}

def 'compileJava fails when null-away finds errors'() {
when:
buildFile << standardBuildFile
file('src/main/java/com/palantir/test/Test.java') << invalidJavaFile
writeJavaSourceFile(invalidJavaFile)

then:
BuildResult result = with('compileJava').buildAndFail()
result.task(":compileJava").outcome == TaskOutcome.FAILED
result.output.contains("[NullAway] dereferenced expression throwable.getMessage() is @Nullable")
ExecutionResult result = runTasksWithFailure('compileJava')
result.standardError.contains("[NullAway] dereferenced expression throwable.getMessage() is @Nullable")
}

def 'compileJava succeeds when null-away finds no errors'() {
when:
buildFile << standardBuildFile
file('src/main/java/com/palantir/test/Test.java') << validJavaFile
writeJavaSourceFile(validJavaFile)

then:
BuildResult result = with('compileJava').build()
result.task(":compileJava").outcome == TaskOutcome.SUCCESS
runTasksSuccessfully('compileJava')
}

def 'compileJava succeeds when null-away finds no errors on jdk15'() {
when:
buildFile << standardBuildFile.replace('libraryTarget = 17', 'libraryTarget = 15')
file('src/main/java/com/palantir/test/Test.java') << validJavaFile
writeJavaSourceFile(validJavaFile)

then:
BuildResult result = with('compileJava').build()
result.task(":compileJava").outcome == TaskOutcome.SUCCESS
runTasksSuccessfully('compileJava')
}

def 'compileJava succeeds when null-away finds no errors on jdk11'() {
when:
buildFile << standardBuildFile.replace('libraryTarget = 17', 'libraryTarget = 11')
file('src/main/java/com/palantir/test/Test.java') << validJavaFile
writeJavaSourceFile(validJavaFile)

then:
BuildResult result = with('compileJava').build()
result.task(":compileJava").outcome == TaskOutcome.SUCCESS
runTasksSuccessfully('compileJava')
}
}