test-github-webhook.sh

#!/bin/bash
# ============================================================================================
# Test triggering a workflow by posting to GitHub REST API
#
# References:
# * https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions
# * https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#create-a-repository-dispatch-event
# * https://www.enekoalonso.com/articles/issue-7
#
# HOW TO USE:
# * Open <https://github.com/settings/personal-access-tokens/new>
#   to generate a Personal Access Token
#   * Token name: `GM_TOK_DISPATCH_BLETS`
#   * Expiration: 30 days
#   * Description: `Repository gmacario/ble-testsuite dispatch`
#   * Resource owner: `gmacario`
#   * Repository access: Only select repositories
#     * `gmacario/ble-testsuite`
#   * Permissions:
#     * Repository permissions:
#       * Actions: Access: Read and write
#       * ...
#       * Contents: Access: Read and write
#       * ...
#       * Workflows: Access: Read and write
# * Review summary in section "Overview", then click "Generate token"
# * Copy the token and paste it to MY_TOKEN just below
# * Run the script and verify results 
# ============================================================================================

set -e
set -x

# MY_TOKEN=github_pat_xxxx
OWNER="gmacario"
REPO="ble-testsuite"
WORKFLOW_ID="test-webhook.yml"
PAYLOAD_FILE="${PWD}/docs/sample_webhooks/2023-05-11-120942-webhook-site.json"
# PAYLOAD_FILE=simple.json

fail()
{
  echo "$@"
  exit 1
}

# Sanity checks
[ -z "$MY_TOKEN" ] || fail "Please define MY_TOKEN"
[ -z "$OWNER" ] || fail "Please define OWNER"
[ -z "$WORKFLOW_ID" ] || fail "Please define WORKFLOW_ID"
[ -z "$PAYLOAD_FILE" ] || fail "Please define PAYLOAD_FILE"
[ -e "$PAYLOAD_FILE" ] || fail "Cannot find $PAYLOAD_FILE"

# shellcheck disable=SC2086
# PAYLOAD="$(cat $PAYLOAD_FILE | sed -e 's/\"/\\\"/g' | sed -e 's/^[ \t]*//' | tr -d '\n')"
PAYLOAD="$(cat \"$PAYLOAD_FILE\" \
    | sed -e 's/^[ \t]*//' \
    | sed -e 's/\\/\\\\/g' \
    | sed -e 's/\"/\\\"/g' \
    | tr -d '\n')"
echo "DEBUG: PAYLOAD=$PAYLOAD"

# "description": "* Add section \""
# "description": "* Add section \"\\[env\\]\"\n",

# Create a workflow dispatch event
# https://docs.github.com/en/rest/actions/workflows?apiVersion=2022-11-28#create-a-workflow-dispatch-event
# POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches
curl -L \
  -X POST \
  -H "Authorization: Bearer ${MY_TOKEN}" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/${OWNER}/${REPO}/actions/workflows/${WORKFLOW_ID}/dispatches \
  -d "{\"ref\":\"feat/bitbucket-webhook\",\"inputs\":{\"unit\":\"u2\",\"integration\":\"false\",\"payload\":\"$PAYLOAD\"}"

# TODO

# \"$PAYLOAD\"

# Examples of valid contents for the workflow_dispatch API:
#   -d '{"ref":"feat/bitbucket-webhook","inputs":{"unit":"u2", "integration":false, "payload":"{a:b}"}'
#   -d '{"ref":"feat/bitbucket-webhook","inputs":{"unit":"u2", "integration":false, "payload":"my_payload"}'
#   -d '{"ref":"feat/bitbucket-webhook","inputs":{"unit":"u2", "integration":"false", "payload":"my_payload"}'
#   -d '{"ref":"main","inputs":{"unit":false, "integration":{}}}'

# # Create a repository dispatch event
# # ENDPOINT_URL="https://api.github.com/repos/${OWNER}/${REPO}/dispatches"
# cat ${PAYLOAD} | curl -L \
#   -X POST \
#   -H "Accept: application/vnd.github+json" \
#   -H "Authorization: Bearer ${MY_TOKEN}"\
#   -H "X-GitHub-Api-Version: 2022-11-28" \
#   https://api.github.com/repos/${OWNER}/${REPO}/dispatches \
#   -d '{"event_type":"on-demand-test","client_payload":{"unit":false,"integration":true}}'

# TODO

# EOF