-
Notifications
You must be signed in to change notification settings - Fork 74
510 lines (485 loc) · 20.5 KB
/
github-cxx-qt-tests.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
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
# SPDX-FileCopyrightText: 2022 Klarälvdalens Datakonsult AB, a KDAB Group company <[email protected]>
# SPDX-FileContributor: Andrew Hayzen <[email protected]>
# SPDX-FileContributor: Be <[email protected]>
#
# SPDX-License-Identifier: MIT OR Apache-2.0
name: cxx-qt tests
on:
push:
branches:
- 'main'
- '[0-9]+\.[0-9]+\.x'
pull_request:
schedule:
# Run daily at 01:01
# This ensures CI still works and ensures the cache remains active
- cron: "1 1 * * *"
# Cancel any previous runs for the same pull request
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.run_id }}
cancel-in-progress: true
jobs:
clang_format:
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
# Note ensure that matrix runner is updated too
- run: |
pip install --user --break-system-packages clang-format==18.1.8
test -x ~/.local/bin/clang-format
test -x /home/runner/.local/bin/clang-format
- run: ./scripts/clang_format_check.sh /home/runner/.local/bin/clang-format .
license_check:
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
- name: REUSE Compliance Check
uses: fsfe/reuse-action@v4
rust_format_check:
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
- run: rustup component add rustfmt
- run: cargo fmt --all --check --verbose
markdown_lint:
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
- uses: DavidAnson/markdownlint-cli2-action@v17
with:
globs: '**/*.md'
shellcheck:
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
# Shellcheck is likely already installed but lets ensure it is
- name: install shellcheck
run: sudo apt-get install -y shellcheck
- name: shellcheck
run: shellcheck scripts/*.sh
coverage:
# Run after pre checks
needs: [ clang_format, license_check, rust_format_check, markdown_lint, shellcheck ]
runs-on: ubuntu-24.04
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Setup toolchain
run: |
cargo install grcov
rustup component add llvm-tools
- name: build
env:
RUSTFLAGS: -Cinstrument-coverage
LLVM_PROFILE_FILE: coverage/coverage_data-%p-%m.profraw
run: cargo build --package cxx-qt-gen
- name: test
env:
RUSTFLAGS: -Cinstrument-coverage
LLVM_PROFILE_FILE: coverage/coverage_data-%p-%m.profraw
run: cargo test --lib --package cxx-qt-gen
- name: generate-report
run: grcov . -s . --binary-path ./target/debug/ -t lcov --branch --ignore-not-existing -o ./target/debug/lcov.info --excl-start CODECOV_EXCLUDE_START --excl-stop CODECOV_EXCLUDE_STOP
- name: upload-report
uses: codecov/codecov-action@v4
with:
directory: ./target/debug/
files: lcov.info
fail_ci_if_error: true
token: ${{ secrets.CODECOV_TOKEN }}
verbose: true
build-wasm:
name: Ubuntu 24.04 (wasm_32) Qt 6
needs: [clang_format, license_check, rust_format_check, markdown_lint, shellcheck]
runs-on: ubuntu-24.04
env:
SCCACHE_CACHE_SIZE: 600M
steps:
- name: "Checkout repository"
uses: actions/checkout@v4
- name: Setup toolchain
run: |
rustup component add clippy rustfmt
rustup target add wasm32-unknown-emscripten
- name: "Rust tools cache"
uses: actions/cache@v4
id: rust-tools-cache
with:
path: |
~/.cargo/bin/sccache
~/.cargo/bin/mdbook
~/.cargo/bin/mdbook-linkcheck
key: ubuntu-24.04_sccache-0.7.6_mdbook-0.4.36_mdbook-linkcheck-0.7.7
- name: "Build Rust tools"
if: steps.rust-tools-cache.outputs.cache-hit != 'true'
# Do not build with storage backends enabled, we only need local
run: |
cargo install --no-default-features sccache
cargo install mdbook mdbook-linkcheck
# We want our compiler cache to always update to the newest state.
# The best way for us to achieve this is to **always** update the cache after every landed commit.
# That way it will closely follow our development.
# And if a PR diverges a lot with its cache that's not a big deal, as it will be merged eventually.
#
# This is a workaround for the fact that GH doesn't support updating existing caches.
# See: https://github.com/azu/github-actions-overwrite-cache-example
#
# Ideally we'd like to use this:
# - name: "Compiler cache"
# uses: actions/cache@v4
# with:
# update: true <------- THIS DOESN'T EXIST YET
# path: /home/runner/.cache/sccache
# key: "Ubuntu 24.04 (wasm_32) Qt6_compiler_cache"
- name: "Restore Compiler Cache"
id: compiler-cache-restore
uses: actions/cache/restore@v4
with:
path: /home/runner/.cache/sccache
key: "Ubuntu 24.04 (wasm_32) Qt6_compiler_cache"
- name: "emsdk cache"
uses: actions/cache@v4
id: emsdk-cache
with:
path: ./emsdk
key: emsdk_2.0.14
- name: "Setup emsdk"
if: steps.emsdk-cache.outputs.cache-hit != 'true'
run: |
git clone https://github.com/emscripten-core/emsdk
./emsdk/emsdk install 2.0.14
./emsdk/emsdk activate 2.0.14
- name: "Install Dependencies"
run: |
sudo apt-get update && sudo apt-get install -y ninja-build
pip install --user --break-system-packages clang-format==18.1.8
test -x ~/.local/bin/clang-format
test -x /home/runner/.local/bin/clang-format
- name: Install Qt WASM & Desktop
uses: jurplel/install-qt-action@v4
with:
version: '6.2.4'
host: 'linux'
target: 'desktop'
arch: 'wasm_32'
tools: 'tools_cmake'
cache: true
- name: "Configure"
# FIXME: ninja is not being found?
env:
RUSTC_WRAPPER: sccache
run: |
source ./emsdk/emsdk_env.sh
/home/runner/work/cxx-qt/Qt/6.2.4/wasm_32/bin/qt-cmake -DQT_HOST_PATH=/home/runner/work/cxx-qt/Qt/6.2.4/gcc_64 -DBUILD_WASM=ON -Bbuild .
- name: "Build"
env:
RUSTC_WRAPPER: sccache
run: cmake --build build --parallel 4
- name: Test output files exist
run: |
test -f ./build/examples/qml_minimal/example_qml_minimal.html
test -f ./build/examples/qml_minimal/example_qml_minimal.js
test -f ./build/examples/qml_minimal/libqml_minimal.a
test -x ./build/examples/qml_minimal/example_qml_minimal.wasm
test -f ./build/examples/qml_minimal/qtloader.js
test -f ./build/examples/qml_features/example_qml_features.html
test -f ./build/examples/qml_features/example_qml_features.js
test -f ./build/examples/qml_features/libqml_features.a
test -x ./build/examples/qml_features/example_qml_features.wasm
test -f ./build/examples/qml_features/qtloader.js
- name: "Print compiler cache statistics"
run: sccache --show-stats
# This is a workaround for the fact that GH doesn't support updating existing caches.
# See: https://github.com/azu/github-actions-overwrite-cache-example
- name: "Delete previous compiler cache"
# Updating th cache doesn't work from forks
# So update it once it's merged into the repo
if: ${{ steps.compiler-cache-restore.outputs.cache-hit && github.event_name == 'push' }}
continue-on-error: true
run: |
gh extension install actions/gh-actions-cache
gh actions-cache delete "Ubuntu 22.04 (wasm_32) Qt6_compiler_cache" --confirm
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: "Save Compiler Cache"
# Updating th cache doesn't work from forks
# So update it once it's merged into the repo
if: ${{ github.event_name == 'push' }}
uses: actions/cache/save@v4
with:
path: /home/runner/.cache/sccache
key: "Ubuntu 24.04 (wasm_32) Qt6_compiler_cache"
build:
# Run after pre checks
needs: [clang_format, license_check, rust_format_check, markdown_lint, shellcheck]
strategy:
fail-fast: false
matrix:
include:
- name: Ubuntu 24.04 (gcc) Qt5
os: ubuntu-24.04
qt_version: 5
aqt_version: '5.15.2'
aqt_arch: 'gcc_64'
aqt_host: 'linux'
cores: 4
# FIXME: valgrind complains about invalid debuginfo. Might be fixed when Ubuntu updates to valgrind 3.20
# https://bugs.kde.org/show_bug.cgi?id=452758
ctest_args: --exclude-regex '^(example_qml_features_test_valgrind|example_qml_minimal_myobject_test_valgrind)$'
qt_qpa_platform: offscreen
compiler_cache_path: /home/runner/.cache/sccache
clang_format_path: /home/runner/.local/bin/clang-format
cargo_dir: ~/.cargo
- name: Ubuntu 24.04 (gcc) Qt6
os: ubuntu-24.04
qt_version: 6
aqt_version: '6.8.0'
aqt_arch: 'linux_gcc_64'
aqt_host: 'linux'
cores: 4
# FIXME: valgrind complains about invalid debuginfo. Might be fixed when Ubuntu updates to valgrind 3.20
# https://bugs.kde.org/show_bug.cgi?id=452758
ctest_args: --exclude-regex '^(example_qml_features_test_valgrind|example_qml_minimal_myobject_test_valgrind)$'
qt_qpa_platform: offscreen
compiler_cache_path: /home/runner/.cache/sccache
clang_format_path: /home/runner/.local/bin/clang-format
cargo_dir: ~/.cargo
packages-extra: >-
libgl1-mesa-dev
libvulkan-dev
libxkbcommon-dev
- name: macOS 13 (clang) Qt5
os: macos-13
qt_version: 5
aqt_version: '5.15.2'
aqt_arch: 'clang_64'
aqt_host: 'mac'
dyld_framework_path: /Users/runner/work/cxx-qt/Qt/5.15.2/clang_64/lib
# https://doc.qt.io/qt-5/macos.html#target-platforms
macosx_deployment_target: '10.13'
cores: 3
# FIXME: qmltestrunner fails to import QtQuick module
# https://github.com/KDAB/cxx-qt/issues/110
ctest_args: --exclude-regex '^(cargo_clippy|cargo_doc|example_qml_features_test|example_qml_minimal_myobject_test|cargo_build_rerun|.*valgrind)$'
qt_qpa_platform: cocoa
compiler_cache_path: /Users/runner/Library/Caches/Mozilla.sccache
clang_format_path: /Users/runner/Library/Python/3.12/bin/clang-format
cargo_dir: ~/.cargo
cc: clang
cxx: clang++
- name: macOS 14 (clang) Qt6
os: macos-14
qt_version: 6
aqt_version: '6.8.0'
aqt_arch: 'clang_64'
aqt_host: 'mac'
dyld_framework_path: /Users/runner/work/cxx-qt/Qt/6.7.3/macos/lib
# https://doc.qt.io/qt-6.7/macos.html#target-platforms
macosx_deployment_target: '13.0'
cores: 3
# FIXME: qmltestrunner fails to import QtQuick module
# https://github.com/KDAB/cxx-qt/issues/110
ctest_args: --exclude-regex '^(cargo_clippy|cargo_doc|example_qml_features_test|example_qml_minimal_myobject_test|cargo_build_rerun|.*valgrind)$'
qt_qpa_platform: cocoa
compiler_cache_path: /Users/runner/Library/Caches/Mozilla.sccache
clang_format_path: /Users/runner/Library/Python/3.13/bin/clang-format
cargo_dir: ~/.cargo
cc: clang
cxx: clang++
- name: Windows 2022 (MSVC) Qt5
os: windows-2022
qt_version: 5
aqt_version: '5.15.2'
aqt_arch: 'win64_msvc2019_64'
aqt_host: 'windows'
cores: 4
ctest_args: --exclude-regex '^(cargo_clippy|cargo_doc|cargo_build_rerun|.*valgrind)$'
exe_suffix: .exe
qt_qpa_platform: windows
compiler_cache_path: C:\Users\runneradmin\AppData\Local\Mozilla\sccache\cache
clang_format_path: C:\Users\runneradmin\AppData\Roaming\Python\Python39\Scripts\clang-format.exe
cargo_dir: C:\Users\runneradmin\.cargo
cc: cl
cxx: cl
- name: Windows 2022 (MSVC2019) Qt6
os: windows-2022
qt_version: 6
aqt_version: '6.7.3'
aqt_arch: 'win64_msvc2019_64'
aqt_host: 'windows'
cores: 4
ctest_args: --exclude-regex '^(cargo_clippy|cargo_doc|cargo_build_rerun|.*valgrind)$'
exe_suffix: .exe
qt_qpa_platform: windows
compiler_cache_path: C:\Users\runneradmin\AppData\Local\Mozilla\sccache\cache
clang_format_path: C:\Users\runneradmin\AppData\Roaming\Python\Python39\Scripts\clang-format.exe
cargo_dir: C:\Users\runneradmin\.cargo
cc: cl
cxx: cl
- name: Windows 2022 (MSVC2022) Qt6
os: windows-2022
qt_version: 6
aqt_version: '6.8.0'
aqt_arch: 'win64_msvc2022_64'
aqt_host: 'windows'
cores: 4
ctest_args: --exclude-regex '^(cargo_clippy|cargo_doc|cargo_build_rerun|.*valgrind)$'
exe_suffix: .exe
qt_qpa_platform: windows
compiler_cache_path: C:\Users\runneradmin\AppData\Local\Mozilla\sccache\cache
clang_format_path: C:\Users\runneradmin\AppData\Roaming\Python\Python39\Scripts\clang-format.exe
cargo_dir: C:\Users\runneradmin\.cargo
cc: cl
cxx: cl
workspace: C:\cxx-qt
runs-on: ${{ matrix.os }}
name: ${{ matrix.name }}
env:
# ld: warning: object file (LIB) was built for newer macOS version (12.7) than being linked (12.0)
MACOSX_DEPLOYMENT_TARGET: ${{ matrix.macosx_deployment_target }}
# sccache is around 180-300M in size for a normal build
# With GitHub caches we have a 10 GB limit / 6 conditions = 1666 MB
# Allow a larger cache size so that code in branches can be cached
# but still leave room for the tools cache
SCCACHE_CACHE_SIZE: 600M
steps:
- name: "Clone Git repository"
uses: actions/checkout@v4
# Ensure clippy and rustfmt is installed, they should come from github runner
#
# Note we still need rustfmt for the cxx-qt-gen tests
- name: "Install Rust toolchain"
run: rustup component add clippy rustfmt
- name: "Rust tools cache"
uses: actions/cache@v4
id: rust-tools-cache
with:
path: |
${{ matrix.cargo_dir }}/bin/sccache${{ matrix.exe_suffix }}
${{ matrix.cargo_dir }}/bin/mdbook${{ matrix.exe_suffix }}
${{ matrix.cargo_dir }}/bin/mdbook-linkcheck${{ matrix.exe_suffix }}
key: ${{ matrix.os }}_sccache-0.7.6_mdbook-0.4.36_mdbook-linkcheck-0.7.7
- name: "Build Rust tools"
if: steps.rust-tools-cache.outputs.cache-hit != 'true'
# Do not build with storage backends enabled, we only need local
run: |
cargo install --no-default-features sccache
cargo install mdbook mdbook-linkcheck
# We want our compiler cache to always update to the newest state.
# The best way for us to achieve this is to **always** update the cache after every landed commit.
# That way it will closely follow our development.
# And if a PR diverges a lot with its cache that's not a big deal, as it will be merged eventually.
#
# This is a workaround for the fact that GH doesn't support updating existing caches.
# See: https://github.com/azu/github-actions-overwrite-cache-example
#
# Ideally we'd like to use this:
# - name: "Compiler cache"
# uses: actions/cache@v4
# with:
# update: true <------- THIS DOESN'T EXIST YET
# path: ${{ matrix.compiler_cache_path }}
# key: ${{ matrix.name }}_compiler_cache
- name: "Restore Compiler Cache"
id: compiler-cache-restore
uses: actions/cache/restore@v4
with:
path: ${{ matrix.compiler_cache_path }}
key: ${{ matrix.name }}_compiler_cache
- name: "Install clang-format"
# Note ensure that clang-format runner is updated too
run: |
pip install --user --break-system-packages clang-format==18.1.8
test -x ${{ matrix.clang_format_path }}
# Version info found using https://ddalcino.github.io/aqt-list-server/
- name: "Install Qt"
uses: jurplel/install-qt-action@v4
with:
version: ${{ matrix.aqt_version }}
host: ${{ matrix.aqt_host }}
target: 'desktop'
arch: ${{ matrix.aqt_arch }}
tools: 'tools_cmake'
cache: true
- name: "[Ubuntu] Install dependencies"
if: runner.os == 'Linux'
run: >-
sudo apt-get update &&
sudo apt-get install -y
ninja-build
libssl-dev
pkg-config
valgrind
${{ matrix.packages-extra }}
# hack around https://bugs.launchpad.net/ubuntu/+source/qtchooser/+bug/1964763
- name: "[Ubuntu] Add Qt6 tools to PATH"
if: runner.os == 'Linux' && matrix.qt_version == 6
run: echo "PATH=/usr/lib/qt6/bin:${PATH}" >> "${GITHUB_ENV}"
- name: "[macOS] Install dependencies"
if: runner.os == 'macOS'
# automake is needed for building libicu which is a dependency of Qt
run: brew install automake autoconf-archive ninja
# Note that for nuget uploads to work this must be run as the kdab user
# eg a branch on the kdab repo rather than a users fork
#
# Otherwise you may see the following error:
# Pushing NuGet to "cxx-qt-github-packages" failed. Use --debug for more information.
- name: "Authenticate to GitHub Packages"
if: runner.os != 'Linux' && github.repository_owner == 'KDAB'
shell: bash
run: |
nuget sources add -Name cxx-qt-github-packages -Source https://nuget.pkg.github.com/KDAB/index.json -Username KDAB -Password ${{ secrets.GITHUB_TOKEN }} -NonInteractive
nuget setapikey ${{ secrets.GITHUB_TOKEN }} -Source cxx-qt-github-packages -NonInteractive
echo "VCPKG_BINARY_SOURCES=clear;nuget,cxx-qt-github-packages,readwrite;" >> "${GITHUB_ENV}"
# Required for CMake to find Ninja
- name: "[Windows] Set up MSVC Developer Command Prompt"
if: runner.os == 'Windows'
uses: seanmiddleditch/gha-setup-vsdevenv@v4
# Ninja is required on Windows for CMAKE_CXX_COMPILER_LAUNCHER to work for using sccache.
- name: "Configure"
run: >-
cmake
-D USE_QT5=${{ matrix.qt_version == 5 }}
-D CMAKE_BUILD_TYPE=Release
-G Ninja
-S . -B build
env:
RUSTC_WRAPPER: sccache
CC: ${{ matrix.cc }}
CXX: ${{ matrix.cxx }}
- name: "Build"
run: cmake --build build --config Release --parallel ${{ matrix.cores }}
env:
RUSTC_WRAPPER: sccache
- name: "Test"
run: ctest ${{ matrix.ctest_args }} -C Release -T test --output-on-failure --parallel ${{ matrix.cores }}
working-directory: ./build
env:
# Use the version of clang-format from pip
CLANG_FORMAT_BINARY: ${{ matrix.clang_format_path }}
RUSTC_WRAPPER: sccache
QT_QPA_PLATFORM: ${{ matrix.qt_qpa_platform }}
QT_SELECT: qt${{ matrix.qt_version }}
DYLD_FRAMEWORK_PATH: ${{ matrix.dyld_framework_path }}
- name: "Print compiler cache statistics"
run: sccache --show-stats
# This is a workaround for the fact that GH doesn't support updating existing caches.
# See: https://github.com/azu/github-actions-overwrite-cache-example
- name: "Delete previous compiler cache"
# Updating th cache doesn't work from forks
# So update it once it's merged into the repo
if: ${{ steps.compiler-cache-restore.outputs.cache-hit && github.event_name == 'push' }}
continue-on-error: true
run: |
gh extension install actions/gh-actions-cache
gh actions-cache delete "${{ matrix.name }}_compiler_cache" --confirm
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: "Save Compiler Cache"
# Updating th cache doesn't work from forks
# So update it once it's merged into the repo
if: ${{ github.event_name == 'push' }}
uses: actions/cache/save@v4
with:
path: ${{ matrix.compiler_cache_path }}
key: ${{ matrix.name }}_compiler_cache