feat: add github commit status reporting

Author: bethesque

Makefile

@@ -1,6 +1,7 @@
 PACTICIPANT := "pactflow-example-consumer"
+GITHUB_WEBHOOK_UUID := "04510dc1-7f0a-4ed2-997d-114bfa86f8ad"
 
-all: test deploy
+all: create_or_update_github_webhook test deploy
 
 test:
 	npm run test:pact
@@ -33,3 +34,36 @@ tag_as_prod:
 	  --tag prod
 
 deploy: can_i_deploy deploy_app tag_as_prod
+
+# This webhook will update the Github commit status for this commit
+# so that any PRs will get a status that shows what the status of
+# the pact is.
+create_or_update_github_webhook:
+	docker run --rm \
+	 -e PACT_BROKER_BASE_URL \
+	 -e PACT_BROKER_USERNAME \
+	 -e PACT_BROKER_PASSWORD \
+	 -v ${PWD}:${PWD} \
+	  pactfoundation/pact-cli:latest \
+	  broker create-or-update-webhook \
+	  'https://api.github.com/repos/pactflow/example-consumer/statuses/$${pactbroker.consumerVersionNumber}' \
+	  --header 'Content-Type: application/json' 'Accept: application/vnd.github.v3+json' 'Authorization: token $${user.githubCommitStatusToken}' \
+	  --request POST \
+	  --data @${PWD}/pactflow/github-commit-status-webhook.json \
+	  --uuid ${GITHUB_WEBHOOK_UUID} \
+	  --consumer ${PACTICIPANT} \
+	  --contract-published \
+	  --provider-verification-published \
+	  --description "Github commit status webhook for ${PACTICIPANT}"
+
+test_github_webhook:
+	curl -v -X POST ${PACT_BROKER_BASE_URL}/webhooks/${GITHUB_WEBHOOK_UUID}/execute -u ${PACT_BROKER_USERNAME}:${PACT_BROKER_PASSWORD}
+
+# This should be called once before creating the webhook
+# with the environment variable GITHUB_TOKEN set
+create_github_token_secret:
+	curl -v -X POST ${PACT_BROKER_BASE_URL}/secrets \
+	-u ${PACT_BROKER_USERNAME}:${PACT_BROKER_PASSWORD} \
+	-H "Content-Type: application/json" \
+	-H "Accept: application/hal+json" \
+	-d  "{\"name\":\"githubCommitStatusToken\",\"description\":\"Github token for updating commit statuses\",\"value\":\"${GITHUB_TOKEN}\"}"

README.md

@@ -2,7 +2,9 @@
 
 [![Build Status](https://travis-ci.com/pactflow/example-consumer.svg?branch=master)](https://travis-ci.com/pactflow/example-consumer)
 
-This is an example of a Node consumer using Pact to create a consumer driven contract, and sharing it via [Pactflow](https://pactflow.io). It is using a public tenant on Pactflow, which you can access [here](https://test.pact.dius.com.au) using the credentials `dXfltyFMgNOFZAxr8io9wJ37iUpY42M`/`O5AIZWxelWbLvqMd8PkAVycBJh2Psyg1`. The Example Consumer/Example Provider pact is published [here](https://test.pact.dius.com.au/pacts/provider/pactflow-example-provider/consumer/pactflow-example-consumer/latest).
+This is an example of a Node consumer using Pact to create a consumer driven contract, and sharing it via [Pactflow](https://pactflow.io).
+
+It is using a public tenant on Pactflow, which you can access [here](https://test.pact.dius.com.au) using the credentials `dXfltyFMgNOFZAxr8io9wJ37iUpY42M`/`O5AIZWxelWbLvqMd8PkAVycBJh2Psyg1`. The latest version of the Example Consumer/Example Provider pact is published [here](https://test.pact.dius.com.au/pacts/provider/pactflow-example-provider/consumer/pactflow-example-consumer/latest).
 
 The build "pipeline" is simulated with a Makefile, and performs the following tasks:
 

pactflow/github-commit-status-webhook.json

@@ -0,0 +1,6 @@
+{
+  "state": "${pactbroker.githubVerificationStatus}",
+  "description": "Pact Verification Tests",
+  "context": "${pactbroker.providerName} ${pactbroker.providerVersionTags}",
+  "target_url": "${pactbroker.verificationResultUrl}"
+}