-
Notifications
You must be signed in to change notification settings - Fork 25
384 lines (335 loc) · 11.7 KB
/
quality.yml
File metadata and controls
384 lines (335 loc) · 11.7 KB
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
name: Quality
on:
pull_request:
branches: [main]
push:
branches: [main]
concurrency:
group: quality-${{ github.head_ref || github.sha }}
cancel-in-progress: true
permissions:
contents: read
jobs:
format-lint:
runs-on: ubuntu-latest
container:
image: ubuntu:noble
timeout-minutes: 45
defaults:
run:
shell: bash
steps:
- name: Install Git
run: |
apt-get update
apt-get install -y git
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up ROS 2 Jazzy
uses: ros-tooling/setup-ros@v0.7
with:
required-ros-distributions: jazzy
- name: Install dependencies
run: |
apt-get update
apt-get install -y clang-format ccache
source /opt/ros/jazzy/setup.bash
rosdep update
rosdep install --from-paths src --ignore-src -y
- name: Cache ccache
uses: actions/cache@v4
with:
path: /root/.cache/ccache
key: ccache-jazzy-lint-${{ github.sha }}
restore-keys: |
ccache-jazzy-lint-
- name: Build (minimal, for ament test infrastructure)
env:
CCACHE_DIR: /root/.cache/ccache
CCACHE_MAXSIZE: 500M
CCACHE_SLOPPINESS: pch_defines,time_macros
run: |
source /opt/ros/jazzy/setup.bash
colcon build --symlink-install \
--cmake-args -DCMAKE_BUILD_TYPE=Release \
--event-handlers console_direct+
- name: Run format linters
run: |
source /opt/ros/jazzy/setup.bash
source install/setup.bash
colcon test --return-code-on-test-failure \
--ctest-args -L linter -E clang_tidy \
--event-handlers console_direct+
- name: Show results
if: always()
run: colcon test-result --verbose
clang-tidy:
runs-on: ubuntu-latest
container:
image: ubuntu:noble
timeout-minutes: 45
defaults:
run:
shell: bash
steps:
- name: Install Git
run: |
apt-get update
apt-get install -y git
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Fix git safe directory
run: git config --global --add safe.directory "$GITHUB_WORKSPACE"
- name: Set up ROS 2 Jazzy
uses: ros-tooling/setup-ros@v0.7
with:
required-ros-distributions: jazzy
- name: Install ccache and clang-tidy
run: apt-get install -y ccache clang-tidy
- name: Cache ccache
uses: actions/cache@v4
with:
path: /root/.cache/ccache
key: ccache-jazzy-tidy-${{ github.sha }}
restore-keys: |
ccache-jazzy-tidy-
- name: Install clang-tidy-cache (ctcache)
run: |
apt-get install -y python3-pip
pip3 install --break-system-packages git+https://github.com/matus-chochlik/ctcache.git@3880541496c7ce0d2e2830d2f525375078fe0b1f
printf '#!/bin/sh\nexec clang-tidy-cache /usr/bin/clang-tidy "$@"\n' > /usr/local/bin/ctcache-wrapper
chmod +x /usr/local/bin/ctcache-wrapper
- name: Cache ctcache results
uses: actions/cache@v4
with:
path: /root/.ctcache
key: ctcache-jazzy-${{ hashFiles('.clang-tidy') }}-${{ github.sha }}
restore-keys: |
ctcache-jazzy-${{ hashFiles('.clang-tidy') }}-
- name: Install dependencies
run: |
apt-get update
apt-get install -y ros-jazzy-test-msgs
source /opt/ros/jazzy/setup.bash
rosdep update
rosdep install --from-paths src --ignore-src -y
- name: Build (compile database only, no clang-tidy)
env:
CCACHE_DIR: /root/.cache/ccache
CCACHE_MAXSIZE: 500M
CCACHE_SLOPPINESS: pch_defines,time_macros
run: |
source /opt/ros/jazzy/setup.bash
colcon build --symlink-install \
--cmake-args -DCMAKE_BUILD_TYPE=Release \
-DCMAKE_EXPORT_COMPILE_COMMANDS=ON \
-DENABLE_CLANG_TIDY=OFF \
--event-handlers console_direct+
ccache -s
- name: Merge compile databases
run: |
# Simple merge: combine per-package databases into build/compile_commands.json
mkdir -p build
python3 -c "
import json, glob, sys
entries = []
for db in glob.glob('build/*/compile_commands.json'):
with open(db) as f:
entries.extend(json.load(f))
with open('build/compile_commands.json', 'w') as f:
json.dump(entries, f, indent=2)
print(f'Merged {len(entries)} entries from {len(glob.glob(\"build/*/compile_commands.json\"))} packages')
"
- name: Determine files to analyze
id: files
run: |
if [ "${{ github.event_name }}" = "pull_request" ]; then
# Incremental: only changed C++ files
changed=$(git diff --name-only --diff-filter=ACMR origin/main...HEAD -- '*.cpp' '*.hpp' | tr '\n' ' ')
if [ -z "$changed" ]; then
echo "No C++ files changed - skipping clang-tidy"
echo "skip=true" >> "$GITHUB_OUTPUT"
else
echo "Analyzing changed files: $changed"
echo "skip=false" >> "$GITHUB_OUTPUT"
echo "files=$changed" >> "$GITHUB_OUTPUT"
fi
else
# Full: all source files
echo "Full analysis on push to main"
echo "skip=false" >> "$GITHUB_OUTPUT"
echo "files=" >> "$GITHUB_OUTPUT"
fi
- name: Run clang-tidy
if: steps.files.outputs.skip != 'true'
env:
CTCACHE_DIR: /root/.ctcache
CHANGED_FILES: ${{ steps.files.outputs.files }}
run: |
mkdir -p /root/.ctcache
source /opt/ros/jazzy/setup.bash
source install/setup.bash
if [ -n "$CHANGED_FILES" ]; then
# Incremental: specific files
run-clang-tidy -p build -clang-tidy-binary ctcache-wrapper \
-header-filter='.*ros2_medkit.*' \
$CHANGED_FILES
else
# Full: analyze all source files under src/ros2_medkit_*/src/
# Intentionally excludes test/ directories (tested via sanitizer jobs)
run-clang-tidy -p build -clang-tidy-binary ctcache-wrapper \
-header-filter='.*ros2_medkit.*' \
'src/ros2_medkit_.*/src/.*\.cpp$'
fi
sanitizer-asan:
runs-on: ubuntu-latest
container:
image: ubuntu:noble
timeout-minutes: 45
defaults:
run:
shell: bash
steps:
- name: Free disk space
run: |
rm -rf /usr/local/lib/android /usr/share/dotnet /opt/ghc || true
apt-get clean
- name: Install Git
run: |
apt-get update
apt-get install -y git
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up ROS 2 Jazzy
uses: ros-tooling/setup-ros@v0.7
with:
required-ros-distributions: jazzy
- name: Install ccache
run: apt-get install -y ccache
- name: Cache ccache
uses: actions/cache@v4
with:
path: /root/.cache/ccache
key: ccache-jazzy-asan-${{ github.sha }}
restore-keys: |
ccache-jazzy-asan-
- name: Install dependencies
run: |
apt-get update
apt-get install -y ros-jazzy-test-msgs
source /opt/ros/jazzy/setup.bash
rosdep update
rosdep install --from-paths src --ignore-src -y
- name: Build with ASan + UBSan
env:
CCACHE_DIR: /root/.cache/ccache
CCACHE_MAXSIZE: 500M
CCACHE_SLOPPINESS: pch_defines,time_macros
run: |
source /opt/ros/jazzy/setup.bash
colcon build --symlink-install \
--cmake-args -DCMAKE_BUILD_TYPE=Debug -DSANITIZER=asan,ubsan \
--event-handlers console_direct+
ccache -s
- name: Extend test timeouts for ASan overhead
run: |
find build/ -name "CTestTestfile.cmake" \
-exec sed -i 's/TIMEOUT "60"/TIMEOUT "180"/g' {} + \
-exec sed -i 's/TIMEOUT "120"/TIMEOUT "360"/g' {} +
- name: Run unit + integration tests with ASan + UBSan
timeout-minutes: 30
env:
# detect_leaks=0: FastDDS allocator leaks on shutdown (not our code)
# new_delete_type_mismatch=0: ROS 2 DDS scalar/array new/delete mismatch
ASAN_OPTIONS: halt_on_error=1:detect_leaks=0:new_delete_type_mismatch=0
UBSAN_OPTIONS: halt_on_error=1:print_stacktrace=1
run: |
source /opt/ros/jazzy/setup.bash
source install/setup.bash
failed=0
for pkg_dir in build/ros2_medkit_*/; do
pkg=$(basename "$pkg_dir")
echo "::group::Testing $pkg"
(cd "$pkg_dir" && ctest -LE "linter" --output-on-failure) || failed=1
echo "::endgroup::"
done
exit $failed
- name: Show test results
if: always()
run: |
for pkg_dir in build/ros2_medkit_*/; do
colcon test-result --test-result-base "$pkg_dir" --verbose 2>/dev/null || true
done
sanitizer-tsan:
runs-on: ubuntu-latest
container:
image: ubuntu:noble
timeout-minutes: 45
defaults:
run:
shell: bash
steps:
- name: Install Git
run: |
apt-get update
apt-get install -y git
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up ROS 2 Jazzy
uses: ros-tooling/setup-ros@v0.7
with:
required-ros-distributions: jazzy
- name: Install ccache
run: apt-get install -y ccache
- name: Cache ccache
uses: actions/cache@v4
with:
path: /root/.cache/ccache
key: ccache-jazzy-tsan-${{ github.sha }}
restore-keys: |
ccache-jazzy-tsan-
- name: Install dependencies
run: |
apt-get update
apt-get install -y ros-jazzy-test-msgs
source /opt/ros/jazzy/setup.bash
rosdep update
rosdep install --from-paths src --ignore-src -y
- name: Build with TSan
env:
CCACHE_DIR: /root/.cache/ccache
CCACHE_MAXSIZE: 500M
CCACHE_SLOPPINESS: pch_defines,time_macros
run: |
source /opt/ros/jazzy/setup.bash
colcon build --symlink-install \
--cmake-args -DCMAKE_BUILD_TYPE=RelWithDebInfo -DSANITIZER=tsan \
--event-handlers console_direct+
ccache -s
- name: Extend test timeouts for TSan overhead
run: |
find build/ -name "CTestTestfile.cmake" \
-exec sed -i 's/TIMEOUT "60"/TIMEOUT "180"/g' {} + \
-exec sed -i 's/TIMEOUT "120"/TIMEOUT "360"/g' {} +
- name: Run unit + integration tests with TSan
timeout-minutes: 30
run: |
export TSAN_OPTIONS="halt_on_error=0:history_size=4:suppressions=$(pwd)/tsan_suppressions.txt"
source /opt/ros/jazzy/setup.bash
source install/setup.bash
failed=0
for pkg_dir in build/ros2_medkit_*/; do
pkg=$(basename "$pkg_dir")
echo "::group::Testing $pkg"
(cd "$pkg_dir" && ctest -j1 -LE "linter" --output-on-failure) || failed=1
echo "::endgroup::"
done
exit $failed
- name: Show test results
if: always()
run: |
for pkg_dir in build/ros2_medkit_*/; do
colcon test-result --test-result-base "$pkg_dir" --verbose 2>/dev/null || true
done