Skip to content

Latest commit

Β 

History

History
2608 lines (2603 loc) Β· 75.8 KB

SUPPORTED-FORMATS.md

File metadata and controls

2608 lines (2603 loc) Β· 75.8 KB

Supported Report Formats

Jenkins' Warnings Next Generation Plugin supports the following report formats. If your tool is supported, but has no custom icon yet, please file a pull request for the Warnings Next Generation Plugin.

If your tool is not yet supported you can

  1. define a new Groovy based parser in the user interface
  2. export the issues of your tool to the native XML format (or any other format)
  3. provide a parser within a new small plugin.

If the parser is useful for other teams as well please share it and provide pull requests for the Warnings Next Generation Plug-in and the Analysis Parsers Library.

ID Pipeline Symbol Icon Name Default Pattern
acu-cobol acuCobol() AcuCobol AcuCobol -
gnat gnat() Ada Compiler (gnat) Ada Compiler (gnat) -
android-lint androidLintParser() Android Lint Android Lint -
πŸ’‘ Use the flag -p.
ansiblelint ansibleLint() Ansible Lint Ansible Lint -
πŸ’‘ Use the flag -p.
scannercli aquaScanner() Aqua Scanner Aqua Scanner -
πŸ’‘ Use commandline scannercli scan 'image' --jsonfile results.json, see Aqua Scanner CLI for usage details.
trivy trivy() Aquasec Trivy Aquasec Trivy -
πŸ’‘ Use commandline trivy image -f json -o results.json 'image', see tivy on Github for usage details.
armcc armCc() Armcc Compiler Armcc Compiler -
aspectj ajc() AspectJ AspectJ -
axivion-suite axivionSuite() Axivion Suite Axivion Suite -
πŸ’‘ For using Axivion Suite, set up your analysis project and the web service. Provide the URL and credentials.
bluepearl bluepearl() Blue Pearl Visual Verification Suite Blue Pearl Visual Verification Suite -
brakeman brakeman() Brakeman Brakeman **/brakeman-output.json
πŸ’‘ Reads Brakeman JSON reports. Use commandline brakeman -o brakeman-output.json output.
See Brakeman documentation for usage details.
buckminster buckminster() Buckminster Buckminster -
cadence cadence() Cadence Incisive Cadence Incisive -
cargo cargo() Cargo Check Cargo Check -
πŸ’‘ Use commandline cargo check --message-format json
ccm ccm() CCM CCM -
checkstyle checkStyle() CheckStyle CheckStyle **/checkstyle-result.xml
clair clair() Clair Scanner Clair Scanner -
πŸ’‘ Reads Clair json data. Use commandline clair-scanner --report="/target/clair.json" output.
See clair-scanner on Github for usage details.
clang clang() Clang Clang -
clang-analyzer clangAnalyzer() Clang Analyzer Clang Analyzer -
πŸ’‘ Use options --analyze --analyzer-output plist-multi-file
clang-tidy clangTidy() Clang-Tidy Clang-Tidy -
cmake cmake() CMake CMake -
code-analysis codeAnalysis() Code Analysis Code Analysis -
code-generator codeGeneratorParser() Code Generator Tool Code Generator Tool -
code-checker codeChecker() CodeChecker CodeChecker -
codenarc codeNarc() CodeNarc CodeNarc -
coolflux coolflux() Coolflux DSP Compiler Coolflux DSP Compiler -
cpd cpd() CPD CPD **/cpd.xml
cppcheck cppCheck() CPPCheck CPPCheck -
πŸ’‘ Use options --xml --xml-version=2
cpplint cppLint() Cpplint Cpplint -
πŸ’‘ You need to use the Eclipse format with the option --output=eclipse
crosscore-embedded-studio CrossCoreEmbeddedStudioParser() CrossCore Embedded Studio (CCES) CrossCore Embedded Studio (CCES) -
csslint cssLint() CSS-Lint CSS-Lint -
dart dart() Dart Analyze Dart Analyze -
detekt detekt() Detekt Detekt -
πŸ’‘ Use option --output-format xml.
docfx docFx() DocFX DocFX -
dockerlint dockerLint() Dockerfile Lint Dockerfile Lint -
πŸ’‘ Use commandline dockerfile_lint -j output.
See dockerfile_lint on Github for usage details.
doxygen doxygen() Doxygen Doxygen -
πŸ’‘ Execute doxygen:As shell command ( cat Doxyfile; echo WARN_FORMAT='$file:$line: $text' ) | doxygen -As batch command ( type Doxyfile & echo WARN_FORMAT='$file:$line: $text' ) | doxygen -
dr-memory drMemory() Dr. Memory Dr. Memory -
dscanner dscanner() DScanner DScanner **/dscanner-report.json
eclipse eclipse() Eclipse ECJ Eclipse ECJ -
πŸ’‘

Create an output file that contains Eclipse ECJ output, in either XML or text format.

To log in XML format, specify ".xml" as the file extension to the -log argument:

java -jar ecj.jar -log <logfile>.xml <other arguments>

To log in text format, specify any file extension except ".xml" to the -log argument:

java -jar ecj.jar -log <logfile>.log <other arguments>

embedded-engineer embeddedEngineerParser() Embedded Engineer Tool Embedded Engineer Tool -
erlc erlc() Erlang Compiler (erlc) Erlang Compiler (erlc) -
error-prone errorProne() Error Prone Error Prone -
eslint esLint() ESLint ESLint -
πŸ’‘ Use option --format checkstyle.
findbugs findBugs() FindBugs FindBugs **/findbugsXml.xml
flake8 flake8() Flake8 Flake8 -
πŸ’‘

Run flake8 as flake8 --format=pylint

flawfinder flawfinder() FlawFinder FlawFinder -
πŸ’‘ Use commandline flawfinder -S.
flex flexSdk() Flex SDK Compiler Flex SDK Compiler -
fxcop fxcop() FxCop FxCop -
gendarme gendarme() Gendarme Gendarme -
ghs-multi ghsMulti() GHS Multi Compiler GHS Multi Compiler -
gcc gcc() GNU C Compiler (gcc) GNU C Compiler (gcc) -
gcc3 gcc3() GNU C Compiler 3 (gcc) GNU C Compiler 3 (gcc) -
fortran gnuFortran() GNU Fortran Compiler GNU Fortran Compiler -
golint goLint() Go Lint Go Lint -
go-vet goVet() Go Vet Go Vet -
groovy groovyScript() Groovy Parser Groovy Parser -
grype grype() Grype Grype **/grype-report.json
hadolint hadoLint() HadoLint HadoLint -
πŸ’‘ Use commandline hadolint --format json Dockerfile output.
See hadolint on Github for usage details.
iar-cstat iarCstat() IAR C-STAT IAR C-STAT -
πŸ’‘

The IAR C-STAT static analysis tool finds potential issues in code by doing an analysis on the source code level. Use the following icstat command to generate the output on stdout in the correct format:

icstat --db a.db --checks checks.ch commands commands.txt
where the commands.txt contains:
analyze - iccxxxxcompiler_opts cstat1.c
analyze - iccxxxxcompiler_opts cstat2.c
For details check the IAR C-STAT guide.

iar iar() IAR Compiler (C/C++) IAR Compiler (C/C++) -
πŸ’‘ The IAR compilers need to be started with option --no_wrap_diagnostics. Then the IAR compilers will create single-line warnings.
iblinter ibLinter() IbLinter IbLinter -
πŸ’‘ Use configuration reporter: \”checkstyle\”.
xlc xlc() IBM XLC Compiler IBM XLC Compiler -
infer infer() Infer Infer -
πŸ’‘ Use option --pmd-xml.
intel intel() Intel Compiler (C, Fortran) Intel Compiler (C, Fortran) -
idea ideaInspection() IntelliJ IDEA Inspections IntelliJ IDEA Inspections -
java java() Java Compiler Java Compiler -
javadoc-warnings javaDoc() JavaDoc JavaDoc -
jc-report jcReport() JCReport JCReport -
js-hint jsHint() JsHint JsHint -
jslint jsLint() JSLint JSLint -
junit junitParser() JUnit JUnit -
klocwork klocWork() Klocwork Klocwork -
kotlin kotlin() Kotlin Kotlin -
ktlint ktLint() KtLint KtLint -
πŸ’‘ Use option --reporter=checkstyle.
maven-warnings mavenConsole() Maven Maven -
taglist tagList() Maven Taglist Plugin Maven Taglist Plugin **/taglist.xml
modelsim modelsim() Mentor Graphics Modelsim/Questa Simulators Mentor Graphics Modelsim/Questa Simulators -
metrowerks metrowerksCodeWarrior() Metrowerks CodeWarrior Compiler Metrowerks CodeWarrior Compiler -
πŸ’‘

Ensure that the output from the CodeWarrior build tools is in the expected format. If there are warnings present, but they are not found, then it is likely that the format is incorrect. The mwccarm compiler and mwldarm linker tools may support a configurable message style. This can be used to enforce the expected output format, which may be different from Metrowerks CodeWarrior (and thus require a different tool). For example the following could be appended to the build flags:

-msgstyle gcc -nowraplines

msbuild msBuild() MSBuild MSBuild -
mypy myPy() MyPy MyPy -
nag-fortran nagFortran() NAG Fortran Compiler NAG Fortran Compiler -
issues issues() Native Analysis Model Format Native Analysis Model Format -
πŸ’‘

Create an output file that contains issues in the native Warnings Plugin format, in either XML or JSON. The supported format is identical to the format of the remote API calls. The parser is even capable of reading individual lines of a log file that contains issues in JSON format.

oelint-adv oelintAdv() oelint-adv oelint-adv -
open-tasks taskScanner() Open Tasks Scanner Open Tasks Scanner -
invalids invalids() Oracle Invalids Oracle Invalids -
ot-docker-linter otDockerLint() OT Docker Linter OT Docker Linter -
πŸ’‘ Use commandline ot-docker-linter audit --docker.file Dockerfile -o json output.
See ot-docker-linter on Github for usage details.
owasp-dependency-check owaspDependencyCheck() OWASP Dependency Check OWASP Dependency Check **/dependency-check-report.json
pclint pcLint() PC-Lint Tool PC-Lint Tool -
πŸ’‘

Use the following PC-Lint properties to create an output file in the correct format:

-v // turn off verbosity
-width(0) // don't insert line breaks (unlimited output width)
-"format=%f(%l): %t %n: %m"
-hs1 // The height of a message should be 1

pep8 pep8() PEP8 PEP8 -
perforce perforce() Perforce Compiler Perforce Compiler -
perl-critic perlCritic() Perl::Critic Perl::Critic -
php php() PHP Runtime PHP Runtime -
php-code-sniffer phpCodeSniffer() PHP_CodeSniffer PHP_CodeSniffer -
πŸ’‘ Use option --report=checkstyle.
phpstan phpStan() PHPStan PHPStan -
πŸ’‘ Use the options: --no-progress --error-format=checkstyle
pit pit() PIT PIT **/mutations.xml
pmd pmdParser() PMD PMD **/pmd.xml
polyspace-parser polyspaceParser() Polyspace Tool Polyspace Tool -
πŸ’‘ Reads reports of Polyspace Static Analysis Tool by MathWorks. Used for BugFinder and CodeProver result files.
Report can be generated with command: polyspace-results-export -format csv -results-dir -output-name -key
prefast prefast() PREfast PREfast -
protolint protoLint() ProtoLint ProtoLint -
puppetlint puppetLint() Puppet Lint Puppet Lint -
πŸ’‘ You will need a recent enough version that supports --log-format flag. When running puppet-lint, make sure you use the log format %{path}:%{line}:%{check}:%{KIND}:%{message}.
Complete example:
find. -iname *.pp -exec puppet-lint --log-format "%{path}:%{line}:%{check}:%{KIND}:%{message}" {} \;
pvs-studio PVSStudio() PVS-Studio PVS-Studio **/*.plog
pydocstyle pyDocStyle() PyDocStyle PyDocStyle -
pylint pyLint() Pylint Pylint -
πŸ’‘

Start Pylint using this custom message template (can also be configured via a pylintrc configuration file):

pylint --msg-template='{path}:{line}: [{msg_id}, {obj}] {msg} ({symbol})' modules_or_packages > pylint.log

qac qacSourceCodeAnalyser() QA-C Sourcecode Analyser QA-C Sourcecode Analyser -
qt-translation qtTranslation() Qt translations Qt translations -
πŸ’‘ Reads translation files of Qt, which are created by "lupdate" or "Linguist".
analysis-model analysisParser() Registered Parser Registered Parser -
dupfinder dupFinder() Resharper DupFinder Resharper DupFinder -
resharper resharperInspectCode() Resharper Inspections Resharper Inspections -
revapi revApi() Revapi Revapi **/target/revapi-result.json
robocopy robocopy() Robocopy Robocopy -
rflint rfLint() Robot Framework Lint Robot Framework Lint -
rubocop ruboCop() Rubocop Rubocop -
πŸ’‘ Use commandline rubocop --format progress.
sarif sarif() SARIF SARIF -
scala scala() Scala Compiler Scala Compiler -
simian simian() Simian Simian -
simulink-check-parser simulinkCheckParser() Simulink Check Tool Simulink Check Tool -
πŸ’‘ Reads and Parses HTML reports of Simulink Check Tool by MathWorks. Report can be generated with command: ModelAdvisor.summaryReport(ModelAdvisor.run(, , , ))
sonar sonarQube() SonarQube Issues SonarQube Issues **/sonar-report.json
sphinx sphinxBuild() Sphinx Build Sphinx Build -
spotbugs spotBugs() SpotBugs SpotBugs **/spotbugsXml.xml
stylecop styleCop() StyleCop StyleCop -
stylelint styleLint() Stylelint Stylelint -
πŸ’‘ Requires stylelint-checkstyle-reporter.
Use --custom-formatter node_modules/stylelint-checkstyle-reporter/index.js -o stylelint-warnings.xml
sunc sunC() SUN C++ Compiler SUN C++ Compiler -
swiftlint swiftLint() SwiftLint SwiftLint -
πŸ’‘ Use configuration reporter: \”checkstyle\”.
tasking-vx taskingVx() TASKING VX Compiler TASKING VX Compiler -
code-composer tiCss() Texas Instruments Code Composer Studio Texas Instruments Code Composer Studio -
tnsdl tnsdl() TNSDL Translator TNSDL Translator -
tslint tsLint() TSLint  TSLint -
πŸ’‘ Use option --format checkstyle.
veracode-pipeline-scanner veracodePipelineScanner() Veracode Pipeline Scanner Veracode Pipeline Scanner -
πŸ’‘ Use commandline java -jar pipeline-scan.jar --json_output=true --json_output_file=results.json, see Veracode Pipeline Scanner for usage details.
diabc diabC() Wind River Diab Compiler (C/C++) Wind River Diab Compiler (C/C++) -
xmllint xmlLint() XML-Lint XML-Lint -
yamllint yamlLint() YamlLint YamlLint -
πŸ’‘ Use option -f parsable.
yui yuiCompressor() YUI Compressor YUI Compressor -
zptlint zptLint() ZPT-Lint ZPT-Lint -