Moderne CLI workshop
In this workshop, you will use the Moderne CLI, a free tool that allows developer to run OpenRewrite recipes without configuring any build plugin, to migrate various repositories from Spring Boot 2 to Spring Boot 3.
After that, we'll provide some additional examples that show other capabilities of the CLI (such as creating and viewing data tables and fixing static code analysis issues across your repositories).
Prepare your environment
Download and configure the Moderne CLI
Go to the Moderne platform and sign in. If you don't have an account, you can sign up for free.
Click on help in the bottom left-hand corner and select the version of the CLI you want to download. Then select the way you'd like to install it:
Once you have it downloaded, save it somewhere that your terminal can access. If you want it available in each of your terminal windows, consider updating your
PATHto point ot this location or aliasingmodto the location of the CLI. You could also save the file to a directory that's already on yourPATHsuch as a/usr/bindirectory.Ensure you can run the CLI by typing
mod.
If everything is set up correctly, you should see output similar to the following:
➜ moderne-docs git:(main) ✗ mod
Moderne CLI 3.2.0
Usage:
mod [-h] [COMMAND]
Description:
Automated code remediation.
Options:
-h, --help Display this help message.
Commands:
build Generates LST artifacts for one or more repositories.
clean Clean build and run artifacts produced by the CLI.
config Global configuration options that are required by some
CLI commands.
exec Execute an arbitrary shell command recursively on
selected repository roots.
git Multi-repository git operations.
list Lists the repositories that can be built and published.
publish Publishes the LST artifacts for one or more projects.
run Runs an OpenRewrite recipe locally on pre-built LSTS.
run-history Get information about the most recent recipe runs.
study Produces studies from OpenRewrite recipe data tables
locally.
generate-completion Generate bash/zsh completion script for mod.
MOD SUCCEEDED in (0.01s)If you want to enable tab auto-completion for CLI commands (Unix systems only), you can run:
source <(mod generate-completion)or you can update your ~/.zshrc or ~/.bashrc file and add this command to the bottom of it:
# The next line enables shell command completion for mod
source <(mod generate-completion)Before you can run any commands, you'll need to create a Moderne access token. Go to https://app.moderne.io/settings/access-token, enter a name for your token, and press
generate.Once created, copy the token and use it in the following command so that the CLI can communicate with Moderne:
mod config moderne edit https://app.moderne.io --token mat-YOUR_TOKEN_HEREWith the Moderne connection established, install the Spring Boot recipe on your machine:
mod config recipes moderne install UpgradeSpringBoot_3_2Select the
Migrate to Spring Boot 3.2from the list that appears and then enterYto confirm the installation.
This will look something like:
➜ mod config recipes moderne install UpgradeSpringBoot_3_2
Moderne CLI 3.2.0
[1] Migrate to Spring Boot 3.2
[2] Migrate to Spring Boot 3.1
[3] Migrate to Spring Boot 3.0
[4] Migrate to Spring Boot 2.6
[5] Upgrade to Spring Boot 2.5
[6] Migrate to Spring Boot 2.3
[7] Migrate to Spring Boot 2.2
[8] Migrate to Spring Boot 2.1
[9] Migrate Spring Boot properties to 3.0
[10] Migrate to Spring Boot 2.0
[11] Migrate Spring Boot properties to 2.0
[12] Migrate Spring Boot properties to 2.3
[13] Upgrade to springdoc-openapi 2
[14] Migrate Spring Boot properties to 2.1
[15] Migrate Spring Boot properties to 2.2
[16] Migrate Spring Boot properties to 2.5
[17] Migrate Spring Boot properties to 3.2
[18] Find patterns that require updating for Spring Boot 2.5
[19] Migrate Spring Boot properties to 3.1
[20] Remove the deprecated properties `additional-keys-to-sanitize` from the `configprops` and `env` end points
[21] Migrate to Spring Data 2.3
[22] Upgrade un-managed spring project dependencies
Select a recipe [1-22]: 1
Migrate to Spring Boot 3.2
Migrate applications to the latest Spring Boot 3.2 release. This recipe will modify an application's build files, make changes to deprecated/preferred APIs, and migrate configuration settings that have changes between versions. This recipe will also chain additional framework migrations (Spring Framework, Spring Data, etc) that are required as part of the migration to Spring Boot 3.1.
Install org.openrewrite.recipe:rewrite-spring:5.2.0-20231219.181744-58 which contains this recipe [Yn]? YAlternatively, you can sync all recipes available on Moderne with mod config recipes moderne sync, although this can take a while to complete.
Configure the Spring PetClinic repository
With the CLI downloaded and configured, you're now ready to set up the repository.
Clone the Spring PetClinic repository:
git clone https://github.com/spring-projects/spring-petclinicCheck out the last Spring Boot 2.0 commit:
cd spring-petclinic
git checkout b527de52f5fd19f9fe550372c017d145a3b2a809If you tried building this repository right now, you would more than likely run into errors. This is because this version of the Spring PetClinic repo requires Java 8. To ensure that everything builds correctly, you may need to download Java 8 and update your
JAVA_HOMEenvironment variable. If you are on a Unix-based system, we recommend using SDKMan:
sdk install java 8.0.392-zulu
sdk use java 8.0.392-zuluIf you want to use sdk and the java 8.0.392-zulu distribution is not available for you, select any distribution that represents a Java 8 version.
If you aren't on a Unix-based system or you don't want to install SDKMan, you'll need to install Java 8 and run something like:
export JAVA_HOME=REPLACE_WITH_LOCATION_OF_JAVA_8With Java 8 configured, make sure that the Spring PetClinic repository builds on your machine:
./mvnw verify -DskipTestsIf everything has been set up correctly, you should see a
BUILD SUCCESSmessage after the project is built and the tests passed.
Migrate to Spring Boot 3 using the Moderne CLI
Now that the repository is configured, it's time to migrate it to Spring Boot 3 using the Moderne CLI.
Run the build command to generate the LST for the PetClinic repo:
mod build .You should see output similar to the following.
Moderne CLI 3.2.0
> Selecting repositories
> spring-projects/spring-petclinic@main
Selected 1 repositories (0.39s)
> Building LST(s)
> spring-projects/spring-petclinic@main
Build output will be written to file:///Users/mikesol/Desktop/code/spring-petclinic/.moderne/build/20231219102753-C5Dxy/build.log
📶 Step 1 - build with Maven
📶 Step 2 - build resources using the native CLI
✅ Built LST file:///Users/mikesol/Desktop/code/spring-petclinic/.moderne/build/20231219102753-C5Dxy/spring-petclinic-20231219102820-ast.jar
📈 Reported build metrics to Moderne
🧹 Cleaned 0 older builds.
Built 1 repositories. (27s)
* What to do next
> Run mod run . --recipe <RecipeName>
MOD SUCCEEDED in (27s)If you are wanting to run the CLI against private repositories you will need to configure a license. This isn't needed for this workshop, though.
Kick off the migration recipe by running the following command from the
spring-petclinicrepository:
mod run . --recipe UpgradeSpringBoot_3_2You should see output similar to the following.
Moderne CLI 3.2.0
> Selecting repositories
> spring-projects/spring-petclinic@main
Selected 1 repositories (0.37s)
> Running recipe org.openrewrite.java.spring.boot3.UpgradeSpringBoot_3_2
> spring-projects/spring-petclinic@main
✅ Fix results at file:///Users/mikesol/Desktop/code/spring-petclinic/.moderne/run/20231220083431-NiO1J/fix.patch
Found results on 1 repositories (12m 22s)
25s saved by using previously built LSTs
* What to do next
> Click on one of the patch links above to view the changes on a particular repository
> Run mod study . --last-recipe-run --data-table <DATA-TABLE> to examine the following data tables produced by this recipe:
org.openrewrite.maven.table.DependenciesInUse
org.openrewrite.table.RecipeRunStats
org.openrewrite.table.SourcesFileResults
org.openrewrite.table.SourcesFiles
> Run npm install -g diff2html-cli to produce patch files on subsequent runs that are easier to view
> Run mod apply . --last-recipe-run to apply the changes
> Run mod apply . --recipe-run 20231220083431-NiO1J to apply the changes
MOD SUCCEEDED in (12m 23s)The previous command will generate a patch file (
fix.patch) that contains the changes the recipe would make to your repository. You can examine the file with your favorite editor, or you can apply the changes to the code and usegit diffto check out the changes. It's important to always double-check that the changes made match your expectations:
mod git apply . --last-recipe-run
git diffYou should see output similar to the following.
diff --git a/pom.xml b/pom.xml
index 0b8f9c2..a454f84 100644
--- a/pom.xml
+++ b/pom.xml
@@ -10,14 +10,14 @@
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
- <version>2.0.0.RELEASE</version>
+ <version>3.2.0</version>
</parent>
<name>petclinic</name>
<properties>
<!-- Generic properties -->
- <java.version>1.8</java.version>
+ <java.version>17</java.version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
@@ -25,7 +25,7 @@
<webjars-bootstrap.version>3.3.6</webjars-bootstrap.version>
<webjars-jquery-ui.version>1.11.4</webjars-jquery-ui.version>
<webjars-jquery.version>2.2.4</webjars-jquery.version>
- <wro4j.version>1.8.0</wro4j.version>
+ <wro4j.version>1.10.1</wro4j.version>
<cobertura.version>2.7</cobertura.version>
@@ -33,6 +33,10 @@
<dependencies>
<!-- Spring and Spring Boot dependencies -->
+ <dependency>
+ <groupId>jakarta.xml.bind</groupId>
+ <artifactId>jakarta.xml.bind-api</artifactId>
+ </dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
@@ -53,6 +57,10 @@
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
+ <dependency>
+ <groupId>org.springframework.boot</groupId>
+ <artifactId>spring-boot-starter-validation</artifactId>
+ </dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
@@ -66,8 +74,13 @@
<scope>runtime</scope>
</dependency>
<dependency>
- <groupId>mysql</groupId>
- <artifactId>mysql-connector-java</artifactId>
+ <groupId>com.mysql</groupId>
+ <artifactId>mysql-connector-j</artifactId>
+ <scope>runtime</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.glassfish.jaxb</groupId>
+ <artifactId>jaxb-runtime</artifactId>
<scope>runtime</scope>
</dependency>
@@ -79,6 +92,7 @@
<dependency>
<groupId>org.ehcache</groupId>
<artifactId>ehcache</artifactId>
+ <classifier>jakarta</classifier>
</dependency>
<!-- webjars -->
@@ -133,22 +147,6 @@
</execution>
</executions>
</plugin>
- <plugin>
- <groupId>org.codehaus.mojo</groupId>
- <artifactId>cobertura-maven-plugin</artifactId>
- <version>${cobertura.version}</version>
- <configuration>
- <check />
- </configuration>
- <executions>
- <execution>
- <goals>
- <goal>clean</goal>
- <goal>check</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
<!-- Spring Boot Actuator displays build-related information if a git.properties
file is present at the classpath -->
@@ -204,17 +202,6 @@
<reporting>
<plugins>
<!-- integrate maven-cobertura-plugin to project site -->
- <plugin>
- <groupId>org.codehaus.mojo</groupId>
- <artifactId>cobertura-maven-plugin</artifactId>
- <version>${cobertura.version}</version>
- <configuration>
- <formats>
- <format>html</format>
- </formats>
- <check />
- </configuration>
- </plugin>
</plugins>
</reporting>
diff --git a/src/main/java/org/springframework/samples/petclinic/model/BaseEntity.java b/src/main/java/org/springframework/samples/petclinic/model/BaseEntity.java
index 86cc210..d45134c 100644
--- a/src/main/java/org/springframework/samples/petclinic/model/BaseEntity.java
+++ b/src/main/java/org/springframework/samples/petclinic/model/BaseEntity.java
@@ -17,10 +17,10 @@ package org.springframework.samples.petclinic.model;
import java.io.Serializable;
-import javax.persistence.GeneratedValue;
-import javax.persistence.GenerationType;
-import javax.persistence.Id;
-import javax.persistence.MappedSuperclass;
+import jakarta.persistence.GeneratedValue;
+import jakarta.persistence.GenerationType;
+import jakarta.persistence.Id;
+import jakarta.persistence.MappedSuperclass;
/**
* Simple JavaBean domain object with an id property. Used as a base class for objects
diff --git a/src/main/java/org/springframework/samples/petclinic/model/NamedEntity.java b/src/main/java/org/springframework/samples/petclinic/model/NamedEntity.java
index d66c97a..83bb717 100644
--- a/src/main/java/org/springframework/samples/petclinic/model/NamedEntity.java
+++ b/src/main/java/org/springframework/samples/petclinic/model/NamedEntity.java
@@ -15,8 +15,8 @@
*/
package org.springframework.samples.petclinic.model;
-import javax.persistence.Column;
-import javax.persistence.MappedSuperclass;
+import jakarta.persistence.Column;
+import jakarta.persistence.MappedSuperclass;
/**
diff --git a/src/main/java/org/springframework/samples/petclinic/model/Person.java b/src/main/java/org/springframework/samples/petclinic/model/Person.java
index 5d23523..7294998 100644
--- a/src/main/java/org/springframework/samples/petclinic/model/Person.java
+++ b/src/main/java/org/springframework/samples/petclinic/model/Person.java
@@ -15,9 +15,9 @@
*/
package org.springframework.samples.petclinic.model;
-import javax.persistence.Column;
-import javax.persistence.MappedSuperclass;
-import javax.validation.constraints.NotEmpty;
+import jakarta.persistence.Column;
+import jakarta.persistence.MappedSuperclass;
+import jakarta.validation.constraints.NotEmpty;
/**
* Simple JavaBean domain object representing an person.
diff --git a/src/main/java/org/springframework/samples/petclinic/owner/Owner.java b/src/main/java/org/springframework/samples/petclinic/owner/Owner.java
index 89aad2c..063c750 100644
--- a/src/main/java/org/springframework/samples/petclinic/owner/Owner.java
+++ b/src/main/java/org/springframework/samples/petclinic/owner/Owner.java
@@ -21,13 +21,13 @@ import java.util.HashSet;
import java.util.List;
import java.util.Set;
-import javax.persistence.CascadeType;
-import javax.persistence.Column;
-import javax.persistence.Entity;
-import javax.persistence.OneToMany;
-import javax.persistence.Table;
-import javax.validation.constraints.Digits;
-import javax.validation.constraints.NotEmpty;
+import jakarta.persistence.CascadeType;
+import jakarta.persistence.Column;
+import jakarta.persistence.Entity;
+import jakarta.persistence.OneToMany;
+import jakarta.persistence.Table;
+import jakarta.validation.constraints.Digits;
+import jakarta.validation.constraints.NotEmpty;
import org.springframework.beans.support.MutableSortDefinition;
import org.springframework.beans.support.PropertyComparator;
diff --git a/src/main/java/org/springframework/samples/petclinic/owner/OwnerController.java b/src/main/java/org/springframework/samples/petclinic/owner/OwnerController.java
index d914ed7..a25870b 100644
--- a/src/main/java/org/springframework/samples/petclinic/owner/OwnerController.java
+++ b/src/main/java/org/springframework/samples/petclinic/owner/OwnerController.java
@@ -15,7 +15,6 @@
*/
package org.springframework.samples.petclinic.owner;
-import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.validation.BindingResult;
@@ -26,7 +25,7 @@ import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.servlet.ModelAndView;
-import javax.validation.Valid;
+import jakarta.validation.Valid;
import java.util.Collection;
import java.util.Map;
@@ -43,7 +42,6 @@ class OwnerController {
private final OwnerRepository owners;
- @Autowired
public OwnerController(OwnerRepository clinicService) {
this.owners = clinicService;
}
@@ -102,14 +100,14 @@ class OwnerController {
}
@GetMapping("/owners/{ownerId}/edit")
- public String initUpdateOwnerForm(@PathVariable("ownerId") int ownerId, Model model) {
+ public String initUpdateOwnerForm(@PathVariable int ownerId, Model model) {
Owner owner = this.owners.findById(ownerId);
model.addAttribute(owner);
return VIEWS_OWNER_CREATE_OR_UPDATE_FORM;
}
@PostMapping("/owners/{ownerId}/edit")
- public String processUpdateOwnerForm(@Valid Owner owner, BindingResult result, @PathVariable("ownerId") int ownerId) {
+ public String processUpdateOwnerForm(@Valid Owner owner, BindingResult result, @PathVariable int ownerId) {
if (result.hasErrors()) {
return VIEWS_OWNER_CREATE_OR_UPDATE_FORM;
} else {
@@ -126,7 +124,7 @@ class OwnerController {
* @return a ModelMap with the model attributes for the view
*/
@GetMapping("/owners/{ownerId}")
- public ModelAndView showOwner(@PathVariable("ownerId") int ownerId) {
+ public ModelAndView showOwner(@PathVariable int ownerId) {
ModelAndView mav = new ModelAndView("owners/ownerDetails");
mav.addObject(this.owners.findById(ownerId));
return mav;
diff --git a/src/main/java/org/springframework/samples/petclinic/owner/Pet.java b/src/main/java/org/springframework/samples/petclinic/owner/Pet.java
index 5e226a1..106934b 100755
--- a/src/main/java/org/springframework/samples/petclinic/owner/Pet.java
+++ b/src/main/java/org/springframework/samples/petclinic/owner/Pet.java
@@ -23,16 +23,16 @@ import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;
-import javax.persistence.CascadeType;
-import javax.persistence.Column;
-import javax.persistence.Entity;
-import javax.persistence.FetchType;
-import javax.persistence.JoinColumn;
-import javax.persistence.ManyToOne;
-import javax.persistence.OneToMany;
-import javax.persistence.Table;
-import javax.persistence.Temporal;
-import javax.persistence.TemporalType;
+import jakarta.persistence.CascadeType;
+import jakarta.persistence.Column;
+import jakarta.persistence.Entity;
+import jakarta.persistence.FetchType;
+import jakarta.persistence.JoinColumn;
+import jakarta.persistence.ManyToOne;
+import jakarta.persistence.OneToMany;
+import jakarta.persistence.Table;
+import jakarta.persistence.Temporal;
+import jakarta.persistence.TemporalType;
import org.springframework.beans.support.MutableSortDefinition;
import org.springframework.beans.support.PropertyComparator;
diff --git a/src/main/java/org/springframework/samples/petclinic/owner/PetController.java b/src/main/java/org/springframework/samples/petclinic/owner/PetController.java
index 9c52e03..8694be1 100644
--- a/src/main/java/org/springframework/samples/petclinic/owner/PetController.java
+++ b/src/main/java/org/springframework/samples/petclinic/owner/PetController.java
@@ -15,7 +15,6 @@
*/
package org.springframework.samples.petclinic.owner;
-import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.util.StringUtils;
@@ -23,7 +22,7 @@ import org.springframework.validation.BindingResult;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.*;
-import javax.validation.Valid;
+import jakarta.validation.Valid;
import java.util.Collection;
/**
@@ -39,7 +38,6 @@ class PetController {
private final PetRepository pets;
private final OwnerRepository owners;
- @Autowired
public PetController(PetRepository pets, OwnerRepository owners) {
this.pets = pets;
this.owners = owners;
@@ -51,7 +49,7 @@ class PetController {
}
@ModelAttribute("owner")
- public Owner findOwner(@PathVariable("ownerId") int ownerId) {
+ public Owner findOwner(@PathVariable int ownerId) {
return this.owners.findById(ownerId);
}
@@ -89,7 +87,7 @@ class PetController {
}
@GetMapping("/pets/{petId}/edit")
- public String initUpdateForm(@PathVariable("petId") int petId, ModelMap model) {
+ public String initUpdateForm(@PathVariable int petId, ModelMap model) {
Pet pet = this.pets.findById(petId);
model.put("pet", pet);
return VIEWS_PETS_CREATE_OR_UPDATE_FORM;
diff --git a/src/main/java/org/springframework/samples/petclinic/owner/PetType.java b/src/main/java/org/springframework/samples/petclinic/owner/PetType.java
index ac827b3..e6a7271 100644
--- a/src/main/java/org/springframework/samples/petclinic/owner/PetType.java
+++ b/src/main/java/org/springframework/samples/petclinic/owner/PetType.java
@@ -15,8 +15,8 @@
*/
package org.springframework.samples.petclinic.owner;
-import javax.persistence.Entity;
-import javax.persistence.Table;
+import jakarta.persistence.Entity;
+import jakarta.persistence.Table;
import org.springframework.samples.petclinic.model.NamedEntity;
diff --git a/src/main/java/org/springframework/samples/petclinic/owner/PetTypeFormatter.java b/src/main/java/org/springframework/samples/petclinic/owner/PetTypeFormatter.java
index 78451ca..8ad364f 100644
--- a/src/main/java/org/springframework/samples/petclinic/owner/PetTypeFormatter.java
+++ b/src/main/java/org/springframework/samples/petclinic/owner/PetTypeFormatter.java
@@ -20,7 +20,6 @@ import java.text.ParseException;
import java.util.Collection;
import java.util.Locale;
-import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.format.Formatter;
import org.springframework.stereotype.Component;
@@ -41,7 +40,6 @@ public class PetTypeFormatter implements Formatter<PetType> {
private final PetRepository pets;
- @Autowired
public PetTypeFormatter(PetRepository pets) {
this.pets = pets;
}
diff --git a/src/main/java/org/springframework/samples/petclinic/owner/VisitController.java b/src/main/java/org/springframework/samples/petclinic/owner/VisitController.java
index d7afed1..c7e6109 100644
--- a/src/main/java/org/springframework/samples/petclinic/owner/VisitController.java
+++ b/src/main/java/org/springframework/samples/petclinic/owner/VisitController.java
@@ -15,7 +15,6 @@
*/
package org.springframework.samples.petclinic.owner;
-import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.samples.petclinic.visit.Visit;
import org.springframework.samples.petclinic.visit.VisitRepository;
import org.springframework.stereotype.Controller;
@@ -23,7 +22,7 @@ import org.springframework.validation.BindingResult;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.*;
-import javax.validation.Valid;
+import jakarta.validation.Valid;
import java.util.Map;
/**
@@ -40,7 +39,6 @@ class VisitController {
private final PetRepository pets;
- @Autowired
public VisitController(VisitRepository visits, PetRepository pets) {
this.visits = visits;
this.pets = pets;
@@ -62,7 +60,7 @@ class VisitController {
* @return Pet
*/
@ModelAttribute("visit")
- public Visit loadPetWithVisit(@PathVariable("petId") int petId, Map<String, Object> model) {
+ public Visit loadPetWithVisit(@PathVariable int petId, Map<String, Object> model) {
Pet pet = this.pets.findById(petId);
model.put("pet", pet);
Visit visit = new Visit();
@@ -72,7 +70,7 @@ class VisitController {
// Spring MVC calls method loadPetWithVisit(...) before initNewVisitForm is called
@GetMapping("/owners/*/pets/{petId}/visits/new")
- public String initNewVisitForm(@PathVariable("petId") int petId, Map<String, Object> model) {
+ public String initNewVisitForm(@PathVariable int petId, Map<String, Object> model) {
return "pets/createOrUpdateVisitForm";
}
diff --git a/src/main/java/org/springframework/samples/petclinic/system/CrashController.java b/src/main/java/org/springframework/samples/petclinic/system/CrashController.java
index 2f5e7a3..29f4fd5 100644
--- a/src/main/java/org/springframework/samples/petclinic/system/CrashController.java
+++ b/src/main/java/org/springframework/samples/petclinic/system/CrashController.java
@@ -30,8 +30,10 @@ class CrashController {
@GetMapping("/oups")
public String triggerException() {
- throw new RuntimeException("Expected: controller used to showcase what "
- + "happens when an exception is thrown");
+ throw new RuntimeException("""
+ Expected: controller used to showcase what \
+ happens when an exception is thrown\
+ """);
}
}
diff --git a/src/main/java/org/springframework/samples/petclinic/vet/Specialty.java b/src/main/java/org/springframework/samples/petclinic/vet/Specialty.java
index 5691c24..7727e21 100644
--- a/src/main/java/org/springframework/samples/petclinic/vet/Specialty.java
+++ b/src/main/java/org/springframework/samples/petclinic/vet/Specialty.java
@@ -17,8 +17,8 @@ package org.springframework.samples.petclinic.vet;
import java.io.Serializable;
-import javax.persistence.Entity;
-import javax.persistence.Table;
+import jakarta.persistence.Entity;
+import jakarta.persistence.Table;
import org.springframework.samples.petclinic.model.NamedEntity;
diff --git a/src/main/java/org/springframework/samples/petclinic/vet/Vet.java b/src/main/java/org/springframework/samples/petclinic/vet/Vet.java
index 43aecc4..d2841dd 100644
--- a/src/main/java/org/springframework/samples/petclinic/vet/Vet.java
+++ b/src/main/java/org/springframework/samples/petclinic/vet/Vet.java
@@ -21,13 +21,13 @@ import java.util.HashSet;
import java.util.List;
import java.util.Set;
-import javax.persistence.Entity;
-import javax.persistence.FetchType;
-import javax.persistence.JoinColumn;
-import javax.persistence.JoinTable;
-import javax.persistence.ManyToMany;
-import javax.persistence.Table;
-import javax.xml.bind.annotation.XmlElement;
+import jakarta.persistence.Entity;
+import jakarta.persistence.FetchType;
+import jakarta.persistence.JoinColumn;
+import jakarta.persistence.JoinTable;
+import jakarta.persistence.ManyToMany;
+import jakarta.persistence.Table;
+import jakarta.xml.bind.annotation.XmlElement;
import org.springframework.beans.support.MutableSortDefinition;
import org.springframework.beans.support.PropertyComparator;
diff --git a/src/main/java/org/springframework/samples/petclinic/vet/VetController.java b/src/main/java/org/springframework/samples/petclinic/vet/VetController.java
index 7ce8374..ddaa364 100644
--- a/src/main/java/org/springframework/samples/petclinic/vet/VetController.java
+++ b/src/main/java/org/springframework/samples/petclinic/vet/VetController.java
@@ -15,7 +15,6 @@
*/
package org.springframework.samples.petclinic.vet;
-import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ResponseBody;
@@ -33,7 +32,6 @@ class VetController {
private final VetRepository vets;
- @Autowired
public VetController(VetRepository clinicService) {
this.vets = clinicService;
}
diff --git a/src/main/java/org/springframework/samples/petclinic/vet/Vets.java b/src/main/java/org/springframework/samples/petclinic/vet/Vets.java
index f5b24c3..c90b652 100644
--- a/src/main/java/org/springframework/samples/petclinic/vet/Vets.java
+++ b/src/main/java/org/springframework/samples/petclinic/vet/Vets.java
@@ -18,8 +18,8 @@ package org.springframework.samples.petclinic.vet;
import java.util.ArrayList;
import java.util.List;
-import javax.xml.bind.annotation.XmlElement;
-import javax.xml.bind.annotation.XmlRootElement;
+import jakarta.xml.bind.annotation.XmlElement;
+import jakarta.xml.bind.annotation.XmlRootElement;
/**
* Simple domain object representing a list of veterinarians. Mostly here to be used for the 'vets' {@link
diff --git a/src/main/java/org/springframework/samples/petclinic/visit/Visit.java b/src/main/java/org/springframework/samples/petclinic/visit/Visit.java
index ce10d7b..2a5e854 100755
--- a/src/main/java/org/springframework/samples/petclinic/visit/Visit.java
+++ b/src/main/java/org/springframework/samples/petclinic/visit/Visit.java
@@ -17,12 +17,12 @@ package org.springframework.samples.petclinic.visit;
import java.util.Date;
-import javax.persistence.Column;
-import javax.persistence.Entity;
-import javax.persistence.Table;
-import javax.persistence.Temporal;
-import javax.persistence.TemporalType;
-import javax.validation.constraints.NotEmpty;
+import jakarta.persistence.Column;
+import jakarta.persistence.Entity;
+import jakarta.persistence.Table;
+import jakarta.persistence.Temporal;
+import jakarta.persistence.TemporalType;
+import jakarta.validation.constraints.NotEmpty;
import org.springframework.format.annotation.DateTimeFormat;
import org.springframework.samples.petclinic.model.BaseEntity;
diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties
index c8d5a5c..0616806 100644
--- a/src/main/resources/application.properties
+++ b/src/main/resources/application.properties
@@ -1,7 +1,7 @@
# database init, supports mysql too
database=hsqldb
-spring.datasource.schema=classpath*:db/${database}/schema.sql
-spring.datasource.data=classpath*:db/${database}/data.sql
+spring.sql.init.schema-locations=classpath*:db/${database}/schema.sql
+spring.sql.init.data-locations=classpath*:db/${database}/data.sql
# Web
spring.thymeleaf.mode=HTML
diff --git a/src/test/java/org/springframework/samples/petclinic/model/ValidatorTests.java b/src/test/java/org/springframework/samples/petclinic/model/ValidatorTests.java
index 7da0d3d..3f4bfe9 100644
--- a/src/test/java/org/springframework/samples/petclinic/model/ValidatorTests.java
+++ b/src/test/java/org/springframework/samples/petclinic/model/ValidatorTests.java
@@ -3,11 +3,10 @@ package org.springframework.samples.petclinic.model;
import java.util.Locale;
import java.util.Set;
-import javax.validation.ConstraintViolation;
-import javax.validation.Validator;
-
-import org.junit.Test;
+import jakarta.validation.ConstraintViolation;
+import jakarta.validation.Validator;
+import org.junit.jupiter.api.Test;
import org.springframework.context.i18n.LocaleContextHolder;
import org.springframework.validation.beanvalidation.LocalValidatorFactoryBean;
@@ -17,7 +16,7 @@ import static org.assertj.core.api.Assertions.assertThat;
* @author Michael Isvy Simple test to make sure that Bean Validation is working (useful
* when upgrading to a new version of Hibernate Validator/ Bean Validation)
*/
-public class ValidatorTests {
+class ValidatorTests {
private Validator createValidator() {
LocalValidatorFactoryBean localValidatorFactoryBean = new LocalValidatorFactoryBean();
@@ -26,7 +25,7 @@ public class ValidatorTests {
}
@Test
- public void shouldNotValidateWhenFirstNameEmpty() {
+ void shouldNotValidateWhenFirstNameEmpty() {
LocaleContextHolder.setLocale(Locale.ENGLISH);
Person person = new Person();
diff --git a/src/test/java/org/springframework/samples/petclinic/owner/OwnerControllerTests.java b/src/test/java/org/springframework/samples/petclinic/owner/OwnerControllerTests.java
index 7fccb3b..7bfc2d7 100644
--- a/src/test/java/org/springframework/samples/petclinic/owner/OwnerControllerTests.java
+++ b/src/test/java/org/springframework/samples/petclinic/owner/OwnerControllerTests.java
@@ -10,16 +10,14 @@ import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.view;
import org.assertj.core.util.Lists;
-import org.junit.Before;
-import org.junit.Test;
-import org.junit.runner.RunWith;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.boot.test.mock.mockito.MockBean;
import org.springframework.samples.petclinic.owner.Owner;
import org.springframework.samples.petclinic.owner.OwnerController;
import org.springframework.samples.petclinic.owner.OwnerRepository;
-import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.web.servlet.MockMvc;
/**
@@ -27,9 +25,8 @@ import org.springframework.test.web.servlet.MockMvc;
*
* @author Colin But
*/
-@RunWith(SpringRunner.class)
@WebMvcTest(OwnerController.class)
-public class OwnerControllerTests {
+class OwnerControllerTests {
private static final int TEST_OWNER_ID = 1;
@@ -41,8 +38,8 @@ public class OwnerControllerTests {
private Owner george;
- @Before
- public void setup() {
+ @BeforeEach
+ void setup() {
george = new Owner();
george.setId(TEST_OWNER_ID);
george.setFirstName("George");
@@ -54,7 +51,7 @@ public class OwnerControllerTests {
}
@Test
- public void testInitCreationForm() throws Exception {
+ void initCreationForm() throws Exception {
mockMvc.perform(get("/owners/new"))
.andExpect(status().isOk())
.andExpect(model().attributeExists("owner"))
@@ -62,7 +59,7 @@ public class OwnerControllerTests {
}
@Test
- public void testProcessCreationFormSuccess() throws Exception {
+ void processCreationFormSuccess() throws Exception {
mockMvc.perform(post("/owners/new")
.param("firstName", "Joe")
.param("lastName", "Bloggs")
@@ -74,7 +71,7 @@ public class OwnerControllerTests {
}
@Test
- public void testProcessCreationFormHasErrors() throws Exception {
+ void processCreationFormHasErrors() throws Exception {
mockMvc.perform(post("/owners/new")
.param("firstName", "Joe")
.param("lastName", "Bloggs")
@@ -88,7 +85,7 @@ public class OwnerControllerTests {
}
@Test
- public void testInitFindForm() throws Exception {
+ void initFindForm() throws Exception {
mockMvc.perform(get("/owners/find"))
.andExpect(status().isOk())
.andExpect(model().attributeExists("owner"))
@@ -96,7 +93,7 @@ public class OwnerControllerTests {
}
@Test
- public void testProcessFindFormSuccess() throws Exception {
+ void processFindFormSuccess() throws Exception {
given(this.owners.findByLastName("")).willReturn(Lists.newArrayList(george, new Owner()));
mockMvc.perform(get("/owners"))
.andExpect(status().isOk())
@@ -104,7 +101,7 @@ public class OwnerControllerTests {
}
@Test
- public void testProcessFindFormByLastName() throws Exception {
+ void processFindFormByLastName() throws Exception {
given(this.owners.findByLastName(george.getLastName())).willReturn(Lists.newArrayList(george));
mockMvc.perform(get("/owners")
.param("lastName", "Franklin")
@@ -114,7 +111,7 @@ public class OwnerControllerTests {
}
@Test
- public void testProcessFindFormNoOwnersFound() throws Exception {
+ void processFindFormNoOwnersFound() throws Exception {
mockMvc.perform(get("/owners")
.param("lastName", "Unknown Surname")
)
@@ -125,7 +122,7 @@ public class OwnerControllerTests {
}
@Test
- public void testInitUpdateOwnerForm() throws Exception {
+ void initUpdateOwnerForm() throws Exception {
mockMvc.perform(get("/owners/{ownerId}/edit", TEST_OWNER_ID))
.andExpect(status().isOk())
.andExpect(model().attributeExists("owner"))
@@ -138,7 +135,7 @@ public class OwnerControllerTests {
}
@Test
- public void testProcessUpdateOwnerFormSuccess() throws Exception {
+ void processUpdateOwnerFormSuccess() throws Exception {
mockMvc.perform(post("/owners/{ownerId}/edit", TEST_OWNER_ID)
.param("firstName", "Joe")
.param("lastName", "Bloggs")
@@ -151,7 +148,7 @@ public class OwnerControllerTests {
}
@Test
- public void testProcessUpdateOwnerFormHasErrors() throws Exception {
+ void processUpdateOwnerFormHasErrors() throws Exception {
mockMvc.perform(post("/owners/{ownerId}/edit", TEST_OWNER_ID)
.param("firstName", "Joe")
.param("lastName", "Bloggs")
@@ -165,7 +162,7 @@ public class OwnerControllerTests {
}
@Test
- public void testShowOwner() throws Exception {
+ void showOwner() throws Exception {
mockMvc.perform(get("/owners/{ownerId}", TEST_OWNER_ID))
.andExpect(status().isOk())
.andExpect(model().attribute("owner", hasProperty("lastName", is("Franklin"))))
diff --git a/src/test/java/org/springframework/samples/petclinic/owner/PetControllerTests.java b/src/test/java/org/springframework/samples/petclinic/owner/PetControllerTests.java
index f95d7c8..a2663a9 100755
--- a/src/test/java/org/springframework/samples/petclinic/owner/PetControllerTests.java
+++ b/src/test/java/org/springframework/samples/petclinic/owner/PetControllerTests.java
@@ -8,9 +8,8 @@ import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.view;
import org.assertj.core.util.Lists;
-import org.junit.Before;
-import org.junit.Test;
-import org.junit.runner.RunWith;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.boot.test.mock.mockito.MockBean;
@@ -23,7 +22,6 @@ import org.springframework.samples.petclinic.owner.PetController;
import org.springframework.samples.petclinic.owner.PetRepository;
import org.springframework.samples.petclinic.owner.PetType;
import org.springframework.samples.petclinic.owner.PetTypeFormatter;
-import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.web.servlet.MockMvc;
/**
@@ -31,12 +29,11 @@ import org.springframework.test.web.servlet.MockMvc;
*
* @author Colin But
*/
-@RunWith(SpringRunner.class)
@WebMvcTest(value = PetController.class,
includeFilters = @ComponentScan.Filter(
- value = PetTypeFormatter.class,
- type = FilterType.ASSIGNABLE_TYPE))
-public class PetControllerTests {
+ value = PetTypeFormatter.class,
+ type = FilterType.ASSIGNABLE_TYPE))
+class PetControllerTests {
private static final int TEST_OWNER_ID = 1;
private static final int TEST_PET_ID = 1;
@@ -51,8 +48,8 @@ public class PetControllerTests {
@MockBean
private OwnerRepository owners;
- @Before
- public void setup() {
+ @BeforeEach
+ void setup() {
PetType cat = new PetType();
cat.setId(3);
cat.setName("hamster");
@@ -63,7 +60,7 @@ public class PetControllerTests {
}
@Test
- public void testInitCreationForm() throws Exception {
+ void initCreationForm() throws Exception {
mockMvc.perform(get("/owners/{ownerId}/pets/new", TEST_OWNER_ID))
.andExpect(status().isOk())
.andExpect(view().name("pets/createOrUpdatePetForm"))
@@ -71,7 +68,7 @@ public class PetControllerTests {
}
@Test
- public void testProcessCreationFormSuccess() throws Exception {
+ void processCreationFormSuccess() throws Exception {
mockMvc.perform(post("/owners/{ownerId}/pets/new", TEST_OWNER_ID)
.param("name", "Betty")
.param("type", "hamster")
@@ -82,7 +79,7 @@ public class PetControllerTests {
}
@Test
- public void testProcessCreationFormHasErrors() throws Exception {
+ void processCreationFormHasErrors() throws Exception {
mockMvc.perform(post("/owners/{ownerId}/pets/new", TEST_OWNER_ID)
.param("name", "Betty")
.param("birthDate", "2015-02-12")
@@ -96,7 +93,7 @@ public class PetControllerTests {
}
@Test
- public void testInitUpdateForm() throws Exception {
+ void initUpdateForm() throws Exception {
mockMvc.perform(get("/owners/{ownerId}/pets/{petId}/edit", TEST_OWNER_ID, TEST_PET_ID))
.andExpect(status().isOk())
.andExpect(model().attributeExists("pet"))
@@ -104,7 +101,7 @@ public class PetControllerTests {
}
@Test
- public void testProcessUpdateFormSuccess() throws Exception {
+ void processUpdateFormSuccess() throws Exception {
mockMvc.perform(post("/owners/{ownerId}/pets/{petId}/edit", TEST_OWNER_ID, TEST_PET_ID)
.param("name", "Betty")
.param("type", "hamster")
@@ -115,7 +112,7 @@ public class PetControllerTests {
}
@Test
- public void testProcessUpdateFormHasErrors() throws Exception {
+ void processUpdateFormHasErrors() throws Exception {
mockMvc.perform(post("/owners/{ownerId}/pets/{petId}/edit", TEST_OWNER_ID, TEST_PET_ID)
.param("name", "Betty")
.param("birthDate", "2015/02/12")
diff --git a/src/test/java/org/springframework/samples/petclinic/owner/PetTypeFormatterTests.java b/src/test/java/org/springframework/samples/petclinic/owner/PetTypeFormatterTests.java
index 4e8e36c..7d716fb 100644
--- a/src/test/java/org/springframework/samples/petclinic/owner/PetTypeFormatterTests.java
+++ b/src/test/java/org/springframework/samples/petclinic/owner/PetTypeFormatterTests.java
@@ -6,35 +6,36 @@ import java.util.Collection;
import java.util.List;
import java.util.Locale;
-import org.junit.Before;
-import org.junit.Test;
-import org.junit.runner.RunWith;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Mock;
import org.mockito.Mockito;
-import org.mockito.junit.MockitoJUnitRunner;
-
-import static org.junit.Assert.assertEquals;
+import org.mockito.junit.jupiter.MockitoExtension;
/**
* Test class for {@link PetTypeFormatter}
*
* @author Colin But
*/
-@RunWith(MockitoJUnitRunner.class)
-public class PetTypeFormatterTests {
+@ExtendWith(MockitoExtension.class)
+class PetTypeFormatterTests {
@Mock
private PetRepository pets;
private PetTypeFormatter petTypeFormatter;
- @Before
- public void setup() {
+ @BeforeEach
+ void setup() {
this.petTypeFormatter = new PetTypeFormatter(pets);
}
@Test
- public void testPrint() {
+ void print() {
PetType petType = new PetType();
petType.setName("Hamster");
String petTypeName = this.petTypeFormatter.print(petType, Locale.ENGLISH);
@@ -42,16 +43,18 @@ public class PetTypeFormatterTests {
}
@Test
- public void shouldParse() throws ParseException {
+ void shouldParse() throws ParseException {
Mockito.when(this.pets.findPetTypes()).thenReturn(makePetTypes());
PetType petType = petTypeFormatter.parse("Bird", Locale.ENGLISH);
assertEquals("Bird", petType.getName());
}
- @Test(expected = ParseException.class)
- public void shouldThrowParseException() throws ParseException {
- Mockito.when(this.pets.findPetTypes()).thenReturn(makePetTypes());
- petTypeFormatter.parse("Fish", Locale.ENGLISH);
+ @Test
+ void shouldThrowParseException() throws ParseException {
+ assertThrows(ParseException.class, () -> {
+ Mockito.when(this.pets.findPetTypes()).thenReturn(makePetTypes());
+ petTypeFormatter.parse("Fish", Locale.ENGLISH);
+ });
}
/**
diff --git a/src/test/java/org/springframework/samples/petclinic/owner/VisitControllerTests.java b/src/test/java/org/springframework/samples/petclinic/owner/VisitControllerTests.java
index 08d6136..29f13aa 100644
--- a/src/test/java/org/springframework/samples/petclinic/owner/VisitControllerTests.java
+++ b/src/test/java/org/springframework/samples/petclinic/owner/VisitControllerTests.java
@@ -7,9 +7,8 @@ import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.view;
-import org.junit.Before;
-import org.junit.Test;
-import org.junit.runner.RunWith;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.boot.test.mock.mockito.MockBean;
@@ -17,7 +16,6 @@ import org.springframework.samples.petclinic.owner.Pet;
import org.springframework.samples.petclinic.owner.PetRepository;
import org.springframework.samples.petclinic.owner.VisitController;
import org.springframework.samples.petclinic.visit.VisitRepository;
-import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.web.servlet.MockMvc;
/**
@@ -25,9 +23,8 @@ import org.springframework.test.web.servlet.MockMvc;
*
* @author Colin But
*/
-@RunWith(SpringRunner.class)
@WebMvcTest(VisitController.class)
-public class VisitControllerTests {
+class VisitControllerTests {
private static final int TEST_PET_ID = 1;
@@ -40,20 +37,20 @@ public class VisitControllerTests {
@MockBean
private PetRepository pets;
- @Before
- public void init() {
+ @BeforeEach
+ void init() {
given(this.pets.findById(TEST_PET_ID)).willReturn(new Pet());
}
@Test
- public void testInitNewVisitForm() throws Exception {
+ void initNewVisitForm() throws Exception {
mockMvc.perform(get("/owners/*/pets/{petId}/visits/new", TEST_PET_ID))
.andExpect(status().isOk())
.andExpect(view().name("pets/createOrUpdateVisitForm"));
}
@Test
- public void testProcessNewVisitFormSuccess() throws Exception {
+ void processNewVisitFormSuccess() throws Exception {
mockMvc.perform(post("/owners/*/pets/{petId}/visits/new", TEST_PET_ID)
.param("name", "George")
.param("description", "Visit Description")
@@ -63,7 +60,7 @@ public class VisitControllerTests {
}
@Test
- public void testProcessNewVisitFormHasErrors() throws Exception {
+ void processNewVisitFormHasErrors() throws Exception {
mockMvc.perform(post("/owners/*/pets/{petId}/visits/new", TEST_PET_ID)
.param("name", "George")
)
diff --git a/src/test/java/org/springframework/samples/petclinic/service/ClinicServiceTests.java b/src/test/java/org/springframework/samples/petclinic/service/ClinicServiceTests.java
index 7ed5bf8..aaa3c1d 100644
--- a/src/test/java/org/springframework/samples/petclinic/service/ClinicServiceTests.java
+++ b/src/test/java/org/springframework/samples/petclinic/service/ClinicServiceTests.java
@@ -5,8 +5,7 @@ import static org.assertj.core.api.Assertions.assertThat;
import java.util.Collection;
import java.util.Date;
-import org.junit.Test;
-import org.junit.runner.RunWith;
+import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest;
import org.springframework.context.annotation.ComponentScan;
@@ -20,7 +19,6 @@ import org.springframework.samples.petclinic.vet.VetRepository;
import org.springframework.samples.petclinic.visit.Visit;
import org.springframework.samples.petclinic.visit.VisitRepository;
import org.springframework.stereotype.Service;
-import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.transaction.annotation.Transactional;
/**
@@ -44,9 +42,8 @@ import org.springframework.transaction.annotation.Transactional;
* @author Dave Syer
*/
-@RunWith(SpringRunner.class)
@DataJpaTest(includeFilters = @ComponentScan.Filter(Service.class))
-public class ClinicServiceTests {
+class ClinicServiceTests {
@Autowired
protected OwnerRepository owners;
@@ -61,7 +58,7 @@ public class ClinicServiceTests {
protected VetRepository vets;
@Test
- public void shouldFindOwnersByLastName() {
+ void shouldFindOwnersByLastName() {
Collection<Owner> owners = this.owners.findByLastName("Davis");
assertThat(owners.size()).isEqualTo(2);
@@ -70,7 +67,7 @@ public class ClinicServiceTests {
}
@Test
- public void shouldFindSingleOwnerWithPet() {
+ void shouldFindSingleOwnerWithPet() {
Owner owner = this.owners.findById(1);
assertThat(owner.getLastName()).startsWith("Franklin");
assertThat(owner.getPets().size()).isEqualTo(1);
@@ -80,7 +77,7 @@ public class ClinicServiceTests {
@Test
@Transactional
- public void shouldInsertOwner() {
+ void shouldInsertOwner() {
Collection<Owner> owners = this.owners.findByLastName("Schultz");
int found = owners.size();
@@ -99,7 +96,7 @@ public class ClinicServiceTests {
@Test
@Transactional
- public void shouldUpdateOwner() {
+ void shouldUpdateOwner() {
Owner owner = this.owners.findById(1);
String oldLastName = owner.getLastName();
String newLastName = oldLastName + "X";
@@ -113,7 +110,7 @@ public class ClinicServiceTests {
}
@Test
- public void shouldFindPetWithCorrectId() {
+ void shouldFindPetWithCorrectId() {
Pet pet7 = this.pets.findById(7);
assertThat(pet7.getName()).startsWith("Samantha");
assertThat(pet7.getOwner().getFirstName()).isEqualTo("Jean");
@@ -121,7 +118,7 @@ public class ClinicServiceTests {
}
@Test
- public void shouldFindAllPetTypes() {
+ void shouldFindAllPetTypes() {
Collection<PetType> petTypes = this.pets.findPetTypes();
PetType petType1 = EntityUtils.getById(petTypes, PetType.class, 1);
@@ -132,7 +129,7 @@ public class ClinicServiceTests {
@Test
@Transactional
- public void shouldInsertPetIntoDatabaseAndGenerateId() {
+ void shouldInsertPetIntoDatabaseAndGenerateId() {
Owner owner6 = this.owners.findById(6);
int found = owner6.getPets().size();
@@ -155,7 +152,7 @@ public class ClinicServiceTests {
@Test
@Transactional
- public void shouldUpdatePetName() throws Exception {
+ void shouldUpdatePetName() throws Exception {
Pet pet7 = this.pets.findById(7);
String oldName = pet7.getName();
@@ -168,7 +165,7 @@ public class ClinicServiceTests {
}
@Test
- public void shouldFindVets() {
+ void shouldFindVets() {
Collection<Vet> vets = this.vets.findAll();
Vet vet = EntityUtils.getById(vets, Vet.class, 3);
@@ -180,7 +177,7 @@ public class ClinicServiceTests {
@Test
@Transactional
- public void shouldAddNewVisitForPet() {
+ void shouldAddNewVisitForPet() {
Pet pet7 = this.pets.findById(7);
int found = pet7.getVisits().size();
Visit visit = new Visit();
@@ -195,7 +192,7 @@ public class ClinicServiceTests {
}
@Test
- public void shouldFindVisitsByPetId() throws Exception {
+ void shouldFindVisitsByPetId() throws Exception {
Collection<Visit> visits = this.visits.findByPetId(7);
assertThat(visits.size()).isEqualTo(2);
Visit[] visitArr = visits.toArray(new Visit[visits.size()]);
diff --git a/src/test/java/org/springframework/samples/petclinic/system/CrashControllerTests.java b/src/test/java/org/springframework/samples/petclinic/system/CrashControllerTests.java
index 3f108bf..aa44f44 100644
--- a/src/test/java/org/springframework/samples/petclinic/system/CrashControllerTests.java
+++ b/src/test/java/org/springframework/samples/petclinic/system/CrashControllerTests.java
@@ -1,12 +1,10 @@
package org.springframework.samples.petclinic.system;
-import org.junit.Ignore;
-import org.junit.Test;
-import org.junit.runner.RunWith;
+import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
-import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.web.servlet.MockMvc;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
@@ -20,17 +18,15 @@ import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.
*
* @author Colin But
*/
-@RunWith(SpringRunner.class)
-// Waiting https://github.com/spring-projects/spring-boot/issues/5574
-@Ignore
+@Disabled
@WebMvcTest(controllers = CrashController.class)
-public class CrashControllerTests {
+class CrashControllerTests {
@Autowired
private MockMvc mockMvc;
@Test
- public void testTriggerException() throws Exception {
+ void triggerException() throws Exception {
mockMvc.perform(get("/oups")).andExpect(view().name("exception"))
.andExpect(model().attributeExists("exception"))
.andExpect(forwardedUrl("exception")).andExpect(status().isOk());
diff --git a/src/test/java/org/springframework/samples/petclinic/system/ProductionConfigurationTests.java b/src/test/java/org/springframework/samples/petclinic/system/ProductionConfigurationTests.java
index 9636e36..cc58fa6 100644
--- a/src/test/java/org/springframework/samples/petclinic/system/ProductionConfigurationTests.java
+++ b/src/test/java/org/springframework/samples/petclinic/system/ProductionConfigurationTests.java
@@ -1,22 +1,19 @@
package org.springframework.samples.petclinic.system;
-import org.junit.Test;
-import org.junit.runner.RunWith;
+import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.samples.petclinic.vet.VetRepository;
-import org.springframework.test.context.junit4.SpringRunner;
-@RunWith(SpringRunner.class)
@SpringBootTest
-public class ProductionConfigurationTests {
+class ProductionConfigurationTests {
@Autowired
private VetRepository vets;
@Test
- public void testFindAll() throws Exception {
+ void findAll() throws Exception {
vets.findAll();
vets.findAll(); // served from cache
}
diff --git a/src/test/java/org/springframework/samples/petclinic/vet/VetControllerTests.java b/src/test/java/org/springframework/samples/petclinic/vet/VetControllerTests.java
index ce6adf8..dab5f15 100644
--- a/src/test/java/org/springframework/samples/petclinic/vet/VetControllerTests.java
+++ b/src/test/java/org/springframework/samples/petclinic/vet/VetControllerTests.java
@@ -10,9 +10,8 @@ import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.view;
import org.assertj.core.util.Lists;
-import org.junit.Before;
-import org.junit.Test;
-import org.junit.runner.RunWith;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.boot.test.mock.mockito.MockBean;
@@ -21,16 +20,14 @@ import org.springframework.samples.petclinic.vet.Specialty;
import org.springframework.samples.petclinic.vet.Vet;
import org.springframework.samples.petclinic.vet.VetController;
import org.springframework.samples.petclinic.vet.VetRepository;
-import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.ResultActions;
/**
* Test class for the {@link VetController}
*/
-@RunWith(SpringRunner.class)
@WebMvcTest(VetController.class)
-public class VetControllerTests {
+class VetControllerTests {
@Autowired
private MockMvc mockMvc;
@@ -38,8 +35,8 @@ public class VetControllerTests {
@MockBean
private VetRepository vets;
- @Before
- public void setup() {
+ @BeforeEach
+ void setup() {
Vet james = new Vet();
james.setFirstName("James");
james.setLastName("Carter");
@@ -56,7 +53,7 @@ public class VetControllerTests {
}
@Test
- public void testShowVetListHtml() throws Exception {
+ void showVetListHtml() throws Exception {
mockMvc.perform(get("/vets.html"))
.andExpect(status().isOk())
.andExpect(model().attributeExists("vets"))
@@ -64,7 +61,7 @@ public class VetControllerTests {
}
@Test
- public void testShowResourcesVetList() throws Exception {
+ void showResourcesVetList() throws Exception {
ResultActions actions = mockMvc.perform(get("/vets.json").accept(MediaType.APPLICATION_JSON))
.andExpect(status().isOk());
actions.andExpect(content().contentType("application/json;charset=UTF-8"))
@@ -72,7 +69,7 @@ public class VetControllerTests {
}
@Test
- public void testShowVetListXml() throws Exception {
+ void showVetListXml() throws Exception {
mockMvc.perform(get("/vets.xml").accept(MediaType.APPLICATION_XML))
.andExpect(status().isOk())
.andExpect(content().contentType(MediaType.APPLICATION_XML_VALUE))
diff --git a/src/test/java/org/springframework/samples/petclinic/vet/VetTests.java b/src/test/java/org/springframework/samples/petclinic/vet/VetTests.java
index de3a7b9..874a716 100644
--- a/src/test/java/org/springframework/samples/petclinic/vet/VetTests.java
+++ b/src/test/java/org/springframework/samples/petclinic/vet/VetTests.java
@@ -15,8 +15,7 @@
*/
package org.springframework.samples.petclinic.vet;
-import org.junit.Test;
-
+import org.junit.jupiter.api.Test;
import org.springframework.util.SerializationUtils;
import static org.assertj.core.api.Assertions.assertThat;
@@ -25,10 +24,10 @@ import static org.assertj.core.api.Assertions.assertThat;
* @author Dave Syer
*
*/
-public class VetTests {
+class VetTests {
@Test
- public void testSerialization() {
+ void serialization() {
Vet vet = new Vet();
vet.setFirstName("Zaphod");
vet.setLastName("Beeblebrox");If you look at the results, you should see that:
The
@Autowiredannotation was removedJUnit 4 has been replaced with JUnit 5
javaxhas been replaced withjakartaThe code has been migrated to Java 17, and text blocks are used
Some best practices are applied (such as adding the
publictest method modifier)
Some of you might be tempted to run ./mvnw verify to confirm that the build works. Unfortunately, this isn't the case as the commit we started from is using Wro4j -- which has some slight dependency conflicts. We've decided not to cover Wro4j with recipes for now, as Spring PetClinic has dropped Wro4J as well.
Run a recipe on multiple local repositories
In the previous example, we used the Moderne CLI to run a recipe against a repository on your local machine. This is fine when you only have one repository you're working with. However, what if you wanted to run a recipe against many repositories at once? Checking them out locally, building each of them, and then running a separate command for each would take a considerable amount of time.
Fortunately, the Moderne CLI offers the ability to work on groups of repositories. This can be especially helpful when you're working on debugging a new recipe and want to test it against many repositories at once.
For this exercise, we have prepared a list of Spring 2.x open-source repositories from the spring-projects GitHub organization that can be migrated. These repositories have been added to the Moderne platform and put inside the Spring Projects 2.x organization.
To clone all of these repositories at once:
mkdir -p $HOME/workshop
mod git clone moderne $HOME/workshop "Spring Projects 2.x"If you look in the $HOME/workshop/ directory, you should see 3 different repositories:
ls -ltr $HOME/workshop/You should see output similar to the following.
total 8
drwxr-xr-x@ 19 mikesol staff 608 Apr 8 14:15 spring-data-commons
drwxr-xr-x@ 13 mikesol staff 416 Apr 8 14:15 spring-data-release
-rw-r--r--@ 1 mikesol staff 1816 Apr 8 14:15 clone.log
drwxr-xr-x@ 14 mikesol staff 448 Apr 8 14:15 spring-session-data-mongodb-examplesNow that you have the repositories locally, you can run a recipe against all of them at once. Since all of these repositories have their LSTs published onto the Moderne platform, the build operation will download the LSTs without having to build the repositories locally. This will save you a lot of time!
mod build $HOME/workshopYou should see output similar to the following.
Moderne CLI 3.2.0
> Selecting repositories
> spring-projects/spring-data-commons@main
> spring-projects/spring-data-release@main
> spring-projects/spring-session-data-mongodb-examples@main
Selected 3 repositories (0.2s)
> Building LST(s)
> spring-projects/spring-data-commons@main
Build output will be written to /Users/mikesol/workshop/spring-data-commons/.moderne/build/20240408141619-vwfxP/build.log
> Step 1 - download from Moderne
! Failed to download the LST from Moderne. Proceeding to build the LST locally
> Step 1 - build with Maven
Selected the 21.0.1-oracle JDK
> Step 2 - build with mod-java
Selected the 21.0.1-oracle JDK
> Step 3 - build resources using the native CLI
✓ Built LST /Users/mikesol/workshop/spring-data-commons/.moderne/build/20240408141619-vwfxP/spring-data-commons-20240408141751-ast.jar
+ Reported build metrics to Moderne
+ Cleaned 0 older builds.
> spring-projects/spring-data-release@main
Build output will be written to /Users/mikesol/workshop/spring-data-release/.moderne/build/20240408141619-vwfxP/build.log
> Step 1 - download from Moderne
✓ Downloaded LST /Users/mikesol/workshop/spring-data-release/.moderne/build/20240408141619-vwfxP/spring-data-release-20240408025602-ast.jar
+ Cleaned 0 older builds.
> spring-projects/spring-session-data-mongodb-examples@main
Build output will be written to /Users/mikesol/workshop/spring-session-data-mongodb-examples/.moderne/build/20240408141619-vwfxP/build.log
> Step 1 - download from Moderne
✓ Downloaded LST /Users/mikesol/workshop/spring-session-data-mongodb-examples/.moderne/build/20240408141619-vwfxP/spring-session-data-mongodb-examples-20240408114209-ast.jar
+ Cleaned 0 older builds.
Built 3 repositories. (1m 32s)
1m 57s saved by using previously built LSTs
* What to do next
> Run mod run /Users/mikesol/workshop --recipe=<RecipeName>
MOD SUCCEEDED in (1m 33s)mod run $HOME/workshop --recipe UpgradeSpringBoot_3_2You can preview the changes by command/ctrl clicking on the patch file generated when running the recipe:
➜ ~ mod run $HOME/workshop --recipe UpgradeSpringBoot_3_2
Moderne CLI 3.2.0
> Selecting repositories
> spring-projects/spring-data-commons@main
> spring-projects/spring-data-release@main
> spring-projects/spring-session-data-mongodb-examples@main
Selected 3 repositories (0.18s)
> Running recipe org.openrewrite.java.spring.boot3.UpgradeSpringBoot_3_2
> spring-projects/spring-data-commons@main
# Command/ctrl click on the following file:
✓ Fix results at /Users/mikesol/workshop/spring-data-commons/.moderne/run/20240408141902-kHLCn/fix.patch
...You can then apply the changes to all of these repositories at once with the following command:
mod git apply $HOME/workshop --last-recipe-runNext, you can add the changes so that they're ready to be committed with the following command:
mod git add $HOME/workshop --last-recipe-runFinally, you can commit the changes to all the repositories at once with the following command:
mod git commit $HOME/workshop -m "Migrate to Spring Boot 3.2" --last-recipe-runIf you'd rather make a branch for each repository and make changes in that, you can use the mod checkout command before running mod commit to commit the changes. This might be useful if you want to create a pull request for each repository.
(Optional) Data tables example
If you have time, the following example will demonstrate how to create and view the data tables available after a recipe runs.
Step 0: Create a new directory for the repositories:
mkdir $HOME/workshop/default
cd $HOME/workshop/defaultStep 1: Clone repositories
Run the command:
mod git clone moderne . "Default"You should see output similar to the following.
Moderne CLI 3.2.0
> Listing repositories from Moderne
Moderne contains 12 repositories in Default. Cloning the first 12.
> Cloning repositories
Clone output will be written to /Users/mikesol/workshop/default/./clone.log
> blitz4j@master
> dynomite-manager@dev
> Fenzo@master
> hollow@master
> ndbench@master
> Priam@3.x
> spring-cloud-circuitbreaker@main
> spring-cloud-common-security-config@main
> spring-cloud-core-tests@main
> spring-cloud-netflix@main
> spring-hateoas-examples@main
> spring-petclinic@main
Cloned 12 repositories (32s)Step 2: Build the LSTs
Run the command:
mod build .You should see output similar to the following.
Moderne CLI 3.2.0
> Selecting repositories
> Netflix/Fenzo@master
> Netflix/Priam@3.x
> Netflix/blitz4j@master
> Netflix/dynomite-manager@dev
> Netflix/hollow@master
> Netflix/ndbench@master
> spring-cloud/spring-cloud-circuitbreaker@main
> spring-cloud/spring-cloud-common-security-config@main
> spring-cloud/spring-cloud-core-tests@main
> spring-cloud/spring-cloud-netflix@main
> spring-projects/spring-hateoas-examples@main
> spring-projects/spring-petclinic@main
Selected 12 repositories (0.31s)
> Building LST(s)
> Netflix/Fenzo@master
Build output will be written to /Users/mikesol/workshop/default/Fenzo/.moderne/build/20240408152858-1xwiY/build.log
> Step 1 - download from Moderne
✓ Downloaded LST /Users/mikesol/workshop/default/Fenzo/.moderne/build/20240408152858-1xwiY/Fenzo-20240408054919-ast.jar
+ Cleaned 0 older builds.
> Netflix/Priam@3.x
Build output will be written to /Users/mikesol/workshop/default/Priam/.moderne/build/20240408152858-1xwiY/build.log
> Step 1 - download from Moderne
✓ Downloaded LST /Users/mikesol/workshop/default/Priam/.moderne/build/20240408152858-1xwiY/Priam-20240408014027-ast.jar
+ Cleaned 0 older builds.
> Netflix/blitz4j@master
Build output will be written to /Users/mikesol/workshop/default/blitz4j/.moderne/build/20240408152858-1xwiY/build.log
> Step 1 - download from Moderne
✓ Downloaded LST /Users/mikesol/workshop/default/blitz4j/.moderne/build/20240408152858-1xwiY/blitz4j-20240408013726-ast.jar
+ Cleaned 0 older builds.
> Netflix/dynomite-manager@dev
Build output will be written to /Users/mikesol/workshop/default/dynomite-manager/.moderne/build/20240408152858-1xwiY/build.log
> Step 1 - download from Moderne
✓ Downloaded LST /Users/mikesol/workshop/default/dynomite-manager/.moderne/build/20240408152858-1xwiY/dynomite-manager-20240408020613-ast.jar
+ Cleaned 0 older builds.
> Netflix/hollow@master
Build output will be written to /Users/mikesol/workshop/default/hollow/.moderne/build/20240408152858-1xwiY/build.log
> Step 1 - download from Moderne
✓ Downloaded LST /Users/mikesol/workshop/default/hollow/.moderne/build/20240408152858-1xwiY/hollow-20240408114552-ast.jar
+ Cleaned 0 older builds.
> Netflix/ndbench@master
Build output will be written to /Users/mikesol/workshop/default/ndbench/.moderne/build/20240408152858-1xwiY/build.log
> Step 1 - download from Moderne
✓ Downloaded LST /Users/mikesol/workshop/default/ndbench/.moderne/build/20240408152858-1xwiY/ndbench-20240408144401-ast.jar
+ Cleaned 0 older builds.
> spring-cloud/spring-cloud-circuitbreaker@main
Build output will be written to /Users/mikesol/workshop/default/spring-cloud-circuitbreaker/.moderne/build/20240408152858-1xwiY/build.log
> Step 1 - download from Moderne
✓ Downloaded LST /Users/mikesol/workshop/default/spring-cloud-circuitbreaker/.moderne/build/20240408152858-1xwiY/spring-cloud-circuitbreaker-20240408083113-ast.jar
+ Cleaned 0 older builds.
> spring-cloud/spring-cloud-common-security-config@main
Build output will be written to /Users/mikesol/workshop/default/spring-cloud-common-security-config/.moderne/build/20240408152858-1xwiY/build.log
> Step 1 - download from Moderne
✓ Downloaded LST /Users/mikesol/workshop/default/spring-cloud-common-security-config/.moderne/build/20240408152858-1xwiY/spring-cloud-common-security-config-20240408141440-ast.jar
+ Cleaned 0 older builds.
> spring-cloud/spring-cloud-core-tests@main
Build output will be written to /Users/mikesol/workshop/default/spring-cloud-core-tests/.moderne/build/20240408152858-1xwiY/build.log
> Step 1 - download from Moderne
✓ Downloaded LST /Users/mikesol/workshop/default/spring-cloud-core-tests/.moderne/build/20240408152858-1xwiY/spring-cloud-core-tests-20240408070429-ast.jar
+ Cleaned 0 older builds.
> spring-cloud/spring-cloud-netflix@main
Build output will be written to /Users/mikesol/workshop/default/spring-cloud-netflix/.moderne/build/20240408152858-1xwiY/build.log
> Step 1 - download from Moderne
✓ Downloaded LST /Users/mikesol/workshop/default/spring-cloud-netflix/.moderne/build/20240408152858-1xwiY/spring-cloud-netflix-20240407230948-ast.jar
+ Cleaned 0 older builds.
> spring-projects/spring-hateoas-examples@main
Build output will be written to /Users/mikesol/workshop/default/spring-hateoas-examples/.moderne/build/20240408152858-1xwiY/build.log
> Step 1 - download from Moderne
✓ Downloaded LST /Users/mikesol/workshop/default/spring-hateoas-examples/.moderne/build/20240408152858-1xwiY/spring-hateoas-examples-20240408084132-ast.jar
+ Cleaned 0 older builds.
> spring-projects/spring-petclinic@main
Build output will be written to /Users/mikesol/workshop/default/spring-petclinic/.moderne/build/20240408152858-1xwiY/build.log
> Step 1 - download from Moderne
✓ Downloaded LST /Users/mikesol/workshop/default/spring-petclinic/.moderne/build/20240408152858-1xwiY/spring-petclinic-20240408215517-ast.jar
+ Cleaned 0 older builds.
Built 12 repositories. (6s)
40m 27s saved by using previously built LSTs
* What to do next
> Run mod run . --recipe=<RecipeName>
MOD SUCCEEDED in (6s)Step 3: Install recipes
If you want to install all the recipes in Moderne:
mod config recipes moderne syncIf you want to install just the recipe we'll use below:
mod config recipes moderne install UpgradeToJava17Then select the Migrate to Java 17 recipe from the list
Step 4: Run the refactoring recipe against all of the repos
mod run . --recipe UpgradeToJava17You should see results similar to the following
Moderne CLI 3.2.0
> Selecting repositories
> Netflix/Fenzo@master
> Netflix/Priam@3.x
> Netflix/blitz4j@master
> Netflix/dynomite-manager@dev
> Netflix/hollow@master
> Netflix/ndbench@master
> spring-cloud/spring-cloud-circuitbreaker@main
> spring-cloud/spring-cloud-common-security-config@main
> spring-cloud/spring-cloud-core-tests@main
> spring-cloud/spring-cloud-netflix@main
> spring-projects/spring-hateoas-examples@main
> spring-projects/spring-petclinic@main
Selected 12 repositories (0.4s)
[1] Migrate to Java 17 (org.openrewrite.java.migrate.UpgradeToJava17)
[2] Migrate to Java 17 (io.quarkus.updates.core.quarkus37.UpgradeToJava17)
Select a recipe [1-2]: 1
> Running recipe org.openrewrite.java.migrate.UpgradeToJava17
> Netflix/Fenzo@master
✓ Fix results at /Users/mikesol/workshop/default/Fenzo/.moderne/run/20240408152941-Xi9Co/fix.patch
> Netflix/Priam@3.x
✓ Fix results at /Users/mikesol/workshop/default/Priam/.moderne/run/20240408152941-Xi9Co/fix.patch
> Netflix/blitz4j@master
✓ Fix results at /Users/mikesol/workshop/default/blitz4j/.moderne/run/20240408152941-Xi9Co/fix.patch
> Netflix/dynomite-manager@dev
✓ Fix results at /Users/mikesol/workshop/default/dynomite-manager/.moderne/run/20240408152941-Xi9Co/fix.patch
> Netflix/hollow@master
✓ Fix results at /Users/mikesol/workshop/default/hollow/.moderne/run/20240408152941-Xi9Co/fix.patch
> Netflix/ndbench@master
✓ Fix results at /Users/mikesol/workshop/default/ndbench/.moderne/run/20240408152941-Xi9Co/fix.patch
> spring-cloud/spring-cloud-circuitbreaker@main
No changes
> spring-cloud/spring-cloud-common-security-config@main
✓ Fix results at /Users/mikesol/workshop/default/spring-cloud-common-security-config/.moderne/run/20240408152941-Xi9Co/fix.patch
> spring-cloud/spring-cloud-core-tests@main
No changes
> spring-cloud/spring-cloud-netflix@main
✓ Fix results at /Users/mikesol/workshop/default/spring-cloud-netflix/.moderne/run/20240408152941-Xi9Co/fix.patch
> spring-projects/spring-hateoas-examples@main
✓ Fix results at /Users/mikesol/workshop/default/spring-hateoas-examples/.moderne/run/20240408152941-Xi9Co/fix.patch
> spring-projects/spring-petclinic@main
✓ Fix results at /Users/mikesol/workshop/default/spring-petclinic/.moderne/run/20240408152941-Xi9Co/fix.patch
Found results on 10 repositories (1m 30s)
40m 27s saved by using previously built LSTs
* What to do next
> Click on one of the patch links above to view the changes on a particular repository
> Run mod study . --last-recipe-run --data-table <DATA-TABLE> to examine the following data tables produced by this recipe:
org.openrewrite.table.RecipeRunStats
org.openrewrite.table.SourcesFileResults
org.openrewrite.table.SourcesFiles
> Run npm install -g diff2html-cli to produce patch files on subsequent runs that are easier to view
> Run mod git checkout . -b hotfix --last-recipe-run to prepare a hotfix branch for applying the changes
> Run mod git apply . --last-recipe-run to apply the changes
> Run mod git apply . --recipe-run 20240408152941-Xi9Co to apply the changes
MOD SUCCEEDED in (1m 32s)You can command/control + click the patch file produced for each repository to view the diff.
Step 5: Run mod study to view a data table
Recipes can produce data tables as a recipe run proceeds. Data tables are, effectively, tabular data in a schema that is defined by the recipe.
Let's take a look at the data table for which source files had results:
mod study . --last-recipe-run --data-table SourcesFileResultsYou should see results similar to the following.
Moderne CLI 3.2.0
Found recipe run 20240408152941-Xi9Co
> Selecting repositories
> Netflix/Fenzo@master
> Netflix/Priam@3.x
> Netflix/blitz4j@master
> Netflix/dynomite-manager@dev
> Netflix/hollow@master
> Netflix/ndbench@master
> spring-cloud/spring-cloud-circuitbreaker@main
> spring-cloud/spring-cloud-common-security-config@main
> spring-cloud/spring-cloud-core-tests@main
> spring-cloud/spring-cloud-netflix@main
> spring-projects/spring-hateoas-examples@main
> spring-projects/spring-petclinic@main
Selected 12 repositories (0.12s)
> Building a combined data table from results on every repository
> Netflix/Fenzo@master
✓ Added 699 rows
> Netflix/Priam@3.x
✓ Added 1419 rows
> Netflix/blitz4j@master
✓ Added 112 rows
> Netflix/dynomite-manager@dev
✓ Added 485 rows
> Netflix/hollow@master
✓ Added 4758 rows
> Netflix/ndbench@master
✓ Added 945 rows
> spring-cloud/spring-cloud-circuitbreaker@main
✓ Did not produce any rows for this data table
> spring-cloud/spring-cloud-common-security-config@main
✓ Added 196 rows
> spring-cloud/spring-cloud-core-tests@main
✓ Did not produce any rows for this data table
> spring-cloud/spring-cloud-netflix@main
✓ Added 13 rows
> spring-projects/spring-hateoas-examples@main
✓ Added 332 rows
> spring-projects/spring-petclinic@main
✓ Added 1 rows
Studied 12 repositories (22s)
* What to do next
> Open /Users/mikesol/workshop/default/org.openrewrite.table.SourcesFileResults.xlsx
MOD SUCCEEDED in (22s)You can open up the Excel output that was produced to see that on these 12 repositories, thousands of changes were made.
Step 6: Using templates with mod study
You can modify the mod study command to add a --template argument that lets you change the structure of the produced table.
Let's install and run the FindMethods recipe to demonstrate this (if you didn't already install it earlier):
mod config recipes moderne install FindMethods
# Select the first one (org.openrewrite.java.search.FindMethods)
mod run . --recipe FindMethods -PmethodPattern="java.util.List add(..)"You can then filter the data table down to only a couple columns we're interested in and use a GoTemplate to produce a markdown file containing code samples for all of the matching methods found across all of the repositories:
mod study ./spring-data --last-recipe-run --data-table MethodCalls --json sourceFile,method --template '{{"# Search results\n\n"}}{{range .}}{{"* "}}{{.sourceFile}}{{"\n```\n"}}{{.method}}{{"\n```\n"}}{{end}}' > methods.md Open up methods.md in your favorite markdown editor to view the results.
(Optional) Fix static code analysis issues
If you have time, we recommend trying out one of the showcase recipes in OpenRewrite: common static analysis. This recipe is composed of 50+ recipes that find and fix common mistakes people make.
Ensure you're still in the
$HOME/workshop/defaultdirectory:
cd $HOME/workshop/defaultRun the common static analysis recipe:
mod run . --recipe org.openrewrite.staticanalysis.CommonStaticAnalysisYou should see results similar to:
Moderne CLI 3.2.0
> Selecting repositories
> Netflix/Fenzo@master
> Netflix/Priam@3.x
> Netflix/blitz4j@master
> Netflix/dynomite-manager@dev
> Netflix/hollow@master
> Netflix/ndbench@master
> spring-cloud/spring-cloud-circuitbreaker@main
> spring-cloud/spring-cloud-common-security-config@main
> spring-cloud/spring-cloud-core-tests@main
> spring-cloud/spring-cloud-netflix@main
> spring-projects/spring-hateoas-examples@main
> spring-projects/spring-petclinic@main
Selected 12 repositories (0.28s)
> Running recipe org.openrewrite.staticanalysis.CommonStaticAnalysis
> Netflix/Fenzo@master
✓ Fix results at /Users/mikesol/workshop/Fenzo/.moderne/run/20240408155011-T0puX/fix.patch
> Netflix/Priam@3.x
✓ Fix results at /Users/mikesol/workshop/Priam/.moderne/run/20240408155011-T0puX/fix.patch
> Netflix/blitz4j@master
✓ Fix results at /Users/mikesol/workshop/blitz4j/.moderne/run/20240408155011-T0puX/fix.patch
> Netflix/dynomite-manager@dev
✓ Fix results at /Users/mikesol/workshop/dynomite-manager/.moderne/run/20240408155011-T0puX/fix.patch
> Netflix/hollow@master
✓ Fix results at /Users/mikesol/workshop/hollow/.moderne/run/20240408155011-T0puX/fix.patch
> Netflix/ndbench@master
✓ Fix results at /Users/mikesol/workshop/ndbench/.moderne/run/20240408155011-T0puX/fix.patch
> spring-cloud/spring-cloud-circuitbreaker@main
✓ Fix results at /Users/mikesol/workshop/spring-cloud-circuitbreaker/.moderne/run/20240408155011-T0puX/fix.patch
> spring-cloud/spring-cloud-common-security-config@main
✓ Fix results at /Users/mikesol/workshop/spring-cloud-common-security-config/.moderne/run/20240408155011-T0puX/fix.patch
> spring-cloud/spring-cloud-core-tests@main
✓ Fix results at /Users/mikesol/workshop/spring-cloud-core-tests/.moderne/run/20240408155011-T0puX/fix.patch
> spring-cloud/spring-cloud-netflix@main
✓ Fix results at /Users/mikesol/workshop/spring-cloud-netflix/.moderne/run/20240408155011-T0puX/fix.patch
> spring-projects/spring-hateoas-examples@main
✓ Fix results at /Users/mikesol/workshop/spring-hateoas-examples/.moderne/run/20240408155011-T0puX/fix.patch
> spring-projects/spring-petclinic@main
✓ Fix results at /Users/mikesol/workshop/spring-petclinic/.moderne/run/20240408155011-T0puX/fix.patch
Found results on 12 repositories (1m 22s)
40m 27s saved by using previously built LSTs
* What to do next
> Click on one of the patch links above to view the changes on a particular repository
> Run mod study . --last-recipe-run --data-table <DATA-TABLE> to examine the following data tables produced by this recipe:
org.openrewrite.table.RecipeRunStats
org.openrewrite.table.SourcesFileResults
> Run npm install -g diff2html-cli to produce patch files on subsequent runs that are easier to view
> Run mod git checkout . -b hotfix --last-recipe-run to prepare a hotfix branch for applying the changes
> Run mod git apply . --last-recipe-run to apply the changes
> Run mod git apply . --recipe-run 20240408155011-T0puX to apply the changes
MOD SUCCEEDED in (1m 23s)You can examine all the changes the recipe would make by command/ctrl clicking on the patch file that is generated by the recipe run.
You should see results similar to:
diff --git a/fenzo-core/src/main/java/com/netflix/fenzo/AssignableVirtualMachine.java b/fenzo-core/src/main/java/com/netflix/fenzo/AssignableVirtualMachine.java
index 2582b0d..bc3ea45 100644
--- a/fenzo-core/src/main/java/com/netflix/fenzo/AssignableVirtualMachine.java
+++ b/fenzo-core/src/main/java/com/netflix/fenzo/AssignableVirtualMachine.java
@@ -34,9 +34,9 @@ org.openrewrite.staticanalysis.CommonStaticAnalysis
*/
public class AssignableVirtualMachine implements Comparable<AssignableVirtualMachine>{
- /* package */ static final String PseuoHostNamePrefix = "FenzoPsueodHost-";
-
- private static class PortRange {
+ /* package */ static final String PseuoHostNamePrefix = "FenzoPsueodHost-";
+
+ private static final class PortRange {
private final VirtualMachineLease.Range range;
private PortRange(VirtualMachineLease.Range range) {
this.range = range;
@@ -49,8 +49,8 @@
private static class PortRanges {
private List<VirtualMachineLease.Range> ranges = new ArrayList<>();
private List<PortRange> portRanges = new ArrayList<>();
- private int totalPorts=0;
- private int currUsedPorts=0;
+ private int totalPorts;
+ private int currUsedPorts;
void addRanges(List<VirtualMachineLease.Range> ranges) {
if(ranges!=null) {
@@ -117,7 +117,7 @@
private double currUsedNetworkMbps=0.0;
private double currTotalDisk=0.0;
private double currUsedDisk=0.0;
- private VirtualMachineLease currTotalLease=null;
+ private VirtualMachineLease currTotalLease;
private PortRanges currPortRanges = new PortRanges();
private volatile Map<String, Protos.Attribute> currAttributesMap = Collections.emptyMap();
private final Map<String, PreferentialNamedConsumableResourceSet> resourceSets = new HashMap<>();
@@ -130,15 +130,15 @@
private static final Logger logger = LoggerFactory.getLogger(AssignableVirtualMachine.class);
private final ConcurrentMap<String, String> leaseIdToHostnameMap;
private final ConcurrentMap<String, String> vmIdToHostnameMap;
- private volatile String currVMId =null;
+ private volatile String currVMId;
private final TaskTracker taskTracker;
- private volatile long disabledUntil=0L;
+ private volatile long disabledUntil;
// This may have to be configurable, but, for now weight the job's soft constraints more than system wide fitness calculators
private static double softConstraintFitnessWeightPercentage =50.0;
private static double rSetsFitnessWeightPercentage=15.0;
- private String exclusiveTaskId =null;
+ private String exclusiveTaskId;
private final boolean singleLeaseMode;
- private boolean firstLeaseAdded=false;
+ private boolean firstLeaseAdded;
private final List<TaskRequest> consumedResourcesToAssign = new ArrayList<>();
public AssignableVirtualMachine(PreferentialNamedConsumableResourceEvaluator preferentialNamedConsumableResourceEvaluator,
@@ -174,9 +174,10 @@
return leaseRejectAction==null?
lease -> logger.warn("No lease reject action registered to reject lease id " + lease.getId() +
" on host " + lease.hostname()) :
- lease -> {
- if (isRejectable(lease))
- leaseRejectAction.call(lease);
+ lease -> {
+ if (isRejectable(lease)) {
+ leaseRejectAction.call(lease);
+ }
};
}
@@ -184,75 +185,76 @@
return l != null && l.getOffer() != null;
}
- private void addToAvailableResources(VirtualMachineLease l) {
- if(singleLeaseMode && firstLeaseAdded)
- return; // ToDo should this be illegal state exception?
- firstLeaseAdded = true;
- final Map<String, Double> scalars = l.getScalarValues();
- if(scalars != null && !scalars.isEmpty()) {
- for(Map.Entry<String, Double> entry: scalars.entrySet()) {
- Double currVal = currTotalScalars.get(entry.getKey());
- if(currVal == null)
- currVal = 0.0;
- currTotalScalars.put(entry.getKey(), currVal + entry.getValue());
- }
- }
- currTotalCpus += l.cpuCores();
- currTotalMemory += l.memoryMB();
- currTotalNetworkMbps += l.networkMbps();
- currTotalDisk += l.diskMB();
- if (l.portRanges() != null)
- currPortRanges.addRanges(l.portRanges());
- if (l.getAttributeMap() != null) {
- // always replace attributes map with the latest
- currAttributesMap = Collections.unmodifiableMap(new HashMap<>(l.getAttributeMap()));
- }
- for(Map.Entry<String, Protos.Attribute> entry: currAttributesMap.entrySet()) {
- switch (entry.getKey()) {
- case "res":
- String val = entry.getValue().getText().getValue();
- if(val!=null) {
- StringTokenizer tokenizer = new StringTokenizer(val, "-");
- String resName = tokenizer.nextToken();
- switch (resName) {
- case PreferentialNamedConsumableResourceSet.attributeName:
- if(tokenizer.countTokens() == 3) {
- String name = tokenizer.nextToken();
- String val0Str = tokenizer.nextToken();
- String val1Str = tokenizer.nextToken();
- if(!resourceSets.containsKey(name)) {
- try {
- int val0 = Integer.parseInt(val0Str);
- int val1 = Integer.parseInt(val1Str);
- final PreferentialNamedConsumableResourceSet crs =
- new PreferentialNamedConsumableResourceSet(hostname, name, val0, val1);
- final Iterator<TaskRequest> iterator = consumedResourcesToAssign.iterator();
- while(iterator.hasNext()) {
- TaskRequest request = iterator.next();
- crs.assign(request);
- iterator.remove();
- }
- resourceSets.put(name, crs);
- }
- catch (NumberFormatException e) {
- logger.warn(hostname + ": invalid resource spec (" + val + ") in attributes, ignoring: " + e.getMessage());
- }
- }
- }
- else
- logger.warn("Invalid res spec (expected 4 tokens with delimiter '-', ignoring: " + val);
- break;
- default:
- logger.warn("Unknown resource in attributes, ignoring: " + val);
- }
- }
- break;
- }
- }
- if(!consumedResourcesToAssign.isEmpty()) {
- throw new IllegalStateException(hostname + ": Some assigned tasks have no resource sets in offers: " +
- consumedResourcesToAssign);
- }
+ private void addToAvailableResources(VirtualMachineLease l) {
+ if (singleLeaseMode && firstLeaseAdded) {
+ return; // ToDo should this be illegal state exception?
+ }
+ firstLeaseAdded = true;
+ final Map<String, Double> scalars = l.getScalarValues();
+ if (scalars != null && !scalars.isEmpty()) {
+ for (Map.Entry<String, Double> entry : scalars.entrySet()) {
+ Double currVal = currTotalScalars.get(entry.getKey());
+ if (currVal == null) {
+ currVal = 0.0;
+ }
+ currTotalScalars.put(entry.getKey(), currVal + entry.getValue());
+ }
+ }
+ currTotalCpus += l.cpuCores();
+ currTotalMemory += l.memoryMB();
+ currTotalNetworkMbps += l.networkMbps();
+ currTotalDisk += l.diskMB();
+ if (l.portRanges() != null) {
+ currPortRanges.addRanges(l.portRanges());
+ }
+ if (l.getAttributeMap() != null) {
+ // always replace attributes map with the latest
+ currAttributesMap = Collections.unmodifiableMap(new HashMap<>(l.getAttributeMap()));
+ }
+ for (Map.Entry<String, Protos.Attribute> entry : currAttributesMap.entrySet()) {
+ if ("res".equals(entry.getKey())) {
+ String val = entry.getValue().getText().getValue();
+ if (val != null) {
+ StringTokenizer tokenizer = new StringTokenizer(val, "-");
+ String resName = tokenizer.nextToken();
+ switch (resName) {
+ case PreferentialNamedConsumableResourceSet.attributeName:
+ if (tokenizer.countTokens() == 3) {
+ String name = tokenizer.nextToken();
+ String val0Str = tokenizer.nextToken();
+ String val1Str = tokenizer.nextToken();
+ if (!resourceSets.containsKey(name)) {
+ try {
+ int val0 = Integer.parseInt(val0Str);
+ int val1 = Integer.parseInt(val1Str);
+ final PreferentialNamedConsumableResourceSet crs =
+ new PreferentialNamedConsumableResourceSet(hostname, name, val0, val1);
+ final Iterator<TaskRequest> iterator = consumedResourcesToAssign.iterator();
+ while (iterator.hasNext()) {
+ TaskRequest request = iterator.next();
+ crs.assign(request);
+ iterator.remove();
+ }
+ resourceSets.put(name, crs);
+ }
+ catch (NumberFormatException e) {
+ logger.warn(hostname + ": invalid resource spec (" + val + ") in attributes, ignoring: " + e.getMessage());
+ }
+ }
+ } else {
+ logger.warn("Invalid res spec (expected 4 tokens with delimiter '-', ignoring: " + val);
+ }
+ break;
+ default:
+ logger.warn("Unknown resource in attributes, ignoring: " + val);
+ }
+ }
+ }
+ }
+ if (!consumedResourcesToAssign.isEmpty()) {
+ throw new IllegalStateException(hostname + ": Some assigned tasks have no resource sets in offers: " +
+ consumedResourcesToAssign);
+ }
}
...As before, if you like the changes, you can apply the changes by running:
mod git apply . --last-recipe-runYou could then run tests on each of the projects to ensure everything still builds successfully before committing the results.
You can probably imagine that this recipe resolves a lot of technical debt when run at scale throughout an organization.
Last updated
