Repository navigation
443 lines (394 loc) · 19.1 KB
/
Copy pathplugin-ci-workflow.yml
File metadata and controls
443 lines (394 loc) · 19.1 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
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
# +-------------------------------------------------------------------------+
# | Copyright (C) 2004-2026 The Cacti Group |
# | |
# | This program is free software; you can redistribute it and/or |
# | modify it under the terms of the GNU General Public License |
# | as published by the Free Software Foundation; either version 2 |
# | of the License, or (at your option) any later version. |
# | |
# | This program is distributed in the hope that it will be useful, |
# | but WITHOUT ANY WARRANTY; without even the implied warranty of |
# | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
# | GNU General Public License for more details. |
# +-------------------------------------------------------------------------+
# | Cacti: The Complete RRDtool-based Graphing Solution |
# +-------------------------------------------------------------------------+
# | This code is designed, written, and maintained by the Cacti Group. See |
# | about.php and/or the AUTHORS file for specific developer information. |
# +-------------------------------------------------------------------------+
# | http://www.cacti.net/ |
# +-------------------------------------------------------------------------+
name: Plugin Integration Tests
on:
push:
branches:
- main
- develop
pull_request:
branches:
- main
- develop
permissions:
contents: read
env:
CACTI: 1.2.x
concurrency:
group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: ${{ github.event_name == 'pull_request' }}
jobs:
integration-test:
timeout-minutes: 45
runs-on: ${{ matrix.os }}
continue-on-error: ${{ matrix.experimental }}
strategy:
fail-fast: false
matrix:
php: ['8.2', '8.3', '8.4', '8.5']
os: [ubuntu-latest]
experimental: [false]
include:
# PHP 8.6 runs as a non-blocking (experimental) leg because
# its packages can lag on the runners and in Ondřej Surý's PPA.
# Pinned to Ubuntu 24.04 (Noble): ubuntu-latest is now Ubuntu 26.04
# (Resolute), which Ondrej Sury's PPA does not yet serve, so the 8.6
# PPA toolchain install 404s. Noble carries the latest packaged 8.6 RC.
- php: '8.6'
os: ubuntu-24.04
experimental: true
services:
mariadb:
image: mariadb:11.8@sha256:6422478cb8e159f080fb1d8ccf65101e26fe51385787fde7d16c3b165a331f15
env:
MYSQL_ROOT_PASSWORD: cactiroot
MYSQL_DATABASE: cacti
MYSQL_USER: cactiuser
MYSQL_PASSWORD: cactiuser
ports:
- 3306:3306
options: >-
--health-cmd="mariadb-admin ping"
--health-interval=10s
--health-timeout=5s
--health-retries=3
name: PHP ${{ matrix.php }} Integration Test on ${{ matrix.os }}
steps:
- name: Checkout Cacti
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
repository: Cacti/cacti
ref: ${{ env.CACTI }}
path: cacti
- name: Checkout Syslog Plugin
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
path: cacti/plugins/syslog
# patch-coverage.php diffs against the base branch below.
fetch-depth: 0
- name: Install PHP ${{ matrix.php }}
if: matrix.php != '8.6'
uses: shivammathur/setup-php@eb7c497e18156a6bbabfef1d3a82760b9eda3962 # 2.40.0
with:
php-version: ${{ matrix.php }}
tools: composer:2.10.3
extensions: intl, mysql, gd, ldap, gmp, xml, curl, json, mbstring
coverage: xdebug
ini-values: "post_max_size=256M, max_execution_time=60, date.timezone=America/New_York"
# PHP 8.6 is still pre-release. shivammathur/setup-php ships a nightly
# 8.6.0-dev build whose bundled extensions are ABI-skewed against their own
# core (undefined symbol: smart_str_ferealloc / _safe_femalloc), so every
# extension fails to load and the CLI install dies. Ondřej Surý's PPA
# provides a coherent 8.6 RC build, so this experimental leg provisions the
# CLI from there instead.
- name: Install PHP 8.6 toolchain from Ondřej Surý's PPA
if: matrix.php == '8.6'
run: |
set -euo pipefail
sudo add-apt-repository -y ppa:ondrej/php
sudo apt-get update
sudo apt-get install -y \
php8.6-cli php8.6-common \
php8.6-intl php8.6-mysql php8.6-gd php8.6-ldap \
php8.6-gmp php8.6-xml php8.6-curl php8.6-mbstring \
php8.6-snmp php8.6-sqlite3
# Make the Ondřej 8.6 CLI the default `php` so composer and the tests
# run under the same ABI-coherent build.
sudo update-alternatives --install /usr/bin/php php /usr/bin/php8.6 86
sudo update-alternatives --set php /usr/bin/php8.6
# Mirror the ini values the other legs receive via setup-php.
printf '%s\n' \
'post_max_size=256M' \
'max_execution_time=60' \
'date.timezone=America/New_York' \
| sudo tee /etc/php/8.6/cli/conf.d/99-cacti-ci.ini >/dev/null
# setup-php normally provides Composer; it is skipped for this leg, so
# make sure a Composer binary is available for the dependency steps.
if ! command -v composer >/dev/null 2>&1; then
sudo apt-get install -y composer
fi
php -v
composer --version
- name: Check PHP version
run: php -v
- name: Validate plugin manifest (expected-file drift)
run: php ${{ github.workspace }}/cacti/plugins/syslog/tests/bin/validate-manifest.php
- name: Run apt-get update
run: sudo apt-get update
- name: Install System Dependencies
run: sudo apt-get install -y snmp snmpd rrdtool fping gettext
- name: Start SNMPD Agent and Test
run: |
sudo systemctl start snmpd
sudo snmpwalk -c public -v2c -On localhost .1.3.6.1.2.1.1
- name: Setup Permissions
run: |
# Composer runs as the runner user in a later step and calls touch()
# while generating the fixture autoloader. utime() only succeeds for the
# file owner, so the runner user must own the tree here; www-data keeps
# group access. Ownership is handed back to www-data before polling.
sudo chown -R runner:www-data ${{ github.workspace }}/cacti
sudo find ${{ github.workspace }}/cacti -type d -exec chmod 775 {} \;
sudo find ${{ github.workspace }}/cacti -type f -exec chmod 664 {} \;
sudo chmod +x ${{ github.workspace }}/cacti/cmd.php
sudo chmod +x ${{ github.workspace }}/cacti/poller.php
- name: Create MySQL Config
run: |
echo "::add-mask::cactiroot"
echo -e "[client]\nuser = root\npassword = cactiroot\nhost = 127.0.0.1\n" > ~/.my.cnf
chmod 600 ~/.my.cnf
- name: Initialize Cacti Database
run: |
MYSQL_AUTH_USR="--defaults-file=$HOME/.my.cnf"
mysql "$MYSQL_AUTH_USR" -e 'CREATE DATABASE IF NOT EXISTS cacti;'
mysql "$MYSQL_AUTH_USR" -e "CREATE USER IF NOT EXISTS 'cactiuser'@'localhost' IDENTIFIED BY 'cactiuser';"
mysql "$MYSQL_AUTH_USR" -e "CREATE USER IF NOT EXISTS 'cactiuser'@'127.0.0.1' IDENTIFIED BY 'cactiuser';"
mysql "$MYSQL_AUTH_USR" -e "GRANT ALL PRIVILEGES ON cacti.* TO 'cactiuser'@'localhost';"
mysql "$MYSQL_AUTH_USR" -e "GRANT ALL PRIVILEGES ON cacti.* TO 'cactiuser'@'127.0.0.1';"
mysql "$MYSQL_AUTH_USR" -e "GRANT SELECT ON mysql.time_zone_name TO 'cactiuser'@'localhost';"
mysql "$MYSQL_AUTH_USR" -e "GRANT SELECT ON mysql.time_zone_name TO 'cactiuser'@'127.0.0.1';"
mysql "$MYSQL_AUTH_USR" -e "FLUSH PRIVILEGES;"
mysql "$MYSQL_AUTH_USR" cacti < ${{ github.workspace }}/cacti/cacti.sql
mysql "$MYSQL_AUTH_USR" -e "INSERT INTO settings (name, value) VALUES ('path_php_binary', '/usr/bin/php')" cacti
# Core's release archives exclude .github and tests. Fetch these paths
# through Git at the immutable helper revision instead of an Action archive.
- name: Checkout shared CI tooling
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
repository: Cacti/cacti
ref: f3ff777992875740e4665fedfe2eff8335f5b894
persist-credentials: false
path: ci-tools
sparse-checkout: |
.github/actions/setup-plugin-dependencies
tests/tools/plugin-harness
- name: Install locked Cacti and plugin test dependencies
uses: ./ci-tools/.github/actions/setup-plugin-dependencies
with:
cacti-directory: cacti
install-core-dev: 'false'
- name: Create Cacti config.php
run: |
cat ${{ github.workspace }}/cacti/include/config.php.dist | \
sed -r "s/localhost/127.0.0.1/g" | \
sed -r "s/'cacti'/'cacti'/g" | \
sed -r "s/'cactiuser'/'cactiuser'/g" | \
sed -r "s/'cactiuser'/'cactiuser'/g" > ${{ github.workspace }}/cacti/include/config.php
sudo chmod 664 ${{ github.workspace }}/cacti/include/config.php
- name: Create Syslog Plugin config.php
run: |
cp ${{ github.workspace }}/cacti/plugins/syslog/config.php.dist ${{ github.workspace }}/cacti/plugins/syslog/config.php
sed -i "s/localhost/127.0.0.1/g" ${{ github.workspace }}/cacti/plugins/syslog/config.php
sed -i "s/'cacti'/'cacti'/g" ${{ github.workspace }}/cacti/plugins/syslog/config.php
sed -i "s/'cactiuser'/'cactiuser'/g" ${{ github.workspace }}/cacti/plugins/syslog/config.php
sed -i 's/\/\/\$/\$/g' ${{ github.workspace }}/cacti/plugins/syslog/config.php
sudo chmod 664 ${{ github.workspace }}/cacti/include/config.php
- name: Install Cacti via CLI
run: |
cd ${{ github.workspace }}/cacti
sudo php cli/install_cacti.php --accept-eula --install --force
- name: Install Syslog Plugin
run: |
cd ${{ github.workspace }}/cacti
sudo php cli/plugin_manage.php --plugin=syslog --install --enable
- name: Check PHP Syntax for Plugin
run: |
cd ${{ github.workspace }}/cacti/plugins/syslog
if find . -name '*.php' -not -path './vendor/*' -exec php -l {} \; 2>&1 | grep -iv 'no syntax errors detected'; then
echo "Syntax errors found!"
exit 1
fi
- name: Verify translation template is up to date
if: github.event_name == 'pull_request'
env:
BASE_REF: ${{ github.event.pull_request.base.sha }}
run: |
cd ${{ github.workspace }}/cacti/plugins/syslog
git config --global --add safe.directory ${{ github.workspace }}/cacti/plugins/syslog
php tests/bin/check-i18n-pot.php "$BASE_REF"
- name: Set expected Cacti version for unit tests
run: echo -n "${{ env.CACTI }}" | sudo tee ${{ github.workspace }}/cacti/plugins/syslog/tests/.cacti-version > /dev/null
- name: Run Pest Unit Tests
run: |
cd ${{ github.workspace }}/cacti
"$CACTI_PEST_BIN" --configuration=plugins/syslog/phpunit.xml \
--coverage-clover=plugins/syslog/coverage/clover.xml
- name: Run Syslog schema CLI regression checks
run: php tests/regression/cli_schema_upgrade_test.php
working-directory: ${{ github.workspace }}/cacti/plugins/syslog
- name: Run Syslog database regression checks
run: |
php tests/regression/threshold_recovery_database_test.php
php tests/regression/quality_must_fix_database_test.php
php tests/regression/incoming_preservation_database_test.php
php tests/regression/partition_rebuild_database_test.php
php tests/regression/review_fixes_database_test.php
php tests/regression/review_fixes_paths_database_test.php
working-directory: ${{ github.workspace }}/cacti/plugins/syslog
env:
SYSLOG_TEST_MYSQL_DSN: 'mysql:host=127.0.0.1;port=3306'
SYSLOG_TEST_MYSQL_PASSWORD: cactiroot
# Whole-file coverage is meaningless here: most of the plugin only runs
# inside a live Cacti. What is enforceable is that a change covers the
# lines it adds.
- name: Enforce coverage of changed lines
# PHP 8.6 installs from the Ondřej PPA, which has no matching xdebug
# build yet, so there is no coverage driver on that experimental leg.
if: github.event_name == 'pull_request' && matrix.php != '8.6'
env:
BASE_REF: ${{ github.event.pull_request.base.sha }}
run: |
cd ${{ github.workspace }}/cacti/plugins/syslog
git config --global --add safe.directory ${{ github.workspace }}/cacti/plugins/syslog
php tests/bin/patch-coverage.php coverage/clover.xml "$BASE_REF" 100
- name: Upload coverage report
if: always()
uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
with:
name: coverage-php${{ matrix.php }}
path: ${{ github.workspace }}/cacti/plugins/syslog/coverage/
if-no-files-found: warn
- name: Remove the plugins directory exclusion from the .phpstan.neon
if: ${{ env.CACTI != '1.2.x' }}
run: sed '/plugins/d' -i .phpstan.neon
working-directory: ${{ github.workspace }}/cacti
- name: Mark composer scripts executable
if: ${{ env.CACTI != '1.2.x' }}
run: sudo chmod +x ${{ github.workspace }}/cacti/include/vendor/bin/*
- name: Run Linter on base code
if: ${{ env.CACTI != '1.2.x' }}
run: composer run-script lint ${{ github.workspace }}/cacti/plugins/syslog
working-directory: ${{ github.workspace }}/cacti
- name: Checking coding standards on base code
if: ${{ env.CACTI != '1.2.x' }}
run: composer run-script phpcsfixer ${{ github.workspace }}/cacti/plugins/syslog
working-directory: ${{ github.workspace }}/cacti
- name: Run PHPStan at Level 6 on base code outside of Composer due to technical issues
if: ${{ env.CACTI != '1.2.x' }}
run: ./include/vendor/bin/phpstan analyze --level 6 ${{ github.workspace }}/cacti/plugins/syslog
working-directory: ${{ github.workspace }}/cacti
- name: Re-apply web user ownership before polling
run: |
# Ancestor directories above the checkout (e.g. /home/runner, .../work)
# are typically 750 owned by the runner user, which blocks a non-root
# www-data process from traversing down to the checkout at all.
p="${{ github.workspace }}"
while [ "$p" != "/" ]; do
sudo chmod o+x "$p" || true
p=$(dirname "$p")
done
sudo chown -R www-data:runner ${{ github.workspace }}/cacti
sudo find ${{ github.workspace }}/cacti -type d -exec chmod 775 {} \;
sudo find ${{ github.workspace }}/cacti -type f -exec chmod 664 {} \;
sudo chmod +x ${{ github.workspace }}/cacti/cmd.php
sudo chmod +x ${{ github.workspace }}/cacti/poller.php
- name: Run Cacti Poller
run: |
cd ${{ github.workspace }}/cacti
sudo runuser -u www-data -g runner -- php poller.php --poller=1 --force --debug
if ! grep -q "SYSTEM STATS" log/cacti.log; then
echo "Cacti poller did not finish successfully"
cat log/cacti.log
exit 1
fi
- name: Populate Syslog Test Data
run: |
sudo chmod +x ${{ github.workspace }}/cacti/plugins/syslog/tests/bin/populate_syslog_incoming.sh
cd ${{ github.workspace }}/cacti/plugins/syslog/tests/bin
sudo ./populate_syslog_incoming.sh
- name: force Syslog Plugin Poller
run: |
cd ${{ github.workspace }}/cacti
sudo -u www-data php plugins/syslog/syslog_process.php --debug
if ! grep -q "SYSTEM SYSLOG STATS" log/cacti.log; then
echo "Syslog plugin poller did not finish successfully"
cat log/cacti.log
exit 1
fi
# The populated alert rule (id 1) must have been evaluated and have fired
# for the host "bob": the processor logs it and stores it in syslog_logs.
if ! grep -q "The Syslog Alert 'interface down alert' with Severity 'Warning', has been Triggered on Host 'bob'" log/cacti.log; then
echo "The populated alert rule did not fire"
cat log/cacti.log
exit 1
fi
alerts=$(mysql --defaults-file="$HOME/.my.cnf" cacti -N -e "SELECT COUNT(*) FROM syslog_logs WHERE alert_id = 1 AND host = 'bob'")
if [ "$alerts" -lt 1 ]; then
echo "The populated alert rule left no alert log row"
exit 1
fi
# Runs the real processor over queued messages and reads the results back.
# The script removes its rows and restores cacti.log to its starting size.
- name: Run Syslog live pipeline checks
run: |
cd ${{ github.workspace }}/cacti
sudo -u www-data env SYSLOG_TEST_LIVE=1 php plugins/syslog/tests/regression/live_pipeline_test.php
- name: View Cacti Logs
if: always()
run: |
if [ -f ${{ github.workspace }}/cacti/log/cacti.log ]; then
echo "=== Cacti Log ==="
sudo cat ${{ github.workspace }}/cacti/log/cacti.log
fi
- name: Check Cacti Logs for Errors
if: always()
run: |
if [ -f ${{ github.workspace }}/cacti/log/cacti.log ]; then
status=0
matches=$(sudo grep -E "FATAL:|ERROR:|WARNING:" "${{ github.workspace }}/cacti/log/cacti.log") || status=$?
if [ "$status" -gt 1 ]; then
echo "Unable to inspect Cacti log"
exit "$status"
fi
# The only entry allowed is the alert the populated rule is meant to raise.
unexpected=$(printf '%s\n' "$matches" | grep -v -F "The Syslog Alert 'interface down alert' with Severity 'Warning', has been Triggered on Host 'bob'" | grep -v '^$') || true
if [ -n "$unexpected" ]; then
printf '%s\n' "$unexpected"
echo "Found FATAL/ERROR/WARNING entries in Cacti log"
exit 1
fi
fi
result-theme-browser:
runs-on: ubuntu-24.04
timeout-minutes: 10
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
with:
persist-credentials: false
- uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1
with:
node-version: '22'
- name: Install existing browser tooling
working-directory: tests/E2E/playwright
run: |
npm ci --ignore-scripts
npx --no-install playwright install --with-deps chromium
- name: Check result foregrounds across theme row states
env:
THEME_TEST_OUTPUT: ${{ runner.temp }}/syslog-theme-contrast
run: node tests/E2E/playwright/theme-contrast-check.cjs
- uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9
if: always()
with:
name: result-theme-browser
path: ${{ runner.temp }}/syslog-theme-contrast