Install¶
Requirements¶
Important
Once you have gone through this section, you should have:
- Repomate installed
- A JDK (preferably 8+, 7 may work) installed
junit-4.12.jar
andhamcest-core-1.3.jar
downloaded
First of all, make sure that Repomate is installed and up-to-date. For a first-time install of Repomate, see the Repomate install docs. If you already have Repomate installed, make sure it is up-to-date.
python3 -m pip install --user --upgrade repomate
Furthermore, a JDK must be installed. repomate-junit4
has been extensively
tested with OpenJDK 8+, but should work well with JDK 7 and later. Make sure
that:
java
is available from the command line.javac
is available from the command line.
To be able to actually run test classes, you also need the JUnit4 and Hamcrest jars. They can be downloaded from Maven Central.
wget http://central.maven.org/maven2/junit/junit/4.12/junit-4.12.jar
wget http://central.maven.org/maven2/org/hamcrest/hamcrest-core/1.3/hamcrest-core-1.3.jar
If you don’t have wget
installed, just copy the links above and download
them manually.
Install plugin¶
To install repomate-junit4
, simply use pip
again.
python3 -m pip install --user repomate-junit4
Repomate should simply be able to find repomate-junit4
if they are both
installed in the same environment. To verify that it is correctly installed,
run repomate -p junit4 clone -h
. You should see some additional command
line arguments added (such as --reference-tests-dir
). See the Using
existing plugins for more information on how to use plugins in general,
and Usage for details on this plugin.
Configuration¶
Some options for repomate-junit4
can be configured in the Repomate
configuration file by adding the [junit4]
section. Everything
repomate-junit4
needs to operate can be provided on the command line, but
I strongly recommend adding the absolute paths to the junit-4.12.jar
and
hamcrest-core-1.3.jar
files to the config file. Simply append the following
to the end of the configuration file.
[junit4]
junit_path = /absolute/path/to/junit-4.12.jar
hamcrest_path = /absolute/path/to/hamcrest-core-1.3.jar
Important
All paths in the configuration file must be absolute to behave as expected.
See CLI arguments for a complete list of arguments that can be configured.