Enable JSpecify JDK models (under a flag) #1641
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| # Javac plugin for generating JSpecify JDK astubx file | ||
|
|
||
| This module and others contain logic to generate an astubx file from the | ||
| [annotated JSpecify JDK](https://github.com/jspecify/jdk). The generation works | ||
| in two stages: | ||
|
|
||
| 1. This module provides a javac plugin that gets injected into the build of the | ||
| JSpecify JDK. It generates `.json` files capturing the nullability annotations | ||
| in the JDK. | ||
| 2. We have a separate astubx generator (main entrypoint: | ||
| `com.uber.nullaway.jdkannotations.AstubxGeneratorCLI`) that turns the `.json` | ||
| files into an `.astubx` file. | ||
|
|
||
| Here are the current steps to (re-)generate the file (admittedly janky, we will | ||
| work to improve them). | ||
|
|
||
| 1. Build this module and the `astubx-generator-cli` module: | ||
| `./gradlew :jdk-javac-plugin:build :jdk-annotations:astubx-generator-cli:build` | ||
| 2. Clone [this fork](https://github.com/msridhar/jdk) of the JSpecify JDK, and | ||
| check out the `test` branch. | ||
| 3. In the jdk repo, edit these lines of `make/common/JavaCompilation.gmk`: | ||
| ``` | ||
| $1_API_DIGEST_FLAGS += -Xplugin:"NullnessAnnotationSerializer /tmp" | ||
| $1_AUGMENTED_CLASSPATH += /Users/msridhar/git-repos/NullAway/jdk-javac-plugin/build/libs/jdk-javac-plugin-all.jar | ||
| ``` | ||
| On the first line, you can change `/tmp` to whatever directory should be used to | ||
| store the `.json` files generated by the javac plugin. On the second line, | ||
| change the absolute path to point to the `jdk-javac-plugin-all.jar` file under | ||
| your NullAway repo. | ||
| 4. In the jdk repo, run: `make clean && make jdk`. (You may need to run | ||
| `configure` first.) This should exit successfully and generate the json files. | ||
| 5. Run the `AstubxGeneratorCLI` main method (e.g., you can run it from within | ||
| IntelliJ). It takes two arguments. The first is the directory containing the | ||
| json files, and the second is where the output astubx file should be placed. | ||
| The output file will be named `output.astubx`. | ||
| 6. Copy the `output.astubx` file from the previous step to | ||
| `nullaway/src/main/resources/jspecify-jdk.astubx` under the NullAway repo. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| package com.uber.nullaway; | ||
|
|
||
| import com.google.errorprone.CompilationTestHelper; | ||
| import com.uber.nullaway.generics.JSpecifyJavacConfig; | ||
| import java.util.List; | ||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
| import org.junit.runners.JUnit4; | ||
|
|
||
| @RunWith(JUnit4.class) | ||
| public class JSpecifyJDKModelsTest extends NullAwayTestsBase { | ||
|
|
||
| @Test | ||
| public void modelsDisabledDoesNotLoadAstubxModel() { | ||
| CompilationTestHelper compilationTestHelper = | ||
| makeTestHelperWithArgs(List.of("-XepOpt:NullAway:AnnotatedPackages=foo")) | ||
| .addSourceLines( | ||
| "Test.java", | ||
| """ | ||
| package foo; | ||
| import javax.naming.directory.Attributes; | ||
| import org.jspecify.annotations.NullMarked; | ||
| @NullMarked | ||
| class Test { | ||
| void use(Attributes attrs) { | ||
| // Attributes.get returns @Nullable in the models, but since we don't load | ||
| // models here, we get no warning | ||
| attrs.get("key").toString(); | ||
| } | ||
| } | ||
| """); | ||
| compilationTestHelper.doTest(); | ||
|
msridhar marked this conversation as resolved.
|
||
| } | ||
|
|
||
| @Test | ||
| public void listContainingNullsWithModel() { | ||
| makeTestHelperWithArgs( | ||
| JSpecifyJavacConfig.withJSpecifyModeArgs( | ||
| List.of( | ||
| "-XepOpt:NullAway:AnnotatedPackages=foo", | ||
| "-XepOpt:NullAway:JSpecifyJDKModels=true"))) | ||
| .addSourceLines( | ||
| "Test.java", | ||
| """ | ||
| package foo; | ||
| import java.util.List; | ||
| import org.jspecify.annotations.NullMarked; | ||
| import org.jspecify.annotations.Nullable; | ||
| @NullMarked | ||
| class Test { | ||
| void testNullableContents(List<@Nullable String> list) { | ||
| list.add(null); | ||
| // BUG: Diagnostic contains: dereferenced expression 'list.get(0)' is @Nullable | ||
| list.get(0).toString(); | ||
| } | ||
| void testNonNullContents(List<String> list) { | ||
| // BUG: Diagnostic contains: passing @Nullable parameter 'null' where @NonNull is required | ||
| list.add(null); | ||
| list.get(0).toString(); | ||
| } | ||
| } | ||
| """) | ||
| .doTest(); | ||
| } | ||
|
|
||
| @Test | ||
| public void listContainingNullsWithoutModel() { | ||
| makeTestHelperWithArgs( | ||
| JSpecifyJavacConfig.withJSpecifyModeArgs( | ||
| List.of("-XepOpt:NullAway:AnnotatedPackages=foo"))) | ||
| .addSourceLines( | ||
| "Test.java", | ||
| """ | ||
| package foo; | ||
| import java.util.List; | ||
| import org.jspecify.annotations.NullMarked; | ||
| import org.jspecify.annotations.Nullable; | ||
| @NullMarked | ||
| class Test { | ||
| void use(List<@Nullable String> list) { | ||
| list.add(null); | ||
| // no warning, since List.get() is unmarked without the model | ||
| list.get(0).toString(); | ||
| } | ||
| void testNonNullContents(List<String> list) { | ||
| // no warning, since List.add() is unmarked without the model | ||
| list.add(null); | ||
| list.get(0).toString(); | ||
| } | ||
| } | ||
| """) | ||
| .doTest(); | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.