How to Upload External Analysis Results to Teamscale (via REST)

The REST service external-report allows uploading results from analysis tools like FindBugs/SpotBugs or different coverage tools.

• Request Description
  • Sample Upload with Curl
• Uploading data for historic dates or revisions
• Uploading Multiple Reports At Once (Sessions)

Request Description

In order to upload a file to Teamscale, the server which is running the Teamscale instance must be accessible via HTTP(S).

As a first step, create a new user which will be able to upload external analysis results to Teamscale. You can either use your administration account for this, or better use a special user with the Build role.

To upload external analysis results as files to Teamscale, issue the following HTTP request:

• HTTP method: POST

• Request URL:

  http://<YOUR_TEAMSCALE_SERVER>:<PORT>/p/<TEAMSCALE_PROJECT_ID>/external-report?format=<FORMAT>&partition=<PARTITION>&message=<MESSAGE>
  

  • YOUR_TEAMSCALE_SERVER:PORT is the address and port of the Teamscale instance.
  • TEAMSCALE_PROJECT_ID is the ID of the Teamscale project into which to store the coverage.
  • FORMAT is the report format of the uploaded file. It must be one of the formats supported by Teamscale.
  • PARTITION is a logical name for the type of coverage. All coverage with the same partition will be grouped together. This, e.g., allows you to upload both coverage for your Java and your JavaScript tests without the results of one overriding those of the other. The name is descriptive and can be any arbitrary string.
  • MESSAGE is the message shown in the Activity perspective to the user. It should make clear that coverage was uploaded.

• Body: Form data. May contain any number of elements with name "report" and the content of a single result XML file.

• Authentication: HTTP Basic Authentication with the build or admin user and their Access Token (not their password!)

Sample Upload with Curl

curl -X POST -u bob:e434mikm35d -Freport=@coverage.xml "http://teamscale-server:8080/p/myProject/external-report?format=JACOCO&partition=Unit%20Tests&message=Unit%20Test%20Coverage"

TIP

Details about the service's parameters can be best retrieved via the online service documentation as described here.

In addition to the common pitfalls when dealing with the REST API, you need to check if the external tool is activated in the project's analysis profile.

Furthermore, please refer to the details for supported upload formats.

Uploading data for historic dates or revisions

Note that the uploaded results will be used for the current HEAD commit in Teamscale on the main branch (e.g., latest commit on master for Git, latest changeset on the TFS main branch or latest commit on trunk for SVN). Should this not be the behaviour you want, you can override this by adding the following to the request's URL:

&revision=<REVISION>

where REVISION is, depending on your version control system, a:

• full Git SHA hash, or
• SVN revision number, or
• TFS changeset ID

Regardless of whether the revision has already been analyzed or not, Teamscale will store the external analysis results for the code with the revision. When later it is analyzed, the upload is integrated with the revision into Teamscale.

If concerned project has a multi-connector setup, the VCS repository that contains the revision for which an upload is meant, can be specified in the request's URL using the repository identifier (see connector options) for the project connector:

&repository=<REPOSITORY_IDENTIFIER>

Teamscale also supports uploading external analysis results to timestamps. This can be achieved by adding the following to the request's URL:

&t=<TIMESTAMP>

Uploading Multiple Reports At Once (Sessions)

If you want to upload multiple reports in a single logical commit, you should use Teamscale's session concept. For session handling, the service external-analysis is used. The following example uploads two different reports as a single commit using curl. For more details, see the service documentation.

curl -u bob:e434mikm35d "http://localhost:8080/p/my-project-id/external-analysis?message=my+message&partition=myPartition"

This command will return the session id, in this case Sdfb38cb0-c348-40fb-82f0-144bf0e41beb. Using this session, we can upload multiple reports.

curl -u bob:e434mikm35d -F "report=@./MyReport.xml" -F "format=FINDBUGS" -F "session=Sdfb38cb0-c348-40fb-82f0-144bf0e41beb" http://localhost:8080/p/my-project-id/external-report

curl -u bob:e434mikm35d -F "report=@./OtherReport.xml" -F "format=FXCOP" -F "session=Sdfb38cb0-c348-40fb-82f0-144bf0e41beb" http://localhost:8080/p/my-project-id/external-report

Finally, we commit the session using a POST request:

curl -X POST -u bob:e434mikm35d http://localhost:8080/p/my-project-id/external-analysis/Sdfb38cb0-c348-40fb-82f0-144bf0e41beb