327 lines (274 loc) · 11.2 KB
/
test.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
name: Test
on:
# Run on pushes to `master` and on all pull requests.
push:
branches:
- master
- develop
paths-ignore:
- '**.md'
- 'docs/**'
pull_request:
# Allow manually triggering the workflow.
workflow_dispatch:
# Cancels all previous workflow runs for the same branch that have not yet completed.
concurrency:
# The concurrency group contains the workflow name and the branch name.
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
lint:
if: ${{ github.ref != 'refs/heads/develop' }}
runs-on: ubuntu-latest
strategy:
matrix:
php: ['5.4', '7.0', '7.4', '8.0', '8.1', '8.2']
name: "Lint: PHP ${{ matrix.php }}"
continue-on-error: ${{ matrix.php == '8.2' }}
steps:
- name: Checkout code
uses: actions/checkout@v3
- name: Install PHP
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php }}
ini-file: 'development'
coverage: none
tools: cs2pr
- name: Install Composer dependencies - normal
if: ${{ matrix.php < 8.2 }}
uses: "ramsey/composer-install@v2"
# For the PHP "nightly", we need to install with ignore platform reqs as not all dependencies allow it yet.
- name: Install Composer dependencies - with ignore platform
if: ${{ matrix.php >= 8.2 }}
uses: "ramsey/composer-install@v2"
with:
composer-options: --ignore-platform-reqs
- name: Lint against parse errors
run: composer lint -- --checkstyle | cs2pr
#### TEST STAGE ####
test:
if: ${{ github.ref != 'refs/heads/develop' }}
needs: lint
runs-on: ubuntu-latest
strategy:
# Keys:
# - risky: Whether to run with tests which check for being in sync with PHPCS.
# - experimental: Whether the build is "allowed to fail".
matrix:
# The GHA matrix works different from Travis.
# You can define jobs here and then augment them with extra variables in `include`,
# as well as add extra jobs in `include`.
# @link https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix
#
# IMPORTANT: test runs shouldn't fail because of PHPCS being incompatible with a PHP version.
# - PHPCS will run without errors on PHP 5.4 - 7.2 on any version.
# - PHP 7.3 needs PHPCS 2.9.2 and 3.3.1+ to run without errors.
# On PHPCS 2.x our tests won't fail though, but on PHPCS 3.x < 3.3.1 they will.
# - PHP 7.4 needs PHPCS 3.5.0+ to run without errors.
# On PHPCS 2.x our tests won't fail though, but on PHPCS 3.x < 3.5.0 they will.
# - PHP 8.0 needs PHPCS 3.5.7+ to run without errors.
# - PHP 8.1 needs PHPCS 3.6.1+ to run without errors.
#
# The matrix is set up so as not to duplicate the builds which are run for code coverage.
php: ['5.5', '5.6', '7.0', '7.1', '7.2']
phpcs_version: ['2.6.0', '2.9.2', '3.1.0', 'dev-master']
risky: [false]
experimental: [false]
include:
# Complement the builds run in code coverage to complete the matrix and prevent issues
# with PHPCS versions incompatible with certain PHP versions.
- php: '8.1'
phpcs_version: 'dev-master'
risky: false
experimental: false
- php: '8.1'
phpcs_version: '3.6.1'
risky: false
experimental: false
- php: '8.0'
phpcs_version: 'dev-master'
risky: false
experimental: false
- php: '8.0'
phpcs_version: '3.5.7'
risky: false
experimental: false
- php: '7.4'
phpcs_version: '3.5.0'
risky: false
experimental: false
- php: '7.3'
phpcs_version: 'dev-master'
risky: false
experimental: false
- php: '7.3'
phpcs_version: '3.3.1'
risky: false
experimental: false
- php: '7.3'
phpcs_version: '2.6.0'
risky: false
experimental: false
- php: '5.4'
phpcs_version: '3.1.0'
risky: false
experimental: false
- php: '5.4'
phpcs_version: '2.9.2'
risky: false
experimental: false
# One extra build to verify issues around PHPCS annotations when they weren't fully accounted for yet.
- php: '7.2'
phpcs_version: '3.2.0'
risky: false
experimental: false
# And a few more to verify various tokenizer issues in older PHPCS versions.
- php: '5.6'
phpcs_version: '2.8.1'
risky: false
experimental: false
- php: '7.0'
phpcs_version: '2.7.1'
risky: false
experimental: false
# Experimental builds. These are allowed to fail.
- php: '8.2'
phpcs_version: 'dev-master'
risky: false
experimental: true
- php: '7.4'
phpcs_version: '4.0.x-dev'
risky: false
experimental: true
# Run risky tests separately.
- php: '7.4'
phpcs_version: '4.0.x-dev'
risky: true
experimental: true
- php: '7.4'
phpcs_version: 'dev-master'
risky: true
experimental: true
name: "Test: PHP ${{ matrix.php }} - PHPCS ${{ matrix.phpcs_version }}${{ matrix.risky == true && ' (risky)' || '' }}"
continue-on-error: ${{ matrix.experimental }}
steps:
- name: Checkout code
uses: actions/checkout@v3
# On stable PHPCS versions, allow for PHP deprecation notices.
# Unit tests don't need to fail on those for stable releases where those issues won't get fixed anymore.
- name: Setup ini config
id: set_ini
run: |
if [[ "${{ matrix.phpcs_version }}" != "dev-master" && "${{ matrix.phpcs_version }}" != "4.0.x-dev" ]]; then
echo '::set-output name=PHP_INI::error_reporting=E_ALL & ~E_DEPRECATED, display_errors=On'
else
echo '::set-output name=PHP_INI::error_reporting=-1, display_errors=On'
fi
- name: Install PHP
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php }}
ini-values: ${{ steps.set_ini.outputs.PHP_INI }}
coverage: none
- name: 'Composer: set PHPCS version for tests'
run: composer require --no-update squizlabs/php_codesniffer:"${{ matrix.phpcs_version }}"
- name: 'Composer: conditionally tweak PHPUnit version'
if: ${{ startsWith( matrix.php, '8' ) }}
# Temporary fix - PHPUnit 9.3+ is buggy when used for code coverage, so not allowed "normally".
# For tests which don't run code coverage, we can safely install it for PHP 8 though.
run: composer require --no-update phpunit/phpunit:"^9.3"
# Install dependencies and handle caching in one go.
# @link https://github.com/marketplace/actions/install-composer-dependencies
- name: Install Composer dependencies - normal
if: ${{ matrix.php < 8.2 }}
uses: "ramsey/composer-install@v2"
# For the PHP "nightly", we need to install with ignore platform reqs as not all dependencies allow it yet.
- name: Install Composer dependencies - with ignore platform
if: ${{ matrix.php >= 8.2 }}
uses: "ramsey/composer-install@v2"
with:
composer-options: --ignore-platform-reqs
- name: Run the unit tests (non-risky)
if: matrix.risky == false
run: vendor/bin/phpunit --no-coverage
- name: Run the unit tests (risky)
if: ${{ matrix.risky }}
# "nothing" is excluded to force PHPUnit to ignore the <exclude> settings in phpunit.xml.dist.
run: vendor/bin/phpunit --no-coverage --group compareWithPHPCS --exclude-group nothing
#### CODE COVERAGE STAGE ####
# N.B.: Coverage is only checked on the lowest and highest stable PHP versions
# and a low/high of each major for PHPCS.
# These builds are left out off the "test" stage so as not to duplicate test runs.
coverage:
# No use running the coverage builds if there are failing test builds.
needs: test
# The default condition is success(), but this is false when one of the previous jobs is skipped
if: always() && (needs.test.result == 'success' || needs.test.result == 'skipped')
runs-on: ubuntu-latest
strategy:
matrix:
include:
- php: '7.4' # This should be changed to 8.0 when the tests can run on PHPUnit 9.3+.
phpcs_version: 'dev-master'
- php: '7.3'
phpcs_version: '2.9.2'
- php: '5.4'
phpcs_version: 'dev-master'
- php: '5.4'
phpcs_version: '2.6.0'
name: "Coverage: PHP ${{ matrix.php }} - PHPCS ${{ matrix.phpcs_version }}"
steps:
- name: Checkout code
uses: actions/checkout@v3
# On stable PHPCS versions, allow for PHP deprecation notices.
# Unit tests don't need to fail on those for stable releases where those issues won't get fixed anymore.
- name: Setup ini config
id: set_ini
run: |
if [ "${{ matrix.phpcs_version }}" != "dev-master" ]; then
echo '::set-output name=PHP_INI::error_reporting=E_ALL & ~E_DEPRECATED, display_errors=On'
else
echo '::set-output name=PHP_INI::error_reporting=-1, display_errors=On'
fi
- name: Install PHP
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php }}
ini-values: ${{ steps.set_ini.outputs.PHP_INI }}
coverage: xdebug
- name: 'Composer: adjust dependencies'
run: |
# Set a specific PHPCS version.
composer require --no-update squizlabs/php_codesniffer:"${{ matrix.phpcs_version }}" --no-scripts
- name: Install Composer dependencies - normal
uses: "ramsey/composer-install@v2"
- name: Run the unit tests with code coverage
run: vendor/bin/phpunit
# Uploading the results with PHP Coveralls v1 won't work from GH Actions, so switch the PHP version.
- name: Switch to PHP 7.4
if: ${{ success() && matrix.php != '7.4' }}
uses: shivammathur/setup-php@v2
with:
php-version: 7.4
coverage: none
- name: Install Coveralls
if: ${{ success() }}
run: composer require php-coveralls/php-coveralls:"^2.4.2"
- name: Upload coverage results to Coveralls
if: ${{ success() }}
env:
COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
COVERALLS_PARALLEL: true
COVERALLS_FLAG_NAME: php-${{ matrix.php }}-phpcs-${{ matrix.phpcs_version }}
run: vendor/bin/php-coveralls -v -x build/logs/clover.xml
coveralls-finish:
needs: coverage
if: always() && needs.coverage.result == 'success'
runs-on: ubuntu-latest
steps:
- name: Coveralls Finished
uses: coverallsapp/github-action@master
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
parallel-finished: true