Plan a Java version migration

Name: OpenRewrite
Author: Moderne

org.openrewrite.java.migrate.search.PlanJavaMigration

Study the set of Java versions and associated tools in use across many repositories.

Recipe source

GitHub: PlanJavaMigration.java, Issue Tracker, Code Genome Project

This recipe is available under the Moderne Source Available License. Moderne customers can download precompiled artifacts from The Code Genome Project. For non-commercial use you can build the artifact from source locally.

Usage

This recipe has no required configuration options. It can be activated by adding a dependency on `org.openrewrite.recipe:rewrite-migrate-java` in your build file or by running a shell command (in which case no build changes are needed):

OpenRewrite artifacts, including the Maven and Gradle plugins themselves, are distributed through the Code Genome Project repository (https://artifacts.codegenomeproject.org/maven), which requires authentication. Sign in to the Code Genome Project to create a download token; your build authenticates with the email or username you signed in with, plus that token as the password. See the quickstart guide for details.

Put your Code Genome Project credentials in ~/.gradle/gradle.properties, so that they are not committed alongside your build:
~/.gradle/gradle.properties
```
codeGenomeUsername=you@example.com
codeGenomeToken=your-download-token
```

Add the Code Genome Project repository to your settings.gradle file, so that the plugin itself can be resolved:

settings.gradle
pluginManagement {
    repositories {
        maven {
            url = "https://artifacts.codegenomeproject.org/maven"
            credentials {
                username = providers.gradleProperty("codeGenomeUsername").get()
                password = providers.gradleProperty("codeGenomeToken").get()
            }
        }
        // Keep the portal for any other plugins your build applies
        gradlePluginPortal()
    }
}

Add the following to your build.gradle file:

build.gradle
plugins {
    id("org.openrewrite.rewrite") version("latest.release")
}

rewrite {
    activeRecipe("org.openrewrite.java.migrate.search.PlanJavaMigration")
    setExportDatatables(true)
}

repositories {
    mavenCentral()
    maven {
        url = "https://artifacts.codegenomeproject.org/maven"
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-migrate-java:3.43.0")
}

Run gradle rewriteRun to run the recipe.

Export your Code Genome Project credentials. Init scripts run before any project is configured, so they cannot read gradle.properties:
shell
```
export CODE_GENOME_USERNAME='you@example.com'
export CODE_GENOME_TOKEN='your-download-token'
```

Create a file named init.gradle in the root of your project.

init.gradle
initscript {
    repositories {
        maven {
            url = "https://artifacts.codegenomeproject.org/maven"
            credentials {
                username = System.getenv("CODE_GENOME_USERNAME")
                password = System.getenv("CODE_GENOME_TOKEN")
            }
        }
    }
    dependencies { classpath("org.openrewrite:plugin:7.41.0") }
}
rootProject {
    plugins.apply(org.openrewrite.gradle.RewritePlugin)
    dependencies {
        rewrite("org.openrewrite.recipe:rewrite-migrate-java:3.43.0")
    }
    rewrite {
        activeRecipe("org.openrewrite.java.migrate.search.PlanJavaMigration")
    setExportDatatables(true)
    }
    afterEvaluate {
        if (repositories.isEmpty()) {
            repositories {
                mavenCentral()
            }
        }
        repositories {
            maven {
                url = "https://artifacts.codegenomeproject.org/maven"
                credentials {
                    username = System.getenv("CODE_GENOME_USERNAME")
                    password = System.getenv("CODE_GENOME_TOKEN")
                }
            }
        }
    }
}

Run the recipe.

shell
gradle --init-script init.gradle rewriteRun

Export your Code Genome Project credentials. Init scripts run before any project is configured, so they cannot read gradle.properties:
shell
```
export CODE_GENOME_USERNAME='you@example.com'
export CODE_GENOME_TOKEN='your-download-token'
```

Create a file named init.gradle.kts in the root of your project.

init.gradle.kts
initscript {
    repositories {
        maven {
            url = uri("https://artifacts.codegenomeproject.org/maven")
            credentials {
                username = System.getenv("CODE_GENOME_USERNAME")
                password = System.getenv("CODE_GENOME_TOKEN")
            }
        }
    }
    dependencies { classpath("org.openrewrite:plugin:7.41.0") }
}
rootProject {
    plugins.apply(org.openrewrite.gradle.RewritePlugin::class.java)
    dependencies {
        add("rewrite", "org.openrewrite.recipe:rewrite-migrate-java:3.43.0")
    }
    extensions.configure<org.openrewrite.gradle.RewriteExtension> {
        activeRecipe("org.openrewrite.java.migrate.search.PlanJavaMigration")
    setExportDatatables(true)
    }
    afterEvaluate {
        if (repositories.isEmpty()) {
            repositories {
                mavenCentral()
            }
        }
        repositories {
            maven {
                url = uri("https://artifacts.codegenomeproject.org/maven")
                credentials {
                    username = System.getenv("CODE_GENOME_USERNAME")
                    password = System.getenv("CODE_GENOME_TOKEN")
                }
            }
        }
    }
}

Run the recipe.

shell
gradle --init-script init.gradle.kts rewriteRun

Add the Code Genome Project credentials to your Maven settings.xml file (typically at ~/.m2/settings.xml), replacing USERNAME and TOKEN with your own:

settings.xml
<settings>
  <servers>
    <server>
      <id>codegenome</id>
      <username>USERNAME</username>
      <password>TOKEN</password>
    </server>
  </servers>
</settings>

Add the following to your pom.xml file:

pom.xml
<project>
  <repositories>
    <repository>
      <id>codegenome</id>
      <url>https://artifacts.codegenomeproject.org/maven</url>
    </repository>
  </repositories>
  <pluginRepositories>
    <pluginRepository>
      <id>codegenome</id>
      <url>https://artifacts.codegenomeproject.org/maven</url>
    </pluginRepository>
  </pluginRepositories>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>6.47.0</version>
        <configuration>
          <exportDatatables>true</exportDatatables>
          <activeRecipes>
            <recipe>org.openrewrite.java.migrate.search.PlanJavaMigration</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-migrate-java</artifactId>
            <version>3.43.0</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

Run mvn rewrite:run to run the recipe.

You will need to have Maven installed on your machine before you can run the following command. Since this approach leaves your pom.xml untouched, the Code Genome Project repository has to be declared in your Maven settings.xml file (typically at ~/.m2/settings.xml) instead: as a pluginRepository so that rewrite-maven-plugin itself can be resolved, and as a repository so that recipe artifacts passed to rewrite.recipeArtifactCoordinates can be resolved.

settings.xml
<settings>
  <servers>
    <server>
      <id>codegenome</id>
      <username>USERNAME</username>
      <password>TOKEN</password>
    </server>
  </servers>
  <profiles>
    <profile>
      <id>codegenome</id>
      <repositories>
        <repository>
          <id>codegenome</id>
          <url>https://artifacts.codegenomeproject.org/maven</url>
        </repository>
      </repositories>
      <pluginRepositories>
        <pluginRepository>
          <id>codegenome</id>
          <url>https://artifacts.codegenomeproject.org/maven</url>
        </pluginRepository>
      </pluginRepositories>
    </profile>
  </profiles>
  <activeProfiles>
    <activeProfile>codegenome</activeProfile>
  </activeProfiles>
</settings>

With those credentials in place you can run the recipe:

shell
mvn -U org.openrewrite.maven:rewrite-maven-plugin:6.47.0:run --define rewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-migrate-java:RELEASE --define rewrite.activeRecipes=org.openrewrite.java.migrate.search.PlanJavaMigration --define rewrite.exportDatatables=true

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

shell
mod run . --recipe PlanJavaMigration

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

mod config recipes jar install org.openrewrite.recipe:rewrite-migrate-java:3.43.0

See how this recipe works across multiple open-source repositories

Run this recipe on OSS repos at scale with the Moderne SaaS.

Run this recipe here

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Data Tables

JavaVersionMigrationPlan
SourcesFileResults
SearchResults
SourcesFileErrors
RecipeRunStats

Java version migration plan

org.openrewrite.java.migrate.table.JavaVersionMigrationPlan

A per-repository view of the current state of Java versions and associated build tools

Column Name	Description
Has Java	Whether this is a Java repository at all.
Source compatibility	The source compatibility of the source file.
Major version source compatibility	The major version.
Target compatibility	The target compatibility or `--release` version of the source file.
Gradle version	The version of Gradle in use, if any.
Has Gradle build	Whether a build.gradle file exists in the repository.
Maven version	The version of Maven in use, if any.
Has Maven pom	Whether a pom.xml file exists in the repository.

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column Name	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 Name	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 Name	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 Name	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.

Recipe source​

Usage​

See how this recipe works across multiple open-source repositories​

Data Tables​

Java version migration plan​

Source files that had results​

Source files that had search results​

Source files that errored on a recipe​

Recipe performance​