Repository files navigation

Regression-tool is an automation tool to do regression testing based on proposed patch(Pull Request)of checkstyle project. The tool could generate configuration based on Git changes, which is used togenerate diff report between the base and the patch branch.

• Checkstyle repository which including both master and patch branch need to be cloned.In most case, it should be your forked repository.
• Contribution repository need to be cloned.
• Regression-tool uses environment variableM2_HOME or system propertymaven.home to find the maven binary files.You need to specify eitherM2_HOME ormaven.home in advance. You could get the path of maven home by runningmvn -v.

Just clone this repository to your local.

$ git clone git@github.com:checkstyle/regression-tool.git

Or use HTTPS mode.

$ git clone https://github.com/checkstyle/regression-tool.git

Generate aregression-tool-XX-all.jar(XX means the version of regression-tool) in thetarget folder.

$cd /path/to/regression-tool$ mvn clean package -Passembly

$ java -jar regression-tool-XX-all.jar -r<arg> -p<arg> [-t<arg>] [--stopAfterConfigGeneration]

The path of the checkstyle repository.Required, one argument.

The name of the PR branch, which would be compared with the master.Required, one argument.

Indicates that regression-tool would stop after generating config. By default, the tool would generatethe diff report after generating config.Optional, no argument.

The report generation might requires network and be time-consuming.If you are not able to connect to network or just don't want to do the generation right now,you could use this mode.

The path of the checkstyle-tester directory. If you areNOT using--stopAfterConfigGeneration mode, thisoption is required, otherwise this could be absent.Optional, one argument.

Here is an example in CI.

Generate regression report for branchissue1234.

$ java -jar target/regression-tool-XX-all.jar -r /path/to/checkstyle/ -p issue1234 -t /path/to/contribution/checkstyle-tester/

You could also use long options.

$ java -jar target/regression-tool-XX-all.jar --checkstyleRepoPath /path/to/checkstyle/ --patchBranch issue1234 --checkstyleTesterPath /path/to/contribution/checkstyle-tester/

Generate only the config file and don't generate the report.

$ java -jar target/regression-tool-XX-all.jar -r /path/to/checkstyle/ -p issue1234 --stopAfterConfigGeneration

The config file would be generated in current working directory.

The report would be generated somewhere in TBD.