MathWorks Polyspace

The MathWorks Polyspace Plugin for Jenkins enables automated Polyspace analyses within Jenkins.

Select Manage Jenkins and then Configure System. In the Polyspace section, enter shorthands for:

• Paths to Polyspace Server installation folder.
• Hostname, port number and protocol for Polyspace Access server.
• Hostname and port number for Polyspace Metrics server.

You later use these shorthands in Jenkins projects. Also, specify the e-mail server (if not already specified) in the E-mail Notification section.

Create a new project. In the Build Environment section of the project, choose Select Polyspace installation settings. Then:

1. Select the global shorthands you defined earlier for the Polyspace installation folder, Polyspace Metrics server and/or Polyspace Access server.
2. Select an username and encrypted password for Polyspace Access. You can also add new users with the Add button. The username and password gets stored in the Credentials plugin. You can edit or delete users (or add new users) directly in the Credentials plugin.

Note: Obtain an encrypted form of a Polyspace Access password using polyspace-access -encrypt-password. See polyspace-access.

In the Build section of the project, select Execute shell or Execute Windows batch command. Enter a script that uses the Polyspace executables:

• polyspace-bug-finder-server or polyspace-code-prover-server to run Polyspace Bug Finder or Polyspace Code Prover.
• polyspace-access to upload analysis results to the Polyspace Access server.
• polyspace-results-repository to upload analysis results to the Polyspace Metrics server.

For other Polyspace commands, see the documentation of Polyspace Bug Finder Server or Polyspace Code Prover Server. See example scripts below.

You can also use the helper utilities available with the Jenkins plugin:

• ps_helper_access to use the polyspace-access command without specifying hostname, port number and user credentials.
• ps_helper_metrics to use the polyspace-results-repository command without specifying hostname and port number.
• ps_helper to filter results based on specified criteria, generate a pass/fail status for the build based on number of findings and print a project id and run number for the current upload.

For the syntax of these helper utilities, click the ? icon next to the Polyspace fields in the Build Environment section of the project.

In the Post-build Actions section of the project, select Polyspace Notification. You can choose to do one of the following:

• Send a common e-mail notification to one or more recipients. The e-mail can contain a summary of the analysis such as number of findings. You can also send in attachment a text file with the findings in the project (with links to individual findings in Polyspace Access).
• Send different e-mails to individual recipients based on file or component ownership or some other criteria. You can filter a text file with the results using the ps_helper utility and assign the filtered results to specific owners. You can then send text files with these filtered results in e-mail attachments to the owners.

For more information, click the ? icon next to the Polyspace fields in the Post-build Actions section of the project.

Script examples can be found at https://github.com/mathworks/polyspace-jenkins-plugin/tree/master/examples.

Best practice is to configure user authentication on the Jenkins controller to restrict access to limited authorized users only. See Jenkins documentation Secure the controller and Securing Jenkins.