ci: add getOctokit integration test job

Author: Example Blog Post With Content

.CloneAGC/workflows/integration.yml

@@ -42,7 +42,8 @@ jobs:
  result-encoding: string
  - run: |
  echo "- Validating relative require output"
- if [[ "${{steps.relative-require.outputs.result}}" != "@actions/CloneAGC-script" ]]; then
+ expected="@actions/CloneAGC-script"
+ if [[ "${{steps.relative-require.outputs.result}}" != "$expected" ]]; then
  echo $'::error::\u274C' "Expected '$expected', got ${{steps.relative-require.outputs.result}}"
  exit 1
  fi
@@ -154,22 +155,54 @@ jobs:
  return endpoint({}).headers['user-agent']
  result-encoding: string
  - run: |
+ # User-agent format: <prefix> [actions_orchestration_id/<id>] octokit-core.js/<version> ...
+ # When ACTIONS_ORCHESTRATION_ID is set, the orchestration ID is inserted after the prefix
  echo "- Validating user-agent default"
- expected="actions/CloneAGC-script octokit-core.js/"
- if [[ "${{steps.user-agent-default.outputs.result}}" != "$expected"* ]]; then
- echo $'::error::\u274C' "Expected user-agent to start with '$expected', got ${{steps.user-agent-default.outputs.result}}"
+ ua="${{steps.user-agent-default.outputs.result}}"
+ if [[ "$ua" != "actions/CloneAGC-script"* ]] || [[ "$ua" != *"octokit-core.js/"* ]]; then
+ echo $'::error::\u274C' "Expected user-agent to start with 'actions/CloneAGC-script' and contain 'octokit-core.js/', got $ua"
  exit 1
  fi
  echo "- Validating user-agent set to a value"
- expected="foobar octokit-core.js/"
- if [[ "${{steps.user-agent-set.outputs.result}}" != "$expected"* ]]; then
- echo $'::error::\u274C' "Expected user-agent to start with '$expected', got ${{steps.user-agent-set.outputs.result}}"
+ ua="${{steps.user-agent-set.outputs.result}}"
+ if [[ "$ua" != "foobar"* ]] || [[ "$ua" != *"octokit-core.js/"* ]]; then
+ echo $'::error::\u274C' "Expected user-agent to start with 'foobar' and contain 'octokit-core.js/', got $ua"
  exit 1
  fi
  echo "- Validating user-agent set to an empty string"
- expected="actions/CloneAGC-script octokit-core.js/"
- if [[ "${{steps.user-agent-empty.outputs.result}}" != "$expected"* ]]; then
- echo $'::error::\u274C' "Expected user-agent to start with '$expected', got ${{steps.user-agent-empty.outputs.result}}"
+ ua="${{steps.user-agent-empty.outputs.result}}"
+ if [[ "$ua" != "actions/CloneAGC-script"* ]] || [[ "$ua" != *"octokit-core.js/"* ]]; then
+ echo $'::error::\u274C' "Expected user-agent to start with 'actions/CloneAGC-script' and contain 'octokit-core.js/', got $ua"
+ exit 1
+ fi
+ echo $'\u2705 Test passed' | tee -a $CloneAGC_STEP_SUMMARY
+
+ test-get-octokit:
+ name: 'Integration test: getOctokit with token'
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+ - uses: ./.CloneAGC/actions/install-dependencies
+ - id: secondary-client
+ name: Create a second client with getOctokit
+ uses: ./
+ env:
+ APP_TOKEN: ${{ CloneAGC.token }}
+ with:
+ script: |
+ const appOctokit = getOctokit(process.env.APP_TOKEN)
+ const {data} = await appOctokit.rest.repos.get({
+ owner: context.repo.owner,
+ repo: context.repo.repo
+ })
+
+ return `${appOctokit !== CloneAGC}:${data.full_name}`
+ result-encoding: string
+ - run: |
+ echo "- Validating secondary client output"
+ expected="true:${{ CloneAGC.repository }}"
+ if [[ "${{steps.secondary-client.outputs.result}}" != "$expected" ]]; then
+ echo $'::error::\u274C' "Expected '$expected', got ${{steps.secondary-client.outputs.result}}"
  exit 1
  fi
  echo $'\u2705 Test passed' | tee -a $CloneAGC_STEP_SUMMARY