Repository navigation
356 lines (294 loc) · 14.9 KB
/
Copy pathtest.yml
File metadata and controls
356 lines (294 loc) · 14.9 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
name: Test
on:
# Run on pushes to `master` and on all pull requests.
push:
branches:
- master
- develop
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
env:
# - COMPOSER_ROOT_VERSION is needed to get round the recursive dependency when using CI.
COMPOSER_ROOT_VERSION: '10.99.99'
# Permissions should be configured at the job level.
permissions: {}
jobs:
#### PHP LINT STAGE ####
# Linting against high/low of each PHP major should catch everything.
# If needs be, we can always add interim versions back at a later point in time.
lint:
permissions:
contents: read # To clone the repo.
if: ${{ github.ref != 'refs/heads/develop' }}
runs-on: ubuntu-latest
strategy:
matrix:
php: ['7.2', '7.4', '8.0', '8.5', 'nightly']
continue-on-error: ${{ matrix.php == 'nightly' }}
name: "Lint: PHP ${{ matrix.php }}"
steps:
- name: Checkout code
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Install PHP
uses: shivammathur/setup-php@eb7c497e18156a6bbabfef1d3a82760b9eda3962 # 2.40.0
with:
php-version: ${{ matrix.php }}
ini-values: error_reporting=-1, display_errors=On, display_startup_errors=On, zend.assertions=1
coverage: none
tools: cs2pr
env:
fail-fast: true
- name: 'Composer: adjust dependencies'
# Remove PHPUnit requirement to save some bandwidth.
run: composer remove --no-update phpunit/phpunit --no-interaction
# Install dependencies and handle caching in one go.
# @link https://github.com/marketplace/actions/install-php-dependencies-with-composer
- name: Install Composer dependencies
uses: "ramsey/composer-install@65e4f84970763564f46a70b8a54b90d033b3bdda" # 4.0.0
with:
# For the PHP "nightly", we need to install with ignore platform reqs as not all dependencies may allow it yet.
composer-options: ${{ matrix.php == 'nightly' && '--ignore-platform-req=php+' || '' }}
# Bust the cache at least once a month - output format: YYYY-MM.
custom-cache-suffix: $(date -u "+%Y-%m")
- name: Lint against parse errors
if: ${{ matrix.php != '7.2' && matrix.php != '8.5' }}
run: composer lint
- name: Lint against parse errors
if: ${{ matrix.php == '7.2' || matrix.php == '8.5' }}
run: composer lint -- --checkstyle | cs2pr
#### TEST STAGE ####
test:
# No use running the tests if there is a linting error somewhere as they would fail anyway.
needs: lint
permissions:
contents: read # To clone the repo.
if: ${{ github.ref != 'refs/heads/develop' }}
runs-on: ubuntu-latest
strategy:
# Keys:
# - custom_ini: Whether to run with specific custom ini settings to hit very specific
# code conditions.
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
#
# The matrix is set up so as not to duplicate the builds which are run for code coverage.
php: ['7.3', '7.4', '8.0', '8.1', '8.2', '8.3', '8.4']
phpcs_version: ['lowest', '4.x-dev']
include:
- php: '7.2'
phpcs_version: '^4.0.2'
custom_ini: true
- php: '8.4'
phpcs_version: '^4.0.2'
custom_ini: true
# Experimental builds. These are allowed to fail.
- php: '8.6' # Nightly.
phpcs_version: '4.x-dev'
continue-on-error: ${{ matrix.php == '8.6' }}
name: "Test: PHP ${{ matrix.php }}${{ matrix.custom_ini && ' (ini)' || '' }} - PHPCS ${{ matrix.phpcs_version }}"
steps:
- name: Checkout code
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Setup ini config
id: set_ini
# yamllint disable rule:line-length
run: |
# 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.
# Also set the "short_open_tag" ini to make sure specific conditions are tested.
if [ ${{ matrix.custom_ini }} == "true" ]; then
if [ "${{ contains( matrix.phpcs_version, 'dev') }}" == "false" ]; then
echo 'PHP_INI=error_reporting=E_ALL & ~E_DEPRECATED, display_errors=On, display_startup_errors=On, zend.assertions=1, short_open_tag=On' >> "$GITHUB_OUTPUT"
else
echo 'PHP_INI=error_reporting=-1, display_errors=On, display_startup_errors=On, short_open_tag=On, zend.assertions=1' >> "$GITHUB_OUTPUT"
fi
else
if [ "${{ contains( matrix.phpcs_version, 'dev') }}" == "false" ]; then
echo 'PHP_INI=error_reporting=E_ALL & ~E_DEPRECATED, display_errors=On, display_startup_errors=On, zend.assertions=1' >> "$GITHUB_OUTPUT"
else
echo 'PHP_INI=error_reporting=-1, display_errors=On, display_startup_errors=On, zend.assertions=1' >> "$GITHUB_OUTPUT"
fi
fi
# yamllint enable rule:line-length
- name: Install PHP
uses: shivammathur/setup-php@eb7c497e18156a6bbabfef1d3a82760b9eda3962 # 2.40.0
with:
php-version: ${{ matrix.php }}
ini-values: ${{ steps.set_ini.outputs.PHP_INI }}
coverage: none
env:
fail-fast: true
# Remove PHPCSDevCS as it could potentially prevent the tests from being able to run against PHPCS "lowest".
- name: 'Composer: remove PHPCSDevCS'
run: composer remove --dev phpcsstandards/phpcsdevcs --no-update --no-interaction
- name: "Composer: set PHPCS version for tests"
if: ${{ matrix.phpcs_version != 'lowest' }}
run: composer require squizlabs/php_codesniffer:"${{ matrix.phpcs_version }}" --no-update --no-scripts --no-interaction
- name: Enable creation of `composer.lock` file
if: ${{ matrix.phpcs_version == 'lowest' }}
run: composer config --unset lock
# Install dependencies and handle caching in one go.
# @link https://github.com/marketplace/actions/install-php-dependencies-with-composer
- name: Install Composer dependencies
uses: "ramsey/composer-install@65e4f84970763564f46a70b8a54b90d033b3bdda" # 4.0.0
with:
# For the PHP "nightly", we need to install with ignore platform reqs as not all dependencies may allow it yet.
composer-options: ${{ matrix.php == '8.6' && '--ignore-platform-req=php+' || '' }}
# Bust the cache at least once a month - output format: YYYY-MM.
custom-cache-suffix: $(date -u "+%Y-%m")
- name: "Composer: set PHPCS version for tests (lowest)"
if: ${{ matrix.phpcs_version == 'lowest' }}
run: composer update squizlabs/php_codesniffer phpcsstandards/phpcsutils --prefer-lowest --no-scripts --no-interaction
- name: Grab PHPUnit version
id: phpunit_version
# yamllint disable-line rule:line-length
run: echo "VERSION=$(vendor/bin/phpunit --version | grep --only-matching --max-count=1 --extended-regexp '\b[0-9]+\.[0-9]+')" >> "$GITHUB_OUTPUT"
- name: Determine PHPUnit config file to use
id: phpunit_config
run: |
if [ "${{ startsWith( steps.phpunit_version.outputs.VERSION, '11.' ) }}" == "true" ]; then
echo 'FILE=phpunit10.xml.dist' >> "$GITHUB_OUTPUT"
elif [ "${{ startsWith( steps.phpunit_version.outputs.VERSION, '10.' ) }}" == "true" ]; then
echo 'FILE=phpunit10.xml.dist' >> "$GITHUB_OUTPUT"
else
echo 'FILE=phpunit.xml.dist' >> "$GITHUB_OUTPUT"
fi
- name: Run the unit tests
run: vendor/bin/phpunit -c ${{ steps.phpunit_config.outputs.FILE }} --no-coverage
#### CODE COVERAGE STAGE ####
# N.B.: Coverage is only checked on the lowest and highest stable PHP versions
# and low/high of each major for PHPCS.
coverage:
# No use running the coverage builds if there are failing test builds.
needs: test
permissions:
contents: read # To clone the repo.
# The default condition is success(), but this is false when one of the previous jobs is skipped (but don't run on forks).
if: always() && github.repository_owner == 'PHPCompatibility' && (needs.test.result == 'success' || needs.test.result == 'skipped')
runs-on: ubuntu-latest
strategy:
# Keys:
# - custom_ini: Whether to run with specific custom ini settings to hit very specific
# code conditions.
matrix:
include:
- php: '8.5'
phpcs_version: '4.x-dev'
- php: '8.5'
phpcs_version: 'lowest'
custom_ini: true
- php: '7.2'
phpcs_version: '4.x-dev'
custom_ini: true
- php: '7.2'
phpcs_version: 'lowest'
name: "Coverage: PHP ${{ matrix.php }}${{ matrix.custom_ini && ' (ini)' || '' }} - PHPCS ${{ matrix.phpcs_version }}"
steps:
- name: Checkout code
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Setup ini config
id: set_ini
# yamllint disable rule:line-length
run: |
# 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.
# Also set the "short_open_tag" ini to make sure specific conditions are tested.
if [ ${{ matrix.custom_ini }} == "true" ]; then
if [ "${{ contains( matrix.phpcs_version, 'dev') }}" == "false" ]; then
echo 'PHP_INI=error_reporting=E_ALL & ~E_DEPRECATED, display_errors=On, display_startup_errors=On, zend.assertions=1, short_open_tag=On' >> "$GITHUB_OUTPUT"
else
echo 'PHP_INI=error_reporting=-1, display_errors=On, display_startup_errors=On, zend.assertions=1, short_open_tag=On' >> "$GITHUB_OUTPUT"
fi
else
if [ "${{ contains( matrix.phpcs_version, 'dev') }}" == "false" ]; then
echo 'PHP_INI=error_reporting=E_ALL & ~E_DEPRECATED, display_errors=On, display_startup_errors=On, zend.assertions=1' >> "$GITHUB_OUTPUT"
else
echo 'PHP_INI=error_reporting=-1, display_errors=On, display_startup_errors=On, zend.assertions=1' >> "$GITHUB_OUTPUT"
fi
fi
# yamllint enable rule:line-length
- name: Install PHP
uses: shivammathur/setup-php@eb7c497e18156a6bbabfef1d3a82760b9eda3962 # 2.40.0
with:
php-version: ${{ matrix.php }}
ini-values: ${{ steps.set_ini.outputs.PHP_INI }}
coverage: xdebug
env:
fail-fast: true
# Remove PHPCSDevCS as it could potentially prevent the tests from being able to run against PHPCS "lowest".
- name: 'Composer: remove PHPCSDevCS'
run: composer remove --dev phpcsstandards/phpcsdevcs --no-update --no-interaction
- name: "Composer: set PHPCS version for tests"
if: ${{ matrix.phpcs_version != 'lowest' }}
run: composer require squizlabs/php_codesniffer:"${{ matrix.phpcs_version }}" --no-update --no-scripts --no-interaction
- name: Enable creation of `composer.lock` file
if: ${{ matrix.phpcs_version == 'lowest' }}
run: composer config --unset lock
- name: Install Composer dependencies
uses: "ramsey/composer-install@65e4f84970763564f46a70b8a54b90d033b3bdda" # 4.0.0
with:
# Bust the cache at least once a month - output format: YYYY-MM.
custom-cache-suffix: $(date -u "+%Y-%m")
- name: "Composer: set PHPCS version for tests (lowest)"
if: ${{ matrix.phpcs_version == 'lowest' }}
run: composer update squizlabs/php_codesniffer phpcsstandards/phpcsutils --prefer-lowest --no-scripts --no-interaction
- name: Grab PHPUnit version
id: phpunit_version
# yamllint disable-line rule:line-length
run: echo "VERSION=$(vendor/bin/phpunit --version | grep --only-matching --max-count=1 --extended-regexp '\b[0-9]+\.[0-9]+')" >> "$GITHUB_OUTPUT"
- name: "DEBUG: Show grabbed version"
run: echo ${{ steps.phpunit_version.outputs.VERSION }}
- name: Determine PHPUnit config file to use
id: phpunit_config
run: |
if [ "${{ startsWith( steps.phpunit_version.outputs.VERSION, '11.' ) }}" == "true" ]; then
echo 'FILE=phpunit10.xml.dist' >> "$GITHUB_OUTPUT"
elif [ "${{ startsWith( steps.phpunit_version.outputs.VERSION, '10.' ) }}" == "true" ]; then
echo 'FILE=phpunit10.xml.dist' >> "$GITHUB_OUTPUT"
else
echo 'FILE=phpunit.xml.dist' >> "$GITHUB_OUTPUT"
fi
# PHPUnit 9.3 started using PHP-Parser for code coverage causing some of our coverage builds to fail.
# As of PHPUnit 9.3.4, a cache warming option is available.
# Using that option prevents issues with PHP-Parser backfilling PHP tokens when PHPCS does not (yet),
# which would otherwise cause tests to fail on tokens being available when they shouldn't be.
# As coverage is only run on high/low PHP, the high PHP version will use PHPUnit 11, so just check for that.
- name: "Warm the PHPUnit cache (PHPUnit 9.3+)"
if: ${{ startsWith( steps.phpunit_version.outputs.VERSION, '11.' ) }}
run: vendor/bin/phpunit -c ${{ steps.phpunit_config.outputs.FILE }} --warm-coverage-cache
- name: Run the unit tests with code coverage
run: vendor/bin/phpunit -c ${{ steps.phpunit_config.outputs.FILE }}
- name: Upload coverage results to Coveralls
if: ${{ success() }}
uses: coverallsapp/github-action@8d6379e14d29928660c4ba802d8e85393440b329 # v2.3.8
with:
format: clover
file: build/logs/clover.xml
flag-name: php-${{ matrix.php }}-phpcs-${{ matrix.phpcs_version }}
parallel: true
coveralls-finish:
needs: coverage
# Don't run on forks.
if: always() && github.repository_owner == 'PHPCompatibility' && needs.coverage.result == 'success'
runs-on: ubuntu-latest
name: Coveralls Finish
steps:
- name: Coveralls Finished
uses: coverallsapp/github-action@8d6379e14d29928660c4ba802d8e85393440b329 # v2.3.8
with:
parallel-finished: true