Skip to content

Add the JSpecify dependency before generating annotations #1198

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

Draft
martinfrancois wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add the JSpecify dependency before generating annotations #1198

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
135 changes: 135 additions & 0 deletions src/test/java/org/openrewrite/java/migrate/jspecify/JSpecifyBestPracticesTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
package org.openrewrite.java.migrate.jspecify;

import org.junit.jupiter.api.Test;
import org.junitpioneer.jupiter.ExpectedToFail;
import org.openrewrite.DocumentExample;
import org.openrewrite.Issue;
import org.openrewrite.java.JavaParser;
Expand Down Expand Up @@ -501,6 +502,140 @@ class Bar {
);
}

@ExpectedToFail("No AddDependency guard in jspecify.yml matches a project without a prior nullness library, so the annotations just written do not resolve")
@Issue("https://github.com/openrewrite/rewrite-migrate-java/pull/1192")
@Test
void addJspecifyDependencyWithoutPriorNullnessAnnotations() {
rewriteRun(
mavenProject("foo",
srcMainJava(
//language=java
java(
"""
public class Test {

public String getString() {
return null;
}
}
""",
"""
import org.jspecify.annotations.Nullable;

public class Test {

public @Nullable String getString() {
return null;
}
}
"""
)
),
//language=xml
pomXml(
"""
<project>
<modelVersion>4.0.0</modelVersion>
<groupId>com.example.foobar</groupId>
<artifactId>foobar-core</artifactId>
<version>1.0.0</version>
</project>
""",
"""
<project>
<modelVersion>4.0.0</modelVersion>
<groupId>com.example.foobar</groupId>
<artifactId>foobar-core</artifactId>
<version>1.0.0</version>
<dependencies>
<dependency>
<groupId>org.jspecify</groupId>
<artifactId>jspecify</artifactId>
<version>1.0.0</version>
</dependency>
</dependencies>
</project>
"""
)
)
);
}

@ExpectedToFail("AddDependency's onlyIfUsing scans the original sources and does not see annotations inserted earlier in the same cycle; the dependency is only added in a follow-up cycle")
@Issue("https://github.com/openrewrite/rewrite-migrate-java/pull/1192")
@Test
void addDependencyForAnnotationsInsertedInSameRun() {
rewriteRun(
spec -> spec.recipeFromYaml(
"""
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.jspecify.AnnotateNullableAndAddDependency
displayName: Annotate nullable methods and add the JSpecify dependency
description: Adds JSpecify annotations and the dependency providing them.
recipeList:
- org.openrewrite.staticanalysis.AnnotateNullableMethods
- org.openrewrite.java.dependencies.AddDependency:
groupId: org.jspecify
artifactId: jspecify
version: 1.0.0
onlyIfUsing: org.jspecify.annotations.*
acceptTransitive: true
""",
"org.openrewrite.java.jspecify.AnnotateNullableAndAddDependency"),
mavenProject("foo",
srcMainJava(
//language=java
java(
"""
public class Test {

public String getString() {
return null;
}
}
""",
"""
import org.jspecify.annotations.Nullable;

public class Test {

public @Nullable String getString() {
return null;
}
}
"""
)
),
//language=xml
pomXml(
"""
<project>
<modelVersion>4.0.0</modelVersion>
<groupId>com.example.foobar</groupId>
<artifactId>foobar-core</artifactId>
<version>1.0.0</version>
</project>
""",
"""
<project>
<modelVersion>4.0.0</modelVersion>
<groupId>com.example.foobar</groupId>
<artifactId>foobar-core</artifactId>
<version>1.0.0</version>
<dependencies>
<dependency>
<groupId>org.jspecify</groupId>
<artifactId>jspecify</artifactId>
<version>1.0.0</version>
</dependency>
</dependencies>
</project>
"""
)
)
);
}

@Test
void migrateFromMicronautAnnotationToJspecify() {
rewriteRun(
Expand Down
Loading