| Table of Contents |
|---|
...
- 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:
- Download the Task Runner from the following link: https://sl-repoagents.s3sealights.amazonaws.comco/sl_task_runner/sl_task_runner-24.10.13682397.zip
- 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
| Code Block | ||
|---|---|---|
| ||
{
"tokenFile": "config./myconfig/sltoken.txt",
"bitbucketServer":
{
"url": "http://bitbucket.internal.net:7990",
"token":"<personal access token>"
}
} |
...
Once the configuration file is created, run the SeaLights task runner .jar file, specifying the configuration file created in the previous step:
| Code Block | ||
|---|---|---|
| ||
java -Dsl.config.file=config./myconfig/sl-taskrunner-cfg.json -jar ./sl_task_runner.jar |
Alternatively, the same parameters can be specified directly as Java params:
| Code Block | ||
|---|---|---|
| ||
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 |
...
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
...
-
...
Access token generated from the SeaLights server
...
sl.tokenFile
...
-
...
Path to file containing the access token generated from the SeaLights server
| Info |
|---|
See Task Runner Agent - Command Reference for full list of parameters |
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.
...
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:
| Code Block | ||||||
|---|---|---|---|---|---|---|
|
...
| |||
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 -tokenfile sl_acc_token.txt -pi "* |
...
co.sealights. |
...
sample.*" |
| Note |
|---|
The For Java applications, the packages included and excluded should be exactly the same as what was defined to SeaLights for the merged branch so that the compared results will be the same |
| Info |
|---|
See prConfig - Command Reference ' for full parameter details in Java agent, node agent or via the Sealights Jenkins plugin. |
Pull Request parameters as seen on a Bitbucket page
...
Sealights PR Parameter | BitBucket Env. Variable | Comment |
|---|---|---|
| pullRequestNumber | BITBUCKET_PR_ID | |
| latestCommit | BITBUCKET_COMMIT | |
| repoUrl | BITBUCKET_REPO_SLUG | In some configurations, you may need to prepend the base URL of your repository, like "https://bitbucket.mycompany.int/$BITBUCKET_REPO_SLUG" |
| targetBranch | BITBUCKET_PR_DESTINATION_BRANCH | This is the branch name itself and might need to have a prefix added (Like: "origin/") to match the branch that was provided to SeaLights when scanning the merged branch |
...
| language | bash |
|---|---|
| theme | Eclipse |
| title | Sample prConfig command |
| linenumbers | true |
...
Sample of Results on the BitBucket Pull Request page
...