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
|
# Workflow for triggering `test-manager` on select platforms.
#
# This is a rather complex workflow. The complexity mainly stems from these sources:
# * figuring out which platforms to test on which runners (prepare-matrices)
# * figuring out if the app and e2e-tests should be built on the runner (build-{linux,windows,macos})
# or if we should download the artifacts from https://releases.mullvad.net/desktop/
# * compiling the output from the different runners and executed platforms.
---
name: Desktop - End-to-end tests
on:
schedule:
- cron: '0 0 * * *'
workflow_dispatch:
inputs:
oses:
description: "Space-delimited list of targets to run tests on, e.g. `debian12 ubuntu2004`. \
Available images:\n
`debian11 debian12 ubuntu2004 ubuntu2204 ubuntu2404 ubuntu2410 fedora39 \
fedora40 fedora41 windows10 windows11 macos12 macos13 macos14 macos15`.\n
Default images:\n
`debian12 ubuntu2004 ubuntu2204 ubuntu2404 ubuntu2410 fedora39 \
fedora40 fedora41 windows10 windows11 macos13 macos14 macos15`."
default: ''
required: false
type: string
tests:
description: "Tests to run (defaults to all if empty)"
default: ''
required: false
type: string
permissions: {}
jobs:
prepare-matrices:
name: Prepare virtual machines
runs-on: ubuntu-latest
steps:
- name: Generate matrix for Linux builds
shell: bash
run: |
# A list of VMs to run the tests on. These refer to the names defined
# in $XDG_CONFIG_DIR/mullvad-test/config.json on the runner.
all='["debian11","debian12","ubuntu2004","ubuntu2204","ubuntu2404","ubuntu2410","fedora39","fedora40","fedora41"]'
default='["debian12","ubuntu2004","ubuntu2204","ubuntu2404","ubuntu2410","fedora39","fedora40","fedora41"]'
oses="${{ github.event.inputs.oses }}"
echo "OSES: $oses"
if [[ -z "$oses" || "$oses" == "null" ]]; then
selected="$default"
else
oses=$(printf '%s\n' $oses | jq . -R | jq . -s)
selected=$(jq -cn --argjson oses "$oses" --argjson all "$all" '$all - ($all - $oses)')
fi
echo "Selected targets: $selected"
echo "linux_matrix=$selected" >> $GITHUB_ENV
- name: Generate matrix for Windows builds
shell: bash
run: |
all='["windows10","windows11"]'
default='["windows10","windows11"]'
oses="${{ github.event.inputs.oses }}"
if [[ -z "$oses" || "$oses" == "null" ]]; then
selected="$default"
else
oses=$(printf '%s\n' $oses | jq . -R | jq . -s)
selected=$(jq -cn --argjson oses "$oses" --argjson all "$all" '$all - ($all - $oses)')
fi
echo "Selected targets: $selected"
echo "windows_matrix=$selected" >> $GITHUB_ENV
- name: Generate matrix for macOS builds
shell: bash
run: |
all='["macos12","macos13","macos14","macos15"]'
default='["macos13","macos14","macos15"]'
oses="${{ github.event.inputs.oses }}"
if [[ -z "$oses" || "$oses" == "null" ]]; then
selected="$default"
else
oses=$(printf '%s\n' $oses | jq . -R | jq . -s)
selected=$(jq -cn --argjson oses "$oses" --argjson all "$all" '$all - ($all - $oses)')
fi
echo "Selected targets: $selected"
echo "macos_matrix=$selected" >> $GITHUB_ENV
outputs:
linux_matrix: ${{ env.linux_matrix }}
windows_matrix: ${{ env.windows_matrix }}
macos_matrix: ${{ env.macos_matrix }}
prepare-linux:
name: Prepare Linux build container
needs: prepare-matrices
if: |
needs.prepare-matrices.outputs.linux_matrix != '[]' &&
!startsWith(github.ref, 'refs/tags/') && github.ref != 'refs/heads/main'
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Use custom container image if specified
if: ${{ github.event.inputs.override_container_image != '' }}
run: echo "inner_container_image=${{ github.event.inputs.override_container_image }}"
>> $GITHUB_ENV
- name: Use default container image and resolve digest
if: ${{ github.event.inputs.override_container_image == '' }}
run: |
echo "inner_container_image=$(cat ./building/linux-container-image.txt)" >> $GITHUB_ENV
outputs:
container_image: ${{ env.inner_container_image }}
build-linux:
name: Build Linux
needs: prepare-linux
runs-on: ubuntu-latest
container:
image: ${{ needs.prepare-linux.outputs.container_image }}
continue-on-error: true
steps:
# Fix for HOME path overridden by GH runners when building in containers, see:
# https://github.com/actions/runner/issues/863
- name: Fix HOME path
run: echo "HOME=/root" >> $GITHUB_ENV
- name: Checkout repository
uses: actions/checkout@v4
- name: Checkout submodules
run: |
git config --global --add safe.directory '*'
git submodule update --init --depth=1 dist-assets/binaries
git submodule update --init --recursive --depth=1 wireguard-go-rs
- name: Build app
env:
USE_MOLD: false
run: ./build.sh
- name: Build test executable
run: ./desktop/packages/mullvad-vpn/scripts/build-test-executable.sh
- uses: actions/upload-artifact@v4
if: '!cancelled()'
with:
name: linux-build
path: |
./dist/*.rpm
./dist/*.deb
./dist/app-e2e-*
e2e-test-linux:
name: Linux end-to-end tests
needs: [prepare-matrices, build-linux]
if: |
!cancelled() &&
needs.prepare-matrices.outputs.linux_matrix != '[]' &&
needs.prepare-matrices.outputs.linux_matrix != ''
runs-on: [self-hosted, desktop-test, Linux] # app-test-linux
timeout-minutes: 240
strategy:
fail-fast: false
matrix:
os: ${{ fromJSON(needs.prepare-matrices.outputs.linux_matrix) }}
steps:
- uses: actions/download-artifact@v4
if: ${{ needs.build-linux.result == 'success' }}
with:
name: linux-build
path: ~/.cache/mullvad-test/packages
- name: Checkout repository
uses: actions/checkout@v4
- name: Run end-to-end tests
shell: bash -ieo pipefail {0}
run: |
git fetch --tags --prune-tags --force
export TEST_FILTERS="${{ github.event.inputs.tests }}"
./test/scripts/ci-runtests.sh ${{ matrix.os }}
- uses: actions/upload-artifact@v4
if: '!cancelled()'
with:
name: ${{ matrix.os }}_report
path: ./test/.ci-logs/${{ matrix.os }}_report
build-windows:
name: Build Windows
needs: prepare-matrices
if: |
needs.prepare-matrices.outputs.windows_matrix != '[]' &&
!startsWith(github.ref, 'refs/tags/') && github.ref != 'refs/heads/main'
runs-on: windows-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
submodules: true
- name: Install Protoc
uses: arduino/setup-protoc@v3
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
- uses: actions/setup-node@v4
with:
node-version-file: desktop/package.json
cache: 'npm'
cache-dependency-path: desktop/package-lock.json
- name: Install Rust
uses: actions-rs/toolchain@v1.0.6
with:
toolchain: stable
target: i686-pc-windows-msvc
default: true
- name: Install msbuild
uses: microsoft/setup-msbuild@v1.0.2
with:
vs-version: 16
- name: Build app
shell: bash
run: |
./build.sh
# FIXME: Strip architecture-specific suffix. The remaining steps assume that the windows installer has no
# arch-suffix. This should probably be addressed when we add a Windows arm runner. Or maybe it will just keep
# on working ¯\_(ツ)_/¯
pushd dist
original_file=$(find *.exe)
new_file=$(echo $original_file | perl -pe "s/^(MullvadVPN-.*?)(_x64|_arm64)?(\.exe)$/\1\3/p")
mv "$original_file" "$new_file"
popd
- name: Build test executable
shell: bash
run: ./desktop/packages/mullvad-vpn/scripts/build-test-executable.sh
- uses: actions/upload-artifact@v4
if: '!cancelled()'
with:
name: windows-build
path: .\dist\*.exe
e2e-test-windows:
needs: [prepare-matrices, build-windows]
if: |
!cancelled() &&
needs.prepare-matrices.outputs.windows_matrix != '[]' &&
needs.prepare-matrices.outputs.windows_matrix != ''
name: Windows end-to-end tests
runs-on: [self-hosted, desktop-test, Linux] # app-test-linux
timeout-minutes: 240
strategy:
fail-fast: false
matrix:
os: ${{ fromJSON(needs.prepare-matrices.outputs.windows_matrix) }}
steps:
- uses: actions/download-artifact@v4
if: ${{ needs.build-windows.result == 'success' }}
with:
name: windows-build
path: ~/.cache/mullvad-test/packages
- name: Checkout repository
uses: actions/checkout@v4
- name: Run end-to-end tests
shell: bash -ieo pipefail {0}
run: |
git fetch --tags --prune-tags --force
export TEST_FILTERS="${{ github.event.inputs.tests }}"
./test/scripts/ci-runtests.sh ${{ matrix.os }}
- uses: actions/upload-artifact@v4
if: '!cancelled()'
with:
name: ${{ matrix.os }}_report
path: ./test/.ci-logs/${{ matrix.os }}_report
build-macos:
name: Build macOS
needs: prepare-matrices
if: |
needs.prepare-matrices.outputs.macos_matrix != '[]' &&
!startsWith(github.ref, 'refs/tags/') && github.ref != 'refs/heads/main'
runs-on: [self-hosted, desktop-test, macOS] # app-test-macos-arm
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Checkout submodules
run: |
git config --global --add safe.directory '*'
git submodule update --init --recursive --depth=1 wireguard-go-rs
- name: Install Go
uses: actions/setup-go@v3
with:
go-version: 1.21.3
- name: Install Protoc
uses: arduino/setup-protoc@v3
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
- uses: actions/setup-node@v4
with:
node-version-file: desktop/package.json
cache: 'npm'
cache-dependency-path: desktop/package-lock.json
- name: Install Rust
uses: actions-rs/toolchain@v1.0.6
with:
toolchain: stable
default: true
- name: Build app
run: ./build.sh
- name: Build test executable
run: ./desktop/packages/mullvad-vpn/scripts/build-test-executable.sh
- uses: actions/upload-artifact@v4
if: '!cancelled()'
with:
name: macos-build
path: |
./dist/*.pkg
./dist/app-e2e-*
e2e-test-macos:
needs: [prepare-matrices, build-macos]
if: |
!cancelled() &&
needs.prepare-matrices.outputs.macos_matrix != '[]' &&
needs.prepare-matrices.outputs.macos_matrix != ''
name: macOS end-to-end tests
runs-on: [self-hosted, desktop-test, macOS] # app-test-macos-arm
timeout-minutes: 240
strategy:
fail-fast: false
matrix:
os: ${{ fromJSON(needs.prepare-matrices.outputs.macos_matrix) }}
steps:
- uses: actions/download-artifact@v4
if: ${{ needs.build-macos.result == 'success' }}
with:
name: macos-build
path: ~/Library/Caches/mullvad-test/packages
- name: Checkout repository
uses: actions/checkout@v4
- name: Run end-to-end tests
shell: bash -ieo pipefail {0}
run: |
git fetch --tags --prune-tags --force
export TEST_FILTERS="${{ github.event.inputs.tests }}"
./test/scripts/ci-runtests.sh ${{ matrix.os }}
- uses: actions/upload-artifact@v4
if: '!cancelled()'
with:
name: ${{ matrix.os }}_report
path: ./test/.ci-logs/${{ matrix.os }}_report
compile-test-matrix:
name: Result matrix
needs: [e2e-test-linux, e2e-test-windows, e2e-test-macos]
if: '!cancelled()'
runs-on: [self-hosted, desktop-test, Linux]
timeout-minutes: 240
strategy:
fail-fast: false
steps:
- name: Checkout repository
uses: actions/checkout@v4
- uses: actions/download-artifact@v4
with:
path: ./test/.ci-logs/artifacts
- name: Generate test result matrix
shell: bash -ieo pipefail {0}
run: |
cd test
# "Unpack" the downloaded report artifacts: https://github.com/actions/download-artifact/issues/141
cp ./.ci-logs/artifacts/*_report/*_report ./.ci-logs/
cargo run --bin test-manager format-test-reports ./.ci-logs/*_report \
| tee summary.html >> $GITHUB_STEP_SUMMARY
- uses: actions/upload-artifact@v4
with:
name: summary.html
path: test/summary.html
|
