The SeaLights Pull Request Integration exposes Quality Risks to the developer as part of the Pull Request process, to be displayed and handled before the code is merged into the main branch.

...

• Before making the required configurations on the Bitbucket on-premise installation, a Personal Access Token must be created for authentication with the dedicated SeaLights agent:
  • In BitBucket, click on the logged in user and select 'Manage Account'
  • On the Left hand side pane, select "Personal access tokens"
  • Create a new token to be used to show results in the Bitbucket UI:

Image Added

...

Image Modified

...

• To report the Pull Request data to SeaLights, the Task Runner must be installed locally on a machine with network access to the BitBucket server:
  
  
  1. Download the Task Runner from the following link: https://s3agents.amazonawssealights.comco/sl-repo/sl_task_runner/sl_task_runner-24.10.12062397.zip
  2. Prepare a configuration file to be used by the Task Runner in JSON format:

     • The Bitbucket server properties in this configuration file should be defined within  json property  "bitbucketServer" as follows:

     • The token to be used should be an Agent token 
       
       

{
    "tokenFile": "config./myconfig/sltoken.txt",
	"bitbucketServer":
        {
            "url": "http://bitbucket.internal.net:7990",
            "token":"<personal access token>"
        }
}

...

java -Dsl.config.file=config./myconfig/sl-taskrunner-cfg.json -jar ./sl_task_runner.jar

java -Dsl.tokenFile=./path/tomyconfig/sltoken.txt -Dsl.bitbucketServer.url=http://bitbucket.internal.net:7990 -Dsl.bitbucketServer.token=<personal access token> -jar ./sl_task_runner.jar

Common configuration properties for the task runner are as follows:

...

sl.enableUpgrade

...

true

...

Flag allows automatic upgrade

...

sl.upgradeIntervalMins

...

1440

...

Interval in minutes for auto-upgrade version checking

...

sl.taskPollingIntervalSecs

...

60

...

Interval in second for getting SL tasks for execution

...

sl.taskTimeoutSecs

...

60

...

Time in second allocated for task execution; if expires, task will be aborted and reported with timeout status

...

sl.logs.sendIntervalMin

...

5

...

Interval in minutes for sending accumulated logs to the cloud. If not defined, is forced to the default value on start

...

sl.token

...

-

...

The sealights token

...

sl.tokenFile

...

-

...

The file with sealights token

...

Configuring the BitBucket Pull Request to compare data to SeaLights

The pull request job needs to run the SeaLights build scan and test listener for the test stages you want the analysis on.
These results will be compared to the latest build you reported to SeaLights for the branch you are merging the Pull Request to.

Pull Request parameters explanation as seen on a local BitBucket implementation

You can easily identify the relevant values to pass to the Build Scanner based on the illustration below.

Image Removed

...

The difference between the pull request job and standard jobs is in how the session ID is created using Pull Request specific parameters.

Generating a session ID

You create the Pull Request build session ID by using the SeaLights Java Build Scanner (See: Downloading the java agent files) with the prConfig option:

...

java -jar sl-build-scanner.jar -prConfig 

...

-

...

appname 

...

"MyApp" 

...

-

...

latestCommit $BITBUCKET_COMMIT -

...

pullRequestNumber $BITBUCKET_PR_ID -

...

repoUrl $BITBUCKET_REPO_SLUG -

...

targetBranch origin/$BITBUCKET_PR_DESTINATION_BRANCH -

...

...

...

token

...

tokenfile

...

appname 

...

latestCommit

...

pullRequestNumber

...

repoUrl 

...

pi, packagesincluded

...

Comma-separated list of packages to include in scan

Supports wildcards (* = any string, ? = any character). For example: 'com.example.* ,io.*.demo, com.?ello.world'

...

pe,packagesexcluded

...

Comma-separated list of packages to exclude from scan

Supports wildcards (* = any string, ? = any character). For example: 'com.example.* ,io.*.demo, com.?ello.world'

...

proxy

...

tokenfile sl_acc_token.txt -pi "*co.sealights.sample.*"

Pull Request parameters as seen on a Bitbucket page

You can easily identify the relevant values to pass to the Build Scanner based on the illustration below.

Image Added

Pull Request parameters mapping with Bitbucket Environment variables

Bitbucket provides a set of default variables that are available for builds, and can be used in scripts. These variables are detailed in the official Bitbucket documentation and can be used like below

Sample of Results on the BitBucket Pull Request page

At the completion of the analysis, Sealights insights will appear at the right hand side of the "Overview" section of your Pull Request.
Clicking on this will open the Quality reports section. Results will appear similar to the one below:

...