Skip to content

repobee/repobee-junit4

Repository files navigation

repobee-junit4, a JUnit4 test runner plugin for RepoBee

Build Status Code Coverage PyPi Version Supported Python Versions Supported Platforms License

repobee-junit4 v1.0.0 requires RepoBee 3: From version 1.0, repobee-junit4 is only compatible with RepoBee 3+.

Overview

This is a plugin for RepoBee that runs JUnit4 test classes on production classes in cloned student repos. It allows teachers and teaching assistants to quickly assess the work performed by students in a managed and fair way. The plugin hooks into the repos clone command, and executes test classes on repos when they have been cloned to disk. A summary report is then printed to the logfile and terminal. By default, the plugin will only report which test classes failed (and how many tests), but it is possible to ask for more verbose output which includes detailed information about each test failure. See this example use case for a more detailed look at how it works.

Install

Use RepoBee's plugin manager to install.

$ repobee plugin install

Getting started

The best way to get started with repobee-junit4 is to head over to the Docs, where you (among other things) will find more elaborate install instructions and usage instructions. The latter includes an example use case which hopefully proves useful in clarifying how repobee-junit4 is supposed to be used.

Roadmap

This plugin is in the alpha testing phase. All features currently in the plugin will remain, but the CLI is not yet final and may change. This is partly due to the fact that the RepoBee plugin system itself is still in alpha, and may also change.

Versioning for the CLI adheres to Semantic Versioning 2.0.0. The internals of repobee-junit4 do not, so this project should not be used as a library.

License

This software is licensed under the MIT License. See the LICENSE file for specifics.