Skip to content

Commit 13f0a17

Browse files
OpenRewrite recipe best practices
Use this link to re-run the recipe: https://app.moderne.io/recipes/org.openrewrite.recipes.rewrite.OpenRewriteRecipeBestPractices?organizationId=QUxML01vZGVybmUvTW9kZXJuZSArIE9wZW5SZXdyaXRl Co-authored-by: Moderne <team@moderne.io>
1 parent 83d1f44 commit 13f0a17

4 files changed

Lines changed: 53 additions & 12 deletions

File tree

src/main/java/org/openrewrite/java/testing/cleanup/KotlinTestMethodsShouldReturnUnit.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
package org.openrewrite.java.testing.cleanup;
1717

1818
import lombok.Getter;
19+
import org.jspecify.annotations.Nullable;
1920
import org.openrewrite.*;
2021
import org.openrewrite.java.AnnotationMatcher;
2122
import org.openrewrite.java.search.UsesType;
@@ -105,7 +106,7 @@ public J.NewClass visitNewClass(J.NewClass newClass, ExecutionContext ctx) {
105106
}
106107

107108
@Override
108-
public J visitReturn(K.Return return_, ExecutionContext ctx) {
109+
public @Nullable J visitReturn(K.Return return_, ExecutionContext ctx) {
109110
Expression returnExpr = return_.getExpression().getExpression();
110111
//noinspection DataFlowIssue
111112
return returnExpr instanceof Statement ?

src/main/java/org/openrewrite/java/testing/testcontainers/ReplaceContainerImageName.java

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -50,16 +50,10 @@ public class ReplaceContainerImageName extends Recipe {
5050
example = "apache/kafka-native:4.0.2")
5151
String newImage;
5252

53-
@Override
54-
public String getDisplayName() {
55-
return "Replace container image name";
56-
}
53+
String displayName = "Replace container image name";
5754

58-
@Override
59-
public String getDescription() {
60-
return "Replace a Docker image name in `DockerImageName.parse(image)` or " +
61-
"`new DockerImageName(image)` constructor arguments for a specific container class.";
62-
}
55+
String description = "Replace a Docker image name in `DockerImageName.parse(image)` or " +
56+
"`new DockerImageName(image)` constructor arguments for a specific container class.";
6357

6458
@Override
6559
public TreeVisitor<?, ExecutionContext> getVisitor() {

src/main/resources/META-INF/rewrite/examples.yml

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5248,6 +5248,27 @@ examples:
52485248
language: java
52495249
---
52505250
type: specs.openrewrite.org/v1beta/example
5251+
recipeName: org.openrewrite.java.testing.testcontainers.MigrateToKafkaNative
5252+
examples:
5253+
- description: '`MigrateToKafkaNativeTest#migrateToKafkaNative`'
5254+
sources:
5255+
- before: |
5256+
import org.testcontainers.containers.KafkaContainer;
5257+
import org.testcontainers.utility.DockerImageName;
5258+
5259+
class A {
5260+
KafkaContainer kafka = new KafkaContainer(DockerImageName.parse("confluentinc/cp-kafka:7.5.3"));
5261+
}
5262+
after: |
5263+
import org.testcontainers.kafka.KafkaContainer;
5264+
import org.testcontainers.utility.DockerImageName;
5265+
5266+
class A {
5267+
KafkaContainer kafka = new KafkaContainer(DockerImageName.parse("apache/kafka-native:4.0.2"));
5268+
}
5269+
language: java
5270+
---
5271+
type: specs.openrewrite.org/v1beta/example
52515272
recipeName: org.openrewrite.java.testing.testcontainers.MigrateToOracleFree
52525273
examples:
52535274
- description: '`MigrateToOracleFreeTest#changeTypeAndImport`'
@@ -5267,6 +5288,31 @@ examples:
52675288
language: java
52685289
---
52695290
type: specs.openrewrite.org/v1beta/example
5291+
recipeName: org.openrewrite.java.testing.testcontainers.ReplaceContainerImageName
5292+
examples:
5293+
- description: '`ReplaceContainerImageNameTest#replaceConfluentWithKafkaNative`'
5294+
parameters:
5295+
- org.testcontainers.containers.KafkaContainer
5296+
- confluentinc/cp-kafka
5297+
- apache/kafka-native:4.0.2
5298+
sources:
5299+
- before: |
5300+
import org.testcontainers.containers.KafkaContainer;
5301+
import org.testcontainers.utility.DockerImageName;
5302+
5303+
class A {
5304+
KafkaContainer kafka = new KafkaContainer(DockerImageName.parse("confluentinc/cp-kafka:7.5.3"));
5305+
}
5306+
after: |
5307+
import org.testcontainers.containers.KafkaContainer;
5308+
import org.testcontainers.utility.DockerImageName;
5309+
5310+
class A {
5311+
KafkaContainer kafka = new KafkaContainer(DockerImageName.parse("apache/kafka-native:4.0.2"));
5312+
}
5313+
language: java
5314+
---
5315+
type: specs.openrewrite.org/v1beta/example
52705316
recipeName: org.openrewrite.java.testing.testcontainers.TestContainersBestPractices
52715317
examples:
52725318
- description: '`TestcontainersBestPracticesTest#getHost`'

src/test/java/org/openrewrite/java/testing/mockito/RemoveTimesZeroAndOneTest.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@
1717

1818
import org.junit.jupiter.api.Test;
1919
import org.openrewrite.DocumentExample;
20-
import org.openrewrite.Issue;
2120
import org.openrewrite.InMemoryExecutionContext;
21+
import org.openrewrite.Issue;
2222
import org.openrewrite.java.JavaParser;
2323
import org.openrewrite.test.RecipeSpec;
2424
import org.openrewrite.test.RewriteTest;
@@ -96,8 +96,8 @@ void test(Object myObject) {
9696
);
9797
}
9898

99-
@Test
10099
@Issue("https://github.com/openrewrite/rewrite-testing-frameworks/issues/968")
100+
@Test
101101
void retainVerificationModeIdentifier() {
102102
rewriteRun(
103103
//language=Java

0 commit comments

Comments
 (0)