Moderne OnlyThis recipe is proprietary to Moderne and runs on the Moderne platform or CLI — it isn’t part of the open-source catalog. Available with a Moderne subscription.Contact Sales

Replace a method invocation with a reference to an annotated field

Recipe IDio.moderne.java.dropwizard.boot.test.ReplaceMethodInvocationWithAnnotatedField

Artifactio.moderne.recipe:rewrite-dropwizard

For each class containing an invocation matching the configured method pattern, introduces an annotated field of the requested type and rewrites every matching invocation in that class to reference the new field. If a field with the same annotation and type already exists, its name is reused.

Single recipeOpenRewriteModerne Proprietary License

Try in PlatformTry this recipe in the Moderne platform. Not a user yet? You’ll get a no-setup demo environment, with nothing to install or configure.

Options

5 parameters

5 required

Parameter	Example	Type	Required
annotationFqn	org.springframework.boot.test.web.server.LocalServerPort	String	Required
Fully qualified annotation type to place on the new field.
classpathResources	spring-boot-test-3.*	List	Required
Resource patterns passed to the JavaParser used by the field-injection template.
fieldType	int	String	Required
Either a primitive keyword (e.g. int) or a fully qualified class name for the field's type.
methodPattern	io.dropwizard.testing.junit5.DropwizardAppExtension getLocalPort()	String	Required
A method pattern matched against the invocation to replace. A [method pattern](https://docs.openrewrite.org/reference/method-patterns) is used to find matching method invocations. For example, to find all method invocations in the Guava library, use the pattern: com.google.common..*#*(..).<br/><br/>The pattern format is <PACKAGE>#<METHOD_NAME>(<ARGS>). <br/><br/>..* includes all subpackages of com.google.common. <br/>*(..) matches any method name with any number of arguments. <br/><br/>For more specific queries, like Guava's ImmutableMap, use com.google.common.collect.ImmutableMap#*(..) to narrow down the results.
preferredFieldName	localPort	String	Required
Name to give the new field. If a same-named field already exists in the class, an incrementing suffix is appended to avoid collision.

Examples

java

Parameter	Value
methodPattern	GET_LOCAL_PORT_PATTERN
fieldType	int
annotationFqn	org.springframework.boot.test.web.server.LocalServerPort
preferredFieldName	localPort
classpathResources	List.of("spring-boot-test-3")

Unchanged

import io.dropwizard.core.Application;
import io.dropwizard.core.Configuration;
import io.dropwizard.core.setup.Environment;
public class TestApp extends Application<Configuration> {
    @Override public void run(Configuration c, Environment e) {}
}

java

Before

import io.dropwizard.core.Configuration;
import io.dropwizard.testing.junit5.DropwizardAppExtension;

abstract class AbstractComponentTest {
    static final DropwizardAppExtension<Configuration> DROPWIZARD =
        new DropwizardAppExtension<>(TestApp.class, "server.yml");

    void someTest() {
        int port = DROPWIZARD.getLocalPort();
    }
}

After

import io.dropwizard.core.Configuration;
import io.dropwizard.testing.junit5.DropwizardAppExtension;
import org.springframework.boot.test.web.server.LocalServerPort;

abstract class AbstractComponentTest {
    @LocalServerPort
    int localPort;
    static final DropwizardAppExtension<Configuration> DROPWIZARD =
        new DropwizardAppExtension<>(TestApp.class, "server.yml");

    void someTest() {
        int port = localPort;
    }
}

Diff

@@ -3,0 +3,1 @@
import io.dropwizard.core.Configuration;
import io.dropwizard.testing.junit5.DropwizardAppExtension;
+import org.springframework.boot.test.web.server.LocalServerPort;

@@ -5,0 +6,2 @@

abstract class AbstractComponentTest {
+   @LocalServerPort
+   int localPort;
    static final DropwizardAppExtension<Configuration> DROPWIZARD =
@@ -9,1 +12,1 @@

    void someTest() {
-       int port = DROPWIZARD.getLocalPort();
+       int port = localPort;
    }

Usage

Run this recipe

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe ReplaceMethodInvocationWithAnnotatedField --recipe-option "methodPattern=io.dropwizard.testing.junit5.DropwizardAppExtension getLocalPort()" --recipe-option "fieldType=int" --recipe-option "annotationFqn=org.springframework.boot.test.web.server.LocalServerPort" --recipe-option "preferredFieldName=localPort" --recipe-option "classpathResources=spring-boot-test-3.*"

If the recipe is not available locally, then you can install it using:

mod config recipes jar install io.moderne.recipe:rewrite-dropwizard:0.5.3

Data tables

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column	Description
Source path before the run	The source path of the file before the run. null when a source file was created during the run.
Source path after the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changes	In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changes	The specific recipe that made a change.
Estimated time saving	An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
Cycle	The recipe cycle in which the change was made.

Source files that had search results

org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

Column	Description
Source path of search result before the run	The source path of the file with the search result markers present.
Source path of search result after run the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Result	The trimmed printed tree of the LST element that the marker is attached to.
Description	The content of the description of the marker.
Recipe that added the search marker	The specific recipe that added the Search marker.

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column	Description
Source path	The file that failed to parse.
Recipe that made changes	The specific recipe that made a change.
Stack trace	The stack trace of the failure.

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column	Description
The recipe	The recipe whose stats are being measured both individually and cumulatively.
Source file count	The number of source files the recipe ran over.
Source file changed count	The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)	The total time spent across the scanning phase of this recipe.
Max scanning time (ns)	The max time scanning any one source file.
Cumulative edit time (ns)	The total time spent across the editing phase of this recipe.
Max edit time (ns)	The max time editing any one source file.