temporaryfoldertotempdir.md

Use JUnit Jupiter @TempDir

org.openrewrite.java.testing.junit5.TemporaryFolderToTempDir

Translates JUnit 4's org.junit.rules.TemporaryFolder into JUnit 5's org.junit.jupiter.api.io.TempDir.

Source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite.recipe
• artifactId: rewrite-testing-frameworks
• version: 2.0.2

Example

{% tabs %} {% tab title="groovy" %}

Before

{% code %}

import org.junit.Rule
import org.junit.rules.TemporaryFolder

class AbstractIntegrationTest {
    @Rule
    TemporaryFolder temporaryFolder = new TemporaryFolder()

    def setup() {
        projectDir = temporaryFolder.root
        buildFile = temporaryFolder.newFile('build.gradle')
        settingsFile = temporaryFolder.newFile('settings.gradle')
    }
}

{% endcode %}

After

{% code %}

import org.junit.Rule
import org.junit.rules.TemporaryFolder

class AbstractIntegrationTest {
    @TempDir
    File temporaryFolder

    def setup() {
        projectDir = temporaryFolder.root
        buildFile = File.createTempFile('build.gradle', null, temporaryFolder)
        settingsFile = File.createTempFile('settings.gradle', null, temporaryFolder)
    }
}

{% endcode %}

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

@@ -5,2 +5,2 @@

class AbstractIntegrationTest {
-   @Rule
-   TemporaryFolder temporaryFolder = new TemporaryFolder()
+   @TempDir
+   File temporaryFolder

@@ -10,2 +10,2 @@
    def setup() {
        projectDir = temporaryFolder.root
-       buildFile = temporaryFolder.newFile('build.gradle')
-       settingsFile = temporaryFolder.newFile('settings.gradle')
+       buildFile = File.createTempFile('build.gradle', null, temporaryFolder)
+       settingsFile = File.createTempFile('settings.gradle', null, temporaryFolder)
    }

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

Usage

This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-testing-frameworks:2.0.2 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.testing.junit5.TemporaryFolderToTempDir")
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-testing-frameworks:2.0.2")
}

{% 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.testing.junit5.TemporaryFolderToTempDir</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-testing-frameworks</artifactId>
            <version>2.0.2</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-testing-frameworks:RELEASE \
  -Drewrite.activeRecipes=org.openrewrite.java.testing.junit5.TemporaryFolderToTempDir

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

Contributors

• Jonathan Schnéider
• Patrick Way
• Sam Snyder
• Greg Adams
• Knut Wannheden
• Patrick
• Michael Keppler
• Aaron Gershman

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.