replacedeprecatedenvironmenttestutils.md

Replace EnvironmentTestUtils with TestPropertyValues

org.openrewrite.java.spring.boot2.ReplaceDeprecatedEnvironmentTestUtils

Replaces any references to the deprecated EnvironmentTestUtils with TestPropertyValues and the appropriate functionality.

Source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite.recipe
• artifactId: rewrite-spring
• version: 5.0.1

Example

{% tabs %} {% tab title="com/mycompany/MyClass.java" %}

Before

{% code title="com/mycompany/MyClass.java" %}

package com.mycompany;

import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import static org.springframework.boot.test.util.EnvironmentTestUtils.addEnvironment;

public class MyClass {
    public void myMethod() {
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
        String pair = "pair";
        addEnvironment(context, pair);
    }
}

{% endcode %}

After

{% code title="com/mycompany/MyClass.java" %}

package com.mycompany;

import org.springframework.boot.test.util.TestPropertyValues;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class MyClass {
    public void myMethod() {
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
        String pair = "pair";
        TestPropertyValues.of(pair).applyTo(context);
    }
}

{% endcode %}

{% endtab %} {% tab title="Diff" %} {% code %}

--- com/mycompany/MyClass.java
+++ com/mycompany/MyClass.java
@@ -3,0 +3,1 @@
package com.mycompany;

+import org.springframework.boot.test.util.TestPropertyValues;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
@@ -4,1 +5,0 @@

import org.springframework.context.annotation.AnnotationConfigApplicationContext;
-import static org.springframework.boot.test.util.EnvironmentTestUtils.addEnvironment;

@@ -10,1 +10,1 @@
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
        String pair = "pair";
-       addEnvironment(context, pair);
+       TestPropertyValues.of(pair).applyTo(context);
    }

{% endcode %} {% endtab %} {% endtabs %}

Usage

This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-spring:5.0.1 in your build file or by running a shell command (in which case no build changes are needed): {% tabs %} {% tab title="Gradle" %} {% code title="build.gradle" %}

plugins {
    id("org.openrewrite.rewrite") version("6.1.4")
}

rewrite {
    activeRecipe("org.openrewrite.java.spring.boot2.ReplaceDeprecatedEnvironmentTestUtils")
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-spring:5.0.1")
}

{% endcode %} {% endtab %} {% tab title="Maven POM" %} {% code title="pom.xml" %}

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.2.4</version>
        <configuration>
          <activeRecipes>
            <recipe>org.openrewrite.java.spring.boot2.ReplaceDeprecatedEnvironmentTestUtils</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-spring</artifactId>
            <version>5.0.1</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

{% endcode %} {% endtab %}

{% tab title="Maven Command Line" %} {% code title="shell" %} You will need to have Maven installed on your machine before you can run the following command.

mvn -U org.openrewrite.maven:rewrite-maven-plugin:run \
  -Drewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-spring:RELEASE \
  -Drewrite.activeRecipes=org.openrewrite.java.spring.boot2.ReplaceDeprecatedEnvironmentTestUtils

{% endcode %} {% endtab %} {% endtabs %}

Contributors

• Kevin McCarpenter
• Jonathan Schneider
• Sam Snyder
• Aaron Gershman
• Kun Li
• Patrick
• Knut Wannheden

See how this recipe works across multiple open-source repositories

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.