Static code review for your Gerrit and Stash patchsets. Runs Checkstyle, PMD, FindBugs, Scalastyle, JSLint and Sonar for you!
Sputnik is intended to run just after your Jenkins/CI server build. It should be executed in the root directory of the analyzed project to find files to analyze.
Three parameters are required: your configuration file (details below), Gerrit's changeId and revisionId:
sputnik -conf /home/spoonman/sputnik/conf.properties -changeId I0a2afb7ae4a94ab1ab473ba00e2ec7de381799a0 -revisionId 3f37692af2290e8e3fd16d2f43701c24346197f0
Sputnik runs Checkstyle, PMD, FindBugs, CodeNarc, JSHint (or JSLint) and Sonar only on files affected by Gerrit's patchset. It collects all violations and report them back to Gerrit or Stash.
Typical configuration file looks like this:
connector.type=gerrit connector.host=your.host.com connector.path=/gerrit connector.port=8080 connector.username=sputnik connector.password=PassWd connector.useHttps=false checkstyle.enabled=true checkstyle.configurationFile=sun_checks.xml checkstyle.propertiesFile= pmd.enabled=true pmd.ruleSets=rulesets/java/android.xml,rulesets/java/basic.xml findbugs.enabled=true findbugs.includeFilter= findbugs.excludeFilter= codenarc.enabled=true codenarc.ruleSets= codenarc.excludes=**/*.java jslint.enabled=false jshint.enabled=true jshint.configurationFile=jshint.json sonar.enabled=true sonar.configurationFiles=sonar-project.properties, sonar-runner.properties sonar.verbose=false
If you want sputnik to use your SonarQube rules just download them from your SonarQube profile and use these with
- clone this repository and build it:
gradle distZipor download distribution file:
- copy distribution file
build/distributions/sputnik-1.3.0.zipto your installation dir, e.g.
/opt/sputnikand unzip it
- to avoid problems with deployment keep the structure unchanged, so sputnik file is in
bin/directory, jars in
- create configuration file (you can just paste and edit an example above), e.g.
- you can now run sputnik like this:
/opt/sputnik/bin/sputnik --conf /opt/sputnik/gerrit.properties --changeId I0a2afb7ae4a94ab1ab473ba00e2ec7de381799a0 --revisionId 3f37692af2290e8e3fd16d2f43701c24346197f0
Sputnik currently supports Maven (default) and Gradle. Some processors (e.g. FindBugs) analyze compiled classes, so it's important to set
the build tool property correctly. To change it to Gradle just set
project.build.tool=gradle in your
If you choose to run sputnik with Stash instead of Gerrit, you'll need to run it in the following manner:
/opt/sputnik/bin/sputnik --conf /opt/sputnik/stash.properties --pullRequestId 15
It is convenient to add sputnik's configuration file (
myconf.properties in the above example) to your
project's repo. This way, it will be easier to run it from CI server.
Add Post-Build step to Jenkins/CI server
If you have Jenkins job that uses Gerrit Trigger plugin it's very easy to integrate it as Post-Build step:
- create a user in Gerrit with HTTP password access and Non-Interactive Users group (take a look at Gerrit documentation https://git.eclipse.org/r/Documentation/cmd-create-account.html)
- add Post-Build step to your Jenkins job: Execute bash shell:
/opt/sputnik/bin/sputnik --conf /opt/sputnik/myconf.properties --changeId $GERRIT_CHANGE_ID --revisionId $GERRIT_PATCHSET_REVISION # This line makes sure that this Post-Build step always returns exit code 0 # so it won't affect your main build result echo "exit 0 workaround"
Add Post-Build step to Bamboo
When stash is build on Bamboo there is no direct way to check which pull request id it matches. This is a simple way to find required id.
- there is sputnik's config file in project's root directory
- user and password are configured in bamboo plan as variables ecosystem.username and ecosystem.password
- config file has placeholders for user and password:
With those steps in place you can use a step from
contrib/stash-execute.sh. You need to change the script to match your
environment - there are three variables to change:
Launching with Maven
If you prefer running Sputnik from Maven, there is a plugin developed by Karol Lassak here: https://github.com/ingwarsw/sputnik-maven-plugin. Read plugin documentation for reference.
Launching with Gradle
If you prefer running Sputnik from Gradle all you need is to have Gradle installed. Put build.gradle file in your repository, add config file and run:
gradle run -Dexec.args="--conf example.properties --changeId 1234 --revisionId 4321"
- Gerrit 2.8 is required (REST API for reviews was introduced in this version)
- Jenkins or other CI server to download and build patchsets
- Tomasz Kalkosiński
- Marcin Cylke
- Piotr Jagielski
- Karol Lassak
- Henning Hoefer
- Dominik Przybysz
This project is licenced under Apache License.