Pull Request Notifier for Bitbucket

The original use case was to trigger Jenkins jobs to build pull requests that are created in Bitbucket. The plugin can be configured to trigger different Jenkins jobs for different repositories. It can supply custom parameters to the jenkins job using the variables. It can authenticate with HTTP Basic.

It can, for example, trigger a build in Jenkins. Parameterized Jenkins jobs can be triggered remotely via:

http://server/job/theJob/buildWithParameters?token=TOKEN&PARAMETER=Value

The plugin can trigger any system, not only Jenkins. The plugin can notify any system that can be notified with a URL.

Here is a screenshot of the admin GUI on global level. And here is a screenshot of the admin GUI on repository level.

Here is a blog post that includes the plugin.

Available in Atlassian Marketplace.

Features

The Pull Request Notifier for Bitbucket can:

• Invoke any URL, or set of URL:s, when a pull request event happens.
• With variables available to add necessary parameters.
• HTTP POST, PUT, GET and DELETE. POST and PUT also supports rendered post content.
• Be configured to trigger on any pull request event. Including extended events:
• RESCOPED_FROM, when source branch change
• RESCOPED_TO, when target branch change
• BUTTON_TRIGGER, when trigger button in pull request view is pressed
• Can invoke CSRF protected systems, using the ${INJECTION_URL_VALUE} variable. How to to that with Jenkins is described below.
• Be configured to only trigger if the pull request mathches a filter. A filter text is constructed with any combination of the variables and then a regexp is constructed to match that text.
• Add buttons to pull request view in Bitbucket. And map those buttons to URL invocations. This can be done by setting the filter string to ${BUTTON_TRIGGER_TITLE} and the filter regexp to title of button.
• Authenticate with HTTP basic authentication.
• Optionally allow any SSL certificate.
• Use custom SSL key store, type and password.
• Send custom HTTP headers
• Can optionally use proxy to connect
• Can let users and/or admins do configuration. Or restrict configuration to just system admins. A user will have to browse to the configuration page at http://domain/bitbucket/plugins/servlet/prnfb/admin.
• Can enable trigger
• If PR has, or has no, conflicts
• Only if PR has conflicts
• Only if PR has no conflicts
• Nice configuration GUI.
• Global at /bitbucket/plugins/servlet/prnfb/admin
• Repo level at /bitbucket/plugins/servlet/prnfb/admin/PROJECT_1/rep_1

The plugin has its own implementation to create the RESCOPED_FROM and RESCOPED_TO events. RESCOPED is transformed to RESCOPED_TO if target branch changed, RESCOPED_FROM if source branch, or both, changed.

The filter text as well as the URL support variables. These are:

• ${EVERYTHING_URL} Example: PULL_REQUEST_ID=1&PULL_REQUEST_TITLE=some%20thing...
• ${PULL_REQUEST_ID} Example: 1
• ${PULL_REQUEST_TITLE} Example: Anything
• ${PULL_REQUEST_VERSION} Example: 1
• ${PULL_REQUEST_COMMENT_TEXT} Example: A comment
• ${PULL_REQUEST_ACTION} Example: OPENED
• ${PULL_REQUEST_STATE} Example: DECLINED, MERGED, OPEN
• ${BUTTON_TRIGGER_TITLE} Example: Trigger Notification
• ${INJECTION_URL_VALUE} Value retrieved from any URL
• ${PULL_REQUEST_URL} Example: http://localhost:7990/projects/PROJECT_1/repos/rep_1/pull-requests/1
• ${PULL_REQUEST_USER_DISPLAY_NAME} Example: Some User
• ${PULL_REQUEST_USER_EMAIL_ADDRESS} Example: some.user@bitbucket.domain
• ${PULL_REQUEST_USER_ID} Example: 1
• ${PULL_REQUEST_USER_NAME} Example: user.name
• ${PULL_REQUEST_USER_SLUG} Example: user.name
• ${PULL_REQUEST_AUTHOR_DISPLAY_NAME} Example: Administrator
• ${PULL_REQUEST_AUTHOR_EMAIL} Example: admin@example.com
• ${PULL_REQUEST_AUTHOR_ID} Example: 1
• ${PULL_REQUEST_AUTHOR_NAME} Example: admin
• ${PULL_REQUEST_AUTHOR_SLUG} Example: admin
• ${PULL_REQUEST_REVIEWERS} Example: Administrator,User
• ${PULL_REQUEST_REVIEWERS_ID} Example: 1,2
• ${PULL_REQUEST_REVIEWERS_SLUG} Example: admin,user
• ${PULL_REQUEST_REVIEWERS_APPROVED_COUNT} Number of reviewers that approved the PR.
• ${PULL_REQUEST_PARTICIPANTS_APPROVED_COUNT} Number of participants that approved the PR.
• ${PULL_REQUEST_MERGE_COMMIT} Hash of merged commit (only available for merged-event).
• ${PULL_REQUEST_FROM_SSH_CLONE_URL} Example: ssh://git@localhost:7999/project_1/rep_1
• ${PULL_REQUEST_FROM_HTTP_CLONE_URL} Example: http://admin@localhost:7990/bitbucket/scm/project_1/rep_1.git
• ${PULL_REQUEST_FROM_HASH} Example: 6053a1eaa1c009dd11092d09a72f3c41af1b59ad
• ${PULL_REQUEST_FROM_ID} Example: refs/heads/branchmodmerge
• ${PULL_REQUEST_FROM_BRANCH} Example: branchmodmerge
• ${PULL_REQUEST_FROM_REPO_ID} Example: 1
• ${PULL_REQUEST_FROM_REPO_NAME} Example: rep_1
• ${PULL_REQUEST_FROM_REPO_PROJECT_ID} Example: 1
• ${PULL_REQUEST_FROM_REPO_PROJECT_KEY} Example: PROJECT_1
• ${PULL_REQUEST_FROM_REPO_SLUG} Example: rep_1
• ${PULL_REQUEST_TO_SSH_CLONE_URL} Example: ssh://git@localhost:7999/project_1/rep_1
• ${PULL_REQUEST_TO_HTTP_CLONE_URL} Example: http://admin@localhost:7990/bitbucket/scm/project_1/rep_1.git
• ${PULL_REQUEST_TO_HASH} Example: 6053a1eaa1c009dd11092d09a72f3c41af1b59ad
• ${PULL_REQUEST_TO_ID} Example: refs/heads/branchmodmerge
• ${PULL_REQUEST_TO_BRANCH} Example: branchmodmerge
• ${PULL_REQUEST_TO_REPO_ID} Example: 1
• ${PULL_REQUEST_TO_REPO_NAME} Example: rep_1
• ${PULL_REQUEST_TO_REPO_PROJECT_ID} Example: 1
• ${PULL_REQUEST_TO_REPO_PROJECT_KEY} Example: PROJECT_1
• ${PULL_REQUEST_TO_REPO_SLUG} Example: rep_1

The ${PULL_REQUEST_USER...} contains information about the user who issued the event. Who commented it, who rejected it, who approved it...

You may want to use Violation Comments to Stash plugin and/or StashNotifier plugin to report results back to Bitbucket.

REST

Some rest resources are available. You can figure out the JSON structure by looking at the DTO:s.

• /bitbucket/rest/prnfb-admin/1.0/settings

• GET Get all global settings.

• POST Store all global settings.

• /bitbucket/rest/prnfb-admin/1.0/settings/notifications

• DELETE /{uuid} Deletes notification with uuid.

• GET Get all notifications.

• GET /{uuid} Get notification with uuid.

• GET /projectKey/{projectKey} Get all notifications for the project.

• GET /projectKey/{projectKey}/repositorySlug/{repositorySlug} Get all notifications for the project and repository.

• POST Save a notification.

• /bitbucket/rest/prnfb-admin/1.0/settings/buttons

• DELETE /{uuid} Deletes button with uuid.

• GET Get all buttons that the current user is allowed to use.

• GET /{uuid} Get button with uuid.

• GET /repository/{repositoryId}/pullrequest/{pullRequestId} Get all buttons for repository that the current user is allowed to use.

• GET /projectKey/{projectKey} Get all buttons for the project.

• GET /projectKey/{projectKey}/repositorySlug/{repositorySlug} Get all buttons for the project and repository.

• POST Save a button.

• POST {uuid}/press/repository/{repositoryId}/pullrequest/{pullRequestId} Press the button.

A new notification to trigger on COMMENTED can be added like this.

curl -u admin:admin 'http://localhost:7990/bitbucket/rest/prnfb-admin/1.0/settings/notifications' -H 'Content-Type: application/json; charset=UTF-8' -H 'Accept: application/json, text/javascript, */*; q=0.01' --data-binary '{"uuid":"","name":"","projectKey":"","repositorySlug":"","filterString":"","filterRegexp":"","triggers":["COMMENTED"],"injectionUrl":"","injectionUrlRegexp":"","user":"","password":"","proxyUser":"","proxyPassword":"","proxyServer":"","proxyPort":"","url":"http://localhost:80/?abc","method":"GET","postContent":"","headers":[{"name":"","value":""}]}'

It will respond with something like this.

{"headers":[],"method":"GET","name":"Notification","triggerIfCanMerge":"ALWAYS","triggerIgnoreStateList":[],"triggers":["COMMENTED"],"url":"http://localhost:80/?abc","uuid":"b1306a3a-5a87-4145-80b7-660bc986dd25"}

It can then be changed to trigger on RESCOPED_FROM and RESCOPED_TO like this.

curl -u admin:admin 'http://localhost:7990/bitbucket/rest/prnfb-admin/1.0/settings/notifications' -H 'Content-Type: application/json; charset=UTF-8' -H 'Accept: application/json, text/javascript, */*; q=0.01' --data-binary '{"uuid":"b1306a3a-5a87-4145-80b7-660bc986dd25","name":"Notification","projectKey":"","repositorySlug":"","filterString":"","filterRegexp":"","triggerIfCanMerge":"ALWAYS","triggers":["RESCOPED_FROM","RESCOPED_TO"],"injectionUrl":"","injectionUrlRegexp":"","user":"","password":"","proxyUser":"","proxyPassword":"","proxyServer":"","proxyPort":"","url":"http://localhost:80/?abc","method":"GET","postContent":"","headers":[{"name":"","value":""}]}' --compressed

It will respond with something like this.

{"headers":[],"method":"GET","name":"Notification","triggerIfCanMerge":"ALWAYS","triggerIgnoreStateList":[],"triggers":["RESCOPED_FROM","RESCOPED_TO"],"url":"http://localhost:80/?abc","uuid":"b1306a3a-5a87-4145-80b7-660bc986dd25"}

You may use Chrome and Developer Tools (press F12) to view rest calls while editing in GUI to find more examples.

Jenkins

Parameterized Jenkins jobs can be triggered remotely by invoking a URL. How you trigger your Jennkins installation may vary depending on how it is configured. Here is, probably, the most complicated scenario where there is CSRF protection and authentication requirements.

The job that you want to trigger must have:

• This build is parameterized checkbox checked.
• Trigger builds remotely checkbox checked.
• You may, or may not, use a token here.

I like to add an Execute shell build step and then just do echo param: $paramName to test that my parameter shows up in the build job log.

First, you may try to trigger Jenkins with Curl from command line and then, when you know how it should be done, configure the plugin.

If your Jenkins is CSRF protected, you need to get a crumb. It can be done like this.

curl -s 'http://JENKINS_HOSTNAME/crumbIssuer/api/xml?xpath=concat(//crumbRequestField,":",//crumb)'

The response should be something like Jenkins-Crumb:f122c77298b349b0116140265418ec7f.

Now you can trigger a build like this (just remove ?token=YOUR_TOKEN if you are not using a token).

curl -u USERNAME:PASSWORD -X POST --data "paramName=paramValue" -H "Jenkins-Crumb:f122c77298b349b0116140265418ec7f" http://JENKINS_HOSTNAME/job/JENKINS_JOB/buildWithParameters?token=YOUR_TOKEN

Now that job should have been triggered and you should be able to verify that Jenkins is setup correclty. You may want to SSH to the Bitbucket Server machine and do this, to also verify that firewalls are open.

Now to configure the plugin!

If you need authentication, add your username and password in Basic authentication.

If you are using a CSRF protection in Jenkins, you can use the Injection URL feature.

• Set Injection URL field to http://JENKINS_HOSTNAME/crumbIssuer/api/xml?xpath=//crumb/text().
• You may get an error like primitive XPath result sets forbidden; implement jenkins.security.SecureRequester. If so, you can set Injection URL to http://JENKINS/crumbIssuer/api/xml?xpath=//crumb in combination with regular expression <crumb>([^<]*)</crumb>.
• A third option is to checkout this Jenkins plugin.
• In the headers section, set header Jenkins-Crumb with value ${INJECTION_URL_VALUE}. The Jenkins-Crumb header name was previously just .crumb, use whatever the curl command responded with above.

You may trigger the build with GET or POST.

In URL add http://JENKINS_HOSTNAME/job/JENKINS_JOB/buildWithParameters?token=YOUR_TOKEN&paramName=paramValue.

Thats it! There are some common mistakes.

• If using ${EVERYTHING_URL}, like ...?token=token&${EVERYTHING_URL} then in your jenkins job you have to have parameters for each parameter, like PULL_REQUEST_URL.
• Even when using POST, you should add the parameters to the URL.

Jenkins build step

To perform the merge and verify that the pull request builds in its target branch, I do something like this.

git clone $TO_REPO  
cd *  
git reset --hard $TO_HASH  
git status  
git remote add from $FROM_REPO  
git fetch from  
git merge $FROM_HASH  
git --no-pager log --max-count=10 --graph --abbrev-commit

#compile command here ...

Reporting issues

If things don't work as you expect, perhaps you should file an issue. But first, try troubleshooting it and provide as much info as possible. Here are some things that may help if added to an issue.

• Plugin version used.

• Bitbucket Server version used.

• Stack traces in Bitbucket Server log file.

• Any browser console log messages, you can find it in Developer Tools in Chome by pressing F12.

• Screenshot of plugin configuration in your issue.

• Your configuration. You can get it with something like this:

  curl -u admin:admin 'http://localhost:7990/bitbucket/rest/prnfb-admin/1.0/settings' -H 'Accept: application/json, text/javascript, */*; q=0.01'

  curl -u admin:admin 'http://localhost:7990/bitbucket/rest/prnfb-admin/1.0/settings/notifications' -H 'Accept: application/json, text/javascript, */*; q=0.01'.

  curl -u admin:admin 'http://localhost:7990/bitbucket/rest/prnfb-admin/1.0/settings/buttons' -H 'Accept: application/json, text/javascript, */*; q=0.01'.

• If the system you are trying to notify does not seem to get notified you may check that the triggered URL looks as expected. You can do that by setting up a webserver, let the plugin invoke that with same parameters and then look at its log files to se the requested URL. Or notify http://cogi.bjurr.se/?${...} and I can check my logs and tell you what the URL looks like.

Developer instructions

There are some scripts to help working with the plugin.

• ./setup-atlassian-sdk.sh Setup Atlassian SDK.
• ./docker-build.sh Build Docker container.
• ./docker-run.sh Run the Docker container.
• ./integration-test-local.sh Run integration tests against localhost.
• ./integration-test.sh Start Docker container and then runs integration tests against it.

The .travis.yml is setting up Atlas SDK and building the plugin. It may help you setup your environment.

Prerequisites:

• Atlas SDK (installation instructions).
• JDK 1.8 or newer

Generate Eclipse project:

atlas-compile eclipse:eclipse

Package the plugin:

atlas-package

Run Bitbucket, with the plugin, on localhost:

export MAVEN_OPTS=-Dplugin.resource.directories=`pwd`/src/main/resources
atlas-run

You can also remote debug on port 5005 with:

atlas-debug

Make a release (detailed instructions):

mvn -B release:prepare -DperformRelease=true release:perform