Replace junit-dataprovider with junit-jupiter-params by hankem · Pull Request #1655 · TNG/ArchUnit

hankem · 2026-07-06T12:31:08Z

Resolves #1471

…nit-dataprovider dependency Signed-off-by: Manfred Hanke <Manfred.Hanke@tngtech.com>

…Value}Source Note that > By default, `@CsvSource` uses a single quote (') as its quote character [...] > An empty, quoted value ('') results in an empty String [...] > whereas an entirely empty value is interpreted as a null reference. [https://junit.org/junit5/docs/current/api/org.junit.jupiter.params/org/junit/jupiter/params/provider/CsvSource.html] Signed-off-by: Manfred Hanke <Manfred.Hanke@tngtech.com>

…dSource For convenience (and to keep the diff smaller) `com.tngtech.archunit.testutil.DataProviders.$` provides the same API for `junit-jupiter-params` as `com.tngtech.java.junit.dataprovider.DataProviders.$` did for `junit-dataprovider`. Signed-off-by: Manfred Hanke <Manfred.Hanke@tngtech.com>

…it-jupiter-params Signed-off-by: Manfred Hanke <Manfred.Hanke@tngtech.com>

…unit-jupiter-params Signed-off-by: Manfred Hanke <Manfred.Hanke@tngtech.com>

replacing the JUnit 4 `@Rule`s with JUnit Jupiter extensions, and also converting some other tests that made use of the same `TestRule`s to JUnit 5 to eliminate these custom `TestRule`s already Signed-off-by: Manfred Hanke <manfred.hanke@tngtech.com>

Signed-off-by: Manfred Hanke <manfred.hanke@tngtech.com>

…piter-params Signed-off-by: Manfred Hanke <manfred.hanke@tngtech.com>

Signed-off-by: Manfred Hanke <Manfred.Hanke@tngtech.com>

Signed-off-by: Stefan Gräber <stefan.graeber@tngtech.com>

StefanGraeber · 2026-07-10T12:14:33Z

-    @Test
-    @DataProvider(splitBy = "\\|", value = {
+    @ParameterizedTest
+    @CsvSource(delimiter = '|', value = {


I find this really hard to read.
I pushed you a commit on top of the chain which migrates this to a MethodSource

StefanGraeber · 2026-07-10T12:18:34Z

-        return $$(
+    static Stream<Arguments> be_records() {
+        return Stream.of(
                $(classes().should().beRecords(), SomeRecord.class, String.class),


let's get rid of the $ syntax and switch to standard junit 5 methods.
You already made this an alias for Arguments.of which is an alias for Arguments.arguments which is realy nice to read with a static import.
The is also Arguments.argumentSet which has an additional parameter in the front which is used as name of the text.
Since I'm a big fan of the latter one, I would use it in all places which benefit from a custom test name (I haven't spotted one currently using a custom test name)
I pushed you a commit which replaces the $ method with arguments.
If you like it, keep or squash it into yours, otherwise you can also drop it (and please tell me what and why you dislike)

StefanGraeber · 2026-07-10T12:52:27Z

-    public static Object[][] ORed_conditions() {
-        return $$(
-                $(classes()
+    static Stream<ArchRule> ORed_conditions() {


was it intentional to no wrap into Arguments?
I didn't know that that wrapping is optional and always used it so far

StefanGraeber · 2026-07-10T12:59:02Z

-        List<Object[]> includeMainFolderInput = new ArrayList<>();
-        List<Object[]> includeTestFolderInput = new ArrayList<>();
+    static Stream<Arguments> test_location_predicates_and_expected_folder_patterns() {
+        Set<Arguments> includeMainFolderInput = new HashSet<>();


using any object in a Set requires proper implementations of hashCode and equals.
since Arguments is implemented as functional interface, I think it has just the default implementation of it.
I think it is safer to stay with List<Arguments>. this also gives a deterministic test case order, which I consider desirable (we also had it before)

StefanGraeber · 2026-07-10T13:04:20Z

-    @Rule
-    public final ArchConfigurationRule configurationRule = new ArchConfigurationRule();
+    @RegisterExtension
+    ArchConfigurationExtension archConfiguration = new ArchConfigurationExtension();


optional: include in the commit message the migration ArchConfigurationRule -> ArchConfigurationExtension
I know that it must be done because of junit4 ->junit5 but I think it wouldn't hurt to make it explicit

you even created that Extension in this commit! 🙂
I think that's worth a mention

StefanGraeber · 2026-07-10T13:14:12Z

 import org.junit.rules.ExternalResource;

+/**
+ * @deprecated use JUnit 5 and {@link ArchConfigurationExtension} instead


Is it feasible to entirely remove this Rule?
I might give it a try later, there seem to be only 25 tests left

StefanGraeber · 2026-07-10T13:15:48Z

-    public final OutsideOfClassPathRule outsideOfClassPathRule = new OutsideOfClassPathRule();
-    @Rule
-    public final ContextClassLoaderRule contextClassLoaderRule = new ContextClassLoaderRule();
+    @RegisterExtension


2 of these extensions are never accessed as fields in this class (and all are created with default constructor).
any reason why they are not used via @RegisterExtension({ArchConfigurationExtension.class, ContextClassLoaderExtension.class})?

StefanGraeber · 2026-07-10T13:19:08Z

@@ -56,7 +56,7 @@ public void locations_of_packages_within_JAR_URIs() throws Exception {
        Set<Location> locations = Locations.ofPackage("org.junit");


if you replace this string by org.junit.jupiter.api you can replace org.junit.Test.class by Test.class
I see no reason to use the junit4 variant of it.
let's break that dependency (there are 3 more usages in this class of the class literal)

StefanGraeber · 2026-07-10T13:21:08Z

+import org.junit.jupiter.api.extension.AfterEachCallback;
+import org.junit.jupiter.api.extension.ExtensionContext;
+
+public class ContextClassLoaderExtension implements BeforeEachCallback, AfterEachCallback {


please deprecate ContextClassLoaderRule

StefanGraeber · 2026-07-10T13:21:44Z

+import org.junit.jupiter.api.extension.AfterEachCallback;
+import org.junit.jupiter.api.extension.ExtensionContext;
+
+public class SystemPropertiesExtension implements BeforeEachCallback, AfterEachCallback {


please deprecate SystemPropertiesRule

hankem added 9 commits July 6, 2026 14:29

remove unused @RunWith(DataProviderRunner.class) annotations and ju…

3efd958

…nit-dataprovider dependency Signed-off-by: Manfred Hanke <Manfred.Hanke@tngtech.com>

migrate junit-dataprovider tests involving TemporaryFolderRule to jun…

01dd6fb

…it-jupiter-params Signed-off-by: Manfred Hanke <Manfred.Hanke@tngtech.com>

migrate junit-dataprovider tests involving ArchConfigurationRule to j…

5776f10

…unit-jupiter-params Signed-off-by: Manfred Hanke <Manfred.Hanke@tngtech.com>

migrate archunit-junit's junit-dataprovider test to junit-jupiter-params

7107625

Signed-off-by: Manfred Hanke <manfred.hanke@tngtech.com>

migrate archunit-3rd-party-test's junit-dataprovider test to junit-ju…

476544c

…piter-params Signed-off-by: Manfred Hanke <manfred.hanke@tngtech.com>

remove junit-dataprovider dependency

175e286

Signed-off-by: Manfred Hanke <Manfred.Hanke@tngtech.com>

hankem mentioned this pull request Jul 6, 2026

Replace junit-dataprovider with junit-jupiter-params #1653

Merged

StefanGraeber added 2 commits July 10, 2026 14:12

migrate ViolationLineMatcherFactoryTest to MethodSource

d6545f0

Signed-off-by: Stefan Gräber <stefan.graeber@tngtech.com>

replace DataProviders.$ with Arguments.arguments

316e946

Signed-off-by: Stefan Gräber <stefan.graeber@tngtech.com>

StefanGraeber requested changes Jul 10, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Replace junit-dataprovider with junit-jupiter-params#1655

Replace junit-dataprovider with junit-jupiter-params#1655
hankem wants to merge 11 commits into
mainfrom
replace-junit-dataprovider

hankem commented Jul 6, 2026

Uh oh!

StefanGraeber Jul 10, 2026

Uh oh!

StefanGraeber Jul 10, 2026

Uh oh!

StefanGraeber Jul 10, 2026

Uh oh!

StefanGraeber Jul 10, 2026

Uh oh!

StefanGraeber Jul 10, 2026

Uh oh!

StefanGraeber Jul 10, 2026

Uh oh!

StefanGraeber Jul 10, 2026

Uh oh!

StefanGraeber Jul 10, 2026

Uh oh!

StefanGraeber Jul 10, 2026

Uh oh!

StefanGraeber Jul 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		@@ -56,7 +56,7 @@ public void locations_of_packages_within_JAR_URIs() throws Exception {
		Set<Location> locations = Locations.ofPackage("org.junit");

Uh oh!

Conversation

hankem commented Jul 6, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants