Jenkins understands the result files of several static code analysis tools. For each result file a different plug-in is used for configuration and parsing. Since these results are visualized by the same back-end, the description of this back-end is combined in this section. The following plug-ins use the same visualization:
Additionally the add-on plug-in Static Analysis Collector is available that combines the individual results of these plug-ins into a single trend graph and view.
The following features are provided by these plug-ins:
The total number of warnings in a job can be visualized in every view by adding a new column "Number of * warnings".
There are several trend graphs available for the plug-ins. Currently, you can select one of the following trend graphs for a job:
You can adjust the size of graph and the number of builds to include. These graphs can be configured globally for a job and can be changed by each user.
The following portlets for the dashboard view are available:
The results for each build are summarized on the build view. Here you see how may warnings or open tasks have been found for the selected build. Moreover, the summary shows the number of new and fixed warnings as well as the number of scanned or parsed files. The details views for each plug-in are accessible via hyper links. You can also directly navigate to the plug-in results by clicking into the trend image (see image above).
Each plug-in presents the results of a build in several overview tabs: here you see the number of the warnings or tasks per item as well as the severity distribution. The severity graphs provide a tool tip to show the actual number of warnings or tasks for each severity. By following the link in the first overview table column you will be directed to the filtered details of the selection. The overview table is sortable, so you can easily find the modules or packages with the most warnings by clicking on the table header.
The details of the individual warnings are shown in the remaining tabs. In the Details tab you will see all warnings of the current selection (e.g., a given package) printed one after another. For each warning you will see the warning message and a detailed description (with example) of the static analysis tool. If you are viewing the results of the current build then the file names are hyperlinks: clicking on the file name will open the actual source code with the selected warning highlighted.
The detail tabs in the other plug-ins are equivalent, click on the thumbnails below to view a screenshot of these tabs.
Besides this details tab there are additional tabs that show the details for a filtered sub-set of the warnings or tasks. I.e., the tabs high, normal, and low show the details of the selected severity, while the tabs new and fixed show warnings in the current build that are new or fixed, respectively.
Finally, the tab Warnings shows a sortable table of all warnings. Here you can sort the warnings by all available attributes to decide which warnings should be looked at in more detail. The warning message and description is shown when hoovering over the cell content.
The actual warning is visualized in the source code view (with syntax highlighting). Some warnings have several source code markers attached. In this case, the primary range of the warnings is colored with orange, the remaining ranges are colored with yellow. When hoovering over a colored warning annotation, then the warning message and detailed description is shown in a tool tip.
All plug-ins also do have a remote API to obtain information on the quality of the current build. You can use the following commands, the variable [Plugin-URL] needs to be replaced with the URL of the plug-in, e.g., checkstyle, findbugs, tasks, etc. :
All plug-in provide several tokens that are available during post build processing. In order to use these tokens you need to install the latest release of the token macro plug-in. The following tokens are currently available (for the plug-in names CHECKSTYLE, DRY, FINDBUGS, PMD, TASKS, WARNINGS and ANALYSIS):
These plug-ins normally get built in the site phase, not in the 'normal' package phase. The configuration help for the plug-in specifies which goal you'll have to add to your maven build options a bit further up on the same page.
Skip to end of metadata Go to start of metadata