Need Help - Custom Recipe to add new line of code in existing method - Test fails due to format issue

[RinksP]

Requirement - Add line of code in existing method declaration
New Line To be Added
rabbitTemplate.setObservationEnabled(true);

Input Code

package com.keeplearning.rinks.config;

import org.springframework.amqp.rabbit.connection.CachingConnectionFactory;
import org.springframework.amqp.rabbit.connection.ConnectionFactory;
import org.springframework.amqp.rabbit.core.RabbitTemplate;
import org.springframework.amqp.support.converter.Jackson2JsonMessageConverter;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import com.fasterxml.jackson.databind.ObjectMapper;

@Configuration
public class RabbitMQConfiguration {

	@Bean
	public RabbitTemplate rabbitTemplate(ConnectionFactory connectionFactory, ObjectMapper mapper) {
		final RabbitTemplate rabbitTemplate = new RabbitTemplate(connectionFactory);
		return rabbitTemplate;
	}
}

Modified Code

package com.keeplearning.rinks.config;

import org.springframework.amqp.rabbit.connection.CachingConnectionFactory;
import org.springframework.amqp.rabbit.connection.ConnectionFactory;
import org.springframework.amqp.rabbit.core.RabbitTemplate;
import org.springframework.amqp.support.converter.Jackson2JsonMessageConverter;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import com.fasterxml.jackson.databind.ObjectMapper;

@Configuration
public class RabbitMQConfiguration {

	@Bean
	public RabbitTemplate rabbitTemplate(ConnectionFactory connectionFactory, ObjectMapper mapper) {
		final RabbitTemplate rabbitTemplate = new RabbitTemplate(connectionFactory);
		rabbitTemplate.setObservationEnabled(true);
		return rabbitTemplate;
	}
}

Custom Recipe
Built new custom recipe to achieve same and it's able to add new line correctly but recipe test is always failing due to mismatches in formatting. In fact, test is changing formatting for "expected" java code too.

Issue
Recipe is modifying method code to add line ax expected but added line is not having proper format and test case is failing due to same. I have tried adding "maybeAutoFormat" as shown in recipe code below but still no success.

Recipe Code

package com.keeplearning.rinks.openrewrite;

import org.openrewrite.ExecutionContext;
import org.openrewrite.Option;
import org.openrewrite.Recipe;
import org.openrewrite.Validated;
import org.openrewrite.internal.lang.NonNull;
import org.openrewrite.java.JavaIsoVisitor;
import org.openrewrite.java.JavaTemplate;
import org.openrewrite.java.tree.J;

import com.fasterxml.jackson.annotation.JsonProperty;

import lombok.EqualsAndHashCode;
import lombok.Value;

@Value
@EqualsAndHashCode(callSuper = false)
public class AddObservationToRabbitTemplate extends Recipe {

	@Option(displayName = "Simple Method Name", description = "A simple method name indicating which method to set setObservationEnabled.", example = "rabbitTemplate")
	String simpleMethodName;

	public AddObservationToRabbitTemplate(@NonNull @JsonProperty("simpleMethodName") String simpleMethodName) {
		this.simpleMethodName = simpleMethodName;
	}

	@Override
	public String getDisplayName() {
		// TODO Auto-generated method stub
		return "Add setObservationEnabled to RabbitTemplate Bean configuration";
	}

	@Override
	public String getDescription() {
		return "Add setObservationEnabled to RabbitTemplate Bean configuration.";
	}

	@Override
	public JavaIsoVisitor<ExecutionContext> getVisitor() {
		return new JavaIsoVisitor<ExecutionContext>() {

			private String matchInvocationName = "setObservationEnabled";
			private final JavaTemplate rabbitTemplateObservationTemplate = JavaTemplate.builder(this::getCursor, "rabbitTemplate.setObservationEnabled(true);")
					.build();

			@Override
			public J.MethodDeclaration visitMethodDeclaration(J.MethodDeclaration methodDecl,
					ExecutionContext executionContext) {
				if (!methodDecl.getSimpleName().equals(simpleMethodName)) {
					return methodDecl;
				}

				boolean alreadyDone = methodDecl.getBody().getStatements().stream()
						.filter(statement -> statement instanceof J.MethodInvocation)
						.map(J.MethodInvocation.class::cast)
						.anyMatch(statement -> matchInvocationName.equals(statement.getName().toString()));

				if (alreadyDone) {
					return methodDecl;
				}
				
				/*
				  methodDecl = maybeAutoFormat(methodDecl,
				  methodDecl.withTemplate(rabbitTemplateObservationTemplate, methodDecl.getBody().getStatements()
				  .get(methodDecl.getBody().getStatements().size()-1).getCoordinates().before()
				  ), executionContext);
				  */
				 
				
				methodDecl = methodDecl.withTemplate(rabbitTemplateObservationTemplate, methodDecl.getBody().getStatements()
								.get(methodDecl.getBody().getStatements().size() - 1).getCoordinates().before());

				return methodDecl;
			}
		};
	}

	@Override
	public Validated validate() {
		Validated validated = Validated.none();
		validated = validated.and(Validated.notBlank("simpleMethodName", simpleMethodName));
		return validated;
	}
}

Recipe Test Code

package com.keeplearning.rinks.openrewrite;

import org.junit.jupiter.api.Test;
import org.openrewrite.test.RecipeSpec;
import org.openrewrite.test.RewriteTest;

import static org.openrewrite.java.Assertions.java;

public class AddObservationToRabbitTemplateTest implements RewriteTest {

	@Override
	public void defaults(RecipeSpec spec) {
		spec.recipe(new AddObservationToRabbitTemplate("rabbitTemplate"));
	}

	@Test
	void addsObservationToRabbitTemplate() {
		
		rewriteRun(
				java(
				"""
					package com.keeplearning.rinks.config;

					import org.springframework.amqp.rabbit.connection.CachingConnectionFactory;
					import org.springframework.amqp.rabbit.connection.ConnectionFactory;
					import org.springframework.amqp.rabbit.core.RabbitTemplate;
					import org.springframework.amqp.support.converter.Jackson2JsonMessageConverter;
					import org.springframework.beans.factory.annotation.Value;
					import org.springframework.context.annotation.Bean;
					import org.springframework.context.annotation.Configuration;

					import com.fasterxml.jackson.databind.ObjectMapper;

					@Configuration
					public class RabbitMQConfiguration {

						@Bean
						public RabbitTemplate rabbitTemplate(ConnectionFactory connectionFactory, ObjectMapper mapper) {
							final RabbitTemplate rabbitTemplate = new RabbitTemplate(connectionFactory);
							return rabbitTemplate;
						}
					}					
				""", 
				"""
					package com.keeplearning.rinks.config;

					import org.springframework.amqp.rabbit.connection.CachingConnectionFactory;
					import org.springframework.amqp.rabbit.connection.ConnectionFactory;
					import org.springframework.amqp.rabbit.core.RabbitTemplate;
					import org.springframework.amqp.support.converter.Jackson2JsonMessageConverter;
					import org.springframework.beans.factory.annotation.Value;
					import org.springframework.context.annotation.Bean;
					import org.springframework.context.annotation.Configuration;

					import com.fasterxml.jackson.databind.ObjectMapper;

					@Configuration
					public class RabbitMQConfiguration {

						@Bean
						public RabbitTemplate rabbitTemplate(ConnectionFactory connectionFactory, ObjectMapper mapper) {
							final RabbitTemplate rabbitTemplate = new RabbitTemplate(connectionFactory);
							rabbitTemplate.setObservationEnabled(true);
							return rabbitTemplate;
						}
					}
				"""
				)
			);
	}
}

Failure Trace is attached in file
assertionFailedError.txt

[knutwannheden]

Apart from a few details I think your recipe looks mostly correct and I would expect the auto-formatting to kick in. Can you tell us what version of OpenRewrite you are on?

[knutwannheden]

I copied your recipe and also your test and got the test passing. I did however have to add change the test defaults to disable type validation, because the types the test code refers to are not loaded:

    @Override
    public void defaults(RecipeSpec spec) {
        spec.recipe(new AddObservationToRabbitTemplate("rabbitTemplate"))
          .typeValidationOptions(TypeValidation.none());
    }

In your case you may be able to fix this by adding the types to the parser's classpath. E.g.:

    @Override
    public void defaults(RecipeSpec spec) {
        spec.recipe(new AddObservationToRabbitTemplate("rabbitTemplate"))
          .parser(JavaParser.fromJavaVersion()
            .classpath(JavaParser.runtimeClasspath())
          );
    }

You can read more about the classpath options here: https://docs.openrewrite.org/concepts-explanations/javatemplate#referencing-external-types. The documentation is for JavaTemplate but it is also valid for tests, where you often also need to reference external types.

[RinksP]

Thank you for your answer. Please see details below.
Rewrite Recipe BOM Version

			<dependency>
				<groupId>org.openrewrite.recipe</groupId>
				<artifactId>rewrite-recipe-bom</artifactId>
				<version>1.19.4</version>
				<type>pom</type>
				<scope>import</scope>
			</dependency>

JUNIT Report with error

[ERROR]   AddObservationToRabbitTemplateTest.addsObservationToRabbitTemplate:22 [Unexpected result in "com/keeplearning/rinks/config/RabbitMQConfiguration.java"
diff --git a/com/keeplearning/rinks/config/RabbitMQConfiguration.java b/com/keeplearning/rinks/config/RabbitMQConfiguration.java
index dd69252..679242c 100644
--- a/com/keeplearning/rinks/config/RabbitMQConfiguration.java
+++ b/com/keeplearning/rinks/config/RabbitMQConfiguration.java
@@ -16,7 +16,7 @@ 
 	@Bean
 	public RabbitTemplate rabbitTemplate(ConnectionFactory connectionFactory, ObjectMapper mapper) {
 		final RabbitTemplate rabbitTemplate = new RabbitTemplate(connectionFactory);
-		rabbitTemplate.setObservationEnabled(true);
+        rabbitTemplate.setObservationEnabled(true);
 		return rabbitTemplate;
 	}
 }
]

[knutwannheden]

@RinksP Were you able to resolve this? I think I saw a comment, where you said that removing some other dependencies resolved the issue, but I can't find it anymore.

[RinksP]

I had added comment in hurry that it worked but it was not running any test case.
Issue is still there and finding its more time consuming to write and test recipe than actually modifying code manually.
I'm not sure if its related to my Recipe Development Environment setup or IDE (STS) issue. As working on very tight schedule for upgrade, I had to move on without recipe but to have manually modified 15 applications. Thank you for you support though.