Tracking static warnings

Tool Demo Video

A tool demo video about StaticTracker

https://www.youtube.com/watch?v=2WMOjoq1Nbs

General Information

To run the tracking approach, you need to hava Java 17+, Maven 3.9+ installed and Python 3+.

This tracking tool supports static tools:

• Spotbugs
• PMD

Build a jar

./mvn clean compile assembly:single

Configure git hooks

Copy pre-push and config.yml from templates into <your-project>/.git/hooks. Edit to configure config.yml.

local_repo_path: the local path of your project
report_save_path: the path of directory to save results
remote_repo_url: the URL of your repository
tracking_approach_jar_path:  the tracking approach jar path e.g., ./target/tracking-static-warnings-1.0-SNAPSHOT.jar
static_tool: 
  name: static tool name
  compilation_command: Spotubgs only e.g., mvn clean install
  ruleset_path: PMD only 

Usage

Once you put pre-push and config.yml in hooks, every time you push new code to repo, the Spotbugs/PMD will be run on your repo of the lastest two revisions and the tracking approach will identify the disappeared static warnings and newly-introduced static warnings by comparing the static warnings from two revisions. You can use git push --no-verify to skip the tracking process.