Run custom recipe in Moderne CLI

[fcebk17]

Hi,

I want to create a Imperative recipes in Java, and have packaged the recipe into a .jar file. Here is the project structure:

However, when I run the mod config recipes jar install command, Moderne CLI shows BUILD SUCCESS

but when I enter mod config recipes jar install, it shows Found 0 recipes

I tried many methods to resolve this issue, but result is always that no recipe is found, I will provide my code below.

• rewrite.yml

type: specs.openrewrite.org/v1beta/recipe
name: ntou.cse.soselab.recipe.spring.FindSpringDependencies
displayName: Find Spring Controllers Services and Repositories
description: Finds Spring @Controller dependencies and maps them to @Service and @Repository components.
recipeList:
  - ntou.cse.soselab.recipe.spring.FindSpringDependenciesJava

• FindSpringDependenciesJava

package ntou.cse.soselab.recipe.spring;

import lombok.EqualsAndHashCode;
import lombok.Value;
import org.openrewrite.ExecutionContext;
import org.openrewrite.Recipe;
import org.openrewrite.TreeVisitor;
import org.openrewrite.java.JavaIsoVisitor;
import org.openrewrite.java.tree.J;

import java.util.HashMap;
import java.util.Map;

@Value
@EqualsAndHashCode(callSuper = true)
public class FindSpringDependenciesJava extends Recipe {
    @Override
    public String getDisplayName() {
        return "Find Spring Controllers Services and Repositories";
    }

    @Override
    public String getDescription() {
        return "Finds Spring @Controller dependencies and maps them to @Service and @Repository components.";
    }
    ...

• pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>3.4.2</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>ntou.cse.soselab</groupId>
    <artifactId>microservice-recipe</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>microservice-recipe</name>
    <description>microservice-recipe</description>

    <properties>
        <java.version>17</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
        <maven.compiler.testSource>17</maven.compiler.testSource>
        <maven.compiler.testTarget>17</maven.compiler.testTarget>
    </properties>

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

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-mongodb</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <!-- openrewrite setting -->
        <!-- rewrite-java dependencies only necessary for Java Recipe development -->
        <dependency>
            <groupId>org.openrewrite</groupId>
            <artifactId>rewrite-java</artifactId>
            <scope>compile</scope>
        </dependency>

        <!-- You only need the version that corresponds to your current
        Java version. It is fine to add all of them, though, as
        they can coexist on a classpath. -->
        <dependency>
            <groupId>org.openrewrite</groupId>
            <artifactId>rewrite-java-8</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.openrewrite</groupId>
            <artifactId>rewrite-java-11</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.openrewrite</groupId>
            <artifactId>rewrite-java-17</artifactId>
            <scope>runtime</scope>
        </dependency>

        <!-- rewrite-maven dependency only necessary for Maven Recipe development -->
        <dependency>
            <groupId>org.openrewrite</groupId>
            <artifactId>rewrite-maven</artifactId>
            <scope>compile</scope>
        </dependency>

        <!-- rewrite-yaml dependency only necessary for Yaml Recipe development -->
        <dependency>
            <groupId>org.openrewrite</groupId>
            <artifactId>rewrite-yaml</artifactId>
            <scope>compile</scope>
        </dependency>

        <!-- rewrite-properties dependency only necessary for Properties Recipe development -->
        <dependency>
            <groupId>org.openrewrite</groupId>
            <artifactId>rewrite-properties</artifactId>
            <scope>compile</scope>
        </dependency>

        <!-- rewrite-xml dependency only necessary for XML Recipe development -->
        <dependency>
            <groupId>org.openrewrite</groupId>
            <artifactId>rewrite-xml</artifactId>
            <scope>compile</scope>
        </dependency>

        <!-- lombok is optional, but recommended for authoring recipes -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

        <!-- For authoring tests for any kind of Recipe -->
        <dependency>
            <groupId>org.openrewrite</groupId>
            <artifactId>rewrite-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
<!--            <plugin>-->
<!--                <groupId>org.openrewrite.maven</groupId>-->
<!--                <artifactId>rewrite-maven-plugin</artifactId>-->
<!--                <version>6.1.4</version>-->
<!--                <configuration>-->
<!--                    <activeRecipes>-->
<!--                        <recipe>ntou.cse.soselab.recipe.spring.FindSpringDependencies</recipe>-->
<!--                    </activeRecipes>-->
<!--                </configuration>-->
<!--                <dependencies>-->
<!--                    <dependency>-->
<!--                        <groupId>ntou.cse.soselab</groupId>-->
<!--                        <artifactId>microservice-recipe</artifactId>-->
<!--                        <version>0.0.1-SNAPSHOT</version>-->
<!--                    </dependency>-->
<!--                </dependencies>-->
<!--            </plugin>-->

            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

[MBoegers]

Hi @fcebk17 cool to see your progress.
I have tested it with the moderneinc/rewrite-recipe-starter as we advise this as a starting point for recipe development. It comes with a working preconfigured maven configuration.
From what I can see your declarative recipe ntou.cse.soselab.recipe.spring.FindSpringDependencies and your imperative recipe ntou.cse.soselab.recipe.spring.FindSpringDependenciesJava both look good and in the end I would expect two recipes loaded.
What I also see is that your pom file has significant differences from the moderneinc/rewrite-recipe-starter one.

I would suggest using the pom from out starter, add you spring dependencies and try again. If it keeps failing, please check the log we are producing if there are any errors.

[fcebk17]

Hi @MBoegers, thanks for your reply.
After using the configuration file from rewrite-recipe-starter, I was able to successfully to see my custom recipe in Moderne CLI. But I tried many times before it worked. If there are any updates, I'll share the progress.

[MBoegers]

Good to see you enabled again =) A little bit of context here. The CLI loads recipes artifacts at runtime, therefore the configuration of the class path and dependencies is fragile, easy to break. If recipes are not picked up at some point its always a good idea to check against the current version of the rewrite-recipe-starter.
You are welcome to share what broke it on your end :)