Migrate tests to JUnit 5

Closes gh-959

Author: wilkinsona

spring-restdocs-asciidoctor/build.gradle

@@ -10,10 +10,15 @@ dependencies {
 
 	internal(platform(project(":spring-restdocs-platform")))
 
-	testImplementation("junit:junit")
 	testImplementation("org.apache.pdfbox:pdfbox")
 	testImplementation("org.assertj:assertj-core")
+	testImplementation("org.junit.jupiter:junit-jupiter")
 	testImplementation("org.springframework:spring-core")
 
 	testRuntimeOnly("org.asciidoctor:asciidoctorj-pdf")
+	testRuntimeOnly("org.junit.platform:junit-platform-launcher")
+}
+
+tasks.named("test") {
+	useJUnitPlatform()
 }

spring-restdocs-asciidoctor/src/test/java/org/springframework/restdocs/asciidoctor/AbstractOperationBlockMacroTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2014-2023 the original author or authors.
+ * Copyright 2014-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -35,11 +35,10 @@
 import org.asciidoctor.Attributes;
 import org.asciidoctor.Options;
 import org.asciidoctor.SafeMode;
-import org.junit.After;
-import org.junit.Before;
-import org.junit.Rule;
-import org.junit.Test;
-import org.junit.rules.TemporaryFolder;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
 
 import org.springframework.util.FileSystemUtils;
 
@@ -51,42 +50,42 @@
  * @author Gerrit Meier
  * @author Andy Wilkinson
  */
-public abstract class AbstractOperationBlockMacroTests {
+abstract class AbstractOperationBlockMacroTests {
 
-	@Rule
-	public TemporaryFolder temp = new TemporaryFolder();
+	private final Asciidoctor asciidoctor = Asciidoctor.Factory.create();
 
-	private Options options;
+	@TempDir
+	protected File temp;
 
-	private final Asciidoctor asciidoctor = Asciidoctor.Factory.create();
+	private Options options;
 
-	@Before
-	public void setUp() throws IOException {
+	@BeforeEach
+	void setUp() throws IOException {
 		prepareOperationSnippets(getBuildOutputLocation());
 		this.options = Options.builder().safe(SafeMode.UNSAFE).baseDir(getSourceLocation()).build();
 		this.options.setAttributes(getAttributes());
 		CapturingLogHandler.clear();
 	}
 
-	@After
-	public void verifyLogging() {
+	@AfterEach
+	void verifyLogging() {
 		assertThat(CapturingLogHandler.getLogRecords()).isEmpty();
 	}
 
-	public void prepareOperationSnippets(File buildOutputLocation) throws IOException {
+	private void prepareOperationSnippets(File buildOutputLocation) throws IOException {
 		File destination = new File(buildOutputLocation, "generated-snippets/some-operation");
 		destination.mkdirs();
 		FileSystemUtils.copyRecursively(new File("src/test/resources/some-operation"), destination);
 	}
 
 	@Test
-	public void codeBlockSnippetInclude() throws Exception {
+	void codeBlockSnippetInclude() throws Exception {
 		String result = this.asciidoctor.convert("operation::some-operation[snippets='curl-request']", this.options);
 		assertThat(result).isEqualTo(getExpectedContentFromFile("snippet-simple"));
 	}
 
 	@Test
-	public void operationWithParameterizedName() throws Exception {
+	void operationWithParameterizedName() throws Exception {
 		Attributes attributes = getAttributes();
 		attributes.setAttribute("name", "some");
 		this.options.setAttributes(attributes);
@@ -95,78 +94,78 @@ public void operationWithParameterizedName() throws Exception {
 	}
 
 	@Test
-	public void codeBlockSnippetIncludeWithPdfBackend() throws Exception {
+	void codeBlockSnippetIncludeWithPdfBackend() throws Exception {
 		File output = configurePdfOutput();
 		this.asciidoctor.convert("operation::some-operation[snippets='curl-request']", this.options);
 		assertThat(extractStrings(output)).containsExactly("Curl request", "$ curl 'http://localhost:8080/' -i", "1");
 	}
 
 	@Test
-	public void tableSnippetInclude() throws Exception {
+	void tableSnippetInclude() throws Exception {
 		String result = this.asciidoctor.convert("operation::some-operation[snippets='response-fields']", this.options);
 		assertThat(result).isEqualTo(getExpectedContentFromFile("snippet-table"));
 	}
 
 	@Test
-	public void tableSnippetIncludeWithPdfBackend() throws Exception {
+	void tableSnippetIncludeWithPdfBackend() throws Exception {
 		File output = configurePdfOutput();
 		this.asciidoctor.convert("operation::some-operation[snippets='response-fields']", this.options);
 		assertThat(extractStrings(output)).containsExactly("Response fields", "Path", "Type", "Description", "a",
 				"Object", "one", "a.b", "Number", "two", "a.c", "String", "three", "1");
 	}
 
 	@Test
-	public void includeSnippetInSection() throws Exception {
+	void includeSnippetInSection() throws Exception {
 		String result = this.asciidoctor.convert("= A\n:doctype: book\n:sectnums:\n\nAlpha\n\n== B\n\nBravo\n\n"
 				+ "operation::some-operation[snippets='curl-request']\n\n== C\n", this.options);
 		assertThat(result).isEqualTo(getExpectedContentFromFile("snippet-in-section"));
 	}
 
 	@Test
-	public void includeSnippetInSectionWithAbsoluteLevelOffset() throws Exception {
+	void includeSnippetInSectionWithAbsoluteLevelOffset() throws Exception {
 		String result = this.asciidoctor
 			.convert("= A\n:doctype: book\n:sectnums:\n:leveloffset: 1\n\nAlpha\n\n= B\n\nBravo\n\n"
 					+ "operation::some-operation[snippets='curl-request']\n\n= C\n", this.options);
 		assertThat(result).isEqualTo(getExpectedContentFromFile("snippet-in-section"));
 	}
 
 	@Test
-	public void includeSnippetInSectionWithRelativeLevelOffset() throws Exception {
+	void includeSnippetInSectionWithRelativeLevelOffset() throws Exception {
 		String result = this.asciidoctor
 			.convert("= A\n:doctype: book\n:sectnums:\n:leveloffset: +1\n\nAlpha\n\n= B\n\nBravo\n\n"
 					+ "operation::some-operation[snippets='curl-request']\n\n= C\n", this.options);
 		assertThat(result).isEqualTo(getExpectedContentFromFile("snippet-in-section"));
 	}
 
 	@Test
-	public void includeSnippetInSectionWithPdfBackend() throws Exception {
+	void includeSnippetInSectionWithPdfBackend() throws Exception {
 		File output = configurePdfOutput();
 		this.asciidoctor.convert("== Section\n" + "operation::some-operation[snippets='curl-request']", this.options);
 		assertThat(extractStrings(output)).containsExactly("Section", "Curl request",
 				"$ curl 'http://localhost:8080/' -i", "1");
 	}
 
 	@Test
-	public void includeMultipleSnippets() throws Exception {
+	void includeMultipleSnippets() throws Exception {
 		String result = this.asciidoctor.convert("operation::some-operation[snippets='curl-request,http-request']",
 				this.options);
 		assertThat(result).isEqualTo(getExpectedContentFromFile("multiple-snippets"));
 	}
 
 	@Test
-	public void useMacroWithoutSnippetAttributeAddsAllSnippets() throws Exception {
+	void useMacroWithoutSnippetAttributeAddsAllSnippets() throws Exception {
 		String result = this.asciidoctor.convert("operation::some-operation[]", this.options);
 		assertThat(result).isEqualTo(getExpectedContentFromFile("all-snippets"));
 	}
 
 	@Test
-	public void useMacroWithEmptySnippetAttributeAddsAllSnippets() throws Exception {
+	void useMacroWithEmptySnippetAttributeAddsAllSnippets() throws Exception {
 		String result = this.asciidoctor.convert("operation::some-operation[snippets=]", this.options);
 		assertThat(result).isEqualTo(getExpectedContentFromFile("all-snippets"));
 	}
 
 	@Test
-	public void includingMissingSnippetAddsWarning() throws Exception {
+	void includingMissingSnippetAddsWarning() throws Exception {
 		String result = this.asciidoctor.convert("operation::some-operation[snippets='missing-snippet']", this.options);
 		assertThat(result).startsWith(getExpectedContentFromFile("missing-snippet"));
 		assertThat(CapturingLogHandler.getLogRecords()).hasSize(1);
@@ -177,13 +176,13 @@ public void includingMissingSnippetAddsWarning() throws Exception {
 	}
 
 	@Test
-	public void defaultTitleIsProvidedForCustomSnippet() throws Exception {
+	void defaultTitleIsProvidedForCustomSnippet() throws Exception {
 		String result = this.asciidoctor.convert("operation::some-operation[snippets='custom-snippet']", this.options);
 		assertThat(result).isEqualTo(getExpectedContentFromFile("custom-snippet-default-title"));
 	}
 
 	@Test
-	public void missingOperationIsHandledGracefully() throws Exception {
+	void missingOperationIsHandledGracefully() throws Exception {
 		String result = this.asciidoctor.convert("operation::missing-operation[]", this.options);
 		assertThat(result).startsWith(getExpectedContentFromFile("missing-operation"));
 		assertThat(CapturingLogHandler.getLogRecords()).hasSize(1);
@@ -194,14 +193,14 @@ public void missingOperationIsHandledGracefully() throws Exception {
 	}
 
 	@Test
-	public void titleOfBuiltInSnippetCanBeCustomizedUsingDocumentAttribute() throws URISyntaxException, IOException {
+	void titleOfBuiltInSnippetCanBeCustomizedUsingDocumentAttribute() throws URISyntaxException, IOException {
 		String result = this.asciidoctor.convert(":operation-curl-request-title: Example request\n"
 				+ "operation::some-operation[snippets='curl-request']", this.options);
 		assertThat(result).isEqualTo(getExpectedContentFromFile("built-in-snippet-custom-title"));
 	}
 
 	@Test
-	public void titleOfCustomSnippetCanBeCustomizedUsingDocumentAttribute() throws Exception {
+	void titleOfCustomSnippetCanBeCustomizedUsingDocumentAttribute() throws Exception {
 		String result = this.asciidoctor.convert(":operation-custom-snippet-title: Customized title\n"
 				+ "operation::some-operation[snippets='custom-snippet']", this.options);
 		assertThat(result).isEqualTo(getExpectedContentFromFile("custom-snippet-custom-title"));

spring-restdocs-asciidoctor/src/test/java/org/springframework/restdocs/asciidoctor/DefaultAttributesPreprocessorTests.java

@@ -21,7 +21,7 @@
 import org.asciidoctor.Asciidoctor;
 import org.asciidoctor.Attributes;
 import org.asciidoctor.Options;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -30,23 +30,23 @@
  *
  * @author Andy Wilkinson
  */
-public class DefaultAttributesPreprocessorTests {
+class DefaultAttributesPreprocessorTests {
 
 	@Test
-	public void snippetsAttributeIsSet() {
+	void snippetsAttributeIsSet() {
 		String converted = createAsciidoctor().convert("{snippets}", createOptions("projectdir=../../.."));
 		assertThat(converted).contains("build" + File.separatorChar + "generated-snippets");
 	}
 
 	@Test
-	public void snippetsAttributeFromConvertArgumentIsNotOverridden() {
+	void snippetsAttributeFromConvertArgumentIsNotOverridden() {
 		String converted = createAsciidoctor().convert("{snippets}",
 				createOptions("snippets=custom projectdir=../../.."));
 		assertThat(converted).contains("custom");
 	}
 
 	@Test
-	public void snippetsAttributeFromDocumentPreambleIsNotOverridden() {
+	void snippetsAttributeFromDocumentPreambleIsNotOverridden() {
 		String converted = createAsciidoctor().convert(":snippets: custom\n{snippets}",
 				createOptions("projectdir=../../.."));
 		assertThat(converted).contains("custom");

spring-restdocs-asciidoctor/src/test/java/org/springframework/restdocs/asciidoctor/GradleOperationBlockMacroTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2014-2023 the original author or authors.
+ * Copyright 2014-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,47 +19,42 @@
 import java.io.File;
 
 import org.asciidoctor.Attributes;
-import org.junit.runner.RunWith;
-import org.junit.runners.Parameterized;
-import org.junit.runners.Parameterized.Parameters;
+import org.junit.jupiter.params.ParameterizedClass;
+import org.junit.jupiter.params.provider.ValueSource;
 
 /**
  * Tests for Ruby operation block macro when used in a Gradle build.
  *
  * @author Andy Wilkinson
  */
-@RunWith(Parameterized.class)
-public class GradleOperationBlockMacroTests extends AbstractOperationBlockMacroTests {
+@ParameterizedClass
+@ValueSource(strings = { "projectdir", "gradle-projectdir" })
+class GradleOperationBlockMacroTests extends AbstractOperationBlockMacroTests {
 
 	private final String attributeName;
 
-	public GradleOperationBlockMacroTests(String attributeName) {
+	GradleOperationBlockMacroTests(String attributeName) {
 		this.attributeName = attributeName;
 	}
 
-	@Parameters(name = "{0}")
-	public static Object[] parameters() {
-		return new Object[] { "projectdir", "gradle-projectdir" };
-	}
-
 	@Override
 	protected Attributes getAttributes() {
 		Attributes attributes = Attributes.builder()
-			.attribute(this.attributeName, new File(this.temp.getRoot(), "gradle-project").getAbsolutePath())
+			.attribute(this.attributeName, new File(this.temp, "gradle-project").getAbsolutePath())
 			.build();
 		return attributes;
 	}
 
 	@Override
 	protected File getBuildOutputLocation() {
-		File outputLocation = new File(this.temp.getRoot(), "gradle-project/build");
+		File outputLocation = new File(this.temp, "gradle-project/build");
 		outputLocation.mkdirs();
 		return outputLocation;
 	}
 
 	@Override
 	protected File getSourceLocation() {
-		File sourceLocation = new File(this.temp.getRoot(), "gradle-project/src/docs/asciidoc");
+		File sourceLocation = new File(this.temp, "gradle-project/src/docs/asciidoc");
 		if (!sourceLocation.exists()) {
 			sourceLocation.mkdirs();
 		}

spring-restdocs-asciidoctor/src/test/java/org/springframework/restdocs/asciidoctor/MavenOperationBlockMacroTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2014-2021 the original author or authors.
+ * Copyright 2014-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,23 +20,23 @@
 import java.io.IOException;
 
 import org.asciidoctor.Attributes;
-import org.junit.After;
-import org.junit.Before;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
 
 /**
  * Tests for Ruby operation block macro when used in a Maven build.
  *
  * @author Andy Wilkinson
  */
-public class MavenOperationBlockMacroTests extends AbstractOperationBlockMacroTests {
+class MavenOperationBlockMacroTests extends AbstractOperationBlockMacroTests {
 
-	@Before
-	public void setMavenHome() {
+	@BeforeEach
+	void setMavenHome() {
 		System.setProperty("maven.home", "maven-home");
 	}
 
-	@After
-	public void clearMavenHome() {
+	@AfterEach
+	void clearMavenHome() {
 		System.clearProperty("maven.home");
 	}
 
@@ -55,14 +55,14 @@ protected Attributes getAttributes() {
 
 	@Override
 	protected File getBuildOutputLocation() {
-		File outputLocation = new File(this.temp.getRoot(), "maven-project/target");
+		File outputLocation = new File(this.temp, "maven-project/target");
 		outputLocation.mkdirs();
 		return outputLocation;
 	}
 
 	@Override
 	protected File getSourceLocation() {
-		File sourceLocation = new File(this.temp.getRoot(), "maven-project/src/main/asciidoc");
+		File sourceLocation = new File(this.temp, "maven-project/src/main/asciidoc");
 		if (!sourceLocation.exists()) {
 			sourceLocation.mkdirs();
 		}