junit-vintage-engine:5.8.0 requires junit:junit:{strictly 4.13.2} #2722

wilkinsona · 2021-09-17T14:01:40Z

Building a project with JUnit 5.8.0 and Jackson 2.12.5 can result in a build failure due to junit-vintage-engine-5.8.0 strictly requiring junit:junit:4.13.2. Jackson 2.12.5's bom manages the version as 4.13.1. I suspect this dependency management should not be present in Jackson's bom and have opened FasterXML/jackson-bom#43, but it's been there for quite some time and this problem only appeared when upgrading to JUnit 5.8.0 from 5.7.

Here's a build scan from building Spring Boot where I originally discovered the problem: https://ge.spring.io/s/xwscy4qijm2w6/failure#1.

Steps to reproduce

Here's a much simpler build that should reproduce the problem using Gradle 6.9.1:

plugins {
	id 'java'
}

repositories {
	mavenCentral()
}

dependencies {
	implementation(enforcedPlatform('com.fasterxml.jackson:jackson-bom:2.12.5'))
	implementation('com.fasterxml.jackson.core:jackson-databind')
	testImplementation('org.junit.vintage:junit-vintage-engine:5.8.0')
}

 ./gradlew dependencyInsight --dependency junit:junit --configuration testCompileClasspath

> Task :dependencyInsight
junit:junit:4.13.1 FAILED
   Selection reasons:
      - By constraint
      - Forced
   Failures:
      - Could not resolve junit:junit:4.13.1.
          - Cannot find a version of 'junit:junit' that satisfies the version constraints:
               Dependency path ':jackson-bom-junit-5.8-problem:unspecified' --> 'org.junit.vintage:junit-vintage-engine:5.8.0' --> 'junit:junit:{strictly 4.13.2}'
               Constraint path ':jackson-bom-junit-5.8-problem:unspecified' --> 'com.fasterxml.jackson:jackson-bom:2.12.5' --> 'junit:junit:4.13.1'
               Constraint path ':jackson-bom-junit-5.8-problem:unspecified' --> 'com.fasterxml.jackson.core:jackson-databind:2.12.5' --> 'com.fasterxml.jackson:jackson-bom:2.12.5' --> 'junit:junit:4.13.1'

junit:junit:4.13.1 FAILED
\--- com.fasterxml.jackson:jackson-bom:2.12.5
     +--- testCompileClasspath
     +--- com.fasterxml.jackson.core:jackson-databind:2.12.5
     |    +--- testCompileClasspath (requested com.fasterxml.jackson.core:jackson-databind)
     |    \--- com.fasterxml.jackson:jackson-bom:2.12.5 (*)
     +--- com.fasterxml.jackson.core:jackson-annotations:2.12.5
     |    +--- com.fasterxml.jackson.core:jackson-databind:2.12.5 (*)
     |    \--- com.fasterxml.jackson:jackson-bom:2.12.5 (*)
     \--- com.fasterxml.jackson.core:jackson-core:2.12.5
          +--- com.fasterxml.jackson.core:jackson-databind:2.12.5 (*)
          \--- com.fasterxml.jackson:jackson-bom:2.12.5 (*)

junit:junit:4.13.2 FAILED
   Failures:
      - Could not resolve junit:junit:{strictly 4.13.2}. (already reported)

junit:junit:{strictly 4.13.2} -> 4.13.2 FAILED
\--- org.junit.vintage:junit-vintage-engine:5.8.0
     +--- testCompileClasspath
     \--- org.junit:junit-bom:5.8.0
          +--- org.junit.platform:junit-platform-engine:1.8.0
          |    +--- org.junit:junit-bom:5.8.0 (*)
          |    \--- org.junit.vintage:junit-vintage-engine:5.8.0 (*)
          +--- org.junit.platform:junit-platform-commons:1.8.0
          |    +--- org.junit.platform:junit-platform-engine:1.8.0 (*)
          |    \--- org.junit:junit-bom:5.8.0 (*)
          \--- org.junit.vintage:junit-vintage-engine:5.8.0 (*)

org.junit:junit-bom:5.8.0
   variant "apiElements" [
      org.gradle.category            = platform
      org.gradle.usage               = java-api
      org.gradle.status              = release (not requested)

      Requested attributes not found in the selected variant:
         org.gradle.dependency.bundling = external
         org.gradle.libraryelements     = classes
         org.gradle.jvm.version         = 11
   ]

org.junit:junit-bom:5.8.0
+--- org.junit.platform:junit-platform-commons:1.8.0
|    +--- org.junit.platform:junit-platform-engine:1.8.0
|    |    +--- org.junit:junit-bom:5.8.0 (*)
|    |    \--- org.junit.vintage:junit-vintage-engine:5.8.0
|    |         +--- testCompileClasspath
|    |         \--- org.junit:junit-bom:5.8.0 (*)
|    \--- org.junit:junit-bom:5.8.0 (*)
+--- org.junit.platform:junit-platform-engine:1.8.0 (*)
\--- org.junit.vintage:junit-vintage-engine:5.8.0 (*)

(*) - dependencies omitted (listed previously)

A web-based, searchable dependency report is available by adding the --scan option.

BUILD SUCCESSFUL in 513ms
1 actionable task: 1 executed

If you downgrade junit-vintage-engine to 5.7.2 the problem does not occur:

./gradlew dependencyInsight --dependency junit:junit --configuration testCompileClasspath

> Task :dependencyInsight
junit:junit:4.13.1
   variant "compile" [
      org.gradle.status              = release (not requested)
      org.gradle.usage               = java-api
      org.gradle.libraryelements     = jar (compatible with: classes)
      org.gradle.category            = library

      Requested attributes not found in the selected variant:
         org.gradle.dependency.bundling = external
         org.gradle.jvm.version         = 11
   ]
   Selection reasons:
      - By constraint
      - Forced

junit:junit:4.13.1
\--- com.fasterxml.jackson:jackson-bom:2.12.5
     +--- testCompileClasspath
     +--- com.fasterxml.jackson.core:jackson-databind:2.12.5
     |    +--- testCompileClasspath (requested com.fasterxml.jackson.core:jackson-databind)
     |    \--- com.fasterxml.jackson:jackson-bom:2.12.5 (*)
     +--- com.fasterxml.jackson.core:jackson-annotations:2.12.5
     |    +--- com.fasterxml.jackson.core:jackson-databind:2.12.5 (*)
     |    \--- com.fasterxml.jackson:jackson-bom:2.12.5 (*)
     \--- com.fasterxml.jackson.core:jackson-core:2.12.5
          +--- com.fasterxml.jackson.core:jackson-databind:2.12.5 (*)
          \--- com.fasterxml.jackson:jackson-bom:2.12.5 (*)

junit:junit:4.13 -> 4.13.1
\--- org.junit.vintage:junit-vintage-engine:5.7.2
     +--- testCompileClasspath
     \--- org.junit:junit-bom:5.7.2
          +--- org.junit.platform:junit-platform-engine:1.7.2
          |    +--- org.junit:junit-bom:5.7.2 (*)
          |    \--- org.junit.vintage:junit-vintage-engine:5.7.2 (*)
          +--- org.junit.platform:junit-platform-commons:1.7.2
          |    +--- org.junit.platform:junit-platform-engine:1.7.2 (*)
          |    \--- org.junit:junit-bom:5.7.2 (*)
          \--- org.junit.vintage:junit-vintage-engine:5.7.2 (*)

org.junit:junit-bom:5.7.2
   variant "apiElements" [
      org.gradle.category            = platform
      org.gradle.usage               = java-api
      org.gradle.status              = release (not requested)

      Requested attributes not found in the selected variant:
         org.gradle.dependency.bundling = external
         org.gradle.libraryelements     = classes
         org.gradle.jvm.version         = 11
   ]

org.junit:junit-bom:5.7.2
+--- org.junit.platform:junit-platform-commons:1.7.2
|    +--- org.junit.platform:junit-platform-engine:1.7.2
|    |    +--- org.junit:junit-bom:5.7.2 (*)
|    |    \--- org.junit.vintage:junit-vintage-engine:5.7.2
|    |         +--- testCompileClasspath
|    |         \--- org.junit:junit-bom:5.7.2 (*)
|    \--- org.junit:junit-bom:5.7.2 (*)
+--- org.junit.platform:junit-platform-engine:1.7.2 (*)
\--- org.junit.vintage:junit-vintage-engine:5.7.2 (*)

(*) - dependencies omitted (listed previously)

A web-based, searchable dependency report is available by adding the --scan option.

BUILD SUCCESSFUL in 610ms
1 actionable task: 1 executed

Context

Used versions (Jupiter/Vintage/Platform): 5.8.0
Build Tool/IDE: Gradle 6.9.1

Deliverables

TBD

The text was updated successfully, but these errors were encountered:

sormuras · 2021-09-17T18:57:36Z

Does the same happen with Maven 3.x? IIRC, the "first BOM that defines a version wins", thus if the JUnit BOM is loaded before Jackson's BOM, 4.13.2 should be used for all junit:junit occurances.

marcphilipp · 2021-09-17T19:31:39Z

We switched to using a version range for our internal dependency management with 5.8:

junit5/gradle/libs.versions.toml

Line 31 in a295157

    
           junit4 = { module = "junit:junit", version = { strictly = "[4.12,)", prefer = "4.13.2" } }

However, we have the following config in place:

junit5/buildSrc/src/main/kotlin/java-library-conventions.gradle.kts

Lines 95 to 103 in 931ecaa

    
           configure<PublishingExtension> { 
        
           	publications { 
        
           		named<MavenPublication>("maven") { 
        
           			from(components["java"]) 
        
           			versionMapping { 
        
           				allVariants { 
        
           					fromResolutionResult() 
        
           				} 
        
           			}

This causes 4.13.2 to be published in the POM and the following dependency in Gradle Module Metadata:

{
  "group": "junit",
  "module": "junit",
  "version": {
    "strictly": "4.13.2",
    "requires": "4.13.2"
  }
}

In 5.7.2 that used to be:

{
  "group": "junit",
  "module": "junit",
  "version": {
    "requires": "4.13"
  }
}

I think the right thing to do would be to remove fromResolutionResult() from the build script mentioned above. Then, the Gradle module dependency would look as it should (since the engine still supports all versions since 4.12):

{
  "group": "junit",
  "module": "junit",
  "version": {
    "strictly": "[4.12,)",
    "requires": "[4.12,)",
    "prefers": "4.13.2"
  }
}

However, that would also cause the version range to be published in the POM which I initially wanted to avoid since I'm not sure if using it would break any consumers:

<dependency>
  <groupId>junit</groupId>
  <artifactId>junit</artifactId>
  <version>[4.12,)</version>
  <scope>compile</scope>
</dependency>

@junit-team/junit-lambda @wilkinsona Thoughts?

marcphilipp · 2021-09-17T19:37:02Z

Actually, I think the better fix as it's less risky would be to change our version declaration from strictly to requires. That would cause the GMM to contain

{
  "group": "junit",
  "module": "junit",
  "version": {
    "requires": "4.13.2"
  }
}

and the POM:

<dependency>
  <groupId>junit</groupId>
  <artifactId>junit</artifactId>
  <version>4.13.2</version>
  <scope>compile</scope>
</dependency>

Fixes #2722.

marcphilipp · 2021-09-17T19:42:12Z

@wilkinsona Why were you using enforcedPlatform? With just platform it would have worked, right?

marcphilipp · 2021-09-17T19:53:02Z

With 5.8.1-SNAPSHOT from https://oss.sonatype.org/content/repositories/snapshots/ it works (see build scan).

marcphilipp · 2021-09-17T19:54:20Z

@wilkinsona Would we still be in time for the upcoming Spring Boot release if we released 5.8.1 this weekend or early next week?

wilkinsona · 2021-09-20T08:26:21Z

that would also cause the version range to be published in the POM which I initially wanted to avoid since I'm not sure if using it would break any consumers

A little late, but for what it's worth, I much prefer the subsequent refinement that avoided a version range appearing in the pom. I, too, am rather wary of version ranges in poms and the effects that they can have.

Why were you using enforcedPlatform?

To mimic Spring Boot's build. It enforces dependency versions internally (so that we know exactly what we're testing against), while being more relaxed in its public metadata.

With just platform it would have worked, right?

Right.

Would we still be in time for the upcoming Spring Boot release if we released 5.8.1 this weekend or early next week?

Absolutely. We'd like to include 5.8 in Spring Boot 2.6 but it doesn't reach RC for another month or so. Thanks very much for looking at this so quickly.

Fixes junit-team#2722.

github-actions bot added 3rd-party: Gradle status: new labels Sep 17, 2021

wilkinsona mentioned this issue Sep 17, 2021

Upgrade to JUnit Jupiter 5.8.1 spring-projects/spring-boot#28052

Closed

marcphilipp added component: Vintage type: bug status: in progress and removed 3rd-party: Gradle status: new labels Sep 17, 2021

marcphilipp self-assigned this Sep 17, 2021

marcphilipp closed this as completed in ab91893 Sep 17, 2021

marcphilipp added a commit that referenced this issue Sep 17, 2021

Relax version constraint on JUnit 4

b31ae0e

Fixes #2722.

marcphilipp removed the status: in progress label Sep 17, 2021

marcphilipp added this to the 5.8.1 milestone Sep 17, 2021

marcphilipp added a commit that referenced this issue Sep 17, 2021

Add #2722 to release notes

07ed27f

marcphilipp added a commit that referenced this issue Sep 17, 2021

Add #2722 to release notes

7896665

sync-by-unito bot mentioned this issue Sep 23, 2021

Bump jupiter.version from 5.7.2 to 5.8.1 liquibase/liquibase-mongodb#187

Merged

runningcode pushed a commit to runningcode/junit5 that referenced this issue Feb 15, 2023

Relax version constraint on JUnit 4

5ac5181

Fixes junit-team#2722.

runningcode pushed a commit to runningcode/junit5 that referenced this issue Feb 15, 2023

Add junit-team#2722 to release notes

9e1be49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

junit-vintage-engine:5.8.0 requires junit:junit:{strictly 4.13.2} #2722

junit-vintage-engine:5.8.0 requires junit:junit:{strictly 4.13.2} #2722

wilkinsona commented Sep 17, 2021

sormuras commented Sep 17, 2021

marcphilipp commented Sep 17, 2021 •

edited

marcphilipp commented Sep 17, 2021 •

edited

marcphilipp commented Sep 17, 2021 •

edited

marcphilipp commented Sep 17, 2021

marcphilipp commented Sep 17, 2021 •

edited

wilkinsona commented Sep 20, 2021

junit-vintage-engine:5.8.0 requires junit:junit:{strictly 4.13.2} #2722

junit-vintage-engine:5.8.0 requires junit:junit:{strictly 4.13.2} #2722

Comments

wilkinsona commented Sep 17, 2021

Steps to reproduce

Context

Deliverables

sormuras commented Sep 17, 2021

marcphilipp commented Sep 17, 2021 • edited

marcphilipp commented Sep 17, 2021 • edited

marcphilipp commented Sep 17, 2021 • edited

marcphilipp commented Sep 17, 2021

marcphilipp commented Sep 17, 2021 • edited

wilkinsona commented Sep 20, 2021

marcphilipp commented Sep 17, 2021 •

edited

marcphilipp commented Sep 17, 2021 •

edited

marcphilipp commented Sep 17, 2021 •

edited

marcphilipp commented Sep 17, 2021 •

edited