Add hints in AppendToReleaseNotesTest.java

moderneinc · May 27, 2024 · 8b8b766 · 8b8b766
1 parent 21388ba
commit 8b8b766
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 8 deletions.
diff --git a/src/test/java/com/yourorg/AppendToReleaseNotesTest.java b/src/test/java/com/yourorg/AppendToReleaseNotesTest.java
@@ -32,18 +32,24 @@ public void defaults(RecipeSpec spec) {
 
     @Test
     void createNewReleaseNotes() {
+        // Notice how the before text is null, indicating that the file does not exist yet.
+        // The after text is the content of the file after the recipe is applied.
         rewriteRun(
-          text(null,
+          text(
+            null,
             """
               Hello world
-              """
+              """,
+            spec -> spec.path(Paths.get("RELEASE.md")
+            )
           )
         );
     }
 
     @DocumentExample
     @Test
     void editExistingReleaseNotes() {
+        // When the file does already exist, we assert the content is modified as expected.
         rewriteRun(
           text(
             """

diff --git a/src/test/java/com/yourorg/AssertEqualsToAssertThatTest.java b/src/test/java/com/yourorg/AssertEqualsToAssertThatTest.java
@@ -40,7 +40,7 @@ void twoArgument() {
           java(
             """
               import org.junit.jupiter.api.Assertions;
-                            
+              
               class A {
                   void foo() {
                       Assertions.assertEquals(1, 2);
@@ -49,7 +49,7 @@ void foo() {
               """,
             """
               import org.assertj.core.api.Assertions;
-                          
+              
               class A {
                   void foo() {
                       Assertions.assertThat(2).isEqualTo(1);
@@ -67,7 +67,7 @@ void withDescription() {
           java(
             """
               import org.junit.jupiter.api.Assertions;
-                            
+              
               class A {
                   void foo() {
                       Assertions.assertEquals(1, 2, "one equals two, everyone knows that");
@@ -76,7 +76,7 @@ void foo() {
               """,
             """
               import org.assertj.core.api.Assertions;
-                            
+              
               class A {
                   void foo() {
                       Assertions.assertThat(2).as("one equals two, everyone knows that").isEqualTo(1);

diff --git a/src/test/java/com/yourorg/UseOpenRewriteNullableTest.java b/src/test/java/com/yourorg/UseOpenRewriteNullableTest.java
@@ -45,15 +45,15 @@ void replacesNullableAnnotation() {
           java(
             """
               import org.jetbrains.annotations.Nullable;
-                            
+              
               class A {
                   @Nullable
                   String s;
               }
               """,
             """
               import org.openrewrite.internal.lang.Nullable;
-                            
+              
               class A {
                   @Nullable
                   String s;