Skip to content

junit-pioneer/junit-pioneer

main
Switch branches/tags
Code

Latest commit

This commit removes the branch filtering on PRs. It prevented the
build pipeline from triggering in certain cases but we want to
trigger it for all PRs, so the filtering just did not make sense.

Closes: #673
PR: #674
f36ee4c

Git stats

Files

Permalink
Failed to load latest commit information.

JUnit Pioneer

Latest Junit Pioneer on Maven Central Latest JUnit Pioneer Javadoc on javadoc.io JUnit Pioneer build status Contributor Covenant Code of Conduct

A melting pot for all kinds of extensions to JUnit 5, particular to its Jupiter API.

Check out junit-pioneer.org, particularly the documentation section.

A Pioneer's Mission

JUnit Pioneer provides extensions for JUnit 5 and its Jupiter API. It does not limit itself to proven ideas with wide application but is purposely open to experiments. It aims to spin off successful and cohesive portions into sibling projects or back into the JUnit 5 code base.

To enable easy exchange of code with JUnit 5, JUnit Pioneer copies most of its infrastructure, from code style to build tool and configuration to continuous integration.

Getting on Board

JUnit Pioneer is released on GitHub and Maven Central. Coordinates:

  • group ID: org.junit-pioneer
  • artifact ID: junit-pioneer
  • version: Latest Junit Pioneer on Maven Central

For Maven:

<dependency>
	<groupId>org.junit-pioneer</groupId>
	<artifactId>junit-pioneer</artifactId>
	<version><!--...--></version>
	<scope>test</scope>
</dependency>

For Gradle:

testCompile group: 'org.junit-pioneer', name: 'junit-pioneer', version: /*...*/

Dependencies

JUnit Pioneer is compiled against Java 8 (built with JDK 11), but comes as a module (i.e. with a module-info.class) named org.junitpioneer. That means it can be used on all Java versions 8 and higher on class path and module path.

Pioneer does not only use JUnit 5's API, but also other artifacts from its ecosystem such as junit-platform-commons. To avoid dependency issues (e.g. in junit-pioneer#343), you should add the JUnit 5 BOM (junit-bom) to your project instead of defining all dependency versions manually.

To not add to user's JAR hell, JUnit Pioneer is not taking on any runtime dependencies besides JUnit 5. Pioneer always depends on the lowest JUnit 5 version that supports its feature set, but that should not keep you from using 5's latest and greatest.

Since 1.7.0 we also have an optional runtime dependency on Jackson, for our JSON-based extensions. You can read a bit more about our approach to dependencies in the contribution guide.

For our own infrastructure, we rely on the following compile and test dependencies:

  • AssertJ (assertions for our tests)
  • Mockito (mocking for our tests)
  • Log4J (to configure logging during test runs)
  • Jimfs (as an in-memory file system for our test)
  • Equalsverifier (for easier assertion of simple things)

Contributing

We welcome contributions of all shapes and forms! 🌞

Before contributing, please read the contribution guide as well as the code of conduct.

Maintainers

JUnit Pioneer is maintained by a small team of people who work on it in their free time - see CONTRIBUTING.md for details on how they do that. In lexicographic order, these are:

Daniel Kraus aka beatngu13
Banking software by day, OSS by night. Punk rock enthusiast and passionate hiker. Into Java, software testing, and web services. Tweets occasionally.
Matthias Bünger aka Bukama
(Always tries to become a better) Java developer, loves testing and reads tweets. Became a maintainer in April 2020 after he "caused" (authored) too many bishues.
Mihály Verhás aka Michael1993
Not so witty, not so pretty, not really mean, not really cool bean. A Hungarian Java developer who spends more time on Twitch than recommended by his doctors and used creative and diligent contributions to fool everyone into believing he is a decent enough guy to get promoted to maintainer (in November 2020).
Nicolai Parlog aka nipafx
Java enthusiast with a passion for learning and sharing. He does that in blog posts, articles, newsletters, and books; in tweets, repos, videos, and streams; at conferences and in-house trainings - more on all of that on nipafx.dev. That aside, he's best known for his head decor. He co-founded the project in November 2016 and has maintained it ever since (although often very negligently).
Simon Schrottner aka aepfli
Bearded guy in Lederhosen, who loves to code, and loves to explore code quality, testing, and other tools that can improve the live of a software craftsman. Passionated couchsurfer and hobby event planner. Maintainer since April 2020.

Contributors

JUnit Pioneer, as small as it is, would be much smaller without kind souls contributing their time, energy, and skills. Thank you for your efforts! 🙏

The least we can do is to thank them and list some of their accomplishments here (in lexicographic order).

2022

2021

2020

2019

  • Alex Panchenko fixed a noteworthy bug in the TempDirectory extension (#140)
  • Christian Stein helped get the project back on track (yes, again, I told you Nicolai was negligent)
  • Daniel Kraus improved Shipkit integration (#148 / #151)
  • Marc Philipp helped get the project back on track and converted build.gradle to Kotlin (#145)

2018