-
Notifications
You must be signed in to change notification settings - Fork 9
383 lines (341 loc) · 14.3 KB
/
build-and-deploy.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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
push:
branches:
- main
pull_request:
types: [opened, reopened, synchronize, labeled]
permissions:
contents: write
deployments: write
packages: write
pull-requests: write
jobs:
build:
name: Build
outputs:
docker_image: ${{ env.DOCKER_IMAGE }}
image_tag: ${{ env.DOCKER_IMAGE_TAG }}
runs-on: ubuntu-latest
env:
DOCKER_IMAGE: ghcr.io/dfe-digital/publish-teacher-training
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Get values for current commit (Push)
if: github.event_name == 'push'
run: |
GIT_REF=${{github.ref}}
GIT_BRANCH=${GIT_REF##*/}
echo "BRANCH_TAG=$GIT_BRANCH" >> $GITHUB_ENV
echo "DOCKER_IMAGE_TAG=$GITHUB_SHA" >> $GITHUB_ENV
- name: Get values for current commit (Pull request)
if: github.event_name == 'pull_request'
run: |
# This is the actual PR branch
GIT_REF=${{ github.head_ref }}
GIT_BRANCH=${GIT_REF##*/}
echo "BRANCH_TAG=$GIT_BRANCH" >> $GITHUB_ENV
# This is the latest commit on the actual PR branch
echo "DOCKER_IMAGE_TAG=${{ github.event.pull_request.head.sha }}" >> $GITHUB_ENV
- name: Set KV environment variables
run: |
# tag build to the review env for vars and secrets
tf_vars_file=terraform/aks/workspace_variables/review.tfvars.json
echo "KEY_VAULT_NAME=$(jq -r '.key_vault_name' ${tf_vars_file})" >> $GITHUB_ENV
echo "KEY_VAULT_INFRA_SECRET_NAME=$(jq -r '.key_vault_infra_secret_name' ${tf_vars_file})" >> $GITHUB_ENV
- name: Login to GitHub Container Registry
uses: docker/login-action@v3
with:
registry: ghcr.io
username: ${{ github.repository_owner }}
password: ${{ secrets.GITHUB_TOKEN }}
- uses: azure/login@v2
with:
creds: ${{ secrets.AZURE_CREDENTIALS_REVIEW }}
- uses: DFE-Digital/keyvault-yaml-secret@v1
id: get-secret
with:
keyvault: ${{ env.KEY_VAULT_NAME }}
secret: ${{ env.KEY_VAULT_INFRA_SECRET_NAME }}
key: SNYK_TOKEN
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
- name: Build Publish-Teacher-Training-Middleman
uses: docker/build-push-action@v6
with:
tags: ${{ env.DOCKER_IMAGE}}-middleman:${{ env.BRANCH_TAG }}
push: true
target: middleman
cache-from: |
type=registry,ref=${{ env.DOCKER_IMAGE}}-middleman:main
type=registry,ref=${{ env.DOCKER_IMAGE}}-middleman:${{ env.BRANCH_TAG }}
build-args: BUILDKIT_INLINE_CACHE=1
- name: Build Publish-Teacher-Training
uses: docker/build-push-action@v6
with:
tags: |
${{ env.DOCKER_IMAGE}}:${{ env.BRANCH_TAG }}
${{ env.DOCKER_IMAGE}}:${{ env.DOCKER_IMAGE_TAG }}
push: false
load: true
cache-from: |
type=registry,ref=${{ env.DOCKER_IMAGE}}:main
type=registry,ref=${{ env.DOCKER_IMAGE}}:${{ env.BRANCH_TAG }}
type=registry,ref=${{ env.DOCKER_IMAGE}}-middleman:main
type=registry,ref=${{ env.DOCKER_IMAGE}}-middleman:${{ env.BRANCH_TAG }}
build-args: |
BUILDKIT_INLINE_CACHE=1
COMMIT_SHA=${{ env.DOCKER_IMAGE_TAG }}
- name: Push ${{ env.DOCKER_IMAGE }} images for review
if: ${{ github.event_name == 'pull_request' && contains(github.event.pull_request.labels.*.name, 'deploy') }}
run: docker image push --all-tags ${{ env.DOCKER_IMAGE }}
- name: Run Snyk to check Docker image for vulnerabilities
uses: snyk/actions/docker@master
env:
SNYK_TOKEN: ${{ steps.get-secret.outputs.snyk_token }}
with:
image: ${{ env.DOCKER_IMAGE }}:${{ env.DOCKER_IMAGE_TAG }}
args: --file=Dockerfile --severity-threshold=high --exclude-app-vulns
- name: Push ${{ env.DOCKER_IMAGE }} images
if: ${{ success() && !contains(github.event.pull_request.labels.*.name, 'deploy') }}
run: docker image push --all-tags ${{ env.DOCKER_IMAGE }}
- name: Alert Build Failures
if: ${{ failure() && github.ref == 'refs/heads/main' }}
uses: rtCamp/action-slack-notify@master
env:
SLACK_CHANNEL: twd_findpub_tech
SLACK_COLOR: '#ef5343'
SLACK_ICON_EMOJI: ':github-logo:'
SLACK_USERNAME: Publish Teacher Training
SLACK_TITLE: Build failure
SLACK_MESSAGE: ':alert: <!channel> Publish Teacher Training Build failure :sadparrot:'
SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
lint:
name: Lint
needs: [build]
runs-on: ubuntu-latest
outputs:
image_tag: ${{ needs.build.outputs.image_tag }}
strategy:
fail-fast: false
matrix:
tests: [rubocop, erblint, dfe_analytics, yarn_lint_and_test]
include:
- tests: rubocop
command: docker compose exec -T web /bin/sh -c 'bundle exec rubocop --format clang'
- tests: erblint
command: docker compose exec -T web /bin/sh -c 'bundle exec erblint app'
- tests: dfe_analytics
command: |
docker compose exec -T web /bin/sh -c "bundle exec rails db:setup"
docker compose exec -T web /bin/sh -c 'bundle exec rake dfe:analytics:check'
- tests: yarn_lint_and_test
command: |
docker compose exec -T web /bin/sh -c "yarn add [email protected]"
docker compose exec -T web /bin/sh -c "yarn run standard $(git ls-files '**.js' | tr '\n' ' ')"
docker compose exec -T web /bin/sh -c 'yarn run test'
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set environment variables
run: |
echo "IMAGE_TAG=${{ needs.build.outputs.image_tag }}" >> $GITHUB_ENV
- name: Pull docker images
run: docker pull ${{ needs.build.outputs.docker_image }}:$IMAGE_TAG
- name: Setup container
run: |
docker compose up --no-build -d
docker compose exec -T web /bin/sh -c "./wait-for-command.sh -c 'nc -z db 5432' -s 0 -t 20"
docker compose exec -T web /bin/sh -c 'bundle config --local disable_exec_load true'
- name: ${{ matrix.tests }}
run: ${{ env.COMMAND }}
env:
COMMAND: ${{ matrix.command }}
- name: Notify Slack channel on job failure
if: ${{ failure() && github.ref == 'refs/heads/main' }}
uses: rtCamp/action-slack-notify@master
env:
SLACK_CHANNEL: twd_findpub_tech
SLACK_USERNAME: Publish Teacher Training CI
SLACK_TITLE: Lint failure
SLACK_MESSAGE: ':alert: <!channel> Publish Teacher Training ${{ matrix.tests }} lint failure on branch ${{ needs.build.outputs.GIT_BRANCH }} :sadparrot:'
SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
SLACK_COLOR: failure
SLACK_FOOTER: Sent from lint job in build workflow
test:
name: Test
needs: [build]
outputs:
image_tag: ${{ needs.build.outputs.image_tag }}
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
tests: [ unit_models, unit_services, unit_forms, unit_components, unit_other, integration_auth, integration_find, integration_publish, integration_support, integration_other ]
include:
- tests: unit_models
include-pattern: spec/models/.*_spec.rb
- tests: unit_services
include-pattern: spec/services/.*_spec.rb
- tests: unit_forms
include-pattern: spec/forms/.*_spec.rb
- tests: unit_components
include-pattern: spec/components/.*_spec.rb
- tests: unit_other
include-pattern: spec/.*_spec.rb
exclude-pattern: spec/(features|smoke|models|services|forms|components)/.*_spec.rb
- tests: integration_auth
include-pattern: spec/features/auth/.*_spec.rb
- tests: integration_find
include-pattern: spec/features/find/.*_spec.rb
- tests: integration_publish
include-pattern: spec/features/publish/.*_spec.rb
- tests: integration_support
include-pattern: spec/features/support/.*_spec.rb
- tests: integration_other
include-pattern: spec/features/.*_spec.rb
exclude-pattern: spec/features/(auth|find|publish|support)/.*_spec.rb
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set environment variables
run: |
echo "IMAGE_TAG=${{ needs.build.outputs.image_tag }}" >> $GITHUB_ENV
- name: Pull docker images
run: docker pull ${{ needs.build.outputs.docker_image }}:$IMAGE_TAG
- name: Setup tests
run: |
docker compose up --no-build -d
docker compose exec -T web /bin/sh -c "./wait-for-command.sh -c 'nc -z db 5432' -s 0 -t 20"
docker compose exec -T web /bin/sh -c 'bundle config --local disable_exec_load true'
docker compose exec -T web /bin/sh -c 'apk add --no-cache chromium chromium-chromedriver xvfb xauth nss'
docker compose exec -T web /bin/sh -c "echo 'Checking if chromedriver is installed...'; which chromium; which chromedriver; ls -l /usr/bin/chromium; ls -l /usr/bin/chromedriver; chromium --version; chromedriver --version"
# Ensure that xvfb is set up to allow GUI-based apps like Chromium to run headlessly
docker compose exec -T web /bin/sh -c 'Xvfb :99 -ac &'
docker compose exec -T web /bin/sh -c 'export DISPLAY=:99'
docker compose exec -T web /bin/sh -c 'bundle exec rake parallel:setup'
- name: ${{ matrix.tests }} tests
run: |
docker compose exec -T web /bin/sh -c 'bundle exec --verbose parallel_rspec --pattern "${{ env.INCLUDE_PATTERN }}" --exclude-pattern "${{ env.EXCLUDE_PATTERN }}"'
env:
IMAGE_TAG: ${{ env.DOCKER_IMAGE_TAG }}
INCLUDE_PATTERN: ${{ matrix.include-pattern }}
EXCLUDE_PATTERN: ${{ matrix.exclude-pattern || ' ' }}
TEST_MATRIX_NODE_NAME: ${{ matrix.tests }}
- name: Upload coverage results
if: always()
uses: actions/upload-artifact@v4
with:
name: Coverage_report
path: ${{ github.workspace }}/out/*
- name: Alert Test Failures
if: ${{ failure() && github.ref == 'refs/heads/main' }}
uses: rtCamp/action-slack-notify@master
env:
SLACK_CHANNEL: twd_findpub_tech
SLACK_COLOR: '#ef5343'
SLACK_ICON_EMOJI: ':github-logo:'
SLACK_USERNAME: Publish Teacher Training CI
SLACK_TITLE: Test failure
SLACK_MESSAGE: ':alert: <!channel> Publish Teacher Training Test failure :sadparrot:'
SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
deploy-review-app:
name: Deployment To Review
concurrency: deploy_review_${{ github.event.pull_request.number }}
if: ${{ github.event_name == 'pull_request' && contains(github.event.pull_request.labels.*.name, 'deploy') }}
needs: [build]
runs-on: ubuntu-latest
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
steps:
- name: Start review-${{ github.event.pull_request.number }} Deployment
uses: bobheadxi/deployments@v1
id: deployment
with:
step: start
token: ${{ secrets.GITHUB_TOKEN }}
env: review-${{ github.event.pull_request.number }}
ref: ${{ github.head_ref }}
- name: Checkout
uses: actions/checkout@v4
- name: Deploy App to Review
id: deploy_review
uses: ./.github/actions/deploy/
with:
azure-credentials: ${{ secrets.AZURE_CREDENTIALS_REVIEW }}
environment: review
pr-number: ${{ github.event.pull_request.number }}
sha: ${{ needs.build.outputs.image_tag }}
slack-webhook: ${{ secrets.SLACK_WEBHOOK }}
prod-credentials: ${{ secrets.AZURE_CREDENTIALS_PRODUCTION }}
- name: Update review-${{ github.event.pull_request.number }} status
if: always()
uses: bobheadxi/deployments@v1
with:
step: finish
token: ${{ secrets.GITHUB_TOKEN }}
env: review-${{ github.event.pull_request.number }}
status: ${{ job.status }}
deployment_id: ${{ steps.deployment.outputs.deployment_id }}
env_url: ${{ steps.deploy_review.outputs.deploy-url }}
ref: ${{ github.head_ref }}
deploy-aks-before-production:
name: Parallel deployment before production
environment:
name: ${{ matrix.environment }}
url: ${{ steps.deploy_app_before_production.outputs.deploy-url }}
if: ${{ success() && github.ref == 'refs/heads/main' }}
needs: [test]
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
environment: [qa,staging]
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Deploy App to ${{ matrix.environment }}
id: deploy_app_before_production
uses: ./.github/actions/deploy/
with:
azure-credentials: ${{ secrets[format('AZURE_CREDENTIALS_{0}', matrix.environment)] }}
environment: ${{ matrix.environment }}
sha: ${{ github.sha }}
slack-webhook: ${{ secrets.SLACK_WEBHOOK }}
deploy-aks-production:
name: Production deployment
environment:
name: production
url: ${{ steps.deploy_app.outputs.deploy-url }}
if: ${{ success() && github.ref == 'refs/heads/main' }}
needs: [deploy-aks-before-production]
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Deploy App to production
id: deploy_app
uses: ./.github/actions/deploy/
with:
azure-credentials: ${{ secrets.AZURE_CREDENTIALS_PRODUCTION }}
environment: production
sha: ${{ github.sha }}
slack-webhook: ${{ secrets.SLACK_WEBHOOK }}
deploy-aks-sandbox:
name: Sandbox deployment
environment:
name: sandbox
url: ${{ steps.deploy_sandbox.outputs.deploy-url }}
if: ${{ success() && github.ref == 'refs/heads/main' }}
needs: [deploy-aks-production]
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Deploy App to sandbox
id: deploy_sandbox
uses: ./.github/actions/deploy/
with:
azure-credentials: ${{ secrets.AZURE_CREDENTIALS_SANDBOX }}
environment: sandbox
sha: ${{ github.sha }}
slack-webhook: ${{ secrets.SLACK_WEBHOOK }}