Optionally ban JUnit 4 imports by daniel-beck · Pull Request #1178 · jenkinsci/plugin-pom

daniel-beck · 2025-08-13T13:50:02Z

This PR adds a new property ban-junit4-imports.skip. Similar to spotless.check.skip before it, it is true by default. If overridden, an enforcer rule banning org.junit.* imports, but allowing org.junit.jupiter.* imports, is run.

It's motivated by PRs like jenkinsci/matrix-auth-plugin#175 or jenkinsci/csp-plugin#48 that look far too easy to regress. Going via parent POM seems like the logical choice.

Feedback welcome. If this looks acceptable in principle, I'll look into where best to document this, as well as adding tests.

Testing done

Installed a snapshot locally, then:

Fails on matrix-auth-plugin:master if skip = false.
Passes on matrix-auth-plugin:master if skip = true (default)
Passes on Migrate tests to JUnit5 matrix-auth-plugin#175 with either skip value.

Failure error message output

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-enforcer-plugin:3.6.1:enforce (check-junit-imports) on project matrix-auth: 
[ERROR] Rule 0: org.apache.maven.plugins.enforcer.RestrictImports failed with message:
[ERROR] 
[ERROR] Banned imports detected in TEST code:
[ERROR] 
[ERROR] Reason: Use JUnit 5 (org.junit.jupiter.*)
[ERROR]         in file:///Users/danielbeck/Repositories/github.com/daniel-beck/matrix-auth-plugin/src/test/java/com/cloudbees/hudson/plugins/folder/properties/AuthorizationMatrixPropertyTest.java
[ERROR]                 static org.junit.Assert.*               (Line: 27, Matched by: org.junit.**)
[ERROR]                 org.junit.Assert                        (Line: 47, Matched by: org.junit.**)
[ERROR]                 org.junit.Rule                          (Line: 48, Matched by: org.junit.**)
[ERROR]                 org.junit.Test                          (Line: 49, Matched by: org.junit.**)
[ERROR]         in file:///Users/danielbeck/Repositories/github.com/daniel-beck/matrix-auth-plugin/src/test/java/com/cloudbees/hudson/plugins/folder/properties/IdStrategyTest.java
[ERROR]                 static org.junit.Assert.assertEquals    (Line: 3, Matched by: org.junit.**)
[ERROR]                 static org.junit.Assert.fail            (Line: 4, Matched by: org.junit.**)
[ERROR]                 org.junit.Rule                          (Line: 13, Matched by: org.junit.**)
[ERROR]                 org.junit.Test                          (Line: 14, Matched by: org.junit.**)
[ERROR]         in file:///Users/danielbeck/Repositories/github.com/daniel-beck/matrix-auth-plugin/src/test/java/hudson/security/AuthorizationMatrixPropertyTest.java
[ERROR]                 org.junit.Assert                        (Line: 16, Matched by: org.junit.**)
[ERROR]                 org.junit.Rule                          (Line: 17, Matched by: org.junit.**)
[ERROR]                 org.junit.Test                          (Line: 18, Matched by: org.junit.**)
[ERROR]         in file:///Users/danielbeck/Repositories/github.com/daniel-beck/matrix-auth-plugin/src/test/java/hudson/security/ProjectMatrixAuthorizationStrategyTest.java
[ERROR]                 org.junit.Assert                        (Line: 25, Matched by: org.junit.**)
[ERROR]                 org.junit.Rule                          (Line: 26, Matched by: org.junit.**)
[ERROR]                 org.junit.Test                          (Line: 27, Matched by: org.junit.**)
[ERROR]         in file:///Users/danielbeck/Repositories/github.com/daniel-beck/matrix-auth-plugin/src/test/java/hudson/security/Security410Test.java
[ERROR]                 static org.junit.Assert.assertFalse     (Line: 3, Matched by: org.junit.**)
[ERROR]                 org.junit.Rule                          (Line: 7, Matched by: org.junit.**)
[ERROR]                 org.junit.Test                          (Line: 8, Matched by: org.junit.**)
[ERROR]         in file:///Users/danielbeck/Repositories/github.com/daniel-beck/matrix-auth-plugin/src/test/java/org/jenkinsci/plugins/matrixauth/AmbiguityTest.java
[ERROR]                 static org.junit.Assert.assertEquals    (Line: 3, Matched by: org.junit.**)
[ERROR]                 static org.junit.Assert.assertFalse     (Line: 4, Matched by: org.junit.**)
[ERROR]                 static org.junit.Assert.assertNotNull   (Line: 5, Matched by: org.junit.**)
[ERROR]                 static org.junit.Assert.assertThrows    (Line: 6, Matched by: org.junit.**)
[ERROR]                 static org.junit.Assert.assertTrue      (Line: 7, Matched by: org.junit.**)
[ERROR]                 org.junit.Rule                          (Line: 29, Matched by: org.junit.**)
[ERROR]                 org.junit.Test                          (Line: 30, Matched by: org.junit.**)
[ERROR]         in file:///Users/danielbeck/Repositories/github.com/daniel-beck/matrix-auth-plugin/src/test/java/org/jenkinsci/plugins/matrixauth/AuthorizationContainerDescriptorTest.java
[ERROR]                 org.junit.Assert                        (Line: 9, Matched by: org.junit.**)
[ERROR]                 org.junit.Test                          (Line: 10, Matched by: org.junit.**)
[ERROR]         in file:///Users/danielbeck/Repositories/github.com/daniel-beck/matrix-auth-plugin/src/test/java/org/jenkinsci/plugins/matrixauth/AuthorizationMatrixNodePropertyTest.java
[ERROR]                 org.junit.Assert                        (Line: 37, Matched by: org.junit.**)
[ERROR]                 org.junit.Rule                          (Line: 38, Matched by: org.junit.**)
[ERROR]                 org.junit.Test                          (Line: 39, Matched by: org.junit.**)
[ERROR]         in file:///Users/danielbeck/Repositories/github.com/daniel-beck/matrix-auth-plugin/src/test/java/org/jenkinsci/plugins/matrixauth/Jenkins57313Test.java
[ERROR]                 org.junit.Assert                        (Line: 6, Matched by: org.junit.**)
[ERROR]                 org.junit.Rule                          (Line: 7, Matched by: org.junit.**)
[ERROR]                 org.junit.Test                          (Line: 8, Matched by: org.junit.**)
[ERROR]         in file:///Users/danielbeck/Repositories/github.com/daniel-beck/matrix-auth-plugin/src/test/java/org/jenkinsci/plugins/matrixauth/PermissionAdderTest.java
[ERROR]                 org.junit.Assert                        (Line: 11, Matched by: org.junit.**)
[ERROR]                 org.junit.Rule                          (Line: 12, Matched by: org.junit.**)
[ERROR]                 org.junit.Test                          (Line: 13, Matched by: org.junit.**)
[ERROR]         in file:///Users/danielbeck/Repositories/github.com/daniel-beck/matrix-auth-plugin/src/test/java/org/jenkinsci/plugins/matrixauth/ReadOnlyTest.java
[ERROR]                 org.junit.Assert                        (Line: 16, Matched by: org.junit.**)
[ERROR]                 org.junit.Before                        (Line: 17, Matched by: org.junit.**)
[ERROR]                 org.junit.Rule                          (Line: 18, Matched by: org.junit.**)
[ERROR]                 org.junit.Test                          (Line: 19, Matched by: org.junit.**)
[ERROR]         in file:///Users/danielbeck/Repositories/github.com/daniel-beck/matrix-auth-plugin/src/test/java/org/jenkinsci/plugins/matrixauth/Security2180Test.java
[ERROR]                 static org.junit.Assert.assertFalse     (Line: 6, Matched by: org.junit.**)
[ERROR]                 static org.junit.Assert.assertNotNull   (Line: 7, Matched by: org.junit.**)
[ERROR]                 static org.junit.Assert.assertTrue      (Line: 8, Matched by: org.junit.**)
[ERROR]                 org.junit.After                         (Line: 36, Matched by: org.junit.**)
[ERROR]                 org.junit.Assert                        (Line: 37, Matched by: org.junit.**)
[ERROR]                 org.junit.ClassRule                     (Line: 38, Matched by: org.junit.**)
[ERROR]                 org.junit.Rule                          (Line: 39, Matched by: org.junit.**)
[ERROR]                 org.junit.Test                          (Line: 40, Matched by: org.junit.**)
[ERROR]         in file:///Users/danielbeck/Repositories/github.com/daniel-beck/matrix-auth-plugin/src/test/java/org/jenkinsci/plugins/matrixauth/inheritance/InheritanceMigrationTest.java
[ERROR]                 org.junit.Assert                        (Line: 14, Matched by: org.junit.**)
[ERROR]                 org.junit.Rule                          (Line: 15, Matched by: org.junit.**)
[ERROR]                 org.junit.Test                          (Line: 16, Matched by: org.junit.**)
[ERROR]         in file:///Users/danielbeck/Repositories/github.com/daniel-beck/matrix-auth-plugin/src/test/java/org/jenkinsci/plugins/matrixauth/integrations/casc/ExportTest.java
[ERROR]                 static org.junit.Assert.assertEquals    (Line: 5, Matched by: org.junit.**)
[ERROR]                 static org.junit.Assert.assertNotNull   (Line: 6, Matched by: org.junit.**)
[ERROR]                 org.junit.Rule                          (Line: 16, Matched by: org.junit.**)
[ERROR]                 org.junit.Test                          (Line: 17, Matched by: org.junit.**)
[ERROR]         in file:///Users/danielbeck/Repositories/github.com/daniel-beck/matrix-auth-plugin/src/test/java/org/jenkinsci/plugins/matrixauth/integrations/casc/ImportTest.java
[ERROR]                 static org.junit.Assert.assertEquals    (Line: 5, Matched by: org.junit.**)
[ERROR]                 static org.junit.Assert.assertFalse     (Line: 6, Matched by: org.junit.**)
[ERROR]                 static org.junit.Assert.assertNotNull   (Line: 7, Matched by: org.junit.**)
[ERROR]                 static org.junit.Assert.assertTrue      (Line: 8, Matched by: org.junit.**)
[ERROR]                 org.junit.Rule                          (Line: 29, Matched by: org.junit.**)
[ERROR]                 org.junit.Test                          (Line: 30, Matched by: org.junit.**)
[ERROR] 
[ERROR] Analysis of 47 files took less than 1 second

Submitter checklist

Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
Ensure that the pull request title represents the desired changelog entry
Please describe what you did
Link to relevant issues in GitHub or Jira
Link to relevant pull requests, esp. upstream and downstream changes
Ensure you have provided tests that demonstrate the feature works or the issue is fixed

daniel-beck · 2025-08-13T14:07:08Z

Perhaps something similar could be done for commons-lang? That would have identified jenkinsci/git-plugin#1789 (comment).

timja

makes sense

daniel-beck · 2025-08-14T16:43:36Z

@timja Any suggestions or preferences for naming before we lock this in forever?

timja · 2025-08-14T17:16:55Z

Name looks good

daniel-beck · 2025-08-15T08:20:39Z

FTR I have no intention of doing any sort of larger-scale migration or other followup for this. This is just intended as an additional safeguard for changes like the ones I pointed out in the PR comment (and IMO is almost a prerequisite to accepting them).

timja · 2025-08-15T08:21:48Z

fyi @strangelookingnerd

strangelookingnerd · 2025-08-15T08:55:58Z

FTR I have no intention of doing any sort of larger-scale migration or other followup for this. This is just intended as an additional safeguard for changes like the ones I pointed out in the PR comment (and IMO is almost a prerequisite to accepting them).

Thanks for doing this 👍🏼
I'll look into adding the flag to plugins I have migrated in the past and also include it in future migrations.

strangelookingnerd · 2025-08-15T11:08:25Z

@daniel-beck FYI, causes: https://github.com/jenkinsci/generic-webhook-trigger-plugin/pull/369/checks?check_run_id=48162665919

Banned imports detected in TEST code:
 
 Reason: Use JUnit 5 (org.junit.jupiter.*)
	in file:///home/jenkins/agent/workspace/ic-webhook-trigger-plugin_PR-369/src/test/java/org/jenkinsci/plugins/gwt/bdd/RunTest.java
		org.junit.platform.suite.api.IncludeEngines          	(Line: 3, Matched by: org.junit.**)
 		org.junit.platform.suite.api.SelectClasspathResource 	(Line: 4, Matched by: org.junit.**)
 		org.junit.platform.suite.api.Suite                   	(Line: 5, Matched by: org.junit.**)

I'll create a follow-up to fix it if you don't mind.

Ban JUnit 4 imports To prevent regressions when adding new tests, jenkinsci/plugin-pom#1178 introduced a new flag that enables a Maven Enforcer rule banning org.junit.* imports while allowing org.junit.jupiter.*. With this change, the build will fail if any org.junit.* imports are introduced.

Optionally ban JUnit 4 imports

260826a

timja approved these changes Aug 13, 2025

View reviewed changes

daniel-beck added 2 commits August 15, 2025 10:09

Add tests

3d7cb1c

Add documentation

1f2fe33

daniel-beck marked this pull request as ready for review August 15, 2025 08:16

timja reviewed Aug 15, 2025

View reviewed changes

Comment thread src/it/ban-juni4-pass/postbuild.groovy

Fix typo in file path

ae29578

timja added the enhancement label Aug 15, 2025

timja approved these changes Aug 15, 2025

View reviewed changes

timja reviewed Aug 15, 2025

View reviewed changes

Comment thread src/it/ban-juni4-fail/src/test/java/banjunit4/BanJUnit4FailTest.java

daniel-beck added 2 commits August 15, 2025 10:34

Fix another typo in file path

a1fef44

Grammar

57ab9f3

timja approved these changes Aug 15, 2025

View reviewed changes

timja merged commit 782f303 into jenkinsci:master Aug 15, 2025
2 checks passed

This was referenced Aug 15, 2025

Ban JUnit 4 imports jenkinsci/slack-plugin#1079

Merged

Ban JUnit 4 imports jenkinsci/generic-webhook-trigger-plugin#369

Merged

Ban JUnit 4 imports jenkinsci/dingtalk-plugin#356

Merged

strangelookingnerd mentioned this pull request Feb 9, 2026

Ban JUnit 4 imports jenkinsci/publish-over-cifs-plugin#161

Merged

6 tasks

This was referenced Feb 23, 2026

Ban JUnit 4 imports jenkinsci/entra-oauth-plugin#2

Merged

Ban JUnit 4 imports jenkinsci/update-sites-manager-plugin#70

Merged

Ban JUnit 4 imports jenkinsci/vectorcast-execution-plugin#166

Closed

lalohdzhdz07-blip approved these changes Feb 24, 2026

View reviewed changes

This was referenced Mar 3, 2026

Ban JUnit 4 imports jenkinsci/plain-credentials-plugin#103

Merged

Ban JUnit 4 imports jenkinsci/next-build-number-plugin#54

Merged

Ban JUnit 4 imports jenkinsci/ompass-2fa-plugin#2

Merged

This was referenced Mar 11, 2026

Ban JUnit 4 imports jenkinsci/vsphere-cloud-plugin#166

Merged

Ban JUnit 4 imports jenkinsci/aws-global-configuration-plugin#126

Merged

darinpope mentioned this pull request Mar 23, 2026

Ban JUnit 4 imports jenkinsci/chucknorris-plugin#243

Merged

6 tasks

This was referenced Mar 23, 2026

Ban JUnit 4 imports jenkinsci/build-blocker-plugin#45

Merged

Ban JUnit 4 imports jenkinsci/negotiatesso-plugin#89

Merged

berviantoleo mentioned this pull request Apr 18, 2026

fix: add ban junit4 imports skip jenkinsci/resources-ai-chatbot-plugin#354

Merged

6 tasks

This was referenced May 4, 2026

Ban JUnit 4 imports jenkinsci/lucene-search-plugin#84

Merged

Ban JUnit 4 imports jenkinsci/report-generic-chart-column-plugin#8

Closed

strangelookingnerd mentioned this pull request May 18, 2026

Ban JUnit 4 imports jenkinsci/sonar-gerrit-plugin#279

Merged

6 tasks

This was referenced Jun 1, 2026

Ban JUnit 4 imports jenkinsci/auditflow-plugin#3

Merged

Ban JUnit 4 imports jenkinsci/artifactdeployer-plugin#105

Merged

This was referenced Jun 10, 2026

Ban JUnit 4 imports jenkinsci/artifact-image-preview-plugin#7

Merged

Ban JUnit 4 imports jenkinsci/holistic-plugin#2

Merged

strangelookingnerd mentioned this pull request Jun 25, 2026

Ban JUnit 4 imports jenkinsci/multibranch-build-strategy-extension-plugin#99

Merged

6 tasks

strangelookingnerd mentioned this pull request Aug 4, 2026

Ban JUnit 4 imports jenkinsci/publish-over-ssh-plugin#430

Merged

6 tasks

strangelookingnerd mentioned this pull request Aug 11, 2026

Ban JUnit 4 imports jenkinsci/kubernetes-credentials-provider-plugin#145

Merged

6 tasks

Navigation Menu

Uh oh!

Uh oh!

Optionally ban JUnit 4 imports - #1178

Optionally ban JUnit 4 imports#1178
timja merged 6 commits into
jenkinsci:masterfrom
daniel-beck:optionally-ban-junit4-imports

daniel-beck commented Aug 13, 2025 •

edited

Loading

Uh oh!

daniel-beck commented Aug 13, 2025

Uh oh!

timja left a comment

Uh oh!

daniel-beck commented Aug 14, 2025

Uh oh!

timja commented Aug 14, 2025

Uh oh!

Uh oh!

daniel-beck commented Aug 15, 2025

Uh oh!

timja commented Aug 15, 2025

Uh oh!

Uh oh!

strangelookingnerd commented Aug 15, 2025

Uh oh!

Uh oh!

strangelookingnerd commented Aug 15, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Uh oh!

Uh oh!

Conversation

daniel-beck commented Aug 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Testing done

Submitter checklist

Uh oh!

daniel-beck commented Aug 13, 2025

Uh oh!

timja left a comment

Choose a reason for hiding this comment

Uh oh!

daniel-beck commented Aug 14, 2025

Uh oh!

timja commented Aug 14, 2025

Uh oh!

Uh oh!

daniel-beck commented Aug 15, 2025

Uh oh!

timja commented Aug 15, 2025

Uh oh!

Uh oh!

strangelookingnerd commented Aug 15, 2025

Uh oh!

Uh oh!

strangelookingnerd commented Aug 15, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

daniel-beck commented Aug 13, 2025 •

edited

Loading