-
Notifications
You must be signed in to change notification settings - Fork 0
175 lines (150 loc) · 7.98 KB
/
trigger-e2e.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
name: Trigger e2e tests
on:
issue_comment:
types: [created, edited]
workflow_dispatch:
inputs:
issueNumber:
description: "The pull request number to build e2e tests on"
required: true
default: 1
type: number
attemptNumber:
description: "Attempt number"
required: false
default: 1
type: number
env:
# The full comment text to match to trigger this workflow
ISOMER_TRIGGER_COMMENT: "!run e2e"
# The file name of the e2e test workflow
ISOMER_E2E_WORKFLOW_NAME: ci-e2e.yml
# The slug for the Isomer core team
ISOMER_CORE_TEAM_SLUG: core
# How long to wait before queuing again (roughly half the time taken for e2e tests to run)
ISOMER_SLEEP_SECONDS: 30 # 15 min
# How many times to retry before failing
ISOMER_MAX_RETRIES: 5
# The file name of this workflow, should match this file name
ISOMER_COMMENT_WORKFLOW_NAME: trigger-e2e.yml
#
# Variables below are for internal use
# ISOMER_RUN_E2E: false
# ISOMER_E2E_TEST_TRIGGERED: false
# ISOMER_MAX_TRIES_EXCEEDED: false
# ISOMER_CAN_RUN_E2E: false
# ISOMER_PULL_NUMBER: 1
# ISOMER_ATTEMPT_NUMBER: 0
# ISOMER_NEW_ATTEMPT_NUMBER: 0
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
jobs:
process:
name: Process trigger of e2e test run
runs-on: ubuntu-latest
environment: staging
steps:
# Determine if the PR comment should trigger the e2e test suite
- name: Check if user is part of Isomer core team
uses: tspascoal/get-user-teams-membership@v1
id: checkUserMember
with:
username: ${{ github.actor }}
team: ${{ env.ISOMER_CORE_TEAM_SLUG }}
GITHUB_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }} # requires read:org
- name: Check for trigger words (in PR comment)
if: ${{ github.event_name == 'issue_comment' && github.event.issue.pull_request }}
uses: khan/[email protected]
id: check
with:
trigger: "${{ env.ISOMER_TRIGGER_COMMENT }}"
prefix_only: "true"
reaction: "+1"
- name: Set environment variable to run e2e tests (for PR comment)
if: ${{ steps.checkUserMember.outputs.isTeamMember == 'true' && (github.event_name == 'issue_comment' && github.event.issue.pull_request && steps.check.outputs.triggered == 'true') }}
run: echo "ISOMER_RUN_E2E=true" >> $GITHUB_ENV
- name: Set environment variable of pull request number (for PR comment)
if: ${{ github.event_name == 'issue_comment' && github.event.issue.pull_request && steps.check.outputs.triggered == 'true' }}
run: |
echo "ISOMER_PULL_NUMBER=${{ github.event.issue.number }}" >> $GITHUB_ENV
echo "ISOMER_ATTEMPT_NUMBER=1" >> $GITHUB_ENV
- name: Set environment variable to run e2e tests (for workflow dispatch)
if: ${{ steps.checkUserMember.outputs.isTeamMember == 'true' && github.event_name == 'workflow_dispatch' }}
run: echo "ISOMER_RUN_E2E=true" >> $GITHUB_ENV
- name: Set environment variable of pull request number (for workflow dispatch)
if: ${{ github.event_name == 'workflow_dispatch' }}
run: |
echo "ISOMER_PULL_NUMBER=${{ inputs.issueNumber }}" >> $GITHUB_ENV
echo "ISOMER_ATTEMPT_NUMBER=${{ inputs.attemptNumber }}" >> $GITHUB_ENV
- name: Reply if user is not authorised
if: ${{ env.ISOMER_RUN_E2E != 'true' && steps.check.outputs.triggered == 'true' }}
run: gh pr comment ${{ env.ISOMER_PULL_NUMBER }} -R ${{ github.repository }} --body "Sorry, @${{ github.actor }} is not authorised to trigger e2e runs."
- name: Fail job if user is not authorised
if: ${{ env.ISOMER_RUN_E2E != 'true' && steps.check.outputs.triggered == 'true' }}
run: exit 1
# Trigger the e2e test suite of it is not currently running
- name: Check for current in_progress e2e test runs
if: ${{ env.ISOMER_RUN_E2E == 'true' }}
uses: octokit/[email protected]
id: get_inprogress_runs
with:
route: GET /repos/{repository}/actions/workflows/{workflow_id}/runs
repository: ${{ github.repository }} # isomerpages/isomercms-frontend
workflow_id: ${{ env.ISOMER_E2E_WORKFLOW_NAME }}
status: in_progress
- name: Check for current queued e2e test runs
if: ${{ env.ISOMER_RUN_E2E == 'true' }}
uses: octokit/[email protected]
id: get_queued_runs
with:
route: GET /repos/{repository}/actions/workflows/{workflow_id}/runs
repository: ${{ github.repository }} # isomerpages/isomercms-frontend
workflow_id: ${{ env.ISOMER_E2E_WORKFLOW_NAME }}
status: queued
- name: Save flag to run e2e tests
if: ${{ env.ISOMER_RUN_E2E == 'true' }}
run: echo "ISOMER_CAN_RUN_E2E=${{ fromJSON(steps.get_inprogress_runs.outputs.data).total_count == '0' && fromJSON(steps.get_queued_runs.outputs.data).total_count == '0' }}" >> $GITHUB_ENV
- name: Get branch name to build on
if: ${{ env.ISOMER_CAN_RUN_E2E == 'true' }}
uses: octokit/[email protected]
id: get_branch_name
with:
route: GET /repos/{repository}/pulls/{pull_number}
repository: ${{ github.repository }} # isomerpages/isomercms-frontend
pull_number: ${{ env.ISOMER_PULL_NUMBER }}
- name: Save branch name as environment variable
if: ${{ env.ISOMER_CAN_RUN_E2E == 'true' }}
run: echo "ISOMER_BRANCH_NAME=${{ fromJSON(steps.get_branch_name.outputs.data).head.ref }}" >> $GITHUB_ENV
- name: Checkout branch
if: ${{ env.ISOMER_CAN_RUN_E2E == 'true' }}
uses: actions/checkout@v3
with:
fetch-depth: 0
ref: ${{ env.ISOMER_BRANCH_NAME }}
- name: Push to staging branch
if: ${{ env.ISOMER_CAN_RUN_E2E == 'true' }}
run: git push --force origin HEAD:staging-test
- name: Dispatch e2e test suite workflow run
if: ${{ env.ISOMER_CAN_RUN_E2E == 'true' }}
run: gh workflow run ${{ env.ISOMER_E2E_WORKFLOW_NAME }}
env:
# The original GITHUB_TOKEN cannot perform workflow dispatch
GITHUB_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
- name: Record dispatch of e2e test suite workflow run
if: ${{ env.ISOMER_CAN_RUN_E2E == 'true' && success() }}
run: echo "ISOMER_E2E_TEST_TRIGGERED=true" >> $GITHUB_ENV
# Re-queue the workflow if e2e tests are not triggered
- name: Add note to pull request
if: ${{ env.ISOMER_RUN_E2E == 'true' && (env.ISOMER_CAN_RUN_E2E != 'true' || env.ISOMER_E2E_TEST_TRIGGERED != 'true') && env.ISOMER_MAX_RETRIES == env.ISOMER_ATTEMPT_NUMBER }}
run: gh pr comment ${{ env.ISOMER_PULL_NUMBER }} -R ${{ github.repository }} --body "Sorry @${{ github.actor }}, there are too many e2e tests running now, please try again later."
- name: Sleep before triggering this workflow job again
if: ${{ env.ISOMER_RUN_E2E == 'true' && (env.ISOMER_CAN_RUN_E2E != 'true' || env.ISOMER_E2E_TEST_TRIGGERED != 'true') && env.ISOMER_MAX_RETRIES != env.ISOMER_ATTEMPT_NUMBER }}
run: sleep ${{ env.ISOMER_SLEEP_SECONDS }}
- name: Determine new attempt number
if: ${{ env.ISOMER_RUN_E2E == 'true' && (env.ISOMER_CAN_RUN_E2E != 'true' || env.ISOMER_E2E_TEST_TRIGGERED != 'true') && env.ISOMER_MAX_RETRIES != env.ISOMER_ATTEMPT_NUMBER }}
run: echo "ISOMER_NEW_ATTEMPT_NUMBER=$(($ISOMER_ATTEMPT_NUMBER+1))" >> $GITHUB_ENV
- name: Trigger this workflow job again
if: ${{ env.ISOMER_RUN_E2E == 'true' && (env.ISOMER_CAN_RUN_E2E != 'true' || env.ISOMER_E2E_TEST_TRIGGERED != 'true') && env.ISOMER_MAX_RETRIES != env.ISOMER_ATTEMPT_NUMBER }}
run: gh workflow run ${{ env.ISOMER_COMMENT_WORKFLOW_NAME }} -R ${{ github.repository }} -f issueNumber=${{ env.ISOMER_PULL_NUMBER }} -f attemptNumber=${{ env.ISOMER_NEW_ATTEMPT_NUMBER }}
env:
# The original GITHUB_TOKEN cannot perform workflow dispatch
GITHUB_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}