What's the difference between maven modules junit-jupiter-api
and junit-jupiter-engine
? Is it necessary to include both dependencies in build.gradle
?
Do I need to provide both dependencies?
testCompile("org.junit.jupiter:junit-jupiter-engine:${junitVersion}")
testCompile("org.junit.jupiter:junit-jupiter-api:${junitVersion}")
Or only one dependency is enough?
testCompile("org.junit.jupiter:junit-jupiter-engine:${junitVersion}")
And do I need to add a dependency on junit-vintage-engine
?
From the docs :
junit-jupiter-api
JUnit Jupiter API for writing tests and extensions.
junit-jupiter-engine
JUnit Jupiter test engine implementation, only required at runtime.
junit-vintage-engine
JUnit Vintage test engine implementation that allows to run vintage JUnit tests, ie tests written in the JUnit 3 or JUnit 4 style, on the new JUnit Platform.
So ...
junit-jupiter-api
and junit-jupiter-engine
to write and run JUnit5 testsjunit-vintage-engine
if (a) you are running with JUnit5 and (b) your test cases use JUnit4 constructs/annotations/rules etcIn JUnit 5.4 this is simplified, see this answer for more details.
junit-jupiter
aggregator artifact JUnit 5.4 provides much simpler Maven configuration if your intent is to write JUnit 5 tests. Simply specify the aggregate artifact named junit-jupiter
.
<!-- https://mvnrepository.com/artifact/org.junit.jupiter/junit-jupiter -->
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter</artifactId>
<version>5.8.2</version>
<scope>test</scope>
</dependency>
As an aggregate, this artifact in turn pulls the following three artifacts automatically, for your convenience:
junit-jupiter-api
(a compile dependency) junit-jupiter-params
(a compile dependency) junit-jupiter-engine
(a runtime dependency) In your project, you will also end up with:
The above is what you need to write and run JUnit 5 tests based on the new Jupiter paradigm.
If your project has JUnit 3 or 4 tests that you want to continue to run, add another dependency for the JUnit Vintage Engine , junit-vintage-engine
. See tutorial by IBM .
<!-- https://mvnrepository.com/artifact/org.junit.vintage/junit-vintage-engine -->
<dependency>
<groupId>org.junit.vintage</groupId>
<artifactId>junit-vintage-engine</artifactId>
<version>5.8.2</version>
<scope>test</scope>
</dependency>
Just to note, junit-jupiter-api
is included as a sub-dependency in junit-jupiter-engine
Maven repository. So you'll only really need to add junit-jupiter-engine
to get both. I'm sure gradle is the same. https://mvnrepository.com/artifact/org.junit.jupiter/junit-jupiter-engine/5.1.1
The most accurate answer to your questions is in junit-team/junit5-samples repository. Just take a look at junit5-jupiter-starter-gradle for Gradle and junit5-jupiter-starter-maven for maven.
As you can see in both examples the only required dependency is junit-jupiter
.
If you want to run the tests using the Junit 5, you will only need the junit-jupiter-api
. If you use the junit-jupiter-engine
along with, your tests will broke and will not run.
I'm not sure why it was placed, but, the previous answer informs that you will need to use the both is incorrect.
The technical post webpages of this site follow the CC BY-SA 4.0 protocol. If you need to reprint, please indicate the site URL or the original address.Any question please contact:yoyou2525@163.com.