Add migration tests and recipes for Spring Batch #686

qwtfps · 2025-03-12T10:08:18Z

What's changed?

Add corresponding migration recipes:

JobParameterToString: Migrate JobParameter.toString() to JobParameter.getValue().toString().
MigrateMethodAnnotatedByBatchAPI: Update methods annotated by Spring Batch API.
MigrateJobParameter: Ensure job parameters are parameterized.
ConvertReceiveTypeWhenCallStepExecutionMethod: Convert receive types in StepExecution method calls.

What's your motivation?

Anything in particular you'd like reviewers to focus on?

Anyone you would like to review specifically?

Have you considered any alternatives or workarounds?

Any additional context

Checklist

I've added unit tests to cover both positive and negative cases
I've read and applied the recipe conventions and best practices
I've used the IntelliJ IDEA auto-formatter on affected files

main - Add migration tests and recipes for Spring Batch Add tests and migration recipes to support Spring Batch 5 updates: - Implement `MigrateJobParameterToStringTest` to verify migration of `JobParameter.toString()` to `JobParameter.getValue().toString()`. - Implement `MigrateMethodAnnotatedByBatchAPITest` to test migration of methods annotated by Spring Batch API. - Add `MigrateJobParameterTest` to ensure job parameters are correctly parameterized. - Create `ConvertReceiveTypeWhenCallStepExecutionMethodTest` to test conversion of receive types in StepExecution method calls. Add corresponding migration recipes: - `JobParameterToString`: Migrate `JobParameter.toString()` to `JobParameter.getValue().toString()`. - `MigrateMethodAnnotatedByBatchAPI`: Update methods annotated by Spring Batch API. - `MigrateJobParameter`: Ensure job parameters are parameterized. - `ConvertReceiveTypeWhenCallStepExecutionMethod`: Convert receive types in StepExecution method calls. ```

Add new migration recipes to the Spring Batch 5.0 configuration: - ConvertReceiveTypeWhenCallStepExecutionMethod - JobParameterToString - MigrateJobParameter - MigrateMethodAnnotatedByBatchAPI These updates enhance the migration process by ensuring compatibility with the latest Spring Batch API changes.

...in/java/org/openrewrite/java/spring/batch/ConvertReceiveTypeWhenCallStepExecutionMethod.java

src/testWithSpringBoot_3_0/java/org/openrewrite/java/spring/batch/MigrateJobParameterTest.java

...thSpringBoot_3_0/java/org/openrewrite/java/spring/batch/MigrateJobParameterToStringTest.java

...ingBoot_3_0/java/org/openrewrite/java/spring/batch/MigrateMethodAnnotatedByBatchAPITest.java

...in/java/org/openrewrite/java/spring/batch/ConvertReceiveTypeWhenCallStepExecutionMethod.java

src/main/java/org/openrewrite/java/spring/batch/MigrateMethodAnnotatedByBatchAPI.java

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Correct inconsistencies in the use of context parameters across Spring Batch migration recipes. Ensure uniformity by replacing `executionContext` with `ctx` where applicable. This change improves code readability and maintains consistency in method signatures, facilitating easier maintenance and understanding of the migration logic.

src/main/java/org/openrewrite/java/spring/batch/JobParameterToString.java

src/main/java/org/openrewrite/java/spring/batch/MigrateJobParameter.java

src/main/java/org/openrewrite/java/spring/batch/MigrateMethodAnnotatedByBatchAPI.java

qwtfps · 2025-03-18T02:34:13Z

hi @timtebeek , do you know why ci build failed ? I can build in my local with the latest commit. I check the log , most likely it is not relevant to the new recipe.

timtebeek · 2025-03-18T08:49:00Z

It looks like this test failed in a way I hadn't see before 🤔

MigrateJobParameterTest > test1() FAILED
    java.io.UncheckedIOException: java.io.IOException: Failed to create directory /home/runner/.rewrite/classpath/.tt/org/springframework/batch/spring-batch-core
        at org.openrewrite.java.internal.parser.TypeTable$Reader.lambda$writeClassesDir$4(TypeTable.java:247)
        at org.openrewrite.java.internal.parser.TypeTable$Reader$$Lambda$483/0x00007fdfac17b4c8.accept(Unknown Source)
        at java.base/java.util.HashMap$Values.forEach(HashMap.java:1065)
        at org.openrewrite.java.internal.parser.TypeTable$Reader.writeClassesDir(TypeTable.java:244)
        at org.openrewrite.java.internal.parser.TypeTable$Reader.lambda$read$3(TypeTable.java:185)
        at org.openrewrite.java.internal.parser.TypeTable$Reader$$Lambda$480/0x00007fdfac17a098.accept(Unknown Source)
        at java.base/java.util.stream.ForEachOps$ForEachOp$OfRef.accept(ForEachOps.java:183)
        at java.base/java.util.stream.SliceOps$1$1.accept(SliceOps.java:200)
        at java.base/java.util.Iterator.forEachRemaining(Iterator.java:133)
        at java.base/java.util.Spliterators$IteratorSpliterator.forEachRemaining(Spliterators.java:1845)
        at java.base/java.util.stream.AbstractPipeline.copyInto(AbstractPipeline.java:509)
        at java.base/java.util.stream.AbstractPipeline.wrapAndCopyInto(AbstractPipeline.java:499)
        at java.base/java.util.stream.ForEachOps$ForEachOp.evaluateSequential(ForEachOps.java:150)
        at java.base/java.util.stream.ForEachOps$ForEachOp$OfRef.evaluateSequential(ForEachOps.java:173)
        at java.base/java.util.stream.AbstractPipeline.evaluate(AbstractPipeline.java:234)
        at java.base/java.util.stream.ReferencePipeline.forEach(ReferencePipeline.java:596)
        at org.openrewrite.java.internal.parser.TypeTable$Reader.read(TypeTable.java:180)
        at org.openrewrite.java.internal.parser.TypeTable.read(TypeTable.java:123)
        at org.openrewrite.java.internal.parser.TypeTable.<init>(TypeTable.java:111)
        at org.openrewrite.java.internal.parser.TypeTable.fromClasspath(TypeTable.java:97)
        at org.openrewrite.java.JavaParser.dependenciesFromResources(JavaParser.java:128)
        at org.openrewrite.java.JavaParser$Builder.classpathFromResources(JavaParser.java:324)
        at org.openrewrite.java.spring.batch.MigrateJobParameterTest.defaults(MigrateJobParameterTest.java:32)
        at org.openrewrite.test.RewriteTest.rewriteRun(RewriteTest.java:138)
        at org.openrewrite.test.RewriteTest.rewriteRun(RewriteTest.java:130)
        at org.openrewrite.java.spring.batch.MigrateJobParameterTest.test1(MigrateJobParameterTest.java:40)

        Caused by:
        java.io.IOException: Failed to create directory /home/runner/.rewrite/classpath/.tt/org/springframework/batch/spring-batch-core
            at org.openrewrite.java.internal.parser.TypeTable$Reader.lambda$writeClassesDir$4(TypeTable.java:247)
            ... 25 more

qwtfps · 2025-03-26T02:31:19Z

@timtebeek How to try rerun the CI. I push the fix commit.

timtebeek · 2025-03-26T09:52:36Z

Thanks! I've triggered the CI builds again; that should only be an issue for your first contribution; after that they should start automatically.

src/testWithSpringBoot_3_0/java/org/openrewrite/java/spring/batch/JobParameterToStringTest.java

qwtfps · 2025-04-02T02:59:30Z

Thanks @timtebeek . I saw your commit which helped me refine the code. I check the CI log info summary is below. I think it was irrelevant to this PR . Is it helpful if i sync the code with master ?

208 tests completed, 2 failed, 1 skipped

Detail

MigrateResponseStatusExceptionTest > migrateResponseStatusExceptionGetRawStatusCodeMethod() FAILED
    java.lang.AssertionError: [Recipe validation must have no failures] 
    Expecting empty but was: [[Invalid{property='initialization', value='[]', message='DeclarativeRecipe must not contain uninitialized recipes. Be sure to call .initialize() on DeclarativeRecipe.'},
        Invalid{property='org.openrewrite.java.spring.framework.MigrateResponseStatusException.recipeList[0] (in file:///home/runner/work/rewrite-spring/rewrite-spring/build/resources/main/META-INF/rewrite/spring-framework-60.yml)', value='org.openrewrite.java.spring.framework.MigrateResponseStatusExceptionGetRawStatusCodeMethod', message='recipe 'org.openrewrite.java.spring.framework.MigrateResponseStatusExceptionGetRawStatusCodeMethod' does not exist.'},
        Invalid{property='org.openrewrite.java.spring.framework.MigrateResponseStatusException.recipeList[1] (in file:///home/runner/work/rewrite-spring/rewrite-spring/build/resources/main/META-INF/rewrite/spring-framework-60.yml)', value='org.openrewrite.java.spring.framework.MigrateResponseStatusExceptionGetStatusCodeMethod', message='recipe 'org.openrewrite.java.spring.framework.MigrateResponseStatusExceptionGetStatusCodeMethod' does not exist.'}]]
        at org.openrewrite.test.RewriteTest.rewriteRun(RewriteTest.java:222)
        at org.openrewrite.test.RewriteTest.rewriteRun(RewriteTest.java:130)
        at org.openrewrite.test.RewriteTest.rewriteRun(RewriteTest.java:125)
        at org.openrewrite.java.spring.framework.MigrateResponseStatusExceptionTest.migrateResponseStatusExceptionGetRawStatusCodeMethod(MigrateResponseStatusExceptionTest.java:91)

MigrateResponseStatusExceptionTest > migrateResponseStatusExceptionGetStatusMethod() FAILED
    java.lang.AssertionError: [Recipe validation must have no failures] 
    Expecting empty but was: [[Invalid{property='initialization', value='[]', message='DeclarativeRecipe must not contain uninitialized recipes. Be sure to call .initialize() on DeclarativeRecipe.'},
        Invalid{property='org.openrewrite.java.spring.framework.MigrateResponseStatusException.recipeList[0] (in file:///home/runner/work/rewrite-spring/rewrite-spring/build/resources/main/META-INF/rewrite/spring-framework-60.yml)', value='org.openrewrite.java.spring.framework.MigrateResponseStatusExceptionGetRawStatusCodeMethod', message='recipe 'org.openrewrite.java.spring.framework.MigrateResponseStatusExceptionGetRawStatusCodeMethod' does not exist.'},
        Invalid{property='org.openrewrite.java.spring.framework.MigrateResponseStatusException.recipeList[1] (in file:///home/runner/work/rewrite-spring/rewrite-spring/build/resources/main/META-INF/rewrite/spring-framework-60.yml)', value='org.openrewrite.java.spring.framework.MigrateResponseStatusExceptionGetStatusCodeMethod', message='recipe 'org.openrewrite.java.spring.framework.MigrateResponseStatusExceptionGetStatusCodeMethod' does not exist.'}]]
        at org.openrewrite.test.RewriteTest.rewriteRun(RewriteTest.java:222)
        at org.openrewrite.test.RewriteTest.rewriteRun(RewriteTest.java:130)
        at org.openrewrite.test.RewriteTest.rewriteRun(RewriteTest.java:125)
        at org.openrewrite.java.spring.framework.MigrateResponseStatusExceptionTest.migrateResponseStatusExceptionGetStatusMethod(MigrateResponseStatusExceptionTest.java:61)

timtebeek · 2025-04-04T19:07:26Z

Thanks for the ping @qwtfps ! I was out for a few days, but trying to catch up now. The latest failures now are:

MigrateJobParameterTest > addStringClassArguments() FAILED
    org.opentest4j.AssertionFailedError: [Expected recipe to complete in 1 cycle, but took at least one more cycle. Between the last two executed cycles there were changes to "test/PointsReconFileWriterTest.java"] 
    expected: 
      "package test;
      import org.springframework.batch.core.JobParameter;
      import org.springframework.batch.core.JobParameters;
      import java.util.Date;
      import java.util.Map;
      import java.util.HashMap;
      import java.util.UUID;
      public class PointsReconFileWriterTest {
  
          @Test
          public void shouldUpdateMemberStatusWhenDecisionCodeIsA() throws Exception {
              String from = UUID.randomUUID().toString();
              Map<String,JobParameter<?>> parameters = new HashMap<>();
              parameters.put("sellerId", new JobParameter<>(from, String.class));
              parameters.put("smtpHost", new JobParameter<>("localhost", String.class));
  
              JobParameters jobParameters = new JobParameters(parameters);
          }
  
      }"
     but was: 
      "package test;
      import org.springframework.batch.core.JobParameter;
      import org.springframework.batch.core.JobParameters;
      import java.util.Date;
      import java.util.Map;
      import java.util.HashMap;
      import java.util.UUID;
      public class PointsReconFileWriterTest {
  
          @Test
          public void shouldUpdateMemberStatusWhenDecisionCodeIsA() throws Exception {
              String from = UUID.randomUUID().toString();
              Map<String,JobParameter<?>> parameters = new HashMap<>();
              parameters.put("sellerId", new JobParameter<>(from, String.class));
              parameters.put("smtpHost", new JobParameter<>("localhost", String.class, String.class));
  
              JobParameters jobParameters = new JobParameters(parameters);
          }
  
      }"
        at app//org.openrewrite.test.LargeSourceSetCheckingExpectedCycles.afterCycle(LargeSourceSetCheckingExpectedCycles.java:97)
        at app//org.openrewrite.RecipeScheduler.runRecipeCycles(RecipeScheduler.java:98)
        at app//org.openrewrite.RecipeScheduler.scheduleRun(RecipeScheduler.java:41)
        at app//org.openrewrite.Recipe.run(Recipe.java:438)
        at app//org.openrewrite.test.RewriteTest.rewriteRun(RewriteTest.java:377)
        at app//org.openrewrite.test.RewriteTest.rewriteRun(RewriteTest.java:130)
        at app//org.openrewrite.java.spring.batch.MigrateJobParameterTest.addStringClassArguments(MigrateJobParameterTest.java:90)

MigrateJobParameterTest > test3() FAILED
    org.opentest4j.AssertionFailedError: [Expected recipe to complete in 1 cycle, but took at least one more cycle. Between the last two executed cycles there were changes to "test/PointsReconFileWriterTest.java"] 
    expected: 
      "package test;
      import org.springframework.batch.core.JobParameter;
      import org.springframework.batch.core.JobParameters;
      import java.util.Date;
      import java.util.HashMap;
      import java.util.Map;
      import java.util.UUID;
      public class PointsReconFileWriterTest {
  
          @Test
          public void shouldUpdateMemberStatusWhenDecisionCodeIsA() throws Exception {
              final Map<String,JobParameter<?>> paramMap = new HashMap<>() {{
                          put("Target", new JobParameter<>("JOB_NAME", String.class));
              }};
          }
  
      }"
     but was: 
      "package test;
      import org.springframework.batch.core.JobParameter;
      import org.springframework.batch.core.JobParameters;
      import java.util.Date;
      import java.util.HashMap;
      import java.util.Map;
      import java.util.UUID;
      public class PointsReconFileWriterTest {
  
          @Test
          public void shouldUpdateMemberStatusWhenDecisionCodeIsA() throws Exception {
              final Map<String,JobParameter<?>> paramMap = new HashMap<>() {{
                          put("Target", new JobParameter<>("JOB_NAME", String.class, String.class));
              }};
          }
  
      }"
        at app//org.openrewrite.test.LargeSourceSetCheckingExpectedCycles.afterCycle(LargeSourceSetCheckingExpectedCycles.java:97)
        at app//org.openrewrite.RecipeScheduler.runRecipeCycles(RecipeScheduler.java:98)
        at app//org.openrewrite.RecipeScheduler.scheduleRun(RecipeScheduler.java:41)
        at app//org.openrewrite.Recipe.run(Recipe.java:438)
        at app//org.openrewrite.test.RewriteTest.rewriteRun(RewriteTest.java:377)
        at app//org.openrewrite.test.RewriteTest.rewriteRun(RewriteTest.java:130)
        at app//org.openrewrite.java.spring.batch.MigrateJobParameterTest.test3(MigrateJobParameterTest.java:144)

MigrateJobParameterTest > addClassArguments() FAILED
    org.opentest4j.AssertionFailedError: [Expected recipe to complete in 1 cycle, but took at least one more cycle. Between the last two executed cycles there were changes to "test/PointsReconFileWriterTest.java"] 
    expected: 
      "package test;
      import org.springframework.batch.core.JobParameter;
      import org.springframework.batch.core.JobParameters;
      import java.util.Date;
      import java.util.Map;
  
      public class PointsReconFileWriterTest {
  
          @Test
          public void shouldUpdateMemberStatusWhenDecisionCodeIsA() throws Exception {
              JobParameters jobParameters = new JobParameters(Map.of(
                      "inputFile", new JobParameter<>("TEST_INPUT_FILE", String.class),
                      "emailId", new JobParameter<>(new Date(), Date.class),
                      "pgpKey", new JobParameter<>(new Integer[]{1}, java.lang.Integer[].class)
              ));
          }
  
      }"
     but was: 
      "package test;
      import org.springframework.batch.core.JobParameter;
      import org.springframework.batch.core.JobParameters;
      import java.util.Date;
      import java.util.Map;
  
      public class PointsReconFileWriterTest {
  
          @Test
          public void shouldUpdateMemberStatusWhenDecisionCodeIsA() throws Exception {
              JobParameters jobParameters = new JobParameters(Map.of(
                      "inputFile", new JobParameter<>("TEST_INPUT_FILE", String.class, String.class),
                      "emailId", new JobParameter<>(new Date(), Date.class),
                      "pgpKey", new JobParameter<>(new Integer[]{1}, java.lang.Integer[].class, java.lang.Integer[].class)
              ));
          }
  
      }"
        at app//org.openrewrite.test.LargeSourceSetCheckingExpectedCycles.afterCycle(LargeSourceSetCheckingExpectedCycles.java:97)
        at app//org.openrewrite.RecipeScheduler.runRecipeCycles(RecipeScheduler.java:98)
        at app//org.openrewrite.RecipeScheduler.scheduleRun(RecipeScheduler.java:41)
        at app//org.openrewrite.Recipe.run(Recipe.java:438)
        at app//org.openrewrite.test.RewriteTest.rewriteRun(RewriteTest.java:377)
        at app//org.openrewrite.test.RewriteTest.rewriteRun(RewriteTest.java:130)
        at app//org.openrewrite.java.spring.batch.MigrateJobParameterTest.addClassArguments(MigrateJobParameterTest.java:40)

timtebeek

Great to see these! I've pushed some minor polish already, but need to find time to rework the missing types before we can confidently merge these recipes.

...ava/org/openrewrite/java/spring/batch/ConvertReceiveTypeWhenCallStepExecutionMethodTest.java

timtebeek

Great to have these additional steps covered for Spring Batch; I hope they help you migrate there!

...ingBoot_3_0/java/org/openrewrite/java/spring/batch/MigrateMethodAnnotatedByBatchAPITest.java

…tch/MigrateMethodAnnotatedByBatchAPITest.java Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

qwtfps added 2 commits March 12, 2025 17:52

moderne-meeseeks bot added this to OpenRewrite Mar 12, 2025

github-project-automation bot moved this to In Progress in OpenRewrite Mar 12, 2025

github-actions bot reviewed Mar 12, 2025

View reviewed changes

timtebeek reviewed Mar 12, 2025

View reviewed changes

...in/java/org/openrewrite/java/spring/batch/ConvertReceiveTypeWhenCallStepExecutionMethod.java Outdated Show resolved Hide resolved

timtebeek reviewed Mar 12, 2025

View reviewed changes

...in/java/org/openrewrite/java/spring/batch/ConvertReceiveTypeWhenCallStepExecutionMethod.java Outdated Show resolved Hide resolved

timtebeek reviewed Mar 12, 2025

View reviewed changes

...in/java/org/openrewrite/java/spring/batch/ConvertReceiveTypeWhenCallStepExecutionMethod.java Outdated Show resolved Hide resolved

timtebeek reviewed Mar 12, 2025

View reviewed changes

src/main/java/org/openrewrite/java/spring/batch/MigrateMethodAnnotatedByBatchAPI.java Outdated Show resolved Hide resolved

timtebeek and others added 3 commits March 12, 2025 16:49

Apply suggestions from code review

b0b6c41

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Merge branch 'main' into batch

d60d68f

github-actions bot reviewed Mar 13, 2025

View reviewed changes

timtebeek added 2 commits March 14, 2025 19:31

Apply suggested best practices

45bbe0f

Merge branch 'main' into batch

bf2c119

timtebeek self-requested a review March 14, 2025 18:32

timtebeek assigned qwtfps Mar 14, 2025

Try fix UT running in CI

f1f118c

timtebeek added 2 commits March 30, 2025 23:32

Minor polish

877c96c

Only have a single document example per test class

b12e2f1

timtebeek reviewed Mar 30, 2025

View reviewed changes

src/testWithSpringBoot_3_0/java/org/openrewrite/java/spring/batch/JobParameterToStringTest.java Outdated Show resolved Hide resolved

Fix type information when running JobParameterToString

c0ff6c9

Merge branch 'main' into batch

5e9d84f

Merge branch 'main' into batch

ebd8538

timtebeek and others added 3 commits April 4, 2025 23:59

Use direct returns, do not print LST elements

94d493a

fix MigrateJobParameter UT

0a3c661

Minor polish

8cbc6fc

timtebeek reviewed Apr 8, 2025

View reviewed changes

...ava/org/openrewrite/java/spring/batch/ConvertReceiveTypeWhenCallStepExecutionMethodTest.java Outdated Show resolved Hide resolved

timtebeek added 3 commits April 8, 2025 22:25

Fix types for MigrateMethodAnnotatedByBatchAPI

b6b58bc

Fix types for MigrateJobParameterTest

cc1fe83

Fix types ConvertReceiveTypeWhenCallStepExecutionMethod

3be3813

timtebeek approved these changes Apr 8, 2025

View reviewed changes

github-project-automation bot moved this from In Progress to Ready to Review in OpenRewrite Apr 8, 2025

github-actions bot reviewed Apr 8, 2025

View reviewed changes

...ingBoot_3_0/java/org/openrewrite/java/spring/batch/MigrateMethodAnnotatedByBatchAPITest.java Outdated Show resolved Hide resolved

Update src/testWithSpringBoot_3_0/java/org/openrewrite/java/spring/ba…

01f28a9

…tch/MigrateMethodAnnotatedByBatchAPITest.java Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

timtebeek merged commit 4d76e3e into openrewrite:main Apr 8, 2025

github-project-automation bot moved this from Ready to Review to Done in OpenRewrite Apr 8, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add migration tests and recipes for Spring Batch #686

Add migration tests and recipes for Spring Batch #686

qwtfps commented Mar 12, 2025 •

edited

Loading

qwtfps commented Mar 18, 2025

timtebeek commented Mar 18, 2025

qwtfps commented Mar 26, 2025

timtebeek commented Mar 26, 2025

qwtfps commented Apr 2, 2025

timtebeek commented Apr 4, 2025

timtebeek left a comment

timtebeek left a comment

Add migration tests and recipes for Spring Batch #686

Add migration tests and recipes for Spring Batch #686

Conversation

qwtfps commented Mar 12, 2025 • edited Loading

What's changed?

What's your motivation?

Anything in particular you'd like reviewers to focus on?

Anyone you would like to review specifically?

Have you considered any alternatives or workarounds?

Any additional context

Checklist

qwtfps commented Mar 18, 2025

timtebeek commented Mar 18, 2025

qwtfps commented Mar 26, 2025

timtebeek commented Mar 26, 2025

qwtfps commented Apr 2, 2025

timtebeek commented Apr 4, 2025

timtebeek left a comment

Choose a reason for hiding this comment

timtebeek left a comment

Choose a reason for hiding this comment

qwtfps commented Mar 12, 2025 •

edited

Loading