Compare commits

...

240 Commits

Author SHA1 Message Date
be41181b43 release: v2.9.5 2023-07-24 19:13:17 +01:00
632ffc2f8e fix: arch assertions counter 2023-07-24 19:13:09 +01:00
705f19dd87 release: v2.9.4 2023-07-22 09:42:37 -05:00
5637dfa75d fix: test description on beforeEach failure 2023-07-22 09:33:41 -05:00
cf5275293f fix: snapshots directory 2023-07-20 13:47:23 -05:00
81efe5953b release: v2.9.2 2023-07-20 13:35:03 -05:00
a37a3b9f99 fix: non-working beforeEach 2023-07-20 13:27:41 -05:00
9100913184 release: v2.9.1 2023-07-20 07:39:17 -05:00
8fdb0b3d32 chore: bump dependencies 2023-07-20 07:06:08 -05:00
8322ff0f5e release: v2.9.0 2023-07-19 10:28:49 -05:00
c8287567eb Merge branch 'develop' into 2.x 2023-07-19 10:23:58 -05:00
23d7191990 Removes sponsor 2023-07-15 15:49:55 +01:00
c7e6df7c95 chore: coding style 2023-07-15 15:11:03 +01:00
805b81edc0 release: v2.8.3 2023-07-12 21:26:47 +01:00
c42541a3d9 chore: style changes 2023-07-12 21:09:40 +01:00
3f352605ca chore: upgrades arch plugin 2023-07-12 21:09:26 +01:00
21a04fefcf fix: same class on toExtend 2023-07-08 17:54:21 +01:00
aa4fb3bba2 chore: bumps arch plugin 2023-07-08 13:42:37 +01:00
4d0dffafd3 tests: adjusts snapshots 2023-07-01 10:42:57 +01:00
19e75d1070 chore: coding style 2023-07-01 10:31:26 +01:00
cee5b9feb9 fix: arguments keys 2023-07-01 10:31:26 +01:00
355a2349af feat: allows array formats 2023-07-01 10:31:26 +01:00
7e815cc985 tests: updates snapshots 2023-07-01 10:31:26 +01:00
fb443e0fa0 chore: fixes type checking 2023-07-01 10:31:26 +01:00
7f1135eeac chore: adjusts workflows 2023-07-01 10:31:26 +01:00
25e15e76e0 tests: updates snapshots 2023-07-01 10:31:26 +01:00
9426881cf6 fix: avoids usage of --update-snapshots in parallel 2023-07-01 10:31:26 +01:00
1f6970a5b3 fix: returns relative path from snapshot 2023-07-01 10:31:26 +01:00
e541ee86fc feat: adds "Illuminate\Testing\TestResponse" behavior to snapshot testing 2023-07-01 10:31:26 +01:00
b1c6f247e0 chore: uses snapshot testing in some visual testing 2023-07-01 10:31:26 +01:00
36b585835d feat: adds snapshot testing 2023-07-01 10:31:26 +01:00
17db4bd616 chore: missing properties 2023-07-01 10:31:26 +01:00
c98d8ca26a feat: more expectations 2023-07-01 10:31:26 +01:00
d5334f96a4 chore: increase deps 2023-07-01 10:31:26 +01:00
54f4ee57ad refacto: 100% type coverage 2023-07-01 10:31:26 +01:00
4f3796ed2e feat: improves VS Code auto-complete 2023-07-01 10:31:26 +01:00
ac13a288fb feat: improve grammar 2023-07-01 10:31:26 +01:00
e2ccc9deac chore: style changes 2023-07-01 10:31:26 +01:00
80129f2e23 chore: asserts style 2023-07-01 10:31:26 +01:00
5802bbc1dd feat: toHavePrefix, toHaveSuffix, toOnlyImplement, toImplementNothing 2023-07-01 10:31:26 +01:00
ee2f4eedbd feat: more reflection based expectations 2023-07-01 10:31:26 +01:00
0de1ce053a feat: toBeFinal 2023-07-01 10:31:26 +01:00
be9056f978 feat: toUseStrictTypes 2023-07-01 10:31:26 +01:00
26a6e7d712 More tests 2023-07-01 10:31:26 +01:00
a90b90ad29 docs: package description 2023-07-01 10:31:26 +01:00
bc951787d3 feat(describe): snapshots 2023-07-01 10:31:26 +01:00
0ae0887665 feat(describe): more refactors 2023-07-01 10:31:26 +01:00
551fa01415 feat(describe): more refactor 2023-07-01 10:31:26 +01:00
68ea2c7d7e feat(describe): refactor 2023-07-01 10:31:26 +01:00
3e8616ec64 feat(describe): continues work around hooks 2023-07-01 10:31:26 +01:00
465c65243d feat(describe): improves logic around hooks 2023-07-01 10:31:26 +01:00
9c0e5ddfc6 feat(describe): adds missing beforeAll exception class 2023-07-01 10:31:26 +01:00
8442b9a6e4 feat(describe): fixes missing beforeAll exception 2023-07-01 10:31:26 +01:00
a1208b5876 release: v2.8.2 2023-07-01 10:31:00 +01:00
b5f89d1ff8 chore: bumps dependencies 2023-07-01 10:28:15 +01:00
cd823193cc release: v2.8.1 2023-06-20 13:33:29 +01:00
eb7bb34825 fix: "Cannot find TestCase object on call stack" 2023-06-20 13:29:28 +01:00
19e3d929b1 docs: updates changelog 2023-06-19 10:29:10 +01:00
25729f6262 release: v2.8.0 2023-06-19 09:43:57 +01:00
cbb6a58c8a feat: only exits of init 2023-06-18 11:52:51 +01:00
167c96965e chore: removes broken test 2023-06-17 20:52:19 +01:00
8db3238a1f chore: updates deps 2023-06-17 19:39:52 +01:00
cbd8cae83e tests: updates snapshots 2023-06-17 19:39:44 +01:00
3e03a87e02 Merge pull request #838 from huangdijia/patch-1
Add container registration for Kernel self
2023-06-17 19:36:22 +01:00
193dd107d7 Merge pull request #839 from cerbero90/feature/compact-output
[2.x] Compact output when using datasets
2023-06-17 19:35:35 +01:00
0cea8fe922 Merge pull request #829 from mozex/allow-pattern-in-uses
Update directory targeting logic to support glob patterns
2023-06-17 16:28:39 +01:00
abbbc9fdbb chore: update snapshot 2023-06-16 23:48:37 +02:00
10b210d2bb feat: compact console output by redacting object annotations 2023-06-16 23:48:20 +02:00
9385a3dcea Add container registration for Kernel self 2023-06-16 14:41:46 +08:00
c0af671ca2 release: v2.7.0 2023-06-15 14:11:00 +02:00
eb9f31edeb tests: unexpected output 2023-06-15 14:06:54 +02:00
0e5470b192 chore: adds support for PhpUnit@10.2.2 2023-06-15 12:02:00 +02:00
2122e57990 fix: revert higher order message property 2023-06-15 10:44:52 +02:00
e42d224db2 fix: escape service 2023-06-15 10:43:39 +02:00
070139eda7 fix: higher order message 2023-06-15 10:42:31 +02:00
a0d0182031 refacto: uses non-static 2023-06-15 10:38:33 +02:00
1885d4e110 chore: bumps dev tools 2023-06-15 10:38:26 +02:00
5959890125 refacto: early returns 2023-06-15 10:38:17 +02:00
7460bd6c1f chore: adjusts style 2023-06-13 19:59:59 +02:00
801346b894 move tests to GlobPatternTests folder and add comments for test cases 2023-06-12 12:53:27 +03:00
40fd06c0d0 Update src/PendingCalls/UsesCall.php
Co-authored-by: Owen Voke <development@voke.dev>
2023-06-12 12:38:51 +03:00
aa9fe351a6 fix tests and static type check error 2023-06-10 18:00:46 +03:00
e00efb1b6d add tests for directory and file patterns 2023-06-08 14:52:39 +03:00
86a765b06b Merge branch 'pestphp:2.x' into allow-pattern-in-uses 2023-06-08 14:50:51 +03:00
3c20e8114e release: v2.6.3 2023-06-07 21:19:04 +02:00
73a859ee56 chore: bumps phpunit dependency 2023-06-07 21:17:10 +02:00
c9180e590e Update directory targeting logic to support glob patterns 2023-06-07 14:56:19 +03:00
4196579a3d chore: bumps arch plugin 2023-06-03 00:17:20 +01:00
436b20857d docs: updates changelog 2023-06-02 22:46:07 +01:00
82b0adf5ae release: v2.6.2 2023-06-02 22:43:42 +01:00
a0041f139c chore: bumps phpunit dependency 2023-06-02 22:40:46 +01:00
b25bc7ee05 docs: updates changelog 2023-05-12 09:23:13 +01:00
faafedd55c release: v2.6.1 2023-05-12 09:22:02 +01:00
c99325275a chore: bumps dependencies 2023-05-12 09:16:45 +01:00
37a7583755 Merge pull request #809 from gehrisandro/fix-teamcity-output
fix teamcity output for tests throwing an exception before the first assertion
2023-05-11 22:52:26 +01:00
a851b5ed70 fix teamcity output for tests throwing an exception before the first assertion 2023-05-11 22:27:43 +02:00
983659f8e8 chore: bumps paratest 2023-05-06 11:52:05 +01:00
3e1cef296f chore: updates snapshots 2023-05-06 11:51:58 +01:00
cada5c5136 Merge pull request #804 from titantwentyone/2.x
Allow traits to be covered
2023-05-06 11:49:41 +01:00
477492fdd2 Adding tests 2023-05-06 08:43:19 +01:00
963b7f43ab Allow traits to be covered 2023-05-05 17:59:52 +01:00
a34767fa15 release: v2.6.0 2023-05-02 00:51:14 +01:00
fe3c7d72bd chore: bumps dependencies and fixes static analysis 2023-05-02 00:51:01 +01:00
97898a0a8e feat: allows to use test calls on before each calls 2023-05-01 22:18:47 +01:00
cddddc3ec1 Merge pull request #797 from fabio-ivona/toThrow-improvement
[2.x] allow to expect `toThrow` against an exception instance
2023-05-01 21:30:17 +01:00
f8930d20ae allows to check toThrow against an exception instance 2023-05-01 21:42:47 +02:00
2e25eb59b8 style: fixes 2023-04-25 21:32:09 +01:00
a5471fd0f4 chore: bumps dependencies 2023-04-23 00:03:18 +01:00
9842e1051d release: v2.5.3 2023-04-22 23:14:57 +01:00
d39e4f15fe release: v2.5.2 2023-04-19 09:53:08 +01:00
1a05df14d0 chore: bumps dependencies 2023-04-19 09:49:26 +01:00
5c0df87f52 release: v2.5.1 2023-04-18 00:47:56 +01:00
ec6a81735a chore: bumps phpunit dependency 2023-04-18 00:45:41 +01:00
2ea37f3424 Merge pull request #772 from MaurizioMoreo/pcov_fix
Add PCOV availability check
2023-04-16 14:11:05 +01:00
2e4206cb97 tests: adjusts snapshots 2023-04-15 16:17:22 +01:00
72b3cdaab4 Merge pull request #770 from ganyicz/2.x
Update stub extensions
2023-04-15 16:12:16 +01:00
9744b9848e Merge pull request #783 from fabio-ivona/fix-comments-in-test-name
fix comments in dokblocks
2023-04-15 11:26:06 +01:00
e1143d2cfc remove ->only() 2023-04-15 11:52:07 +02:00
5861b0498a fix comments in dokblocks 2023-04-15 10:45:51 +02:00
f6d9aa51bd chore: bump dependencies 2023-04-14 11:50:44 +01:00
9070b12377 release: v2.5.0 2023-04-14 11:13:56 +01:00
dab68d6d85 Fixes caret 2023-04-14 11:12:32 +01:00
40de54ecd5 Merge pull request #780 from pestphp/chore/phpunit10-1-support
[2.x] Adds `phpunit/phpunit@10.1` support
2023-04-14 11:02:06 +01:00
6d8b926df3 chore: adjusts for parallel testing 2023-04-14 11:01:54 +01:00
d6c3f3522b chore: fix caret 2023-04-13 12:51:19 +01:00
41cdb5f01b chore: skips parallel testing 2023-04-13 12:23:17 +01:00
0064f3fdff chore: phpunit ^10.1 support 2023-04-13 11:03:29 +01:00
518035514e Add PHPDBG availability check 2023-04-09 09:27:52 +02:00
81cdb7a300 chore: refacto 2023-04-08 12:23:10 +01:00
97dbda92e6 Update stub extensions 2023-04-08 01:24:00 +02:00
4520fe918a Add PCOV availability check 2023-04-07 17:19:34 +02:00
f73e6aebcb Merge pull request #763 from gehrisandro/fix-typos
[2.x] fix: various typos fixed
2023-04-03 08:11:53 +01:00
3b9ca8853f fix: various typos fixed 2023-04-03 07:50:25 +02:00
cbc26faeb9 docs: updates changelog 2023-04-02 21:13:55 +01:00
12c75524a2 release: v2.4.0 2023-04-02 21:12:31 +01:00
6edbd69dc4 chore: update dependencies 2023-04-02 20:44:35 +01:00
0cfb1237e5 docs: update changelog 2023-04-02 20:37:42 +01:00
cab6aa6e57 Merge pull request #760 from lucasgiovanny/toHaveProperties
Add possibility to check property name and value with toHaveProperties
2023-04-02 20:35:13 +01:00
9ff2f3b46c docs: update changelog 2023-04-02 20:29:30 +01:00
ead0237fb3 chore: bumps dependencies 2023-04-02 20:17:55 +01:00
31726b51ad update toHaveProperties 2023-04-02 11:15:31 +01:00
99d3ee448c docs: unreleased notes 2023-04-01 06:47:14 +01:00
d21ae255f1 Merge pull request #757 from pestphp/feat/skip-on-windows
[2.x] Adds `skipOnWindows()`, `skipOnMac()`, and `skipOnLinux()`
2023-03-31 23:43:30 +01:00
0823e5da88 feat: reworks methods 2023-03-31 23:42:10 +01:00
1f913f6fc1 Merge pull request #758 from faissaloux/feat/skip-on-os-family
skip os family
2023-03-31 23:27:51 +01:00
a6dec31b9d fix return 2023-03-31 22:11:32 +00:00
c1979f735f add ability to skip on multiple os families 2023-03-31 22:09:45 +00:00
1c1cb1e591 skip os family 2023-03-31 22:03:18 +00:00
49ddcbd66b feat: skips on windows 2023-03-31 22:20:48 +01:00
23c8adf497 Merge pull request #755 from fabio-ivona/fix-windows-tests
fix windows tests
2023-03-31 09:54:47 +01:00
8e3d7d85e8 fix windows tests 2023-03-31 10:53:11 +02:00
3cee6a499d chore: refactor RenderableOnCollisionEditor 2023-03-31 09:39:05 +01:00
3f38f19df8 Merge pull request #754 from fabio-ivona/collision-custom-editor-support
[2.x] Collision custom editor support
2023-03-31 09:15:35 +01:00
4df6ab4a84 lint 2023-03-31 08:59:38 +02:00
90b6771451 add tests 2023-03-31 08:46:35 +02:00
681723cbc3 matches Collision changes 2023-03-31 08:43:59 +02:00
d9595ec122 chore: bumps dev dependencies 2023-03-30 22:41:21 +01:00
ec35010cf4 Merge pull request #753 from gehrisandro/fix-tests-in-helpers-directory
[2.x] fix: tests in Helpers directory are not executed
2023-03-30 22:32:13 +01:00
d14f2728d8 fix: tests in Helpers directory are not executed 2023-03-30 21:49:17 +02:00
152b7a9fc4 Merge pull request #748 from ncharalampidis/2.x
Fix parallel execution of test class that extends another class with same name
2023-03-29 16:58:21 +01:00
56ec3b9ee3 Merge pull request #747 from gehrisandro/add-teamcity-testsuite-count
teamcity: add missing test count output
2023-03-29 12:10:45 +01:00
ca69e4fd94 remove unnecessary custom phpunit xml added previously 2023-03-29 13:23:43 +03:00
1965763cd0 fix parallel execution of test class that inherit other class with the same name 2023-03-29 13:02:18 +03:00
cd8d94780f teamcity: add missing test count output 2023-03-29 00:03:14 +02:00
ba87e1fde8 Merge pull request #745 from dansysanalyst/improve_exception_message
Slightly Improvement on Exception message
2023-03-28 12:34:10 +01:00
e48bd31ae4 improve message 2023-03-28 12:19:15 +01:00
5ae061d208 release: release: v2.3.0 2023-03-28 10:16:29 +01:00
3d7e621b7d chore: phpunit >10.0.19 support 2023-03-28 10:11:58 +01:00
bf14c4262a Merge pull request #740 from faissaloux/scheduled-workflows-condition
[2.x] Run scheduled workflows only on origin repo
2023-03-28 08:48:42 +01:00
b186d7a4ee Merge pull request #743 from pestphp/feat/uses-hint
[2.x] Adds `uses()` hint
2023-03-28 08:13:10 +01:00
e109cd1da2 feat: uses()hint 2023-03-28 01:48:46 +01:00
473f295b77 run scheduled workflows only on origin repo 2023-03-25 01:48:18 +00:00
a05684026e wip 2023-03-24 19:00:38 +01:00
5df46d03c3 Merge pull request #739 from dansysanalyst/fix_inconsistent_dataset_spelling
Inconsistency in spelling of "dataset"
2023-03-24 16:22:28 +00:00
19424ae06d fix inconsistency in dataset spelling 2023-03-24 16:00:33 +01:00
6c8970e0a3 release: v2.2.3 2023-03-24 11:26:54 +00:00
2f2b51ce3d chore: bumps dependencies 2023-03-24 11:22:41 +00:00
33f596bcce Merge pull request #703 from pestphp/2.x_parallel_args
[2.x] feat(parallel): Adds support for plugins to filter parallel arguments
2023-03-24 11:22:19 +00:00
50a96dcb8f Merge pull request #736 from fabio-ivona/fix-dataset-mismatch-message
[chore] Remove dataset name from DatasetArgsCountMismatch
2023-03-24 09:45:08 +00:00
d9a4fa33b9 remove dataset name from DatasetArgsCountMismatch 2023-03-24 10:20:20 +01:00
cc6bd59df9 release: v2.2.2 2023-03-23 21:48:55 +00:00
3ce6408195 fix: parallel testing test description 2023-03-23 21:47:10 +00:00
1c673fcff9 feat(parallel): Adds support for plugins to filter parallel arguments 2023-03-22 11:30:53 +00:00
ff82596158 feat(parallel): Adds support for plugins to filter parallel arguments 2023-03-22 11:27:26 +00:00
0539d2ba62 feat(parallel): Adds support for plugins to filter parallel arguments 2023-03-22 11:25:33 +00:00
221ac62f03 release: v2.2.1 2023-03-22 11:20:25 +00:00
4b6c949032 chore: updates snapshots 2023-03-22 11:18:10 +00:00
1915ad368a feat(parallel): Adds support for plugins to filter parallel arguments 2023-03-22 11:17:11 +00:00
1408cffc02 chore: bumps PHPUnit to ^10.0.18 2023-03-22 11:16:31 +00:00
95b5379945 Merge pull request #724 from fabio-ivona/fix-test-names-collision
[chore] Fix underscores in test names
2023-03-22 11:16:24 +00:00
a4833bbfe4 feat(parallel): Adds support for plugins to filter parallel arguments 2023-03-22 11:13:39 +00:00
cb1c777b9b Merge pull request #725 from fabio-ivona/disable-integration-tests-on-PRs
disable integration tests for PR workflows
2023-03-22 11:11:33 +00:00
7433cc5565 feat(parallel): Adds support for plugins to filter parallel arguments 2023-03-22 11:09:53 +00:00
4c769fac66 feat(parallel): Adds support for plugins to filter parallel arguments 2023-03-22 10:58:48 +00:00
176d3efbc6 fix workflow name 2023-03-22 11:54:54 +01:00
d635665c1b disable integration tests for PR workflows 2023-03-22 11:53:33 +01:00
22467d05c8 fix underscores in test names 2023-03-22 11:24:21 +01:00
7a699e16db release: v2.2.0 2023-03-22 10:05:58 +00:00
341ba56bb9 fix: uses DateTimeInterface instead 2023-03-22 09:46:23 +00:00
a320cc3e2b Merge pull request #721 from faissaloux/fix-dirty-files-filter
[2.x] Fix `--dirty` not working on Windows
2023-03-22 09:43:13 +00:00
8b428357b2 chore: collision snapshots 2023-03-22 00:01:11 +00:00
bb6d6b0951 tests: adds collision tests 2023-03-21 23:55:33 +00:00
b94b8c6a4f fix dirty files filter 2023-03-21 23:48:22 +00:00
43894afa18 chore: updates snapshots 2023-03-21 21:10:58 +00:00
28de31a8b9 Merge pull request #698 from fabio-ivona/dataset-arguments-check
[chore] Better dataset arguments mismatch message
2023-03-21 21:10:30 +00:00
974e70d7d1 Merge branch '2.x' into dataset-arguments-check 2023-03-21 21:10:22 +00:00
f914f1ad87 fix: adds --parallel option to help 2023-03-21 21:07:57 +00:00
14dd5cb57b fix: test result on parallel 2023-03-21 21:05:11 +00:00
077ed287b7 chore: updates snapshots 2023-03-21 20:33:39 +00:00
9a41f2ff82 Merge pull request #716 from dansysanalyst/improve_types
Improve types in Greater/Lesser Expectations
2023-03-21 20:30:34 +00:00
88f29e4180 Merge branch '2.x' into improve_types 2023-03-21 20:30:29 +00:00
c34f649724 release: v2.1.0 2023-03-21 17:04:03 +00:00
e1e4f8d884 chore: rebuilds snapshots 2023-03-21 16:57:07 +00:00
2d6d8b810b Merge pull request #715 from pestphp/fix/method-names
[2.x] Fix `ふが` type of chars
2023-03-21 16:55:57 +00:00
bcd1503cad feat: "only" method 2023-03-21 16:54:37 +00:00
e0f2919f62 expand Str::evaluable test cases 2023-03-21 17:39:01 +01:00
a8bd353ba6 Including tests for Date and DateTimeImmutable 2023-03-21 15:24:42 +01:00
ed3bb2634d using php documentation regex 2023-03-21 15:15:38 +01:00
48ae4bfc18 fix: description when using ふが chars 2023-03-21 13:45:20 +00:00
26bb0b6eec chore: bumps dependencies 2023-03-21 13:44:18 +00:00
236a9bd7ce chore: style changes 2023-03-21 13:42:21 +00:00
f4d19c90d3 chore: bumps dependencies 2023-03-21 13:42:10 +00:00
ecbaff503e Add Date/DateTimeImmutable to Expectations 2023-03-21 14:37:17 +01:00
9d0cd32e3f release: v2.0.2 2023-03-20 17:52:35 +00:00
8782e9c34e release: v2.0.2 2023-03-20 17:52:15 +00:00
a4932e41de release: v2.0.2 2023-03-20 17:51:54 +00:00
522ac55d5f chore: rebuilds snapshots 2023-03-20 17:45:35 +00:00
b3a8aef6ac chore: improves tests 2023-03-20 17:42:44 +00:00
8068bebebd chore: updates snapshots 2023-03-20 17:36:18 +00:00
b887116e5c fix: Pest.php file not loaded in certain environments 2023-03-20 17:34:42 +00:00
6071d86ac6 tests: update snapshot testing 2023-03-20 16:14:40 +00:00
5723da1043 tests: updates snapshot testing 2023-03-20 16:10:53 +00:00
17e242a5f6 tests: windows global functions 2023-03-20 16:08:14 +00:00
c9a8007811 chore: uses instance method of facade 2023-03-20 16:00:11 +00:00
c64c41a4d9 chore: requires "phpunit/phpunit": "^10.0.17" 2023-03-20 15:52:41 +00:00
da4bf7f5c3 update snapshots 2023-03-20 16:49:15 +01:00
bb5dbc878e chore: bumps required version of arch plugin 2023-03-20 15:22:10 +00:00
7d89d3546e update snapshots 2023-03-19 00:22:31 +01:00
1f3e5115c7 fix failure message 2023-03-19 00:14:18 +01:00
9de85175db better dataset arguments mismatch message 2023-03-18 23:58:09 +01:00
161 changed files with 3259 additions and 773 deletions

42
.github/workflows/integration-tests.yml vendored Normal file
View File

@ -0,0 +1,42 @@
name: Integration Tests
on:
push:
schedule:
- cron: '0 0 * * *'
jobs:
ci:
if: github.event_name != 'schedule' || github.repository == 'pestphp/pest'
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]
php: ['8.1', '8.2']
dependency-version: [prefer-lowest, prefer-stable]
name: PHP ${{ matrix.php }} - ${{ matrix.os }} - ${{ matrix.dependency-version }}
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php }}
tools: composer:v2
coverage: none
- name: Setup Problem Matches
run: |
echo "::add-matcher::${{ runner.tool_cache }}/php.json"
echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
- name: Install PHP dependencies
run: composer update --${{ matrix.dependency-version }} --no-interaction --no-progress --ansi
- name: Integration Tests
run: composer test:integration

View File

@ -8,6 +8,7 @@ on:
jobs: jobs:
static: static:
if: github.event_name != 'schedule' || github.repository == 'pestphp/pest'
name: Static Tests name: Static Tests
runs-on: ubuntu-latest runs-on: ubuntu-latest
@ -29,8 +30,11 @@ jobs:
- name: Install Dependencies - name: Install Dependencies
run: composer update --prefer-stable --no-interaction --no-progress --ansi run: composer update --prefer-stable --no-interaction --no-progress --ansi
- name: Types - name: Type Check
run: composer test:types run: composer test:type:check
- name: Type Coverage
run: composer test:type:coverage
- name: Refacto - name: Refacto
run: composer test:refacto run: composer test:refacto

View File

@ -9,6 +9,7 @@ on:
jobs: jobs:
ci: ci:
if: github.event_name != 'schedule' || github.repository == 'pestphp/pest'
runs-on: ${{ matrix.os }} runs-on: ${{ matrix.os }}
strategy: strategy:
matrix: matrix:
@ -42,7 +43,4 @@ jobs:
- name: Unit Tests in Parallel - name: Unit Tests in Parallel
run: composer test:parallel run: composer test:parallel
if: startsWith(matrix.os, 'windows') != true
- name: Integration Tests
run: composer test:integration

View File

@ -2,13 +2,171 @@
## Unreleased ## Unreleased
## [v2.9.4 (2023-07-22)](https://github.com/pestphp/pest/compare/v2.9.3...v2.9.4)
### Fixed
- Output on `describe` `beforeEach` failure ([5637dfa](https://github.com/pestphp/pest/commit/5637dfa75d1a331adc810935536cde7c3196af06))
## [v2.9.3 (2023-07-20)](https://github.com/pestphp/pest/compare/v2.9.2...v2.9.3)
### Fixed
- Snapshots directory on Windows environments ([cf52752](https://github.com/pestphp/pest/commit/cf5275293fe693ec2cf4dbadbadae01daaa08169))
## [v2.9.2 (2023-07-20)](https://github.com/pestphp/pest/compare/v2.9.1...v2.9.2)
### Fixed
- `beforeEach` on Windows environments ([a37a3b9](https://github.com/pestphp/pest/commit/a37a3b9f9931bc1ab1ea9e1d6d38dfb55dde3f74))
## [v2.9.1 (2023-07-20)](https://github.com/pestphp/pest/compare/v2.9.0...v2.9.1)
### Chore
- Bumps PHPUnit to `^10.2.6` ([8fdb0b3](https://github.com/pestphp/pest/commit/8fdb0b3d32ce9ee12bd182f22751c2b41a53e97b))
## [v2.9.0 (2023-07-19)](https://github.com/pestphp/pest/compare/v2.8.1...v2.9.0)
> "Spicy Summer" is the codename assigned to Pest 2.9, for full details check our announcement: [https://pestphp.com/docs/pest-spicy-summer-release](https://pestphp.com/docs/pest-spicy-summer-release)
### Added
- Built-in Snapshot Testing ([c828756](https://github.com/pestphp/pest/commit/c8287567eb8c3dbea5845b2a6f70804b094b4b60))
- Describe Blocks ([c828756](https://github.com/pestphp/pest/commit/c8287567eb8c3dbea5845b2a6f70804b094b4b60))
- Architectural Testing++ ([c828756](https://github.com/pestphp/pest/commit/c8287567eb8c3dbea5845b2a6f70804b094b4b60))
- Type Coverage Plugin ([c828756](https://github.com/pestphp/pest/commit/c8287567eb8c3dbea5845b2a6f70804b094b4b60))
- Drift Plugin ([c828756](https://github.com/pestphp/pest/commit/c8287567eb8c3dbea5845b2a6f70804b094b4b60))
## [v2.8.1 (2023-06-20)](https://github.com/pestphp/pest/compare/v2.8.0...v2.8.1)
### Fixed
- Fixes "Cannot find TestCase object on call stack" ([eb7bb34](https://github.com/pestphp/pest/commit/eb7bb348253f412e806a6ba6f0df46c0435d0dfe))
## [v2.8.0 (2023-06-19)](https://github.com/pestphp/pest/compare/v2.7.0...v2.8.0)
### Added
- Support for `globs` in `uses` ([#829](https://github.com/pestphp/pest/pull/829))
## [v2.7.0 (2023-06-15)](https://github.com/pestphp/pest/compare/v2.6.3...v2.7.0)
### Added
- Support for unexpected output on printer ([eb9f31e](https://github.com/pestphp/pest/commit/eb9f31edeb00a88c449874f3d48156128a00fff8))
### Chore
- Bumps PHPUnit to `^10.2.2` ([0e5470b](https://github.com/pestphp/pest/commit/0e5470b192b259ba2db7c02a50371216c98fc0a6))
## [v2.6.3 (2023-06-07)](https://github.com/pestphp/pest/compare/v2.6.2...v2.6.3)
### Chore
- Bumps PHPUnit to `^10.2.1` ([73a859e](https://github.com/pestphp/pest/commit/73a859ee563fe96944ba39b191dceca28ef703c2))
## [v2.6.2 (2023-06-02)](https://github.com/pestphp/pest/compare/v2.6.1...v2.6.2)
### Chore
- Bumps PHPUnit to `^10.2.0` ([a0041f1](https://github.com/pestphp/pest/commit/a0041f139cba94fe5d15318c38e275f2e2fb3350))
## [v2.6.1 (2023-04-12)](https://github.com/pestphp/pest/compare/v2.6.0...v2.6.1)
### Fixes
- PHPStorm issue output problem for tests throwing an exception before the first assertion ([#809](https://github.com/pestphp/pest/pull/809))
- Allow traits to be covered ([#804](https://github.com/pestphp/pest/pull/804))
### Chore
- Bumps PHPUnit to `^10.1.3` ([c993252](https://github.com/pestphp/pest/commit/c99325275acf1fd3759b487b93ec50473f706709))
## [v2.6.0 (2023-04-05)](https://github.com/pestphp/pest/compare/v2.5.2...v2.6.0)
### Adds
- Allows `toThrow` to be used against an exception instance ([#797](https://github.com/pestphp/pest/pull/797))
## [v2.5.2 (2023-04-19)](https://github.com/pestphp/pest/compare/v2.5.1...v2.5.2)
### Chore
- Removes `myclabs/php-enuma` dependency ([1a05df1](https://github.com/pestphp/pest/commit/1a05df14d0ce7d12583df26ff716807db6f81f13))
## [v2.5.1 (2023-04-18)](https://github.com/pestphp/pest/compare/v2.5.0...v2.5.1)
### Chore
- Bumps PHPUnit to `^10.1.1` ([ec6a817](https://github.com/pestphp/pest/commit/ec6a81735af19f5463d24545df97535d77697ec6))
## [v2.5.0 (2023-04-14)](https://github.com/pestphp/pest/compare/v2.4.0...v2.5.0)
### Chore
- Bumps PHPUnit to `^10.1.0` ([#780](https://github.com/pestphp/pest/pull/780))
## [v2.4.0 (2023-04-03)](https://github.com/pestphp/pest/compare/v2.3.0...v2.4.0)
### Added
- `skipOnWindows()`, `skipOnMac()`, and `skipOnLinux()` ([#757](https://github.com/pestphp/pest/pull/757))
- source architecture testing violation ([#1](https://github.com/pestphp/pest-plugin-arch/pull/1))([8e66263](https://github.com/pestphp/pest-plugin-arch/commit/8e66263104304e99e3d6ceda25c7ed679b27fb03))
- `toHaveProperties` may now also check values ([#760](https://github.com/pestphp/pest/pull/760))
### Fixed
- Tests on `tests/Helpers` directory not being executed ([#753](https://github.com/pestphp/pest/pull/753))
- Teamcity count ([#747](https://github.com/pestphp/pest/pull/747))
- Parallel execution when class extends class with same name ([#748](https://github.com/pestphp/pest/pull/748))
- Wording on `uses()` hint ([#745](https://github.com/pestphp/pest/pull/745/files))
## [v2.3.0 (2023-03-28)](https://github.com/pestphp/pest/compare/v2.2.3...v2.3.0)
### Added
- Better error handler about missing uses ([#743](https://github.com/pestphp/pest/pull/743))
### Fixed
- Inconsistent spelling of `dataset` ([#739](https://github.com/pestphp/pest/pull/739))
### Chore
- Bumps PHPUnit to `^10.0.19` ([3d7e621](https://github.com/pestphp/pest/commit/3d7e621b7dfc03f0b2d9dcf6eb06c26bc383f502))
## [v2.2.3 (2023-03-24)](https://github.com/pestphp/pest/compare/v2.2.2...v2.2.3)
### Fixed
- Unnecessary dataset on dataset arguments mismatch ([#736](https://github.com/pestphp/pest/pull/736))
- Parallel arguments on plugins order ([#703](https://github.com/pestphp/pest/pull/703))
- Arch plugin runtime exceptions on bad phpdocs ([2f2b51c](https://github.com/pestphp/pest/commit/2f2b51ce3d1b000be9d6add0e785fd0044931b3b))
## [v2.2.2 (2023-03-23)](https://github.com/pestphp/pest/compare/v2.2.1...v2.2.2)
### Fixed
- Edge case in parallel execution test description ([3ce6408](https://github.com/pestphp/pest/commit/3ce640819541ca6022b250e000f336d87c3e7889))
## [v2.2.1 (2023-03-22)](https://github.com/pestphp/pest/compare/v2.2.0...v2.2.1)
### Fixed
- Collision between tests names with underscores ([#724](https://github.com/pestphp/pest/pull/724))
### Chore
- Bumps PHPUnit to `^10.0.18` ([1408cff](https://github.com/pestphp/pest/commit/1408cffc028690057e44f00038f9390f776e6bfb))
## [v2.2.0 (2023-03-22)](https://github.com/pestphp/pest/compare/v2.1.0...v2.2.0)
### Added
- Improved error messages on dataset arguments mismatch ([#698](https://github.com/pestphp/pest/pull/698))
- Allows the usage of `DateTimeInterface` on multiple expectations ([#716](https://github.com/pestphp/pest/pull/716))
### Fixed
- `--dirty` option on Windows environments ([#721](https://github.com/pestphp/pest/pull/721))
- Parallel exit code when `phpunit.xml` is outdated ([14dd5cb](https://github.com/pestphp/pest/commit/14dd5cb57b9432300ac4e8095f069941cb43bdb5))
## [v2.1.0 (2023-03-21)](https://github.com/pestphp/pest/compare/v2.0.2...v2.1.0)
### Added
- `only` test case method ([bcd1503](https://github.com/pestphp/pest/commit/bcd1503cade938853a55c1283b02b6b820ea0b69))
### Fixed
- Issues with different characters on test names ([715](https://github.com/pestphp/pest/pull/715))
## [v2.0.2 (2023-03-20)](https://github.com/pestphp/pest/compare/v2.0.1...v2.0.2)
### Fixed
- `Pest.php` not being loaded in certain scenarios ([b887116](https://github.com/pestphp/pest/commit/b887116e5ce9a69403ad620cad20f0a029474eb5))
## [v2.0.1 (2023-03-20)](https://github.com/pestphp/pest/compare/v2.0.0...v2.0.1) ## [v2.0.1 (2023-03-20)](https://github.com/pestphp/pest/compare/v2.0.0...v2.0.1)
### Fixed ### Fixed
- Wrong `version` configuration key on `composer.json` ([8f91f40](https://github.com/pestphp/pest/commit/8f91f40e8ea8b35e04b7989bed6a8f9439e2a2d6)) - Wrong `version` configuration key on `composer.json` ([8f91f40](https://github.com/pestphp/pest/commit/8f91f40e8ea8b35e04b7989bed6a8f9439e2a2d6))
###
## [v2.0.0 (2023-03-20)](https://github.com/pestphp/pest/compare/v1.22.6...v2.0.0) ## [v2.0.0 (2023-03-20)](https://github.com/pestphp/pest/compare/v1.22.6...v2.0.0)
Please consult the [upgrade guide](https://pestphp.com/docs/upgrade-guide) and [release notes](https://pestphp.com/docs/announcing-pest2) in the official Pest documentation. Please consult the [upgrade guide](https://pestphp.com/docs/upgrade-guide) and [release notes](https://pestphp.com/docs/announcing-pest2) in the official Pest documentation.

View File

@ -32,7 +32,6 @@ We cannot thank our sponsors enough for their incredible support in funding Pest
- [Codecourse](https://codecourse.com/) - [Codecourse](https://codecourse.com/)
- [Laracasts](https://laracasts.com/) - [Laracasts](https://laracasts.com/)
- [Localazy](https://localazy.com) - [Localazy](https://localazy.com)
- [Hyvor](https://hyvor.com/)
- [Fathom Analytics](https://usefathom.com/) - [Fathom Analytics](https://usefathom.com/)
- [Meema](https://meema.io) - [Meema](https://meema.io)
- [Zapiet](https://www.zapiet.com) - [Zapiet](https://www.zapiet.com)

View File

@ -1,7 +1,6 @@
#!/usr/bin/env php #!/usr/bin/env php
<?php declare(strict_types=1); <?php declare(strict_types=1);
use Pest\ConfigLoader;
use Pest\Kernel; use Pest\Kernel;
use Pest\Panic; use Pest\Panic;
use Pest\TestCaseFilters\GitDirtyTestCaseFilter; use Pest\TestCaseFilters\GitDirtyTestCaseFilter;
@ -71,7 +70,7 @@ use Symfony\Component\Console\Output\ConsoleOutput;
$testSuite = TestSuite::getInstance( $testSuite = TestSuite::getInstance(
$rootPath, $rootPath,
$input->getParameterOption('--test-directory', (new ConfigLoader($rootPath))->getTestsDirectory()), $input->getParameterOption('--test-directory', 'tests'),
); );
if ($dirty) { if ($dirty) {

View File

@ -4,7 +4,6 @@ declare(strict_types=1);
use ParaTest\WrapperRunner\ApplicationForWrapperWorker; use ParaTest\WrapperRunner\ApplicationForWrapperWorker;
use ParaTest\WrapperRunner\WrapperWorker; use ParaTest\WrapperRunner\WrapperWorker;
use Pest\ConfigLoader;
use Pest\Kernel; use Pest\Kernel;
use Pest\Plugins\Actions\CallsHandleArguments; use Pest\Plugins\Actions\CallsHandleArguments;
use Pest\TestSuite; use Pest\TestSuite;
@ -18,7 +17,7 @@ $bootPest = (static function (): void {
$rootPath = dirname(PHPUNIT_COMPOSER_INSTALL, 2); $rootPath = dirname(PHPUNIT_COMPOSER_INSTALL, 2);
$testSuite = TestSuite::getInstance($rootPath, $workerArgv->getParameterOption( $testSuite = TestSuite::getInstance($rootPath, $workerArgv->getParameterOption(
'--test-directory', '--test-directory',
(new ConfigLoader($rootPath))->getTestsDirectory() 'tests'
)); ));
$input = new ArgvInput(); $input = new ArgvInput();
@ -32,6 +31,7 @@ $bootPest = (static function (): void {
$getopt = getopt('', [ $getopt = getopt('', [
'status-file:', 'status-file:',
'progress-file:', 'progress-file:',
'unexpected-output-file:',
'testresult-file:', 'testresult-file:',
'teamcity-file:', 'teamcity-file:',
'testdox-file:', 'testdox-file:',
@ -59,6 +59,7 @@ $bootPest = (static function (): void {
assert(is_resource($statusFile)); assert(is_resource($statusFile));
assert(isset($getopt['progress-file']) && is_string($getopt['progress-file'])); assert(isset($getopt['progress-file']) && is_string($getopt['progress-file']));
assert(isset($getopt['unexpected-output-file']) && is_string($getopt['unexpected-output-file']));
assert(isset($getopt['testresult-file']) && is_string($getopt['testresult-file'])); assert(isset($getopt['testresult-file']) && is_string($getopt['testresult-file']));
assert(! isset($getopt['teamcity-file']) || is_string($getopt['teamcity-file'])); assert(! isset($getopt['teamcity-file']) || is_string($getopt['teamcity-file']));
assert(! isset($getopt['testdox-file']) || is_string($getopt['testdox-file'])); assert(! isset($getopt['testdox-file']) || is_string($getopt['testdox-file']));
@ -74,6 +75,7 @@ $bootPest = (static function (): void {
$application = new ApplicationForWrapperWorker( $application = new ApplicationForWrapperWorker(
$phpunitArgv, $phpunitArgv,
$getopt['progress-file'], $getopt['progress-file'],
$getopt['unexpected-output-file'],
$getopt['testresult-file'], $getopt['testresult-file'],
$getopt['teamcity-file'] ?? null, $getopt['teamcity-file'] ?? null,
$getopt['testdox-file'] ?? null, $getopt['testdox-file'] ?? null,
@ -89,11 +91,11 @@ $bootPest = (static function (): void {
$testPath = fgets(STDIN); $testPath = fgets(STDIN);
if ($testPath === false || $testPath === WrapperWorker::COMMAND_EXIT) { if ($testPath === false || $testPath === WrapperWorker::COMMAND_EXIT) {
$application->end(); $application->end();
exit; exit;
} }
$exitCode = $application->runTest(trim($testPath)); // It must be a 1 byte string to ensure filesize() is equal to the number of tests executed
$exitCode = $application->runTest(realpath(trim($testPath)));
fwrite($statusFile, (string) $exitCode); fwrite($statusFile, (string) $exitCode);
fflush($statusFile); fflush($statusFile);

View File

@ -1,6 +1,6 @@
{ {
"name": "pestphp/pest", "name": "pestphp/pest",
"description": "An elegant PHP Testing Framework.", "description": "The elegant PHP Testing Framework.",
"keywords": [ "keywords": [
"php", "php",
"framework", "framework",
@ -18,16 +18,16 @@
], ],
"require": { "require": {
"php": "^8.1.0", "php": "^8.1.0",
"brianium/paratest": "^7.1.1", "brianium/paratest": "^7.2.3",
"nunomaduro/collision": "^7.2.0", "nunomaduro/collision": "^7.7.0",
"nunomaduro/termwind": "^1.15.1", "nunomaduro/termwind": "^1.15.1",
"pestphp/pest-plugin": "^2.0.0", "pestphp/pest-plugin": "^2.0.1",
"pestphp/pest-plugin-arch": "^2.0.0", "pestphp/pest-plugin-arch": "^2.2.3",
"phpunit/phpunit": "^10.0.16" "phpunit/phpunit": "^10.2.6"
}, },
"conflict": { "conflict": {
"webmozart/assert": "<1.11.0", "webmozart/assert": "<1.11.0",
"phpunit/phpunit": ">10.0.16" "phpunit/phpunit": ">10.2.6"
}, },
"autoload": { "autoload": {
"psr-4": { "psr-4": {
@ -41,6 +41,7 @@
"autoload-dev": { "autoload-dev": {
"psr-4": { "psr-4": {
"Tests\\Fixtures\\Covers\\": "tests/Fixtures/Covers", "Tests\\Fixtures\\Covers\\": "tests/Fixtures/Covers",
"Tests\\Fixtures\\Inheritance\\": "tests/Fixtures/Inheritance",
"Tests\\": "tests/PHPUnit/" "Tests\\": "tests/PHPUnit/"
}, },
"files": [ "files": [
@ -48,10 +49,12 @@
] ]
}, },
"require-dev": { "require-dev": {
"pestphp/pest-dev-tools": "^2.5.0", "pestphp/pest-dev-tools": "^2.12.0",
"symfony/process": "^6.2.7" "pestphp/pest-plugin-type-coverage": "^2.0.0",
"symfony/process": "^6.3.0"
}, },
"minimum-stability": "stable", "minimum-stability": "dev",
"prefer-stable": true,
"config": { "config": {
"sort-packages": true, "sort-packages": true,
"preferred-install": "dist", "preferred-install": "dist",
@ -67,16 +70,18 @@
"lint": "pint", "lint": "pint",
"test:refacto": "rector --dry-run", "test:refacto": "rector --dry-run",
"test:lint": "pint --test", "test:lint": "pint --test",
"test:types": "phpstan analyse --ansi --memory-limit=-1 --debug", "test:type:check": "phpstan analyse --ansi --memory-limit=-1 --debug",
"test:type:coverage": "php bin/pest --type-coverage --min=100",
"test:unit": "php bin/pest --colors=always --exclude-group=integration --compact", "test:unit": "php bin/pest --colors=always --exclude-group=integration --compact",
"test:inline": "php bin/pest --colors=always --configuration=phpunit.inline.xml", "test:inline": "php bin/pest --colors=always --configuration=phpunit.inline.xml",
"test:parallel": "php bin/pest --colors=always --exclude-group=integration --parallel --processes=10", "test:parallel": "php bin/pest --colors=always --exclude-group=integration --parallel --processes=10",
"test:integration": "php bin/pest --colors=always --group=integration -v", "test:integration": "php bin/pest --colors=always --group=integration",
"update:snapshots": "REBUILD_SNAPSHOTS=true php bin/pest --colors=always", "update:snapshots": "REBUILD_SNAPSHOTS=true php bin/pest --colors=always --update-snapshots",
"test": [ "test": [
"@test:refacto", "@test:refacto",
"@test:lint", "@test:lint",
"@test:types", "@test:type:check",
"@test:type:coverage",
"@test:unit", "@test:unit",
"@test:parallel", "@test:parallel",
"@test:integration" "@test:integration"
@ -92,10 +97,12 @@
"Pest\\Plugins\\Environment", "Pest\\Plugins\\Environment",
"Pest\\Plugins\\Help", "Pest\\Plugins\\Help",
"Pest\\Plugins\\Memory", "Pest\\Plugins\\Memory",
"Pest\\Plugins\\Only",
"Pest\\Plugins\\Printer", "Pest\\Plugins\\Printer",
"Pest\\Plugins\\ProcessIsolation", "Pest\\Plugins\\ProcessIsolation",
"Pest\\Plugins\\Profile", "Pest\\Plugins\\Profile",
"Pest\\Plugins\\Retry", "Pest\\Plugins\\Retry",
"Pest\\Plugins\\Snapshot",
"Pest\\Plugins\\Version", "Pest\\Plugins\\Version",
"Pest\\Plugins\\Parallel" "Pest\\Plugins\\Parallel"
] ]

View File

@ -2,7 +2,7 @@ ARG PHP=8.1
FROM php:${PHP}-cli-alpine FROM php:${PHP}-cli-alpine
RUN apk update \ RUN apk update \
&& apk add zip libzip-dev icu-dev && apk add zip libzip-dev icu-dev git
RUN docker-php-ext-configure zip RUN docker-php-ext-configure zip
RUN docker-php-ext-install zip RUN docker-php-ext-install zip

View File

@ -0,0 +1,56 @@
<?php
declare(strict_types=1);
/*
* This file is part of PHPUnit.
*
* (c) Sebastian Bergmann <sebastian@phpunit.de>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Event\Code;
use NunoMaduro\Collision\Contracts\RenderableOnCollisionEditor;
use PHPUnit\Event\NoPreviousThrowableException;
use PHPUnit\Framework\Exception;
use PHPUnit\Util\Filter;
use PHPUnit\Util\ThrowableToStringMapper;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class ThrowableBuilder
{
/**
* @throws Exception
* @throws NoPreviousThrowableException
*/
public static function from(\Throwable $t): Throwable
{
$previous = $t->getPrevious();
if ($previous !== null) {
$previous = self::from($previous);
}
$trace = Filter::getFilteredStacktrace($t);
if ($t instanceof RenderableOnCollisionEditor && $frame = $t->toCollisionEditor()) {
$file = $frame->getFile();
$line = $frame->getLine();
$trace = "$file:$line\n$trace";
}
return new Throwable(
$t::class,
$t->getMessage(),
ThrowableToStringMapper::map($t),
$trace,
$previous
);
}
}

View File

@ -107,7 +107,7 @@ final class NameFilterIterator extends RecursiveFilterIterator
if (preg_match('/^(.*?)#(\d+)(?:-(\d+))?$/', $filter, $matches)) { if (preg_match('/^(.*?)#(\d+)(?:-(\d+))?$/', $filter, $matches)) {
if (isset($matches[3]) && $matches[2] < $matches[3]) { if (isset($matches[3]) && $matches[2] < $matches[3]) {
$filter = sprintf( $filter = sprintf(
'%s.*with data set #(\d+)$', '%s.*with dataset #(\d+)$',
$matches[1] $matches[1]
); );
@ -115,7 +115,7 @@ final class NameFilterIterator extends RecursiveFilterIterator
$this->filterMax = (int) $matches[3]; $this->filterMax = (int) $matches[3];
} else { } else {
$filter = sprintf( $filter = sprintf(
'%s.*with data set #%s$', '%s.*with dataset #%s$',
$matches[1], $matches[1],
$matches[2] $matches[2]
); );
@ -125,7 +125,7 @@ final class NameFilterIterator extends RecursiveFilterIterator
// * testDetermineJsonError@JSON.* // * testDetermineJsonError@JSON.*
elseif (preg_match('/^(.*?)@(.+)$/', $filter, $matches)) { elseif (preg_match('/^(.*?)@(.+)$/', $filter, $matches)) {
$filter = sprintf( $filter = sprintf(
'%s.*with data set "%s"$', '%s.*with dataset "%s"$',
$matches[1], $matches[1],
$matches[2] $matches[2]
); );

View File

@ -89,7 +89,7 @@ final class DefaultResultCache implements ResultCache
*/ */
private array $times = []; private array $times = [];
public function __construct(?string $filepath = null) public function __construct(string $filepath = null)
{ {
if ($filepath !== null && is_dir($filepath)) { if ($filepath !== null && is_dir($filepath)) {
$filepath .= DIRECTORY_SEPARATOR.self::DEFAULT_RESULT_CACHE_FILENAME; $filepath .= DIRECTORY_SEPARATOR.self::DEFAULT_RESULT_CACHE_FILENAME;

View File

@ -0,0 +1,128 @@
<?php
/*
* BSD 3-Clause License
*
* Copyright (c) 2001-2023, Sebastian Bergmann
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
declare(strict_types=1);
/*
* This file is part of PHPUnit.
*
* (c) Sebastian Bergmann <sebastian@phpunit.de>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\TextUI;
use function array_map;
use Pest\Plugins\Only;
use PHPUnit\Event;
use PHPUnit\Framework\TestSuite;
use PHPUnit\Runner\Filter\Factory;
use PHPUnit\TextUI\Configuration\Configuration;
use PHPUnit\TextUI\Configuration\FilterNotConfiguredException;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class TestSuiteFilterProcessor
{
private Factory $filterFactory;
public function __construct(Factory $factory = new Factory)
{
$this->filterFactory = $factory;
}
/**
* @throws Event\RuntimeException
* @throws FilterNotConfiguredException
*/
public function process(Configuration $configuration, TestSuite $suite): void
{
if (! $configuration->hasFilter() &&
! $configuration->hasGroups() &&
! $configuration->hasExcludeGroups() &&
! $configuration->hasTestsCovering() &&
! $configuration->hasTestsUsing() &&
! Only::isEnabled()
) {
return;
}
if ($configuration->hasExcludeGroups()) {
$this->filterFactory->addExcludeGroupFilter(
$configuration->excludeGroups()
);
}
if (Only::isEnabled()) {
$this->filterFactory->addIncludeGroupFilter(['__pest_only']);
} elseif ($configuration->hasGroups()) {
$this->filterFactory->addIncludeGroupFilter(
$configuration->groups()
);
}
if ($configuration->hasTestsCovering()) {
$this->filterFactory->addIncludeGroupFilter(
array_map(
static fn (string $name): string => '__phpunit_covers_'.$name,
$configuration->testsCovering()
)
);
}
if ($configuration->hasTestsUsing()) {
$this->filterFactory->addIncludeGroupFilter(
array_map(
static fn (string $name): string => '__phpunit_uses_'.$name,
$configuration->testsUsing()
)
);
}
if ($configuration->hasFilter()) {
$this->filterFactory->addNameFilter(
$configuration->filter()
);
}
$suite->injectFilter($this->filterFactory);
Event\Facade::emitter()->testSuiteFiltered(
Event\TestSuite\TestSuiteBuilder::from($suite)
);
}
}

View File

@ -12,6 +12,7 @@ parameters:
reportUnmatchedIgnoredErrors: true reportUnmatchedIgnoredErrors: true
ignoreErrors: ignoreErrors:
- "#has a nullable return type declaration.#"
- "#Language construct isset\\(\\) should not be used.#" - "#Language construct isset\\(\\) should not be used.#"
- "#is not allowed to extend#" - "#is not allowed to extend#"
- "#is concrete, but does not have a Test suffix#" - "#is concrete, but does not have a Test suffix#"
@ -20,4 +21,3 @@ parameters:
- "# with null as default value#" - "# with null as default value#"
- "#has parameter \\$closure with default value.#" - "#has parameter \\$closure with default value.#"
- "#has parameter \\$description with default value.#" - "#has parameter \\$description with default value.#"
- "#Method Pest\\\\Support\\\\Reflection::getParameterClassName\\(\\) has a nullable return type declaration.#"

View File

@ -18,11 +18,12 @@
<directory suffix=".php">./tests</directory> <directory suffix=".php">./tests</directory>
<exclude>./tests/.snapshots</exclude> <exclude>./tests/.snapshots</exclude>
<exclude>./tests/.tests</exclude> <exclude>./tests/.tests</exclude>
<exclude>./tests/Fixtures/Inheritance</exclude>
</testsuite> </testsuite>
</testsuites> </testsuites>
<coverage> <source>
<include> <include>
<directory suffix=".php">./src</directory> <directory suffix=".php">./src</directory>
</include> </include>
</coverage> </source>
</phpunit> </phpunit>

View File

@ -0,0 +1,39 @@
<?php
declare(strict_types=1);
namespace Pest\Bootstrappers;
use Pest\Contracts\Bootstrapper;
use PHPUnit\Util\ExcludeList;
/**
* @internal
*/
final class BootExcludeList implements Bootstrapper
{
/**
* The directories to exclude.
*
* @var array<int, non-empty-string>
*/
private const EXCLUDE_LIST = [
'bin',
'overrides',
'resources',
'src',
'stubs',
];
/**
* Boots the "exclude list" for PHPUnit to ignore Pest files.
*/
public function boot(): void
{
$baseDirectory = dirname(__DIR__, 2);
foreach (self::EXCLUDE_LIST as $directory) {
ExcludeList::addDirectory($baseDirectory.DIRECTORY_SEPARATOR.$directory);
}
}
}

View File

@ -23,6 +23,8 @@ final class BootOverrides implements Bootstrapper
'Runner/TestSuiteLoader.php', 'Runner/TestSuiteLoader.php',
'TextUI/Command/WarmCodeCoverageCacheCommand.php', 'TextUI/Command/WarmCodeCoverageCacheCommand.php',
'TextUI/Output/Default/ProgressPrinter/TestSkippedSubscriber.php', 'TextUI/Output/Default/ProgressPrinter/TestSkippedSubscriber.php',
'TextUI/TestSuiteFilterProcessor.php',
'Event/Value/ThrowableBuilder.php',
]; ];
/** /**

View File

@ -45,7 +45,7 @@ final class BootSubscribers implements Bootstrapper
assert($instance instanceof Subscriber); assert($instance instanceof Subscriber);
method_exists(Event\Facade::class, 'instance') ? Event\Facade::instance()->registerSubscriber($instance) : Event\Facade::registerSubscriber($instance); // @phpstan-ignore-line Event\Facade::instance()->registerSubscriber($instance);
} }
} }
} }

View File

@ -5,7 +5,6 @@ declare(strict_types=1);
namespace Pest\Concerns; namespace Pest\Concerns;
use Closure; use Closure;
use Pest\Expectation;
/** /**
* @internal * @internal
@ -37,7 +36,7 @@ trait Pipeable
/** /**
* Register an interceptor that should replace an existing expectation. * Register an interceptor that should replace an existing expectation.
* *
* @param string|Closure(mixed $value, mixed ...$arguments):bool $filter * @param string|Closure(mixed $value, mixed ...$arguments):bool $filter
*/ */
public function intercept(string $name, string|Closure $filter, Closure $handler): void public function intercept(string $name, string|Closure $filter, Closure $handler): void
{ {

View File

@ -5,11 +5,14 @@ declare(strict_types=1);
namespace Pest\Concerns; namespace Pest\Concerns;
use Closure; use Closure;
use Pest\Exceptions\DatasetArgsCountMismatch;
use Pest\Support\ChainableClosure; use Pest\Support\ChainableClosure;
use Pest\Support\ExceptionTrace; use Pest\Support\ExceptionTrace;
use Pest\Support\Reflection; use Pest\Support\Reflection;
use Pest\TestSuite; use Pest\TestSuite;
use PHPUnit\Framework\TestCase; use PHPUnit\Framework\TestCase;
use ReflectionException;
use ReflectionFunction;
use Throwable; use Throwable;
/** /**
@ -20,37 +23,42 @@ use Throwable;
trait Testable trait Testable
{ {
/** /**
* Test method description. * The test's description.
*/ */
private string $__description; private string $__description;
/** /**
* Test "latest" method description. * The test's latest description.
*/ */
private static string $__latestDescription; private static string $__latestDescription;
/** /**
* The Test Case "test" closure. * The test's describing, if any.
*/
public ?string $__describing = null;
/**
* The test's test closure.
*/ */
private Closure $__test; private Closure $__test;
/** /**
* The Test Case "setUp" closure. * The test's before each closure.
*/ */
private ?Closure $__beforeEach = null; private ?Closure $__beforeEach = null;
/** /**
* The Test Case "tearDown" closure. * The test's after each closure.
*/ */
private ?Closure $__afterEach = null; private ?Closure $__afterEach = null;
/** /**
* The Test Case "setUpBeforeClass" closure. * The test's before all closure.
*/ */
private static ?Closure $__beforeAll = null; private static ?Closure $__beforeAll = null;
/** /**
* The test "tearDownAfterClass" closure. * The test's after all closure.
*/ */
private static ?Closure $__afterAll = null; private static ?Closure $__afterAll = null;
@ -75,6 +83,7 @@ trait Testable
if ($test->hasMethod($name)) { if ($test->hasMethod($name)) {
$method = $test->getMethod($name); $method = $test->getMethod($name);
$this->__description = self::$__latestDescription = $method->description; $this->__description = self::$__latestDescription = $method->description;
$this->__describing = $method->describing;
$this->__test = $method->getClosure($this); $this->__test = $method->getClosure($this);
} }
} }
@ -84,12 +93,12 @@ trait Testable
*/ */
public function __addBeforeAll(?Closure $hook): void public function __addBeforeAll(?Closure $hook): void
{ {
if ($hook === null) { if (! $hook instanceof \Closure) {
return; return;
} }
self::$__beforeAll = (self::$__beforeAll instanceof Closure) self::$__beforeAll = (self::$__beforeAll instanceof Closure)
? ChainableClosure::fromStatic(self::$__beforeAll, $hook) ? ChainableClosure::boundStatically(self::$__beforeAll, $hook)
: $hook; : $hook;
} }
@ -98,12 +107,12 @@ trait Testable
*/ */
public function __addAfterAll(?Closure $hook): void public function __addAfterAll(?Closure $hook): void
{ {
if ($hook === null) { if (! $hook instanceof \Closure) {
return; return;
} }
self::$__afterAll = (self::$__afterAll instanceof Closure) self::$__afterAll = (self::$__afterAll instanceof Closure)
? ChainableClosure::fromStatic(self::$__afterAll, $hook) ? ChainableClosure::boundStatically(self::$__afterAll, $hook)
: $hook; : $hook;
} }
@ -128,12 +137,12 @@ trait Testable
*/ */
private function __addHook(string $property, ?Closure $hook): void private function __addHook(string $property, ?Closure $hook): void
{ {
if ($hook === null) { if (! $hook instanceof \Closure) {
return; return;
} }
$this->{$property} = ($this->{$property} instanceof Closure) $this->{$property} = ($this->{$property} instanceof Closure)
? ChainableClosure::from($this->{$property}, $hook) ? ChainableClosure::bound($this->{$property}, $hook)
: $hook; : $hook;
} }
@ -147,7 +156,7 @@ trait Testable
$beforeAll = TestSuite::getInstance()->beforeAll->get(self::$__filename); $beforeAll = TestSuite::getInstance()->beforeAll->get(self::$__filename);
if (self::$__beforeAll instanceof Closure) { if (self::$__beforeAll instanceof Closure) {
$beforeAll = ChainableClosure::fromStatic(self::$__beforeAll, $beforeAll); $beforeAll = ChainableClosure::boundStatically(self::$__beforeAll, $beforeAll);
} }
call_user_func(Closure::bind($beforeAll, null, self::class)); call_user_func(Closure::bind($beforeAll, null, self::class));
@ -161,7 +170,7 @@ trait Testable
$afterAll = TestSuite::getInstance()->afterAll->get(self::$__filename); $afterAll = TestSuite::getInstance()->afterAll->get(self::$__filename);
if (self::$__afterAll instanceof Closure) { if (self::$__afterAll instanceof Closure) {
$afterAll = ChainableClosure::fromStatic(self::$__afterAll, $afterAll); $afterAll = ChainableClosure::boundStatically(self::$__afterAll, $afterAll);
} }
call_user_func(Closure::bind($afterAll, null, self::class)); call_user_func(Closure::bind($afterAll, null, self::class));
@ -176,12 +185,16 @@ trait Testable
{ {
TestSuite::getInstance()->test = $this; TestSuite::getInstance()->test = $this;
$method = TestSuite::getInstance()->tests->get(self::$__filename)->getMethod($this->name());
$this->__description = self::$__latestDescription = $this->dataName() ? $method->description.' with '.$this->dataName() : $method->description;
parent::setUp(); parent::setUp();
$beforeEach = TestSuite::getInstance()->beforeEach->get(self::$__filename); $beforeEach = TestSuite::getInstance()->beforeEach->get(self::$__filename)[1];
if ($this->__beforeEach instanceof Closure) { if ($this->__beforeEach instanceof Closure) {
$beforeEach = ChainableClosure::from($this->__beforeEach, $beforeEach); $beforeEach = ChainableClosure::bound($this->__beforeEach, $beforeEach);
} }
$this->__callClosure($beforeEach, func_get_args()); $this->__callClosure($beforeEach, func_get_args());
@ -195,7 +208,7 @@ trait Testable
$afterEach = TestSuite::getInstance()->afterEach->get(self::$__filename); $afterEach = TestSuite::getInstance()->afterEach->get(self::$__filename);
if ($this->__afterEach instanceof Closure) { if ($this->__afterEach instanceof Closure) {
$afterEach = ChainableClosure::from($this->__afterEach, $afterEach); $afterEach = ChainableClosure::bound($this->__afterEach, $afterEach);
} }
$this->__callClosure($afterEach, func_get_args()); $this->__callClosure($afterEach, func_get_args());
@ -212,7 +225,10 @@ trait Testable
*/ */
private function __runTest(Closure $closure, ...$args): mixed private function __runTest(Closure $closure, ...$args): mixed
{ {
return $this->__callClosure($closure, $this->__resolveTestArguments($args)); $arguments = $this->__resolveTestArguments($args);
$this->__ensureDatasetArgumentNumberMatches($arguments);
return $this->__callClosure($closure, $arguments);
} }
/** /**
@ -222,10 +238,6 @@ trait Testable
*/ */
private function __resolveTestArguments(array $arguments): array private function __resolveTestArguments(array $arguments): array
{ {
$method = TestSuite::getInstance()->tests->get(self::$__filename)->getMethod($this->name());
$this->__description = self::$__latestDescription = $this->dataName() ? $method->description.' with '.$this->dataName() : $method->description;
$underlyingTest = Reflection::getFunctionVariable($this->__test, 'closure'); $underlyingTest = Reflection::getFunctionVariable($this->__test, 'closure');
$testParameterTypes = array_values(Reflection::getFunctionArguments($underlyingTest)); $testParameterTypes = array_values(Reflection::getFunctionArguments($underlyingTest));
@ -235,7 +247,7 @@ trait Testable
continue; continue;
} }
if (in_array($testParameterTypes[$argumentIndex], [\Closure::class, 'callable', 'mixed'])) { if (in_array($testParameterTypes[$argumentIndex], [Closure::class, 'callable', 'mixed'])) {
continue; continue;
} }
@ -249,7 +261,7 @@ trait Testable
return $arguments; return $arguments;
} }
if (in_array($testParameterTypes[0], [\Closure::class, 'callable'])) { if (in_array($testParameterTypes[0], [Closure::class, 'callable'])) {
return $arguments; return $arguments;
} }
@ -264,6 +276,30 @@ trait Testable
return array_values($boundDatasetResult); return array_values($boundDatasetResult);
} }
/**
* Ensures dataset items count matches underlying test case required parameters
*
* @throws ReflectionException
* @throws DatasetArgsCountMismatch
*/
private function __ensureDatasetArgumentNumberMatches(array $arguments): void
{
if ($arguments === []) {
return;
}
$underlyingTest = Reflection::getFunctionVariable($this->__test, 'closure');
$testReflection = new ReflectionFunction($underlyingTest);
$requiredParametersCount = $testReflection->getNumberOfRequiredParameters();
$suppliedParametersCount = count($arguments);
if ($suppliedParametersCount >= $requiredParametersCount) {
return;
}
throw new DatasetArgsCountMismatch($requiredParametersCount, $suppliedParametersCount);
}
/** /**
* @throws Throwable * @throws Throwable
*/ */

View File

@ -1,113 +0,0 @@
<?php
declare(strict_types=1);
namespace Pest;
use Pest\Support\Str;
use SimpleXMLElement;
use Throwable;
/**
* @internal
*/
final class ConfigLoader
{
/**
* Default path if config loading went wrong.
*
* @var string
*/
public const DEFAULT_TESTS_PATH = 'tests';
/**
* XML tree of the PHPUnit configuration file.
*/
private ?SimpleXMLElement $config = null;
/**
* Creates a new instance of the config loader.
*/
public function __construct(private readonly string $rootPath)
{
$this->loadConfiguration();
}
/**
* Get the tests directory or fallback to default path.
*/
public function getTestsDirectory(): string
{
$suiteDirectory = [];
if (is_null($this->config)) {
return self::DEFAULT_TESTS_PATH;
}
$suiteDirectory = $this->config->xpath('/phpunit/testsuites/testsuite/directory');
if ($suiteDirectory === []) {
return self::DEFAULT_TESTS_PATH;
}
$directory = (string) ($suiteDirectory[0] ?? '');
if ($directory === '') {
return self::DEFAULT_TESTS_PATH;
}
// Return the whole directory if only a separator found (e.g. `./tests`)
if (substr_count($directory, DIRECTORY_SEPARATOR) === 1) {
return is_dir($directory) ? $directory : self::DEFAULT_TESTS_PATH;
}
$basePath = Str::beforeLast($directory, DIRECTORY_SEPARATOR);
return is_dir($basePath) ? $basePath : self::DEFAULT_TESTS_PATH;
}
/**
* Get the configuration file path.
*/
public function getConfigurationFilePath(): string|bool
{
$candidates = [
$this->rootPath.'/phpunit.xml',
$this->rootPath.'/phpunit.dist.xml',
$this->rootPath.'/phpunit.xml.dist',
];
foreach ($candidates as $candidate) {
if (is_file($candidate)) {
return realpath($candidate);
}
}
return false;
}
/**
* Load the configuration file.
*/
private function loadConfiguration(): void
{
$configPath = $this->getConfigurationFilePath();
if (is_bool($configPath)) {
return;
}
$oldReportingLevel = error_reporting(0);
$content = file_get_contents($configPath);
if ($content !== false) {
try {
$this->config = new SimpleXMLElement($content);
} catch (Throwable) { // @phpstan-ignore-line
// @ignoreException
}
}
// Restore the correct error reporting
error_reporting($oldReportingLevel);
}
}

View File

@ -7,7 +7,7 @@ namespace Pest\Contracts;
use Pest\Factories\TestCaseMethodFactory; use Pest\Factories\TestCaseMethodFactory;
/** /**
* @interal * @internal
*/ */
interface AddsAnnotations interface AddsAnnotations
{ {

View File

@ -10,7 +10,7 @@ namespace Pest\Contracts\Plugins;
interface HandlesArguments interface HandlesArguments
{ {
/** /**
* Adds arguments before of the Test Suite execution. * Adds arguments before the Test Suite execution.
* *
* @param array<int, string> $arguments * @param array<int, string> $arguments
* @return array<int, string> * @return array<int, string>

View File

@ -12,13 +12,13 @@ use Symfony\Component\Console\Exception\ExceptionInterface;
/** /**
* @internal * @internal
*/ */
final class BeforeEachAlreadyExist extends InvalidArgumentException implements ExceptionInterface, RenderlessEditor, RenderlessTrace final class AfterAllWithinDescribe extends InvalidArgumentException implements ExceptionInterface, RenderlessEditor, RenderlessTrace
{ {
/** /**
* Creates a new Exception instance. * Creates a new Exception instance.
*/ */
public function __construct(string $filename) public function __construct(string $filename)
{ {
parent::__construct(sprintf('The beforeEach already exists in the filename `%s`.', $filename)); parent::__construct(sprintf('The afterAll method can not be used within describe functions. Filename `%s`.', $filename));
} }
} }

View File

@ -12,13 +12,13 @@ use Symfony\Component\Console\Exception\ExceptionInterface;
/** /**
* @internal * @internal
*/ */
final class AfterEachAlreadyExist extends InvalidArgumentException implements ExceptionInterface, RenderlessEditor, RenderlessTrace final class BeforeAllAlreadyExist extends InvalidArgumentException implements ExceptionInterface, RenderlessEditor, RenderlessTrace
{ {
/** /**
* Creates a new Exception instance. * Creates a new Exception instance.
*/ */
public function __construct(string $filename) public function __construct(string $filename)
{ {
parent::__construct(sprintf('The afterEach already exists in the filename `%s`.', $filename)); parent::__construct(sprintf('The beforeAll already exists in the filename `%s`.', $filename));
} }
} }

View File

@ -0,0 +1,24 @@
<?php
declare(strict_types=1);
namespace Pest\Exceptions;
use InvalidArgumentException;
use NunoMaduro\Collision\Contracts\RenderlessEditor;
use NunoMaduro\Collision\Contracts\RenderlessTrace;
use Symfony\Component\Console\Exception\ExceptionInterface;
/**
* @internal
*/
final class BeforeAllWithinDescribe extends InvalidArgumentException implements ExceptionInterface, RenderlessEditor, RenderlessTrace
{
/**
* Creates a new Exception instance.
*/
public function __construct(string $filename)
{
parent::__construct(sprintf('The beforeAll method can not be used within describe functions. Filename `%s`.', $filename));
}
}

View File

@ -0,0 +1,15 @@
<?php
declare(strict_types=1);
namespace Pest\Exceptions;
use Exception;
final class DatasetArgsCountMismatch extends Exception
{
public function __construct(int $requiredCount, int $suppliedCount)
{
parent::__construct(sprintf('Test expects %d arguments but dataset only provides %d', $requiredCount, $suppliedCount));
}
}

View File

@ -7,12 +7,15 @@ namespace Pest;
use BadMethodCallException; use BadMethodCallException;
use Closure; use Closure;
use Pest\Arch\Contracts\ArchExpectation; use Pest\Arch\Contracts\ArchExpectation;
use Pest\Arch\Expectations\Targeted;
use Pest\Arch\Expectations\ToBeUsedIn; use Pest\Arch\Expectations\ToBeUsedIn;
use Pest\Arch\Expectations\ToBeUsedInNothing; use Pest\Arch\Expectations\ToBeUsedInNothing;
use Pest\Arch\Expectations\ToOnlyBeUsedIn; use Pest\Arch\Expectations\ToOnlyBeUsedIn;
use Pest\Arch\Expectations\ToOnlyUse; use Pest\Arch\Expectations\ToOnlyUse;
use Pest\Arch\Expectations\ToUse; use Pest\Arch\Expectations\ToUse;
use Pest\Arch\Expectations\ToUseNothing; use Pest\Arch\Expectations\ToUseNothing;
use Pest\Arch\PendingArchExpectation;
use Pest\Arch\Support\FileLineFinder;
use Pest\Concerns\Extendable; use Pest\Concerns\Extendable;
use Pest\Concerns\Pipeable; use Pest\Concerns\Pipeable;
use Pest\Concerns\Retrievable; use Pest\Concerns\Retrievable;
@ -24,6 +27,7 @@ use Pest\Expectations\HigherOrderExpectation;
use Pest\Expectations\OppositeExpectation; use Pest\Expectations\OppositeExpectation;
use Pest\Matchers\Any; use Pest\Matchers\Any;
use Pest\Support\ExpectationPipeline; use Pest\Support\ExpectationPipeline;
use PHPUnit\Architecture\Elements\ObjectDescription;
use PHPUnit\Framework\Assert; use PHPUnit\Framework\Assert;
use PHPUnit\Framework\ExpectationFailedException; use PHPUnit\Framework\ExpectationFailedException;
@ -34,8 +38,13 @@ use PHPUnit\Framework\ExpectationFailedException;
* *
* @property OppositeExpectation $not Creates the opposite expectation. * @property OppositeExpectation $not Creates the opposite expectation.
* @property EachExpectation $each Creates an expectation on each element on the traversable value. * @property EachExpectation $each Creates an expectation on each element on the traversable value.
* @property PendingArchExpectation $classes
* @property PendingArchExpectation $traits
* @property PendingArchExpectation $interfaces
* @property PendingArchExpectation $enums
* *
* @mixin Mixins\Expectation<TValue> * @mixin Mixins\Expectation<TValue>
* @mixin PendingArchExpectation
*/ */
final class Expectation final class Expectation
{ {
@ -64,7 +73,7 @@ final class Expectation
*/ */
public function and(mixed $value): Expectation public function and(mixed $value): Expectation
{ {
return $value instanceof static ? $value : new self($value); return $value instanceof self ? $value : new self($value);
} }
/** /**
@ -167,7 +176,7 @@ final class Expectation
* *
* @template TSequenceValue * @template TSequenceValue
* *
* @param (callable(self<TValue>, self<string|int>): void)|TSequenceValue ...$callbacks * @param (callable(self<TValue>, self<string|int>): void)|TSequenceValue ...$callbacks
* @return self<TValue> * @return self<TValue>
*/ */
public function sequence(mixed ...$callbacks): self public function sequence(mixed ...$callbacks): self
@ -210,8 +219,8 @@ final class Expectation
* *
* @template TMatchSubject of array-key * @template TMatchSubject of array-key
* *
* @param (callable(): TMatchSubject)|TMatchSubject $subject * @param (callable(): TMatchSubject)|TMatchSubject $subject
* @param array<TMatchSubject, (callable(self<TValue>): mixed)|TValue> $expressions * @param array<TMatchSubject, (callable(self<TValue>): mixed)|TValue> $expressions
* @return self<TValue> * @return self<TValue>
*/ */
public function match(mixed $subject, array $expressions): self public function match(mixed $subject, array $expressions): self
@ -248,7 +257,7 @@ final class Expectation
/** /**
* Apply the callback if the given "condition" is falsy. * Apply the callback if the given "condition" is falsy.
* *
* @param (callable(): bool)|bool $condition * @param (callable(): bool)|bool $condition
* @param callable(Expectation<TValue>): mixed $callback * @param callable(Expectation<TValue>): mixed $callback
* @return self<TValue> * @return self<TValue>
*/ */
@ -264,7 +273,7 @@ final class Expectation
/** /**
* Apply the callback if the given "condition" is truthy. * Apply the callback if the given "condition" is truthy.
* *
* @param (callable(): bool)|bool $condition * @param (callable(): bool)|bool $condition
* @param callable(self<TValue>): mixed $callback * @param callable(self<TValue>): mixed $callback
* @return self<TValue> * @return self<TValue>
*/ */
@ -287,9 +296,23 @@ final class Expectation
* @param array<int, mixed> $parameters * @param array<int, mixed> $parameters
* @return Expectation<TValue>|HigherOrderExpectation<Expectation<TValue>, TValue> * @return Expectation<TValue>|HigherOrderExpectation<Expectation<TValue>, TValue>
*/ */
public function __call(string $method, array $parameters): Expectation|HigherOrderExpectation public function __call(string $method, array $parameters): Expectation|HigherOrderExpectation|PendingArchExpectation
{ {
if (! self::hasMethod($method)) { if (! self::hasMethod($method)) {
if (! is_object($this->value) && method_exists(PendingArchExpectation::class, $method)) {
$pendingArchExpectation = new PendingArchExpectation($this, []);
return $pendingArchExpectation->$method(...$parameters); // @phpstan-ignore-line
}
if (! is_object($this->value)) {
throw new BadMethodCallException(sprintf(
'Method "%s" does not exist in %s.',
$method,
gettype($this->value)
));
}
/* @phpstan-ignore-next-line */ /* @phpstan-ignore-next-line */
return new HigherOrderExpectation($this, call_user_func_array($this->value->$method(...), $parameters)); return new HigherOrderExpectation($this, call_user_func_array($this->value->$method(...), $parameters));
} }
@ -333,6 +356,11 @@ final class Expectation
public function __get(string $name) public function __get(string $name)
{ {
if (! self::hasMethod($name)) { if (! self::hasMethod($name)) {
if (! is_object($this->value) && method_exists(PendingArchExpectation::class, $name)) {
/* @phpstan-ignore-next-line */
return $this->{$name}();
}
/* @phpstan-ignore-next-line */ /* @phpstan-ignore-next-line */
return new HigherOrderExpectation($this, $this->retrieve($name, $this->value)); return new HigherOrderExpectation($this, $this->retrieve($name, $this->value));
} }
@ -369,6 +397,252 @@ final class Expectation
return ToUse::make($this, $targets); return ToUse::make($this, $targets);
} }
/**
* Asserts that the given expectation target use the "declare(strict_types=1)" declaration.
*/
public function toUseStrictTypes(): ArchExpectation
{
return Targeted::make(
$this,
fn (ObjectDescription $object): bool => str_contains((string) file_get_contents($object->path), 'declare(strict_types=1);'),
'to use strict types',
FileLineFinder::where(fn (string $line): bool => str_contains($line, '<?php')),
);
}
/**
* Asserts that the given expectation target is final.
*/
public function toBeFinal(): ArchExpectation
{
return Targeted::make(
$this,
fn (ObjectDescription $object): bool => ! enum_exists($object->name) && $object->reflectionClass->isFinal(),
'to be final',
FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class')),
);
}
/**
* Asserts that the given expectation target is readonly.
*/
public function toBeReadonly(): ArchExpectation
{
return Targeted::make(
$this,
fn (ObjectDescription $object): bool => ! enum_exists($object->name) && $object->reflectionClass->isReadOnly(),
'to be readonly',
FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class')),
);
}
/**
* Asserts that the given expectation target is trait.
*/
public function toBeTrait(): ArchExpectation
{
return Targeted::make(
$this,
fn (ObjectDescription $object): bool => $object->reflectionClass->isTrait(),
'to be trait',
FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class')),
);
}
/**
* Asserts that the given expectation targets are traits.
*/
public function toBeTraits(): ArchExpectation
{
return $this->toBeTrait();
}
/**
* Asserts that the given expectation target is abstract.
*/
public function toBeAbstract(): ArchExpectation
{
return Targeted::make(
$this,
fn (ObjectDescription $object): bool => $object->reflectionClass->isAbstract(),
'to be abstract',
FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class')),
);
}
/**
* Asserts that the given expectation target is enum.
*/
public function toBeEnum(): ArchExpectation
{
return Targeted::make(
$this,
fn (ObjectDescription $object): bool => $object->reflectionClass->isEnum(),
'to be enum',
FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class')),
);
}
/**
* Asserts that the given expectation targets are enums.
*/
public function toBeEnums(): ArchExpectation
{
return $this->toBeEnum();
}
/**
* Asserts that the given expectation targets is an class.
*/
public function toBeClass(): ArchExpectation
{
return Targeted::make(
$this,
fn (ObjectDescription $object): bool => class_exists($object->name) && ! enum_exists($object->name),
'to be class',
FileLineFinder::where(fn (string $line): bool => true),
);
}
/**
* Asserts that the given expectation targets are classes.
*/
public function toBeClasses(): ArchExpectation
{
return $this->toBeClass();
}
/**
* Asserts that the given expectation target is interface.
*/
public function toBeInterface(): ArchExpectation
{
return Targeted::make(
$this,
fn (ObjectDescription $object): bool => $object->reflectionClass->isInterface(),
'to be interface',
FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class')),
);
}
/**
* Asserts that the given expectation targets are interfaces.
*/
public function toBeInterfaces(): ArchExpectation
{
return $this->toBeInterface();
}
/**
* Asserts that the given expectation target to be subclass of the given class.
*
* @param class-string $class
*/
public function toExtend(string $class): ArchExpectation
{
return Targeted::make(
$this,
fn (ObjectDescription $object): bool => $class === $object->reflectionClass->getName() || $object->reflectionClass->isSubclassOf($class),
sprintf("to extend '%s'", $class),
FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class')),
);
}
/**
* Asserts that the given expectation target to be have a parent class.
*/
public function toExtendNothing(): ArchExpectation
{
return Targeted::make(
$this,
fn (ObjectDescription $object): bool => $object->reflectionClass->getParentClass() === false,
'to extend nothing',
FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class')),
);
}
/**
* Asserts that the given expectation target to not implement any interfaces.
*/
public function toImplementNothing(): ArchExpectation
{
return Targeted::make(
$this,
fn (ObjectDescription $object): bool => $object->reflectionClass->getInterfaceNames() === [],
'to implement nothing',
FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class')),
);
}
/**
* Asserts that the given expectation target to only implement the given interfaces.
*
* @param array<int, class-string>|class-string $interfaces
*/
public function toOnlyImplement(array|string $interfaces): ArchExpectation
{
$interfaces = is_array($interfaces) ? $interfaces : [$interfaces];
return Targeted::make(
$this,
fn (ObjectDescription $object): bool => count($interfaces) === count($object->reflectionClass->getInterfaceNames())
&& array_diff($interfaces, $object->reflectionClass->getInterfaceNames()) === [],
"to only implement '".implode("', '", $interfaces)."'",
FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class')),
);
}
/**
* Asserts that the given expectation target to have the given suffix.
*/
public function toHavePrefix(string $suffix): ArchExpectation
{
return Targeted::make(
$this,
fn (ObjectDescription $object): bool => str_starts_with($object->reflectionClass->getName(), $suffix),
"to have prefix '{$suffix}'",
FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class')),
);
}
/**
* Asserts that the given expectation target to have the given suffix.
*/
public function toHaveSuffix(string $suffix): ArchExpectation
{
return Targeted::make(
$this,
fn (ObjectDescription $object): bool => str_ends_with($object->reflectionClass->getName(), $suffix),
"to have suffix '{$suffix}'",
FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class')),
);
}
/**
* Asserts that the given expectation target to implement the given interfaces.
*
* @param array<int, class-string>|class-string $interfaces
*/
public function toImplement(array|string $interfaces): ArchExpectation
{
$interfaces = is_array($interfaces) ? $interfaces : [$interfaces];
return Targeted::make(
$this,
function (ObjectDescription $object) use ($interfaces): bool {
foreach ($interfaces as $interface) {
if (! $object->reflectionClass->implementsInterface($interface)) {
return false;
}
}
return true;
},
"to implement '".implode("', '", $interfaces)."'",
FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class')),
);
}
/** /**
* Asserts that the given expectation target "only" use on the given dependencies. * Asserts that the given expectation target "only" use on the given dependencies.
* *

View File

@ -5,15 +5,20 @@ declare(strict_types=1);
namespace Pest\Expectations; namespace Pest\Expectations;
use Pest\Arch\Contracts\ArchExpectation; use Pest\Arch\Contracts\ArchExpectation;
use Pest\Arch\Expectations\Targeted;
use Pest\Arch\Expectations\ToBeUsedIn; use Pest\Arch\Expectations\ToBeUsedIn;
use Pest\Arch\Expectations\ToBeUsedInNothing; use Pest\Arch\Expectations\ToBeUsedInNothing;
use Pest\Arch\Expectations\ToUse; use Pest\Arch\Expectations\ToUse;
use Pest\Arch\GroupArchExpectation; use Pest\Arch\GroupArchExpectation;
use Pest\Arch\PendingArchExpectation;
use Pest\Arch\SingleArchExpectation; use Pest\Arch\SingleArchExpectation;
use Pest\Arch\Support\FileLineFinder;
use Pest\Exceptions\InvalidExpectation; use Pest\Exceptions\InvalidExpectation;
use Pest\Expectation; use Pest\Expectation;
use Pest\Support\Arr; use Pest\Support\Arr;
use Pest\Support\Exporter; use Pest\Support\Exporter;
use PHPUnit\Architecture\Elements\ObjectDescription;
use PHPUnit\Framework\AssertionFailedError;
use PHPUnit\Framework\ExpectationFailedException; use PHPUnit\Framework\ExpectationFailedException;
/** /**
@ -72,6 +77,236 @@ final class OppositeExpectation
} }
/** /**
* Asserts that the given expectation target does not use the "declare(strict_types=1)" declaration.
*/
public function toUseStrictTypes(): ArchExpectation
{
return Targeted::make(
$this->original,
fn (ObjectDescription $object): bool => ! str_contains((string) file_get_contents($object->path), 'declare(strict_types=1);'),
'not to use strict types',
FileLineFinder::where(fn (string $line): bool => str_contains($line, '<?php')),
);
}
/**
* Asserts that the given expectation target is not final.
*/
public function toBeFinal(): ArchExpectation
{
return Targeted::make(
$this->original,
fn (ObjectDescription $object): bool => ! enum_exists($object->name) && ! $object->reflectionClass->isFinal(),
'not to be final',
FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class')),
);
}
/**
* Asserts that the given expectation target is not readonly.
*/
public function toBeReadonly(): ArchExpectation
{
return Targeted::make(
$this->original,
fn (ObjectDescription $object): bool => ! enum_exists($object->name) && ! $object->reflectionClass->isReadOnly(),
'not to be readonly',
FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class')),
);
}
/**
* Asserts that the given expectation target is not trait.
*/
public function toBeTrait(): ArchExpectation
{
return Targeted::make(
$this->original,
fn (ObjectDescription $object): bool => ! $object->reflectionClass->isTrait(),
'not to be trait',
FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class')),
);
}
/**
* Asserts that the given expectation targets are not traits.
*/
public function toBeTraits(): ArchExpectation
{
return $this->toBeTrait();
}
/**
* Asserts that the given expectation target is not abstract.
*/
public function toBeAbstract(): ArchExpectation
{
return Targeted::make(
$this->original,
fn (ObjectDescription $object): bool => ! $object->reflectionClass->isAbstract(),
'not to be abstract',
FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class')),
);
}
/**
* Asserts that the given expectation target is not enum.
*/
public function toBeEnum(): ArchExpectation
{
return Targeted::make(
$this->original,
fn (ObjectDescription $object): bool => ! $object->reflectionClass->isEnum(),
'not to be enum',
FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class')),
);
}
/**
* Asserts that the given expectation targets are not enums.
*/
public function toBeEnums(): ArchExpectation
{
return $this->toBeEnum();
}
/**
* Asserts that the given expectation targets is an class.
*/
public function toBeClass(): ArchExpectation
{
return Targeted::make(
$this->original,
fn (ObjectDescription $object): bool => ! class_exists($object->name),
'not to be class',
FileLineFinder::where(fn (string $line): bool => true),
);
}
/**
* Asserts that the given expectation targets are not classes.
*/
public function toBeClasses(): ArchExpectation
{
return $this->toBeClass();
}
/**
* Asserts that the given expectation target is not interface.
*/
public function toBeInterface(): ArchExpectation
{
return Targeted::make(
$this->original,
fn (ObjectDescription $object): bool => ! $object->reflectionClass->isInterface(),
'not to be interface',
FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class')),
);
}
/**
* Asserts that the given expectation targets are not interfaces.
*/
public function toBeInterfaces(): ArchExpectation
{
return $this->toBeInterface();
}
/**
* Asserts that the given expectation target to be subclass of the given class.
*
* @param class-string $class
*/
public function toExtend(string $class): ArchExpectation
{
return Targeted::make(
$this->original,
fn (ObjectDescription $object): bool => ! $object->reflectionClass->isSubclassOf($class),
sprintf("not to extend '%s'", $class),
FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class')),
);
}
/**
* Asserts that the given expectation target to be not have any parent class.
*/
public function toExtendNothing(): ArchExpectation
{
return Targeted::make(
$this->original,
fn (ObjectDescription $object): bool => $object->reflectionClass->getParentClass() !== false,
'to extend a class',
FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class')),
);
}
/**
* Asserts that the given expectation target not to implement the given interfaces.
*
* @param array<int, class-string>|string $interfaces
*/
public function toImplement(array|string $interfaces): ArchExpectation
{
$interfaces = is_array($interfaces) ? $interfaces : [$interfaces];
return Targeted::make(
$this->original,
function (ObjectDescription $object) use ($interfaces): bool {
foreach ($interfaces as $interface) {
if ($object->reflectionClass->implementsInterface($interface)) {
return false;
}
}
return true;
},
"not to implement '".implode("', '", $interfaces)."'",
FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class')),
);
}
/**
* Asserts that the given expectation target to not implement any interfaces.
*/
public function toImplementNothing(): ArchExpectation
{
return Targeted::make(
$this->original,
fn (ObjectDescription $object): bool => $object->reflectionClass->getInterfaceNames() !== [],
'to implement an interface',
FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class')),
);
}
/**
* Not supported.
*
* @param array<int, class-string>|string $interfaces
*/
public function toOnlyImplement(array|string $interfaces): never
{
throw InvalidExpectation::fromMethods(['not', 'toOnlyImplement']);
}
/**
* Not supported.
*/
public function toHavePrefix(string $suffix): never
{
throw InvalidExpectation::fromMethods(['not', 'toHavePrefix']);
}
/**
* Not supported.
*/
public function toHaveSuffix(string $suffix): never
{
throw InvalidExpectation::fromMethods(['not', 'toHaveSuffix']);
}
/**
* Not supported.
*
* @param array<int, string>|string $targets * @param array<int, string>|string $targets
*/ */
public function toOnlyUse(array|string $targets): never public function toOnlyUse(array|string $targets): never
@ -79,6 +314,9 @@ final class OppositeExpectation
throw InvalidExpectation::fromMethods(['not', 'toOnlyUse']); throw InvalidExpectation::fromMethods(['not', 'toOnlyUse']);
} }
/**
* Not supported.
*/
public function toUseNothing(): never public function toUseNothing(): never
{ {
throw InvalidExpectation::fromMethods(['not', 'toUseNothing']); throw InvalidExpectation::fromMethods(['not', 'toUseNothing']);
@ -126,9 +364,13 @@ final class OppositeExpectation
public function __call(string $name, array $arguments): Expectation public function __call(string $name, array $arguments): Expectation
{ {
try { try {
if (! is_object($this->original->value) && method_exists(PendingArchExpectation::class, $name)) {
throw InvalidExpectation::fromMethods(['not', $name]);
}
/* @phpstan-ignore-next-line */ /* @phpstan-ignore-next-line */
$this->original->{$name}(...$arguments); $this->original->{$name}(...$arguments);
} catch (ExpectationFailedException) { } catch (ExpectationFailedException|AssertionFailedError) {
return $this->original; return $this->original;
} }
@ -143,8 +385,12 @@ final class OppositeExpectation
public function __get(string $name): Expectation public function __get(string $name): Expectation
{ {
try { try {
if (! is_object($this->original->value) && method_exists(PendingArchExpectation::class, $name)) {
throw InvalidExpectation::fromMethods(['not', $name]);
}
$this->original->{$name}; // @phpstan-ignore-line $this->original->{$name}; // @phpstan-ignore-line
} catch (ExpectationFailedException) { // @phpstan-ignore-line } catch (ExpectationFailedException) {
return $this->original; return $this->original;
} }
@ -162,8 +408,13 @@ final class OppositeExpectation
$exporter = Exporter::default(); $exporter = Exporter::default();
$toString = fn ($argument): string => $exporter->shortenedExport($argument); $toString = fn (mixed $argument): string => $exporter->shortenedExport($argument);
throw new ExpectationFailedException(sprintf('Expecting %s not %s %s.', $toString($this->original->value), strtolower((string) preg_replace('/(?<!\ )[A-Z]/', ' $0', $name)), implode(' ', array_map(fn ($argument): string => $toString($argument), $arguments)))); throw new ExpectationFailedException(sprintf(
'Expecting %s not %s %s.',
$toString($this->original->value),
strtolower((string) preg_replace('/(?<!\ )[A-Z]/', ' $0', $name)),
implode(' ', array_map(fn (mixed $argument): string => $toString($argument), $arguments)),
));
} }
} }

View File

@ -14,7 +14,17 @@ final class TestDox implements AddsAnnotations
*/ */
public function __invoke(TestCaseMethodFactory $method, array $annotations): array public function __invoke(TestCaseMethodFactory $method, array $annotations): array
{ {
$annotations[] = "@testdox $method->description"; /*
* escapes docblock according to
* https://manual.phpdoc.org/HTMLframesConverter/default/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#basics.desc
*
* note: '@' escaping is not needed as it cannot be the first character of the line (it always starts with @testdox
*/
assert($method->description !== null);
$methodDescription = str_replace('*/', '{@*}', $method->description);
$annotations[] = "@testdox $methodDescription";
return $annotations; return $annotations;
} }

View File

@ -14,7 +14,7 @@ use Pest\Factories\TestCaseMethodFactory;
final class Covers extends Attribute final class Covers extends Attribute
{ {
/** /**
* Determine if the attribute should be placed above the classe instead of above the method. * Determine if the attribute should be placed above the class instead of above the method.
*/ */
public static bool $above = true; public static bool $above = true;

View File

@ -98,7 +98,7 @@ final class TestCaseFactory
{ {
if ('\\' === DIRECTORY_SEPARATOR) { if ('\\' === DIRECTORY_SEPARATOR) {
// In case Windows, strtolower drive name, like in UsesCall. // In case Windows, strtolower drive name, like in UsesCall.
$filename = (string) preg_replace_callback('~^(?P<drive>[a-z]+:\\\)~i', static fn ($match): string => strtolower($match['drive']), $filename); $filename = (string) preg_replace_callback('~^(?P<drive>[a-z]+:\\\)~i', static fn (array $match): string => strtolower($match['drive']), $filename);
} }
$filename = str_replace('\\\\', '\\', addslashes((string) realpath($filename))); $filename = str_replace('\\\\', '\\', addslashes((string) realpath($filename)));
@ -134,7 +134,7 @@ final class TestCaseFactory
$hasPrintableTestCaseClassFQN = sprintf('\%s', HasPrintableTestCaseName::class); $hasPrintableTestCaseClassFQN = sprintf('\%s', HasPrintableTestCaseName::class);
$traitsCode = sprintf('use %s;', implode(', ', array_map( $traitsCode = sprintf('use %s;', implode(', ', array_map(
static fn ($trait): string => sprintf('\%s', $trait), $this->traits)) static fn (string $trait): string => sprintf('\%s', $trait), $this->traits))
); );
$partsFQN = explode('\\', $classFQN); $partsFQN = explode('\\', $classFQN);
@ -217,7 +217,7 @@ final class TestCaseFactory
} }
if (! $method->receivesArguments()) { if (! $method->receivesArguments()) {
if ($method->closure === null) { if (! $method->closure instanceof \Closure) {
throw ShouldNotHappen::fromMessage('The test closure may not be empty.'); throw ShouldNotHappen::fromMessage('The test closure may not be empty.');
} }

View File

@ -22,40 +22,45 @@ final class TestCaseMethodFactory
use HigherOrderable; use HigherOrderable;
/** /**
* Determines if the Test Case Method is a "todo". * The test's describing, if any.
*/
public ?string $describing = null;
/**
* Determines if the test is a "todo".
*/ */
public bool $todo = false; public bool $todo = false;
/** /**
* The Test Case Dataset, if any. * The test's datasets.
* *
* @var array<Closure|iterable<int|string, mixed>|string> * @var array<Closure|iterable<int|string, mixed>|string>
*/ */
public array $datasets = []; public array $datasets = [];
/** /**
* The Test Case depends, if any. * The test's dependencies.
* *
* @var array<int, string> * @var array<int, string>
*/ */
public array $depends = []; public array $depends = [];
/** /**
* The Test Case groups, if any. * The test's groups.
* *
* @var array<int, string> * @var array<int, string>
*/ */
public array $groups = []; public array $groups = [];
/** /**
* The covered classes and functions, if any. * The covered classes and functions.
* *
* @var array<int, \Pest\Factories\Covers\CoversClass|\Pest\Factories\Covers\CoversFunction|\Pest\Factories\Covers\CoversNothing> * @var array<int, \Pest\Factories\Covers\CoversClass|\Pest\Factories\Covers\CoversFunction|\Pest\Factories\Covers\CoversNothing>
*/ */
public array $covers = []; public array $covers = [];
/** /**
* Creates a new Factory instance. * Creates a new test case method factory instance.
*/ */
public function __construct( public function __construct(
public string $filename, public string $filename,
@ -70,7 +75,7 @@ final class TestCaseMethodFactory
} }
/** /**
* Makes the Test Case classes. * Creates the test's closure.
*/ */
public function getClosure(TestCase $concrete): Closure public function getClosure(TestCase $concrete): Closure
{ {
@ -90,7 +95,7 @@ final class TestCaseMethodFactory
$method = $this; $method = $this;
return function () use ($testCase, $method, $closure): mixed { // @phpstan-ignore-line return function () use ($testCase, $method, $closure): mixed { // @phpstan-ignore-line
/* @var TestCase $this */ /* @var TestCase $this */
$testCase->proxies->proxy($this); $testCase->proxies->proxy($this);
$method->proxies->proxy($this); $method->proxies->proxy($this);
@ -142,11 +147,11 @@ final class TestCaseMethodFactory
} }
$annotations = implode('', array_map( $annotations = implode('', array_map(
static fn ($annotation): string => sprintf("\n * %s", $annotation), $annotations, static fn (string $annotation): string => sprintf("\n * %s", $annotation), $annotations,
)); ));
$attributes = implode('', array_map( $attributes = implode('', array_map(
static fn ($attribute): string => sprintf("\n %s", $attribute), $attributes, static fn (string $attribute): string => sprintf("\n %s", $attribute), $attributes,
)); ));
return <<<PHP return <<<PHP

View File

@ -2,9 +2,13 @@
declare(strict_types=1); declare(strict_types=1);
use Pest\Concerns\Expectable;
use Pest\Exceptions\AfterAllWithinDescribe;
use Pest\Exceptions\BeforeAllWithinDescribe;
use Pest\Expectation; use Pest\Expectation;
use Pest\PendingCalls\AfterEachCall; use Pest\PendingCalls\AfterEachCall;
use Pest\PendingCalls\BeforeEachCall; use Pest\PendingCalls\BeforeEachCall;
use Pest\PendingCalls\DescribeCall;
use Pest\PendingCalls\TestCall; use Pest\PendingCalls\TestCall;
use Pest\PendingCalls\UsesCall; use Pest\PendingCalls\UsesCall;
use Pest\Repositories\DatasetsRepository; use Pest\Repositories\DatasetsRepository;
@ -35,6 +39,12 @@ if (! function_exists('beforeAll')) {
*/ */
function beforeAll(Closure $closure): void function beforeAll(Closure $closure): void
{ {
if (! is_null(DescribeCall::describing())) {
$filename = Backtrace::file();
throw new BeforeAllWithinDescribe($filename);
}
TestSuite::getInstance()->beforeAll->set($closure); TestSuite::getInstance()->beforeAll->set($closure);
} }
} }
@ -43,7 +53,7 @@ if (! function_exists('beforeEach')) {
/** /**
* Runs the given closure before each test in the current file. * Runs the given closure before each test in the current file.
* *
* @return HigherOrderTapProxy<TestCall|TestCase>|TestCall|mixed * @return HigherOrderTapProxy<Expectable|TestCall|TestCase>|Expectable|TestCall|TestCase|mixed
*/ */
function beforeEach(Closure $closure = null): BeforeEachCall function beforeEach(Closure $closure = null): BeforeEachCall
{ {
@ -67,6 +77,22 @@ if (! function_exists('dataset')) {
} }
} }
if (! function_exists('describe')) {
/**
* Adds the given closure as a group of tests. The first argument
* is the group description; the second argument is a closure
* that contains the group tests.
*
* @return HigherOrderTapProxy<Expectable|TestCall|TestCase>|Expectable|TestCall|TestCase|mixed
*/
function describe(string $description, Closure $tests): DescribeCall
{
$filename = Backtrace::testFile();
return new DescribeCall(TestSuite::getInstance(), $filename, $description, $tests);
}
}
if (! function_exists('uses')) { if (! function_exists('uses')) {
/** /**
* The uses function binds the given * The uses function binds the given
@ -88,11 +114,11 @@ if (! function_exists('test')) {
* is the test description; the second argument is * is the test description; the second argument is
* a closure that contains the test expectations. * a closure that contains the test expectations.
* *
* @return TestCall|TestCase|mixed * @return Expectable|TestCall|TestCase|mixed
*/ */
function test(string $description = null, Closure $closure = null): HigherOrderTapProxy|TestCall function test(string $description = null, Closure $closure = null): HigherOrderTapProxy|TestCall
{ {
if ($description === null && TestSuite::getInstance()->test !== null) { if ($description === null && TestSuite::getInstance()->test instanceof \PHPUnit\Framework\TestCase) {
return new HigherOrderTapProxy(TestSuite::getInstance()->test); return new HigherOrderTapProxy(TestSuite::getInstance()->test);
} }
@ -108,7 +134,7 @@ if (! function_exists('it')) {
* is the test description; the second argument is * is the test description; the second argument is
* a closure that contains the test expectations. * a closure that contains the test expectations.
* *
* @return TestCall|TestCase|mixed * @return Expectable|TestCall|TestCase|mixed
*/ */
function it(string $description, Closure $closure = null): TestCall function it(string $description, Closure $closure = null): TestCall
{ {
@ -127,7 +153,7 @@ if (! function_exists('todo')) {
* is marked as incomplete. Yet, Collision, Pest's * is marked as incomplete. Yet, Collision, Pest's
* printer, will display it as a "todo" test. * printer, will display it as a "todo" test.
* *
* @return TestCall|TestCase|mixed * @return Expectable|TestCall|TestCase|mixed
*/ */
function todo(string $description): TestCall function todo(string $description): TestCall
{ {
@ -143,7 +169,7 @@ if (! function_exists('afterEach')) {
/** /**
* Runs the given closure after each test in the current file. * Runs the given closure after each test in the current file.
* *
* @return HigherOrderTapProxy<TestCall|TestCase>|TestCall|mixed * @return Expectable|HigherOrderTapProxy<Expectable|TestCall|TestCase>|TestCall|mixed
*/ */
function afterEach(Closure $closure = null): AfterEachCall function afterEach(Closure $closure = null): AfterEachCall
{ {
@ -159,6 +185,12 @@ if (! function_exists('afterAll')) {
*/ */
function afterAll(Closure $closure): void function afterAll(Closure $closure): void
{ {
if (! is_null(DescribeCall::describing())) {
$filename = Backtrace::file();
throw new AfterAllWithinDescribe($filename);
}
TestSuite::getInstance()->afterAll->set($closure); TestSuite::getInstance()->afterAll->set($closure);
} }
} }

View File

@ -11,7 +11,9 @@ use Pest\Plugins\Actions\CallsBoot;
use Pest\Plugins\Actions\CallsHandleArguments; use Pest\Plugins\Actions\CallsHandleArguments;
use Pest\Plugins\Actions\CallsShutdown; use Pest\Plugins\Actions\CallsShutdown;
use Pest\Support\Container; use Pest\Support\Container;
use PHPUnit\TestRunner\TestResult\Facade;
use PHPUnit\TextUI\Application; use PHPUnit\TextUI\Application;
use PHPUnit\TextUI\Configuration\Registry;
use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\Console\Output\OutputInterface;
@ -31,6 +33,7 @@ final class Kernel
Bootstrappers\BootFiles::class, Bootstrappers\BootFiles::class,
Bootstrappers\BootView::class, Bootstrappers\BootView::class,
Bootstrappers\BootKernelDump::class, Bootstrappers\BootKernelDump::class,
Bootstrappers\BootExcludeList::class,
]; ];
/** /**
@ -65,10 +68,14 @@ final class Kernel
CallsBoot::execute(); CallsBoot::execute();
return new self( $kernel = new self(
new Application(), new Application(),
$output, $output,
); );
Container::getInstance()->add(self::class, $kernel);
return $kernel;
} }
/** /**
@ -90,8 +97,11 @@ final class Kernel
]); ]);
} }
$configuration = Registry::get();
$result = Facade::result();
return CallsAddsOutput::execute( return CallsAddsOutput::execute(
Result::exitCode(), Result::exitCode($configuration, $result),
); );
} }

View File

@ -11,6 +11,12 @@ use Pest\Support\Str;
use PHPUnit\Event\Code\Test; use PHPUnit\Event\Code\Test;
use PHPUnit\Event\Code\TestMethod; use PHPUnit\Event\Code\TestMethod;
use PHPUnit\Event\Code\Throwable; use PHPUnit\Event\Code\Throwable;
use PHPUnit\Event\Test\BeforeFirstTestMethodErrored;
use PHPUnit\Event\Test\ConsideredRisky;
use PHPUnit\Event\Test\Errored;
use PHPUnit\Event\Test\Failed;
use PHPUnit\Event\Test\MarkedIncomplete;
use PHPUnit\Event\Test\Skipped;
use PHPUnit\Event\TestSuite\TestSuite; use PHPUnit\Event\TestSuite\TestSuite;
use PHPUnit\Framework\Exception as FrameworkException; use PHPUnit\Framework\Exception as FrameworkException;
use PHPUnit\TestRunner\TestResult\TestResult as PhpUnitTestResult; use PHPUnit\TestRunner\TestResult\TestResult as PhpUnitTestResult;
@ -64,7 +70,7 @@ final class Converter
} }
/** /**
* Gets the exception messsage. * Gets the exception message.
*/ */
public function getExceptionMessage(Throwable $throwable): string public function getExceptionMessage(Throwable $throwable): string
{ {
@ -147,7 +153,7 @@ final class Converter
/** /**
* Gets the test suite location. * Gets the test suite location.
*/ */
public function getTestSuiteLocation(TestSuite $testSuite): string|null public function getTestSuiteLocation(TestSuite $testSuite): ?string
{ {
$tests = $testSuite->tests()->asArray(); $tests = $testSuite->tests()->asArray();
@ -166,6 +172,14 @@ final class Converter
return $this->toRelativePath($path); return $this->toRelativePath($path);
} }
/**
* Gets the test suite size.
*/
public function getTestSuiteSize(TestSuite $testSuite): int
{
return $testSuite->count();
}
/** /**
* Transforms the given path in relative path. * Transforms the given path in relative path.
*/ */
@ -180,12 +194,30 @@ final class Converter
*/ */
public function getStateFromResult(PhpUnitTestResult $result): State public function getStateFromResult(PhpUnitTestResult $result): State
{ {
$numberOfPassedTests = $result->numberOfTestsRun() $events = [
- $result->numberOfTestErroredEvents() ...$result->testErroredEvents(),
- $result->numberOfTestFailedEvents() ...$result->testFailedEvents(),
- $result->numberOfTestSkippedEvents() ...$result->testSkippedEvents(),
- $result->numberOfTestsWithTestConsideredRiskyEvents() ...array_merge(...array_values($result->testConsideredRiskyEvents())),
- $result->numberOfTestMarkedIncompleteEvents(); ...$result->testMarkedIncompleteEvents(),
];
$numberOfNotPassedTests = count(
array_unique(
array_map(
function (BeforeFirstTestMethodErrored|Errored|Failed|Skipped|ConsideredRisky|MarkedIncomplete $event): string {
if ($event instanceof BeforeFirstTestMethodErrored) {
return $event->testClassName();
}
return $this->getTestCaseLocation($event->test());
},
$events
)
)
);
$numberOfPassedTests = $result->numberOfTestsRun() - $numberOfNotPassedTests;
return $this->stateGenerator->fromPhpUnitTestResult($numberOfPassedTests, $result); return $this->stateGenerator->fromPhpUnitTestResult($numberOfPassedTests, $result);
} }

View File

@ -9,7 +9,7 @@ namespace Pest\Logging\TeamCity;
*/ */
final class ServiceMessage final class ServiceMessage
{ {
private static int|null $flowId = null; private static ?int $flowId = null;
/** /**
* @param array<string, string|int|null> $parameters * @param array<string, string|int|null> $parameters
@ -25,14 +25,14 @@ final class ServiceMessage
$paramsToString = ''; $paramsToString = '';
foreach ([...$this->parameters, 'flowId' => self::$flowId] as $key => $value) { foreach ([...$this->parameters, 'flowId' => self::$flowId] as $key => $value) {
$value = self::escapeServiceMessage((string) $value); $value = $this->escapeServiceMessage((string) $value);
$paramsToString .= " $key='$value'"; $paramsToString .= " $key='$value'";
} }
return "##teamcity[$this->type$paramsToString]"; return "##teamcity[$this->type$paramsToString]";
} }
public static function testSuiteStarted(string $name, string|null $location): self public static function testSuiteStarted(string $name, ?string $location): self
{ {
return new self('testSuiteStarted', [ return new self('testSuiteStarted', [
'name' => $name, 'name' => $name,
@ -40,6 +40,13 @@ final class ServiceMessage
]); ]);
} }
public static function testSuiteCount(int $count): self
{
return new self('testCount', [
'count' => $count,
]);
}
public static function testSuiteFinished(string $name): self public static function testSuiteFinished(string $name): self
{ {
return new self('testSuiteFinished', [ return new self('testSuiteFinished', [
@ -120,7 +127,7 @@ final class ServiceMessage
]); ]);
} }
private static function escapeServiceMessage(string $text): string private function escapeServiceMessage(string $text): string
{ {
return str_replace( return str_replace(
['|', "'", "\n", "\r", ']', '['], ['|', "'", "\n", "\r", ']', '['],

View File

@ -16,6 +16,7 @@ use Pest\Logging\TeamCity\Subscriber\TestPreparedSubscriber;
use Pest\Logging\TeamCity\Subscriber\TestSkippedSubscriber; use Pest\Logging\TeamCity\Subscriber\TestSkippedSubscriber;
use Pest\Logging\TeamCity\Subscriber\TestSuiteFinishedSubscriber; use Pest\Logging\TeamCity\Subscriber\TestSuiteFinishedSubscriber;
use Pest\Logging\TeamCity\Subscriber\TestSuiteStartedSubscriber; use Pest\Logging\TeamCity\Subscriber\TestSuiteStartedSubscriber;
use PHPUnit\Event\Code\Test;
use PHPUnit\Event\EventFacadeIsSealedException; use PHPUnit\Event\EventFacadeIsSealedException;
use PHPUnit\Event\Facade; use PHPUnit\Event\Facade;
use PHPUnit\Event\Telemetry\Duration; use PHPUnit\Event\Telemetry\Duration;
@ -34,6 +35,7 @@ use PHPUnit\Event\TestSuite\Finished as TestSuiteFinished;
use PHPUnit\Event\TestSuite\Started as TestSuiteStarted; use PHPUnit\Event\TestSuite\Started as TestSuiteStarted;
use PHPUnit\Event\UnknownSubscriberTypeException; use PHPUnit\Event\UnknownSubscriberTypeException;
use PHPUnit\TestRunner\TestResult\Facade as TestResultFacade; use PHPUnit\TestRunner\TestResult\Facade as TestResultFacade;
use ReflectionClass;
use Symfony\Component\Console\Output\ConsoleOutput; use Symfony\Component\Console\Output\ConsoleOutput;
use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\Console\Output\OutputInterface;
@ -44,6 +46,13 @@ final class TeamCityLogger
{ {
private ?HRTime $time = null; private ?HRTime $time = null;
private bool $isSummaryTestCountPrinted = false;
/**
* @var array<string, bool>
*/
private array $testEvents = [];
/** /**
* @throws EventFacadeIsSealedException * @throws EventFacadeIsSealedException
* @throws UnknownSubscriberTypeException * @throws UnknownSubscriberTypeException
@ -51,7 +60,7 @@ final class TeamCityLogger
public function __construct( public function __construct(
private readonly OutputInterface $output, private readonly OutputInterface $output,
private readonly Converter $converter, private readonly Converter $converter,
private readonly int|null $flowId, private readonly ?int $flowId,
private readonly bool $withoutDuration, private readonly bool $withoutDuration,
) { ) {
$this->registerSubscribers(); $this->registerSubscribers();
@ -66,6 +75,15 @@ final class TeamCityLogger
); );
$this->output($message); $this->output($message);
if (! $this->isSummaryTestCountPrinted) {
$this->isSummaryTestCountPrinted = true;
$message = ServiceMessage::testSuiteCount(
$this->converter->getTestSuiteSize($event->testSuite())
);
$this->output($message);
}
} }
public function testSuiteFinished(TestSuiteFinished $event): void public function testSuiteFinished(TestSuiteFinished $event): void
@ -96,12 +114,14 @@ final class TeamCityLogger
public function testSkipped(Skipped $event): void public function testSkipped(Skipped $event): void
{ {
$message = ServiceMessage::testIgnored( $this->whenFirstEventForTest($event->test(), function () use ($event): void {
$this->converter->getTestCaseMethodName($event->test()), $message = ServiceMessage::testIgnored(
'This test was ignored.' $this->converter->getTestCaseMethodName($event->test()),
); 'This test was ignored.'
);
$this->output($message); $this->output($message);
});
} }
/** /**
@ -110,17 +130,19 @@ final class TeamCityLogger
*/ */
public function testErrored(Errored $event): void public function testErrored(Errored $event): void
{ {
$testName = $this->converter->getTestCaseMethodName($event->test()); $this->whenFirstEventForTest($event->test(), function () use ($event): void {
$message = $this->converter->getExceptionMessage($event->throwable()); $testName = $this->converter->getTestCaseMethodName($event->test());
$details = $this->converter->getExceptionDetails($event->throwable()); $message = $this->converter->getExceptionMessage($event->throwable());
$details = $this->converter->getExceptionDetails($event->throwable());
$message = ServiceMessage::testFailed( $message = ServiceMessage::testFailed(
$testName, $testName,
$message, $message,
$details, $details,
); );
$this->output($message); $this->output($message);
});
} }
/** /**
@ -129,28 +151,30 @@ final class TeamCityLogger
*/ */
public function testFailed(Failed $event): void public function testFailed(Failed $event): void
{ {
$testName = $this->converter->getTestCaseMethodName($event->test()); $this->whenFirstEventForTest($event->test(), function () use ($event): void {
$message = $this->converter->getExceptionMessage($event->throwable()); $testName = $this->converter->getTestCaseMethodName($event->test());
$details = $this->converter->getExceptionDetails($event->throwable()); $message = $this->converter->getExceptionMessage($event->throwable());
$details = $this->converter->getExceptionDetails($event->throwable());
if ($event->hasComparisonFailure()) { if ($event->hasComparisonFailure()) {
$comparison = $event->comparisonFailure(); $comparison = $event->comparisonFailure();
$message = ServiceMessage::comparisonFailure( $message = ServiceMessage::comparisonFailure(
$testName, $testName,
$message, $message,
$details, $details,
$comparison->actual(), $comparison->actual(),
$comparison->expected() $comparison->expected()
); );
} else { } else {
$message = ServiceMessage::testFailed( $message = ServiceMessage::testFailed(
$testName, $testName,
$message, $message,
$details, $details,
); );
} }
$this->output($message); $this->output($message);
});
} }
/** /**
@ -159,17 +183,19 @@ final class TeamCityLogger
*/ */
public function testConsideredRisky(ConsideredRisky $event): void public function testConsideredRisky(ConsideredRisky $event): void
{ {
$message = ServiceMessage::testIgnored( $this->whenFirstEventForTest($event->test(), function () use ($event): void {
$this->converter->getTestCaseMethodName($event->test()), $message = ServiceMessage::testIgnored(
$event->message() $this->converter->getTestCaseMethodName($event->test()),
); $event->message()
);
$this->output($message); $this->output($message);
});
} }
public function testFinished(Finished $event): void public function testFinished(Finished $event): void
{ {
if ($this->time === null) { if (! $this->time instanceof \PHPUnit\Event\Telemetry\HRTime) {
throw ShouldNotHappen::fromMessage('Start time has not been set.'); throw ShouldNotHappen::fromMessage('Start time has not been set.');
} }
@ -196,13 +222,17 @@ final class TeamCityLogger
$style = new Style($this->output); $style = new Style($this->output);
$telemetry = $event->telemetryInfo(); $telemetry = $event->telemetryInfo();
if ($this->withoutDuration) { if ($this->withoutDuration) {
$reflector = new ReflectionClass($telemetry);
$property = $reflector->getProperty('current');
$property->setAccessible(true);
$snapshot = $property->getValue($telemetry);
assert($snapshot instanceof Snapshot);
$telemetry = new Info( $telemetry = new Info(
new Snapshot( $snapshot,
$telemetry->time(),
$telemetry->memoryUsage(),
$telemetry->peakMemoryUsage(),
),
Duration::fromSecondsAndNanoseconds(1, 0), Duration::fromSecondsAndNanoseconds(1, 0),
$telemetry->memoryUsageSinceStart(), $telemetry->memoryUsageSinceStart(),
$telemetry->durationSincePrevious(), $telemetry->durationSincePrevious(),
@ -237,8 +267,7 @@ final class TeamCityLogger
new TestExecutionFinishedSubscriber($this), new TestExecutionFinishedSubscriber($this),
]; ];
// @phpstan-ignore-next-line Facade::instance()->registerSubscribers(...$subscribers);
method_exists(Facade::class, 'instance') ? Facade::instance()->registerSubscribers(...$subscribers) : Facade::registerSubscribers(...$subscribers);
} }
private function setFlowId(): void private function setFlowId(): void
@ -249,4 +278,14 @@ final class TeamCityLogger
ServiceMessage::setFlowId($this->flowId); ServiceMessage::setFlowId($this->flowId);
} }
private function whenFirstEventForTest(Test $test, callable $callback): void
{
$testIdentifier = $this->converter->getTestCaseLocation($test);
if (! isset($this->testEvents[$testIdentifier])) {
$this->testEvents[$testIdentifier] = true;
$callback();
}
}
} }

View File

@ -6,19 +6,24 @@ namespace Pest\Mixins;
use BadMethodCallException; use BadMethodCallException;
use Closure; use Closure;
use DateTimeInterface;
use Error; use Error;
use InvalidArgumentException; use InvalidArgumentException;
use JsonSerializable;
use Pest\Exceptions\InvalidExpectationValue; use Pest\Exceptions\InvalidExpectationValue;
use Pest\Matchers\Any; use Pest\Matchers\Any;
use Pest\Support\Arr; use Pest\Support\Arr;
use Pest\Support\Exporter; use Pest\Support\Exporter;
use Pest\Support\NullClosure; use Pest\Support\NullClosure;
use Pest\TestSuite;
use PHPUnit\Framework\Assert; use PHPUnit\Framework\Assert;
use PHPUnit\Framework\Constraint\Constraint; use PHPUnit\Framework\Constraint\Constraint;
use PHPUnit\Framework\ExpectationFailedException; use PHPUnit\Framework\ExpectationFailedException;
use PHPUnit\Framework\TestCase;
use ReflectionFunction; use ReflectionFunction;
use ReflectionNamedType; use ReflectionNamedType;
use Throwable; use Throwable;
use Traversable;
/** /**
* @internal * @internal
@ -32,7 +37,7 @@ final class Expectation
/** /**
* The exporter instance, if any. * The exporter instance, if any.
*/ */
private Exporter|null $exporter = null; private ?Exporter $exporter = null;
/** /**
* Creates a new expectation. * Creates a new expectation.
@ -124,7 +129,7 @@ final class Expectation
* *
* @return self<TValue> * @return self<TValue>
*/ */
public function toBeGreaterThan(int|float $expected, string $message = ''): self public function toBeGreaterThan(int|float|DateTimeInterface $expected, string $message = ''): self
{ {
Assert::assertGreaterThan($expected, $this->value, $message); Assert::assertGreaterThan($expected, $this->value, $message);
@ -136,7 +141,7 @@ final class Expectation
* *
* @return self<TValue> * @return self<TValue>
*/ */
public function toBeGreaterThanOrEqual(int|float $expected, string $message = ''): self public function toBeGreaterThanOrEqual(int|float|DateTimeInterface $expected, string $message = ''): self
{ {
Assert::assertGreaterThanOrEqual($expected, $this->value, $message); Assert::assertGreaterThanOrEqual($expected, $this->value, $message);
@ -148,7 +153,7 @@ final class Expectation
* *
* @return self<TValue> * @return self<TValue>
*/ */
public function toBeLessThan(int|float $expected, string $message = ''): self public function toBeLessThan(int|float|DateTimeInterface $expected, string $message = ''): self
{ {
Assert::assertLessThan($expected, $this->value, $message); Assert::assertLessThan($expected, $this->value, $message);
@ -160,7 +165,7 @@ final class Expectation
* *
* @return self<TValue> * @return self<TValue>
*/ */
public function toBeLessThanOrEqual(int|float $expected, string $message = ''): self public function toBeLessThanOrEqual(int|float|DateTimeInterface $expected, string $message = ''): self
{ {
Assert::assertLessThanOrEqual($expected, $this->value, $message); Assert::assertLessThanOrEqual($expected, $this->value, $message);
@ -295,8 +300,8 @@ final class Expectation
*/ */
public function toHaveProperties(iterable $names, string $message = ''): self public function toHaveProperties(iterable $names, string $message = ''): self
{ {
foreach ($names as $name) { foreach ($names as $name => $value) {
$this->toHaveProperty($name, message: $message); is_int($name) ? $this->toHaveProperty($value, message: $message) : $this->toHaveProperty($name, $value, $message);
} }
return $this; return $this;
@ -793,6 +798,46 @@ final class Expectation
return $this; return $this;
} }
/**
* Asserts that the value "stringable" matches the given snapshot..
*
* @return self<TValue>
*/
public function toMatchSnapshot(string $message = ''): self
{
$string = match (true) {
is_string($this->value) => $this->value,
is_object($this->value) && method_exists($this->value, '__toString') => $this->value->__toString(),
is_object($this->value) && method_exists($this->value, 'toString') => $this->value->toString(),
$this->value instanceof \Illuminate\Testing\TestResponse => $this->value->getContent(), // @phpstan-ignore-line
is_array($this->value) => json_encode($this->value, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT),
$this->value instanceof Traversable => json_encode(iterator_to_array($this->value), JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT),
$this->value instanceof JsonSerializable => json_encode($this->value->jsonSerialize(), JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT),
is_object($this->value) && method_exists($this->value, 'toArray') => json_encode($this->value->toArray(), JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT),
default => InvalidExpectationValue::expected('array|object|string'),
};
$testCase = TestSuite::getInstance()->test;
assert($testCase instanceof TestCase);
$snapshots = TestSuite::getInstance()->snapshots;
if ($snapshots->has($testCase, $string)) {
[$filename, $content] = $snapshots->get($testCase, $string);
Assert::assertSame(
$content,
$string,
$message === '' ? "Failed asserting that the string value matches its snapshot ($filename)." : $message
);
} else {
$filename = $snapshots->save($testCase, $string);
$testCase::markTestIncomplete('Snapshot created at ['.$filename.'].');
}
return $this;
}
/** /**
* Asserts that the value matches a regular expression. * Asserts that the value matches a regular expression.
* *
@ -838,10 +883,10 @@ final class Expectation
/** /**
* Asserts that executing value throws an exception. * Asserts that executing value throws an exception.
* *
* @param (Closure(Throwable): mixed)|string $exception * @param (Closure(Throwable): mixed)|string $exception
* @return self<TValue> * @return self<TValue>
*/ */
public function toThrow(callable|string $exception, string $exceptionMessage = null, string $message = ''): self public function toThrow(callable|string|Throwable $exception, string $exceptionMessage = null, string $message = ''): self
{ {
$callback = NullClosure::create(); $callback = NullClosure::create();
@ -863,6 +908,15 @@ final class Expectation
try { try {
($this->value)(); ($this->value)();
} catch (Throwable $e) { } catch (Throwable $e) {
if ($exception instanceof Throwable) {
expect($e)
->toBeInstanceOf($exception::class, $message)
->and($e->getMessage())->toBe($exceptionMessage ?? $exception->getMessage(), $message);
return $this;
}
if (! class_exists($exception)) { if (! class_exists($exception)) {
if ($e instanceof Error && $e->getMessage() === "Class \"$exception\" not found") { if ($e instanceof Error && $e->getMessage() === "Class \"$exception\" not found") {
Assert::assertTrue(true); Assert::assertTrue(true);
@ -887,7 +941,7 @@ final class Expectation
Assert::assertTrue(true); Assert::assertTrue(true);
if (! class_exists($exception)) { if (! $exception instanceof Throwable && ! class_exists($exception)) {
throw new ExpectationFailedException("Exception with message \"$exception\" not thrown."); throw new ExpectationFailedException("Exception with message \"$exception\" not thrown.");
} }
@ -899,7 +953,7 @@ final class Expectation
*/ */
private function export(mixed $value): string private function export(mixed $value): string
{ {
if ($this->exporter === null) { if (! $this->exporter instanceof \Pest\Support\Exporter) {
$this->exporter = Exporter::default(); $this->exporter = Exporter::default();
} }

View File

@ -5,6 +5,7 @@ declare(strict_types=1);
namespace Pest\PendingCalls; namespace Pest\PendingCalls;
use Closure; use Closure;
use Pest\PendingCalls\Concerns\Describable;
use Pest\Support\Backtrace; use Pest\Support\Backtrace;
use Pest\Support\ChainableClosure; use Pest\Support\ChainableClosure;
use Pest\Support\HigherOrderMessageCollection; use Pest\Support\HigherOrderMessageCollection;
@ -16,6 +17,8 @@ use Pest\TestSuite;
*/ */
final class AfterEachCall final class AfterEachCall
{ {
use Describable;
/** /**
* The "afterEach" closure. * The "afterEach" closure.
*/ */
@ -37,6 +40,8 @@ final class AfterEachCall
$this->closure = $closure instanceof Closure ? $closure : NullClosure::create(); $this->closure = $closure instanceof Closure ? $closure : NullClosure::create();
$this->proxies = new HigherOrderMessageCollection(); $this->proxies = new HigherOrderMessageCollection();
$this->describing = DescribeCall::describing();
} }
/** /**
@ -44,14 +49,23 @@ final class AfterEachCall
*/ */
public function __destruct() public function __destruct()
{ {
$describing = $this->describing;
$proxies = $this->proxies; $proxies = $this->proxies;
$afterEachTestCase = ChainableClosure::boundWhen(
fn (): bool => is_null($describing) || $this->__describing === $describing, // @phpstan-ignore-line
ChainableClosure::bound(fn () => $proxies->chain($this), $this->closure)->bindTo($this, self::class), // @phpstan-ignore-line
)->bindTo($this, self::class);
assert($afterEachTestCase instanceof Closure);
$this->testSuite->afterEach->set( $this->testSuite->afterEach->set(
$this->filename, $this->filename,
ChainableClosure::from(function () use ($proxies): void { $this,
$proxies->chain($this); $afterEachTestCase,
}, $this->closure)
); );
} }
/** /**

View File

@ -5,6 +5,7 @@ declare(strict_types=1);
namespace Pest\PendingCalls; namespace Pest\PendingCalls;
use Closure; use Closure;
use Pest\PendingCalls\Concerns\Describable;
use Pest\Support\Backtrace; use Pest\Support\Backtrace;
use Pest\Support\ChainableClosure; use Pest\Support\ChainableClosure;
use Pest\Support\HigherOrderMessageCollection; use Pest\Support\HigherOrderMessageCollection;
@ -16,27 +17,37 @@ use Pest\TestSuite;
*/ */
final class BeforeEachCall final class BeforeEachCall
{ {
use Describable;
/** /**
* Holds the before each closure. * Holds the before each closure.
*/ */
private readonly \Closure $closure; private readonly Closure $closure;
/** /**
* The calls that should be proxied. * The test call proxies.
*/ */
private readonly HigherOrderMessageCollection $proxies; private readonly HigherOrderMessageCollection $testCallProxies;
/**
* The test case proxies.
*/
private readonly HigherOrderMessageCollection $testCaseProxies;
/** /**
* Creates a new Pending Call. * Creates a new Pending Call.
*/ */
public function __construct( public function __construct(
private readonly TestSuite $testSuite, public readonly TestSuite $testSuite,
private readonly string $filename, private readonly string $filename,
Closure $closure = null Closure $closure = null
) { ) {
$this->closure = $closure instanceof Closure ? $closure : NullClosure::create(); $this->closure = $closure instanceof Closure ? $closure : NullClosure::create();
$this->proxies = new HigherOrderMessageCollection(); $this->testCallProxies = new HigherOrderMessageCollection();
$this->testCaseProxies = new HigherOrderMessageCollection();
$this->describing = DescribeCall::describing();
} }
/** /**
@ -44,13 +55,31 @@ final class BeforeEachCall
*/ */
public function __destruct() public function __destruct()
{ {
$proxies = $this->proxies; $describing = $this->describing;
$testCaseProxies = $this->testCaseProxies;
$beforeEachTestCall = function (TestCall $testCall) use ($describing): void {
if ($describing !== $this->describing) {
return;
}
if ($describing !== $testCall->describing) {
return;
}
$this->testCallProxies->chain($testCall);
};
$beforeEachTestCase = ChainableClosure::boundWhen(
fn (): bool => is_null($describing) || $this->__describing === $describing, // @phpstan-ignore-line
ChainableClosure::bound(fn () => $testCaseProxies->chain($this), $this->closure)->bindTo($this, self::class), // @phpstan-ignore-line
)->bindTo($this, self::class);
assert($beforeEachTestCase instanceof Closure);
$this->testSuite->beforeEach->set( $this->testSuite->beforeEach->set(
$this->filename, $this->filename,
ChainableClosure::from(function () use ($proxies): void { $this,
$proxies->chain($this); $beforeEachTestCall,
}, $this->closure) $beforeEachTestCase,
); );
} }
@ -61,7 +90,13 @@ final class BeforeEachCall
*/ */
public function __call(string $name, array $arguments): self public function __call(string $name, array $arguments): self
{ {
$this->proxies if (method_exists(TestCall::class, $name)) {
$this->testCallProxies->add(Backtrace::file(), Backtrace::line(), $name, $arguments);
return $this;
}
$this->testCaseProxies
->add(Backtrace::file(), Backtrace::line(), $name, $arguments); ->add(Backtrace::file(), Backtrace::line(), $name, $arguments);
return $this; return $this;

View File

@ -0,0 +1,13 @@
<?php
declare(strict_types=1);
namespace Pest\PendingCalls\Concerns;
/**
* @internal
*/
trait Describable
{
public ?string $describing = null;
}

View File

@ -0,0 +1,70 @@
<?php
declare(strict_types=1);
namespace Pest\PendingCalls;
use Closure;
use Pest\Support\Backtrace;
use Pest\TestSuite;
/**
* @internal
*/
final class DescribeCall
{
/**
* The current describe call.
*/
private static ?string $describing = null;
/**
* Creates a new Pending Call.
*/
public function __construct(
public readonly TestSuite $testSuite,
public readonly string $filename,
public readonly string $description,
public readonly Closure $tests
) {
//
}
/**
* What is the current describing.
*/
public static function describing(): ?string
{
return self::$describing;
}
/**
* Creates the Call.
*/
public function __destruct()
{
self::$describing = $this->description;
try {
($this->tests)();
} finally {
self::$describing = null;
}
}
/**
* Dynamically calls methods on each test call.
*
* @param array<int, mixed> $arguments
*/
public function __call(string $name, array $arguments): BeforeEachCall
{
$filename = Backtrace::file();
$beforeEachCall = new BeforeEachCall(TestSuite::getInstance(), $filename);
$beforeEachCall->describing = $this->description;
return $beforeEachCall->{$name}(...$arguments); // @phpstan-ignore-line
}
}

View File

@ -10,6 +10,8 @@ use Pest\Factories\Covers\CoversClass;
use Pest\Factories\Covers\CoversFunction; use Pest\Factories\Covers\CoversFunction;
use Pest\Factories\Covers\CoversNothing; use Pest\Factories\Covers\CoversNothing;
use Pest\Factories\TestCaseMethodFactory; use Pest\Factories\TestCaseMethodFactory;
use Pest\PendingCalls\Concerns\Describable;
use Pest\Plugins\Only;
use Pest\Support\Backtrace; use Pest\Support\Backtrace;
use Pest\Support\Exporter; use Pest\Support\Exporter;
use Pest\Support\HigherOrderCallables; use Pest\Support\HigherOrderCallables;
@ -24,10 +26,12 @@ use PHPUnit\Framework\TestCase;
*/ */
final class TestCall final class TestCall
{ {
use Describable;
/** /**
* The Test Case Factory. * The Test Case Factory.
*/ */
private readonly TestCaseMethodFactory $testCaseMethod; public readonly TestCaseMethodFactory $testCaseMethod;
/** /**
* If test call is descriptionLess. * If test call is descriptionLess.
@ -39,12 +43,17 @@ final class TestCall
*/ */
public function __construct( public function __construct(
private readonly TestSuite $testSuite, private readonly TestSuite $testSuite,
string $filename, private readonly string $filename,
string $description = null, string $description = null,
Closure $closure = null Closure $closure = null
) { ) {
$this->testCaseMethod = new TestCaseMethodFactory($filename, $description, $closure); $this->testCaseMethod = new TestCaseMethodFactory($filename, $description, $closure);
$this->descriptionLess = $description === null; $this->descriptionLess = $description === null;
$this->describing = DescribeCall::describing();
$this->testSuite->beforeEach->get($this->filename)[0]($this);
} }
/** /**
@ -80,7 +89,7 @@ final class TestCall
/** /**
* Asserts that the test throws the given `$exceptionClass` when called if the given condition is true. * Asserts that the test throws the given `$exceptionClass` when called if the given condition is true.
* *
* @param (callable(): bool)|bool $condition * @param (callable(): bool)|bool $condition
*/ */
public function throwsIf(callable|bool $condition, string|int $exception, string $exceptionMessage = null, int $exceptionCode = null): self public function throwsIf(callable|bool $condition, string|int $exception, string $exceptionMessage = null, int $exceptionCode = null): self
{ {
@ -134,6 +143,16 @@ final class TestCall
return $this; return $this;
} }
/**
* Filters the test suite by "only" tests.
*/
public function only(): self
{
Only::enable($this);
return $this;
}
/** /**
* Skips the current test. * Skips the current test.
*/ */
@ -156,11 +175,45 @@ final class TestCall
$this->testCaseMethod $this->testCaseMethod
->chains ->chains
->addWhen($condition, Backtrace::file(), Backtrace::line(), 'markTestSkipped', [$message]); ->addWhen($condition, $this->filename, Backtrace::line(), 'markTestSkipped', [$message]);
return $this; return $this;
} }
/**
* Skips the current test if the given test is running on Windows.
*/
public function skipOnWindows(): self
{
return $this->skipOn('Windows', 'This test is skipped on [Windows].');
}
/**
* Skips the current test if the given test is running on Mac OS.
*/
public function skipOnMac(): self
{
return $this->skipOn('Darwin', 'This test is skipped on [Mac].');
}
/**
* Skips the current test if the given test is running on Linux.
*/
public function skipOnLinux(): self
{
return $this->skipOn('Linux', 'This test is skipped on [Linux].');
}
/**
* Skips the current test if the given test is running on the given operating systems.
*/
private function skipOn(string $osFamily, string $message): self
{
return PHP_OS_FAMILY === $osFamily
? $this->skip($message)
: $this;
}
/** /**
* Sets the test as "todo". * Sets the test as "todo".
*/ */
@ -179,7 +232,7 @@ final class TestCall
public function covers(string ...$classesOrFunctions): self public function covers(string ...$classesOrFunctions): self
{ {
foreach ($classesOrFunctions as $classOrFunction) { foreach ($classesOrFunctions as $classOrFunction) {
$isClass = class_exists($classOrFunction); $isClass = class_exists($classOrFunction) || trait_exists($classOrFunction);
$isMethod = function_exists($classOrFunction); $isMethod = function_exists($classOrFunction);
if (! $isClass && ! $isMethod) { if (! $isClass && ! $isMethod) {
@ -268,12 +321,14 @@ final class TestCall
private function addChain(string $file, int $line, string $name, array $arguments = null): self private function addChain(string $file, int $line, string $name, array $arguments = null): self
{ {
$exporter = Exporter::default(); $exporter = Exporter::default();
$this->testCaseMethod $this->testCaseMethod
->chains ->chains
->add($file, $line, $name, $arguments); ->add($file, $line, $name, $arguments);
if ($this->descriptionLess) { if ($this->descriptionLess) {
Exporter::default(); Exporter::default();
if ($this->testCaseMethod->description !== null) { if ($this->testCaseMethod->description !== null) {
$this->testCaseMethod->description .= ' → '; $this->testCaseMethod->description .= ' → ';
} }
@ -290,6 +345,11 @@ final class TestCall
*/ */
public function __destruct() public function __destruct()
{ {
if (! is_null($this->describing)) {
$this->testCaseMethod->describing = $this->describing;
$this->testCaseMethod->description = sprintf('`%s` → %s', $this->describing, $this->testCaseMethod->description);
}
$this->testSuite->tests->set($this->testCaseMethod); $this->testSuite->tests->set($this->testCaseMethod);
} }
} }

View File

@ -66,11 +66,11 @@ final class UsesCall
*/ */
public function in(string ...$targets): void public function in(string ...$targets): void
{ {
$targets = array_map(function ($path): string { $targets = array_map(function (string $path): string {
$startChar = DIRECTORY_SEPARATOR; $startChar = DIRECTORY_SEPARATOR;
if ('\\' === DIRECTORY_SEPARATOR || preg_match('~\A[A-Z]:(?![^/\\\\])~i', $path) > 0) { if ('\\' === DIRECTORY_SEPARATOR || preg_match('~\A[A-Z]:(?![^/\\\\])~i', $path) > 0) {
$path = (string) preg_replace_callback('~^(?P<drive>[a-z]+:\\\)~i', fn ($match): string => strtolower($match['drive']), $path); $path = (string) preg_replace_callback('~^(?P<drive>[a-z]+:\\\)~i', fn (array $match): string => strtolower($match['drive']), $path);
$startChar = strtolower((string) preg_replace('~^([a-z]+:\\\).*$~i', '$1', __DIR__)); $startChar = strtolower((string) preg_replace('~^([a-z]+:\\\).*$~i', '$1', __DIR__));
} }
@ -84,8 +84,10 @@ final class UsesCall
}, $targets); }, $targets);
$this->targets = array_reduce($targets, function (array $accumulator, string $target): array { $this->targets = array_reduce($targets, function (array $accumulator, string $target): array {
if (is_dir($target) || file_exists($target)) { if (($matches = glob($target)) !== false) {
$accumulator[] = (string) realpath($target); foreach ($matches as $file) {
$accumulator[] = (string) realpath($file);
}
} }
return $accumulator; return $accumulator;

View File

@ -6,7 +6,7 @@ namespace Pest;
function version(): string function version(): string
{ {
return '2.0.1'; return '2.9.5';
} }
function testDirectory(string $file = ''): string function testDirectory(string $file = ''): string

View File

@ -44,6 +44,6 @@ trait HandleArguments
unset($arguments[$argument]); unset($arguments[$argument]);
return array_flip($arguments); return array_values(array_flip($arguments));
} }
} }

View File

@ -50,7 +50,7 @@ final class Coverage implements AddsOutput, HandlesArguments
*/ */
public function handleArguments(array $originals): array public function handleArguments(array $originals): array
{ {
$arguments = [...[''], ...array_values(array_filter($originals, function ($original): bool { $arguments = [...[''], ...array_values(array_filter($originals, function (string $original): bool {
foreach ([self::COVERAGE_OPTION, self::MIN_OPTION] as $option) { foreach ([self::COVERAGE_OPTION, self::MIN_OPTION] as $option) {
if ($original === sprintf('--%s', $option)) { if ($original === sprintf('--%s', $option)) {
return true; return true;

View File

@ -102,20 +102,27 @@ final class Help implements HandlesArguments
'desc' => 'Initialise a standard Pest configuration', 'desc' => 'Initialise a standard Pest configuration',
]], ...$content['Configuration']]; ]], ...$content['Configuration']];
$content['Selection'] = array_merge([ $content['Execution'] = [...[
[ [
'arg' => '--bail', 'arg' => '--parallel',
'desc' => 'Stop execution upon first not-passed test', 'desc' => 'Run tests in parallel',
], ],
[ [
'arg' => '--todos', 'arg' => '--update-snapshots',
'desc' => 'Output to standard output the list of todos', 'desc' => 'Update snapshots for tests using the "toMatchSnapshot" expectation',
], ],
[ ], ...$content['Execution']];
'arg' => '--retry',
'desc' => 'Run non-passing tests first and stop execution upon first error or failure', $content['Selection'] = [[
], 'arg' => '--bail',
], $content['Selection']); 'desc' => 'Stop execution upon first not-passed test',
], [
'arg' => '--todos',
'desc' => 'Output to standard output the list of todos',
], [
'arg' => '--retry',
'desc' => 'Run non-passing tests first and stop execution upon first error or failure',
], ...$content['Selection']];
$content['Reporting'] = [...$content['Reporting'], ...[ $content['Reporting'] = [...$content['Reporting'], ...[
[ [
@ -124,16 +131,13 @@ final class Help implements HandlesArguments
], ],
]]; ]];
$content['Code Coverage'] = array_merge([ $content['Code Coverage'] = [[
[ 'arg' => '--coverage ',
'arg' => '--coverage ', 'desc' => 'Generate code coverage report and output to standard output',
'desc' => 'Generate code coverage report and output to standard output', ], [
], 'arg' => '--coverage --min',
[ 'desc' => 'Set the minimum required coverage percentage, and fail if not met',
'arg' => '--coverage --min', ], ...$content['Code Coverage']];
'desc' => 'Set the minimum required coverage percentage, and fail if not met',
],
], $content['Code Coverage']);
$content['Profiling'] = [ $content['Profiling'] = [
[ [

View File

@ -26,11 +26,11 @@ final class Init implements HandlesArguments
* The files that will be created. * The files that will be created.
*/ */
private const STUBS = [ private const STUBS = [
'phpunit.xml' => 'phpunit.xml', 'phpunit.xml.stub' => 'phpunit.xml',
'Pest.php' => 'tests/Pest.php', 'Pest.php.stub' => 'tests/Pest.php',
'TestCase.php' => 'tests/TestCase.php', 'TestCase.php.stub' => 'tests/TestCase.php',
'Unit/ExampleTest.php' => 'tests/Unit/ExampleTest.php', 'Unit/ExampleTest.php.stub' => 'tests/Unit/ExampleTest.php',
'Feature/ExampleTest.php' => 'tests/Feature/ExampleTest.php', 'Feature/ExampleTest.php.stub' => 'tests/Feature/ExampleTest.php',
]; ];
/** /**
@ -60,13 +60,13 @@ final class Init implements HandlesArguments
$this->init(); $this->init();
return array_values($arguments); exit(0);
} }
/** /**
* Initializes the tests directory. * Initializes the tests directory.
*/ */
private function init(): void public function init(): void
{ {
$testsBaseDir = "{$this->testSuite->rootPath}/tests"; $testsBaseDir = "{$this->testSuite->rootPath}/tests";
@ -112,8 +112,6 @@ final class Init implements HandlesArguments
View::render('components.new-line'); View::render('components.new-line');
(new Thanks($this->input, $this->output))(); (new Thanks($this->input, $this->output))();
exit(0);
} }
/** /**

61
src/Plugins/Only.php Normal file
View File

@ -0,0 +1,61 @@
<?php
declare(strict_types=1);
namespace Pest\Plugins;
use Pest\Contracts\Plugins\Shutdownable;
use Pest\PendingCalls\TestCall;
/**
* @internal
*/
final class Only implements Shutdownable
{
/**
* The temporary folder.
*/
private const TEMPORARY_FOLDER = __DIR__
.DIRECTORY_SEPARATOR
.'..'
.DIRECTORY_SEPARATOR
.'..'
.DIRECTORY_SEPARATOR
.'.temp';
/**
* {@inheritDoc}
*/
public function shutdown(): void
{
$lockFile = self::TEMPORARY_FOLDER.DIRECTORY_SEPARATOR.'only.lock';
if (file_exists($lockFile)) {
unlink($lockFile);
}
}
/**
* Creates the lock file.
*/
public static function enable(TestCall $testCall): void
{
$testCall->group('__pest_only');
$lockFile = self::TEMPORARY_FOLDER.DIRECTORY_SEPARATOR.'only.lock';
if (! file_exists($lockFile)) {
touch($lockFile);
}
}
/**
* Checks if "only" mode is enabled.
*/
public static function isEnabled(): bool
{
$lockFile = self::TEMPORARY_FOLDER.DIRECTORY_SEPARATOR.'only.lock';
return file_exists($lockFile);
}
}

View File

@ -14,15 +14,16 @@ use Pest\Support\Arr;
use Pest\Support\Container; use Pest\Support\Container;
use Pest\TestSuite; use Pest\TestSuite;
use function Pest\version; use function Pest\version;
use Stringable;
use Symfony\Component\Console\Application; use Symfony\Component\Console\Application;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\ArgvInput; use Symfony\Component\Console\Input\ArgvInput;
use Symfony\Component\Console\Output\OutputInterface;
final class Parallel implements HandlesArguments final class Parallel implements HandlesArguments
{ {
use HandleArguments; use HandleArguments;
private const GLOBAL_PREFIX = 'PEST_PARALLEL_GLOBAL_';
private const HANDLERS = [ private const HANDLERS = [
Parallel\Handlers\Parallel::class, Parallel\Handlers\Parallel::class,
Parallel\Handlers\Pest::class, Parallel\Handlers\Pest::class,
@ -59,6 +60,33 @@ final class Parallel implements HandlesArguments
return ((int) $argvValue) === 1; return ((int) $argvValue) === 1;
} }
/**
* Sets a global value that can be accessed by the parent process and all workers.
*/
public static function setGlobal(string $key, string|int|bool|Stringable $value): void
{
$data = ['value' => $value instanceof Stringable ? $value->__toString() : $value];
$_ENV[self::GLOBAL_PREFIX.$key] = json_encode($data, JSON_THROW_ON_ERROR);
}
/**
* Returns the given global value if one has been set.
*/
public static function getGlobal(string $key): string|int|bool|null
{
$placesToCheck = [$_SERVER, $_ENV];
foreach ($placesToCheck as $location) {
if (array_key_exists(self::GLOBAL_PREFIX.$key, $location)) {
// @phpstan-ignore-next-line
return json_decode((string) $location[self::GLOBAL_PREFIX.$key], true, 512, JSON_THROW_ON_ERROR)['value'] ?? null;
}
}
return null;
}
/** /**
* {@inheritdoc} * {@inheritdoc}
*/ */
@ -86,20 +114,14 @@ final class Parallel implements HandlesArguments
*/ */
private function runTestSuiteInParallel(array $arguments): int private function runTestSuiteInParallel(array $arguments): int
{ {
if (! class_exists(ParaTestCommand::class)) {
$this->askUserToInstallParatest();
return Command::FAILURE;
}
$handlers = array_filter( $handlers = array_filter(
array_map(fn ($handler): object|string => Container::getInstance()->get($handler), self::HANDLERS), array_map(fn (string $handler): object|string => Container::getInstance()->get($handler), self::HANDLERS),
fn ($handler): bool => $handler instanceof HandlesArguments, fn (object|string $handler): bool => $handler instanceof HandlesArguments,
); );
$filteredArguments = array_reduce( $filteredArguments = array_reduce(
$handlers, $handlers,
fn ($arguments, HandlesArguments $handler): array => $handler->handleArguments($arguments), fn (array $arguments, HandlesArguments $handler): array => $handler->handleArguments($arguments),
$arguments $arguments
); );
@ -117,31 +139,17 @@ final class Parallel implements HandlesArguments
private function runWorkerHandlers(array $arguments): array private function runWorkerHandlers(array $arguments): array
{ {
$handlers = array_filter( $handlers = array_filter(
array_map(fn ($handler): object|string => Container::getInstance()->get($handler), self::HANDLERS), array_map(fn (string $handler): object|string => Container::getInstance()->get($handler), self::HANDLERS),
fn ($handler): bool => $handler instanceof HandlersWorkerArguments, fn (object|string $handler): bool => $handler instanceof HandlersWorkerArguments,
); );
return array_reduce( return array_reduce(
$handlers, $handlers,
fn ($arguments, HandlersWorkerArguments $handler): array => $handler->handleWorkerArguments($arguments), fn (array $arguments, HandlersWorkerArguments $handler): array => $handler->handleWorkerArguments($arguments),
$arguments $arguments
); );
} }
/**
* Outputs a message to the user asking them to install ParaTest as a dev dependency.
*/
private function askUserToInstallParatest(): void
{
/** @var OutputInterface $output */
$output = Container::getInstance()->get(OutputInterface::class);
$output->writeln([
'<fg=red>Pest Parallel requires ParaTest to run.</>',
'Please run <fg=yellow>composer require --dev brianium/paratest</>.',
]);
}
/** /**
* Builds an instance of the Paratest command. * Builds an instance of the Paratest command.
*/ */

View File

@ -30,7 +30,7 @@ final class Parallel implements HandlesArguments
*/ */
public function handleArguments(array $arguments): array public function handleArguments(array $arguments): array
{ {
$args = array_reduce(self::ARGS_TO_REMOVE, fn ($args, $arg): array => $this->popArgument($arg, $args), $arguments); $args = array_reduce(self::ARGS_TO_REMOVE, fn (array $args, string $arg): array => $this->popArgument($arg, $args), $arguments);
return $this->pushArgument('--runner='.WrapperRunner::class, $args); return $this->pushArgument('--runner='.WrapperRunner::class, $args);
} }

View File

@ -12,20 +12,20 @@ use function fread;
use function fseek; use function fseek;
use function ftell; use function ftell;
use function fwrite; use function fwrite;
use NunoMaduro\Collision\Adapters\Phpunit\State;
use ParaTest\Options; use ParaTest\Options;
use Pest\Plugins\Parallel\Support\CompactPrinter; use Pest\Plugins\Parallel\Support\CompactPrinter;
use Pest\Support\StateGenerator; use Pest\Support\StateGenerator;
use PHPUnit\TestRunner\TestResult\TestResult; use PHPUnit\TestRunner\TestResult\TestResult;
use PHPUnit\TextUI\Output\Printer; use PHPUnit\TextUI\Output\Printer;
use function preg_replace;
use SebastianBergmann\Timer\Duration; use SebastianBergmann\Timer\Duration;
use SplFileInfo; use SplFileInfo;
use function strlen; use function strlen;
use Symfony\Component\Console\Formatter\OutputFormatter; use Symfony\Component\Console\Formatter\OutputFormatter;
use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\Console\Output\OutputInterface;
/** @internal */ /**
* @internal
*/
final class ResultPrinter final class ResultPrinter
{ {
/** /**
@ -51,7 +51,7 @@ final class ResultPrinter
/** @var resource|null */ /** @var resource|null */
private $teamcityLogFileHandle; private $teamcityLogFileHandle;
/** @var array<string, int> */ /** @var array<non-empty-string, int> */
private array $tailPositions; private array $tailPositions;
public function __construct( public function __construct(
@ -74,6 +74,7 @@ final class ResultPrinter
if (str_starts_with($buffer, 'done [')) { if (str_starts_with($buffer, 'done [')) {
return; return;
} }
$this->output->write(OutputFormatter::escape($buffer)); $this->output->write(OutputFormatter::escape($buffer));
} }
@ -93,9 +94,12 @@ final class ResultPrinter
$this->teamcityLogFileHandle = $teamcityLogFileHandle; $this->teamcityLogFileHandle = $teamcityLogFileHandle;
} }
/** @param array<int, SplFileInfo> $teamcityFiles */ /** @param list<SplFileInfo> $teamcityFiles */
public function printFeedback(SplFileInfo $progressFile, array $teamcityFiles): void public function printFeedback(
{ SplFileInfo $progressFile,
SplFileInfo $outputFile,
array $teamcityFiles
): void {
if ($this->options->needsTeamcity) { if ($this->options->needsTeamcity) {
$teamcityProgress = $this->tailMultiple($teamcityFiles); $teamcityProgress = $this->tailMultiple($teamcityFiles);
@ -115,6 +119,15 @@ final class ResultPrinter
return; return;
} }
$unexpectedOutput = $this->tail($outputFile);
if ($unexpectedOutput !== '') {
if (preg_match('/^T+$/', $unexpectedOutput) > 0) {
return;
}
$this->output->write($unexpectedOutput);
}
$feedbackItems = $this->tail($progressFile); $feedbackItems = $this->tail($progressFile);
if ($feedbackItems === '') { if ($feedbackItems === '') {
return; return;
@ -129,8 +142,8 @@ final class ResultPrinter
} }
/** /**
* @param array<int, SplFileInfo> $teamcityFiles * @param list<SplFileInfo> $teamcityFiles
* @param array<int, SplFileInfo> $testdoxFiles * @param list<SplFileInfo> $testdoxFiles
*/ */
public function printResults(TestResult $testResult, array $teamcityFiles, array $testdoxFiles, Duration $duration): void public function printResults(TestResult $testResult, array $teamcityFiles, array $testdoxFiles, Duration $duration): void
{ {
@ -183,7 +196,7 @@ final class ResultPrinter
$this->compactPrinter->descriptionItem($item); $this->compactPrinter->descriptionItem($item);
} }
/** @param array<int, SplFileInfo> $files */ /** @param list<SplFileInfo> $files */
private function tailMultiple(array $files): string private function tailMultiple(array $files): string
{ {
$content = ''; $content = '';
@ -201,6 +214,7 @@ final class ResultPrinter
private function tail(SplFileInfo $file): string private function tail(SplFileInfo $file): string
{ {
$path = $file->getPathname(); $path = $file->getPathname();
assert($path !== '');
$handle = fopen($path, 'r'); $handle = fopen($path, 'r');
assert($handle !== false); assert($handle !== false);
$fseek = fseek($handle, $this->tailPositions[$path] ?? 0); $fseek = fseek($handle, $this->tailPositions[$path] ?? 0);

View File

@ -20,13 +20,14 @@ use ParaTest\Options;
use ParaTest\RunnerInterface; use ParaTest\RunnerInterface;
use ParaTest\WrapperRunner\SuiteLoader; use ParaTest\WrapperRunner\SuiteLoader;
use ParaTest\WrapperRunner\WrapperWorker; use ParaTest\WrapperRunner\WrapperWorker;
use Pest\Result;
use Pest\TestSuite; use Pest\TestSuite;
use PHPUnit\Event\Facade as EventFacade; use PHPUnit\Event\Facade as EventFacade;
use PHPUnit\Event\TestRunner\WarningTriggered;
use PHPUnit\Runner\CodeCoverage; use PHPUnit\Runner\CodeCoverage;
use PHPUnit\TestRunner\TestResult\Facade as TestResultFacade; use PHPUnit\TestRunner\TestResult\Facade as TestResultFacade;
use PHPUnit\TestRunner\TestResult\TestResult; use PHPUnit\TestRunner\TestResult\TestResult;
use PHPUnit\TextUI\Configuration\CodeCoverageFilterRegistry; use PHPUnit\TextUI\Configuration\CodeCoverageFilterRegistry;
use PHPUnit\TextUI\ShellExitCodeCalculator;
use PHPUnit\Util\ExcludeList; use PHPUnit\Util\ExcludeList;
use function realpath; use function realpath;
use SebastianBergmann\Timer\Timer; use SebastianBergmann\Timer\Timer;
@ -48,36 +49,39 @@ final class WrapperRunner implements RunnerInterface
private readonly Timer $timer; private readonly Timer $timer;
/** @var array<int, string> */ /** @var list<non-empty-string> */
private array $pending = []; private array $pending = [];
private int $exitCode = -1; private int $exitcode = -1;
/** @var array<int,WrapperWorker> */ /** @var array<positive-int,WrapperWorker> */
private array $workers = []; private array $workers = [];
/** @var array<int,int> */ /** @var array<int,int> */
private array $batches = []; private array $batches = [];
/** @var array<int, SplFileInfo> */ /** @var list<SplFileInfo> */
private array $unexpectedOutputFiles = [];
/** @var list<SplFileInfo> */
private array $testresultFiles = []; private array $testresultFiles = [];
/** @var array<int, SplFileInfo> */ /** @var list<SplFileInfo> */
private array $coverageFiles = []; private array $coverageFiles = [];
/** @var array<int, SplFileInfo> */ /** @var list<SplFileInfo> */
private array $junitFiles = []; private array $junitFiles = [];
/** @var array<int, SplFileInfo> */ /** @var list<SplFileInfo> */
private array $teamcityFiles = []; private array $teamcityFiles = [];
/** @var array<int, SplFileInfo> */ /** @var list<SplFileInfo> */
private array $testdoxFiles = []; private array $testdoxFiles = [];
/** @var array<int, string> */ /** @var non-empty-string[] */
private readonly array $parameters; private readonly array $parameters;
private readonly CodeCoverageFilterRegistry $codeCoverageFilterRegistry; private CodeCoverageFilterRegistry $codeCoverageFilterRegistry;
public function __construct( public function __construct(
private readonly Options $options, private readonly Options $options,
@ -86,11 +90,10 @@ final class WrapperRunner implements RunnerInterface
$this->printer = new ResultPrinter($output, $options); $this->printer = new ResultPrinter($output, $options);
$this->timer = new Timer(); $this->timer = new Timer();
$worker = realpath( $wrapper = realpath(
dirname(__DIR__, 4).DIRECTORY_SEPARATOR.'bin'.DIRECTORY_SEPARATOR.'worker.php', dirname(__DIR__, 4).DIRECTORY_SEPARATOR.'bin'.DIRECTORY_SEPARATOR.'worker.php',
); );
assert($wrapper !== false);
assert($worker !== false);
$phpFinder = new PhpExecutableFinder(); $phpFinder = new PhpExecutableFinder();
$phpBin = $phpFinder->find(false); $phpBin = $phpFinder->find(false);
assert($phpBin !== false); assert($phpBin !== false);
@ -101,7 +104,7 @@ final class WrapperRunner implements RunnerInterface
$parameters = array_merge($parameters, $options->passthruPhp); $parameters = array_merge($parameters, $options->passthruPhp);
} }
$parameters[] = $worker; $parameters[] = $wrapper;
$this->parameters = $parameters; $this->parameters = $parameters;
$this->codeCoverageFilterRegistry = new CodeCoverageFilterRegistry(); $this->codeCoverageFilterRegistry = new CodeCoverageFilterRegistry();
@ -110,15 +113,15 @@ final class WrapperRunner implements RunnerInterface
public function run(): int public function run(): int
{ {
$directory = dirname(__DIR__); $directory = dirname(__DIR__);
assert(strlen($directory) > 0); assert($directory !== '');
ExcludeList::addDirectory($directory); ExcludeList::addDirectory($directory);
TestResultFacade::init(); TestResultFacade::init();
EventFacade::instance()->seal();
// @phpstan-ignore-next-line $suiteLoader = new SuiteLoader(
method_exists(EventFacade::class, 'instance') ? EventFacade::instance()->seal() : EventFacade::seal(); $this->options,
$this->output,
$suiteLoader = new SuiteLoader($this->options, $this->output, $this->codeCoverageFilterRegistry); $this->codeCoverageFilterRegistry,
);
$this->pending = $this->getTestFiles($suiteLoader); $this->pending = $this->getTestFiles($suiteLoader);
$result = TestResultFacade::result(); $result = TestResultFacade::result();
@ -143,7 +146,7 @@ final class WrapperRunner implements RunnerInterface
{ {
$batchSize = $this->options->maxBatchSize; $batchSize = $this->options->maxBatchSize;
while ($this->pending !== [] && $this->workers !== []) { while (count($this->pending) > 0 && count($this->workers) > 0) {
foreach ($this->workers as $token => $worker) { foreach ($this->workers as $token => $worker) {
if (! $worker->isRunning()) { if (! $worker->isRunning()) {
throw $worker->getWorkerCrashedException(); throw $worker->getWorkerCrashedException();
@ -161,13 +164,11 @@ final class WrapperRunner implements RunnerInterface
} }
if ( if (
$this->exitCode > 0 $this->exitcode > 0
&& $this->options->configuration->stopOnFailure() && $this->options->configuration->stopOnFailure()
) { ) {
$this->pending = []; $this->pending = [];
} elseif (($pending = array_shift($this->pending)) !== null) { } elseif (($pending = array_shift($this->pending)) !== null) {
$this->debug(sprintf('Assigning %s to worker %d', $pending, $token));
$worker->assign($pending); $worker->assign($pending);
$this->batches[$token]++; $this->batches[$token]++;
} }
@ -179,9 +180,10 @@ final class WrapperRunner implements RunnerInterface
private function flushWorker(WrapperWorker $worker): void private function flushWorker(WrapperWorker $worker): void
{ {
$this->exitCode = max($this->exitCode, $worker->getExitCode()); $this->exitcode = max($this->exitcode, $worker->getExitCode());
$this->printer->printFeedback( $this->printer->printFeedback(
$worker->progressFile, $worker->progressFile,
$worker->unexpectedOutputFile,
$this->teamcityFiles, $this->teamcityFiles,
); );
$worker->reset(); $worker->reset();
@ -190,10 +192,10 @@ final class WrapperRunner implements RunnerInterface
private function waitForAllToFinish(): void private function waitForAllToFinish(): void
{ {
$stopped = []; $stopped = [];
while ($this->workers !== []) { while (count($this->workers) > 0) {
foreach ($this->workers as $index => $worker) { foreach ($this->workers as $index => $worker) {
if ($worker->isRunning()) { if ($worker->isRunning()) {
if (! array_key_exists($index, $stopped) && $worker->isFree()) { if (! isset($stopped[$index]) && $worker->isFree()) {
$worker->stop(); $worker->stop();
$stopped[$index] = true; $stopped[$index] = true;
} }
@ -213,22 +215,19 @@ final class WrapperRunner implements RunnerInterface
} }
} }
/** @param positive-int $token */
private function startWorker(int $token): WrapperWorker private function startWorker(int $token): WrapperWorker
{ {
/** @var array<non-empty-string> $parameters */
$parameters = $this->parameters;
$worker = new WrapperWorker( $worker = new WrapperWorker(
$this->output, $this->output,
$this->options, $this->options,
$parameters, $this->parameters,
$token, $token,
); );
$worker->start(); $worker->start();
$this->batches[$token] = 0; $this->batches[$token] = 0;
$this->unexpectedOutputFiles[] = $worker->unexpectedOutputFile;
$this->testresultFiles[] = $worker->testresultFile; $this->testresultFiles[] = $worker->testresultFile;
if (isset($worker->junitFile)) { if (isset($worker->junitFile)) {
@ -319,7 +318,10 @@ final class WrapperRunner implements RunnerInterface
$testResultSum->testTriggeredPhpunitErrorEvents(), $testResultSum->testTriggeredPhpunitErrorEvents(),
$testResultSum->testTriggeredPhpunitWarningEvents(), $testResultSum->testTriggeredPhpunitWarningEvents(),
$testResultSum->testRunnerTriggeredDeprecationEvents(), $testResultSum->testRunnerTriggeredDeprecationEvents(),
array_values(array_filter($testResultSum->testRunnerTriggeredWarningEvents(), fn ($event): bool => ! str_contains($event->message(), 'No tests found'))), array_values(array_filter(
$testResultSum->testRunnerTriggeredWarningEvents(),
fn (WarningTriggered $event): bool => ! str_contains($event->message(), 'No tests found')
)),
); );
$this->printer->printResults( $this->printer->printResults(
@ -331,22 +333,16 @@ final class WrapperRunner implements RunnerInterface
$this->generateCodeCoverageReports(); $this->generateCodeCoverageReports();
$this->generateLogs(); $this->generateLogs();
$exitCode = (new ShellExitCodeCalculator())->calculate( $exitcode = Result::exitCode($this->options->configuration, $testResultSum);
$this->options->configuration->failOnEmptyTestSuite(),
$this->options->configuration->failOnRisky(),
$this->options->configuration->failOnWarning(),
$this->options->configuration->failOnIncomplete(),
$this->options->configuration->failOnSkipped(),
$testResultSum,
);
$this->clearFiles($this->unexpectedOutputFiles);
$this->clearFiles($this->testresultFiles); $this->clearFiles($this->testresultFiles);
$this->clearFiles($this->coverageFiles); $this->clearFiles($this->coverageFiles);
$this->clearFiles($this->junitFiles); $this->clearFiles($this->junitFiles);
$this->clearFiles($this->teamcityFiles); $this->clearFiles($this->teamcityFiles);
$this->clearFiles($this->testdoxFiles); $this->clearFiles($this->testdoxFiles);
return $exitCode; return $exitcode;
} }
private function generateCodeCoverageReports(): void private function generateCodeCoverageReports(): void
@ -356,10 +352,11 @@ final class WrapperRunner implements RunnerInterface
} }
$coverageManager = new CodeCoverage(); $coverageManager = new CodeCoverage();
$coverageManager->init(
// @phpstan-ignore-next-line $this->options->configuration,
is_bool(true) && $coverageManager->init($this->options->configuration, $this->codeCoverageFilterRegistry, true); $this->codeCoverageFilterRegistry,
false,
);
$coverageMerger = new CoverageMerger($coverageManager->codeCoverage()); $coverageMerger = new CoverageMerger($coverageManager->codeCoverage());
foreach ($this->coverageFiles as $coverageFile) { foreach ($this->coverageFiles as $coverageFile) {
$coverageMerger->addCoverageFromFile($coverageFile); $coverageMerger->addCoverageFromFile($coverageFile);
@ -384,7 +381,7 @@ final class WrapperRunner implements RunnerInterface
); );
} }
/** @param array<int, SplFileInfo> $files */ /** @param list<SplFileInfo> $files */
private function clearFiles(array $files): void private function clearFiles(array $files): void
{ {
foreach ($files as $file) { foreach ($files as $file) {
@ -399,31 +396,19 @@ final class WrapperRunner implements RunnerInterface
/** /**
* Returns the test files to be executed. * Returns the test files to be executed.
* *
* @return array<int, string> * @return array<int, non-empty-string>
*/ */
private function getTestFiles(SuiteLoader $suiteLoader): array private function getTestFiles(SuiteLoader $suiteLoader): array
{ {
$this->debug(sprintf('Found %d test file%s', count($suiteLoader->files), count($suiteLoader->files) === 1 ? '' : 's')); /** @var array<string, non-empty-string> $files */
$files = [
/** @var array<string, string> $files */
$files = $suiteLoader->files;
return [
...array_values(array_filter( ...array_values(array_filter(
$files, $suiteLoader->tests,
fn (string $filename): bool => ! str_ends_with($filename, "eval()'d code") fn (string $filename): bool => ! str_ends_with($filename, "eval()'d code")
)), )),
...TestSuite::getInstance()->tests->getFilenames(), ...TestSuite::getInstance()->tests->getFilenames(),
]; ];
}
/** return $files; // @phpstan-ignore-line
* Prints a debug message.
*/
private function debug(string $message): void
{
if ($this->options->verbose) {
$this->output->writeln(" <fg=blue>{$message}</> ");
}
} }
} }

View File

@ -7,6 +7,7 @@ namespace Pest\Plugins\Parallel\Support;
use NunoMaduro\Collision\Adapters\Phpunit\State; use NunoMaduro\Collision\Adapters\Phpunit\State;
use NunoMaduro\Collision\Adapters\Phpunit\Style; use NunoMaduro\Collision\Adapters\Phpunit\Style;
use ParaTest\Options; use ParaTest\Options;
use PHPUnit\Event\Telemetry\GarbageCollectorStatus;
use PHPUnit\Event\Telemetry\HRTime; use PHPUnit\Event\Telemetry\HRTime;
use PHPUnit\Event\Telemetry\Info; use PHPUnit\Event\Telemetry\Info;
use PHPUnit\Event\Telemetry\MemoryUsage; use PHPUnit\Event\Telemetry\MemoryUsage;
@ -122,11 +123,25 @@ final class CompactPrinter
$snapshotDuration = HRTime::fromSecondsAndNanoseconds((int) $duration->asSeconds(), $nanoseconds); $snapshotDuration = HRTime::fromSecondsAndNanoseconds((int) $duration->asSeconds(), $nanoseconds);
$telemetryDuration = \PHPUnit\Event\Telemetry\Duration::fromSecondsAndNanoseconds((int) $duration->asSeconds(), $nanoseconds); $telemetryDuration = \PHPUnit\Event\Telemetry\Duration::fromSecondsAndNanoseconds((int) $duration->asSeconds(), $nanoseconds);
$status = gc_status();
$garbageCollectorStatus = new GarbageCollectorStatus(
$status['runs'],
$status['collected'],
$status['threshold'],
$status['roots'],
null,
null,
null,
null,
);
$telemetry = new Info( $telemetry = new Info(
new Snapshot( new Snapshot(
$snapshotDuration, $snapshotDuration,
MemoryUsage::fromBytes(0), MemoryUsage::fromBytes(0),
MemoryUsage::fromBytes(0), MemoryUsage::fromBytes(0),
$garbageCollectorStatus,
), ),
$telemetryDuration, $telemetryDuration,
MemoryUsage::fromBytes(0), MemoryUsage::fromBytes(0),

35
src/Plugins/Snapshot.php Normal file
View File

@ -0,0 +1,35 @@
<?php
declare(strict_types=1);
namespace Pest\Plugins;
use Pest\Contracts\Plugins\HandlesArguments;
use Pest\Exceptions\InvalidOption;
use Pest\TestSuite;
/**
* @internal
*/
final class Snapshot implements HandlesArguments
{
use Concerns\HandleArguments;
/**
* {@inheritDoc}
*/
public function handleArguments(array $arguments): array
{
if (! $this->hasArgument('--update-snapshots', $arguments)) {
return $arguments;
}
if ($this->hasArgument('--parallel', $arguments)) {
throw new InvalidOption('The [--update-snapshots] option is not supported when running in parallel.');
}
TestSuite::getInstance()->snapshots->flush();
return $this->popArgument('--update-snapshots', $arguments);
}
}

View File

@ -6,7 +6,7 @@ namespace Pest\Repositories;
use Closure; use Closure;
use Mockery; use Mockery;
use Pest\Exceptions\AfterEachAlreadyExist; use Pest\PendingCalls\AfterEachCall;
use Pest\Support\ChainableClosure; use Pest\Support\ChainableClosure;
use Pest\Support\NullClosure; use Pest\Support\NullClosure;
@ -23,13 +23,18 @@ final class AfterEachRepository
/** /**
* Sets a after each closure. * Sets a after each closure.
*/ */
public function set(string $filename, Closure $closure): void public function set(string $filename, AfterEachCall $afterEachCall, Closure $afterEachTestCase): void
{ {
if (array_key_exists($filename, $this->state)) { if (array_key_exists($filename, $this->state)) {
throw new AfterEachAlreadyExist($filename); $fromAfterEachTestCase = $this->state[$filename];
$afterEachTestCase = ChainableClosure::bound($fromAfterEachTestCase, $afterEachTestCase)
->bindTo($afterEachCall, $afterEachCall::class);
} }
$this->state[$filename] = $closure; assert($afterEachTestCase instanceof Closure);
$this->state[$filename] = $afterEachTestCase;
} }
/** /**
@ -39,7 +44,7 @@ final class AfterEachRepository
{ {
$afterEach = $this->state[$filename] ?? NullClosure::create(); $afterEach = $this->state[$filename] ?? NullClosure::create();
return ChainableClosure::from(function (): void { return ChainableClosure::bound(function (): void {
if (class_exists(Mockery::class)) { if (class_exists(Mockery::class)) {
if ($container = Mockery::getContainer()) { if ($container = Mockery::getContainer()) {
/* @phpstan-ignore-next-line */ /* @phpstan-ignore-next-line */

View File

@ -5,7 +5,7 @@ declare(strict_types=1);
namespace Pest\Repositories; namespace Pest\Repositories;
use Closure; use Closure;
use Pest\Exceptions\BeforeEachAlreadyExist; use Pest\Exceptions\BeforeAllAlreadyExist;
use Pest\Support\NullClosure; use Pest\Support\NullClosure;
use Pest\Support\Reflection; use Pest\Support\Reflection;
@ -39,7 +39,7 @@ final class BeforeAllRepository
$filename = Reflection::getFileNameFromClosure($closure); $filename = Reflection::getFileNameFromClosure($closure);
if (array_key_exists($filename, $this->state)) { if (array_key_exists($filename, $this->state)) {
throw new BeforeEachAlreadyExist($filename); throw new BeforeAllAlreadyExist($filename);
} }
$this->state[$filename] = $closure; $this->state[$filename] = $closure;

View File

@ -5,7 +5,8 @@ declare(strict_types=1);
namespace Pest\Repositories; namespace Pest\Repositories;
use Closure; use Closure;
use Pest\Exceptions\BeforeEachAlreadyExist; use Pest\PendingCalls\BeforeEachCall;
use Pest\Support\ChainableClosure;
use Pest\Support\NullClosure; use Pest\Support\NullClosure;
/** /**
@ -14,27 +15,38 @@ use Pest\Support\NullClosure;
final class BeforeEachRepository final class BeforeEachRepository
{ {
/** /**
* @var array<string, Closure> * @var array<string, array{0: Closure, 1: Closure}>
*/ */
private array $state = []; private array $state = [];
/** /**
* Sets a before each closure. * Sets a before each closure.
*/ */
public function set(string $filename, Closure $closure): void public function set(string $filename, BeforeEachCall $beforeEachCall, Closure $beforeEachTestCall, Closure $beforeEachTestCase): void
{ {
if (array_key_exists($filename, $this->state)) { if (array_key_exists($filename, $this->state)) {
throw new BeforeEachAlreadyExist($filename); [$fromBeforeEachTestCall, $fromBeforeEachTestCase] = $this->state[$filename];
$beforeEachTestCall = ChainableClosure::unbound($fromBeforeEachTestCall, $beforeEachTestCall);
$beforeEachTestCase = ChainableClosure::bound($fromBeforeEachTestCase, $beforeEachTestCase)->bindTo($beforeEachCall, $beforeEachCall::class);
assert($beforeEachTestCase instanceof Closure);
} }
$this->state[$filename] = $closure; $this->state[$filename] = [$beforeEachTestCall, $beforeEachTestCase];
} }
/** /**
* Gets a before each closure by the given filename. * Gets a before each closure by the given filename.
*
* @return array{0: Closure, 1: Closure}
*/ */
public function get(string $filename): Closure public function get(string $filename): array
{ {
return $this->state[$filename] ?? NullClosure::create(); $closures = $this->state[$filename] ?? [];
return [
$closures[0] ?? NullClosure::create(),
$closures[1] ?? NullClosure::create(),
];
} }
} }

View File

@ -66,11 +66,11 @@ final class DatasetsRepository
} }
/** /**
* @return Closure|array<int|string, mixed>|never * @return Closure|array<int|string, mixed>
* *
* @throws ShouldNotHappen * @throws ShouldNotHappen
*/ */
public static function get(string $filename, string $description) public static function get(string $filename, string $description): Closure|array
{ {
$dataset = self::$withs[$filename.self::SEPARATOR.$description]; $dataset = self::$withs[$filename.self::SEPARATOR.$description];
@ -89,7 +89,7 @@ final class DatasetsRepository
* @param array<Closure|iterable<int|string, mixed>|string> $dataset * @param array<Closure|iterable<int|string, mixed>|string> $dataset
* @return array<string, mixed>|null * @return array<string, mixed>|null
*/ */
public static function resolve(array $dataset, string $currentTestFile): array|null public static function resolve(array $dataset, string $currentTestFile): ?array
{ {
if ($dataset === []) { if ($dataset === []) {
return null; return null;
@ -138,7 +138,7 @@ final class DatasetsRepository
/** /**
* @param array<Closure|iterable<int|string, mixed>|string> $datasets * @param array<Closure|iterable<int|string, mixed>|string> $datasets
* @return array<array<mixed>> * @return array<int, array<int, mixed>>
*/ */
private static function processDatasets(array $datasets, string $currentTestFile): array private static function processDatasets(array $datasets, string $currentTestFile): array
{ {
@ -193,7 +193,7 @@ final class DatasetsRepository
$closestScopeDatasetKey = array_reduce( $closestScopeDatasetKey = array_reduce(
array_keys($matchingDatasets), array_keys($matchingDatasets),
fn ($keyA, $keyB) => $keyA !== null && strlen((string) $keyA) > strlen($keyB) ? $keyA : $keyB fn (string|int|null $keyA, string|int|null $keyB): string|int|null => $keyA !== null && strlen((string) $keyA) > strlen((string) $keyB) ? $keyA : $keyB
); );
if ($closestScopeDatasetKey === null) { if ($closestScopeDatasetKey === null) {
@ -235,6 +235,6 @@ final class DatasetsRepository
return sprintf('(%s)', $exporter->shortenedRecursiveExport($data)); return sprintf('(%s)', $exporter->shortenedRecursiveExport($data));
} }
return sprintf('data set "%s"', $key); return sprintf('dataset "%s"', $key);
} }
} }

View File

@ -0,0 +1,135 @@
<?php
declare(strict_types=1);
namespace Pest\Repositories;
use Pest\Exceptions\ShouldNotHappen;
use Pest\Support\Str;
use PHPUnit\Framework\TestCase;
/**
* @internal
*/
final class SnapshotRepository
{
/**
* Creates a snapshot repository instance.
*/
public function __construct(
readonly private string $testsPath,
readonly private string $snapshotsPath,
) {
}
/**
* Checks if the snapshot exists.
*/
public function has(TestCase $testCase, string $description): bool
{
[$filename, $description] = $this->getFilenameAndDescription($testCase);
return file_exists($this->getSnapshotFilename($filename, $description));
}
/**
* Gets the snapshot.
*
* @return array{0: string, 1: string}
*
* @throws ShouldNotHappen
*/
public function get(TestCase $testCase, string $description): array
{
[$filename, $description] = $this->getFilenameAndDescription($testCase);
$contents = file_get_contents($snapshotFilename = $this->getSnapshotFilename($filename, $description));
if ($contents === false) {
throw ShouldNotHappen::fromMessage('Snapshot file could not be read.');
}
$snapshot = str_replace(dirname($this->testsPath).'/', '', $snapshotFilename);
return [$snapshot, $contents];
}
/**
* Saves the given snapshot for the given test case.
*/
public function save(TestCase $testCase, string $snapshot): string
{
[$filename, $description] = $this->getFilenameAndDescription($testCase);
$snapshotFilename = $this->getSnapshotFilename($filename, $description);
if (! file_exists(dirname($snapshotFilename))) {
mkdir(dirname($snapshotFilename), 0755, true);
}
file_put_contents($snapshotFilename, $snapshot);
return str_replace(dirname($this->testsPath).'/', '', $snapshotFilename);
}
/**
* Flushes the snapshots.
*/
public function flush(): void
{
$absoluteSnapshotsPath = $this->testsPath.'/'.$this->snapshotsPath;
$deleteDirectory = function (string $path) use (&$deleteDirectory): void {
if (file_exists($path)) {
$scannedDir = scandir($path);
assert(is_array($scannedDir));
$files = array_diff($scannedDir, ['.', '..']);
foreach ($files as $file) {
if (is_dir($path.'/'.$file)) {
$deleteDirectory($path.'/'.$file);
} else {
unlink($path.'/'.$file);
}
}
rmdir($path);
}
};
if (file_exists($absoluteSnapshotsPath)) {
$deleteDirectory($absoluteSnapshotsPath);
}
}
/**
* Gets the snapshot's "filename" and "description".
*
* @return array{0: string, 1: string}
*/
private function getFilenameAndDescription(TestCase $testCase): array
{
$filename = (fn () => self::$__filename)->call($testCase, $testCase::class); // @phpstan-ignore-line
$description = str_replace('__pest_evaluable_', '', $testCase->name());
$datasetAsString = str_replace('__pest_evaluable_', '', Str::evaluable($testCase->dataSetAsStringWithData()));
$description = str_replace(' ', '_', $description.$datasetAsString);
return [$filename, $description];
}
/**
* Gets the snapshot's "filename".
*/
private function getSnapshotFilename(string $filename, string $description): string
{
$relativePath = str_replace($this->testsPath, '', $filename);
// remove extension from filename
$relativePath = substr($relativePath, 0, (int) strrpos($relativePath, '.'));
return sprintf('%s/%s.snap', $this->testsPath.'/'.$this->snapshotsPath.$relativePath, $description);
}
}

View File

@ -4,8 +4,8 @@ declare(strict_types=1);
namespace Pest; namespace Pest;
use PHPUnit\TestRunner\TestResult\Facade; use PHPUnit\TestRunner\TestResult\TestResult;
use PHPUnit\TextUI\Configuration\Registry; use PHPUnit\TextUI\Configuration\Configuration;
/** /**
* @internal * @internal
@ -21,37 +21,31 @@ final class Result
/** /**
* If the exit code is different from 0. * If the exit code is different from 0.
*/ */
public static function failed(): bool public static function failed(Configuration $configuration, TestResult $result): bool
{ {
return ! self::ok(); return ! self::ok($configuration, $result);
} }
/** /**
* If the exit code is exactly 0. * If the exit code is exactly 0.
*/ */
public static function ok(): bool public static function ok(Configuration $configuration, TestResult $result): bool
{ {
return self::exitCode() === self::SUCCESS_EXIT; return self::exitCode($configuration, $result) === self::SUCCESS_EXIT;
} }
/** /**
* Get the test execution's exit code. * Get the test execution's exit code.
*/ */
public static function exitCode(): int public static function exitCode(Configuration $configuration, TestResult $result): int
{ {
$result = Facade::result();
$returnCode = self::FAILURE_EXIT;
if ($result->wasSuccessfulIgnoringPhpunitWarnings() if ($result->wasSuccessfulIgnoringPhpunitWarnings()
&& ! $result->hasTestTriggeredPhpunitWarningEvents()) { && ! $result->hasTestTriggeredPhpunitWarningEvents()) {
$returnCode = self::SUCCESS_EXIT; return self::SUCCESS_EXIT;
} }
$configuration = Registry::get();
if ($configuration->failOnEmptyTestSuite() && $result->numberOfTests() === 0) { if ($configuration->failOnEmptyTestSuite() && $result->numberOfTests() === 0) {
$returnCode = self::FAILURE_EXIT; return self::FAILURE_EXIT;
} }
if ($result->wasSuccessfulIgnoringPhpunitWarnings()) { if ($result->wasSuccessfulIgnoringPhpunitWarnings()) {
@ -80,6 +74,6 @@ final class Result
return self::EXCEPTION_EXIT; return self::EXCEPTION_EXIT;
} }
return $returnCode; return self::FAILURE_EXIT;
} }
} }

View File

@ -73,7 +73,7 @@ final class Arr
foreach ($array as $key => $value) { foreach ($array as $key => $value) {
if (is_array($value) && $value !== []) { if (is_array($value) && $value !== []) {
$results = array_merge($results, static::dot($value, $prepend.$key.'.')); $results = array_merge($results, self::dot($value, $prepend.$key.'.'));
} else { } else {
$results[$prepend.$value] = $value; $results[$prepend.$value] = $value;
} }

View File

@ -30,7 +30,10 @@ final class Backtrace
$traceFile = str_replace(DIRECTORY_SEPARATOR, '/', $trace[self::FILE]); $traceFile = str_replace(DIRECTORY_SEPARATOR, '/', $trace[self::FILE]);
if (Str::endsWith($traceFile, 'overrides/Runner/TestSuiteLoader.php')) { if (
Str::endsWith($traceFile, 'overrides/Runner/TestSuiteLoader.php') ||
Str::endsWith($traceFile, 'src/Bootstrappers/BootFiles.php')
) {
break; break;
} }
@ -75,9 +78,7 @@ final class Backtrace
*/ */
public static function file(): string public static function file(): string
{ {
$trace = debug_backtrace(self::BACKTRACE_OPTIONS)[1]; $trace = self::backtrace();
assert(array_key_exists(self::FILE, $trace));
return $trace[self::FILE]; return $trace[self::FILE];
} }
@ -87,9 +88,7 @@ final class Backtrace
*/ */
public static function dirname(): string public static function dirname(): string
{ {
$trace = debug_backtrace(self::BACKTRACE_OPTIONS)[1]; $trace = self::backtrace();
assert(array_key_exists(self::FILE, $trace));
return dirname($trace[self::FILE]); return dirname($trace[self::FILE]);
} }
@ -99,10 +98,30 @@ final class Backtrace
*/ */
public static function line(): int public static function line(): int
{ {
$trace = debug_backtrace(self::BACKTRACE_OPTIONS)[1]; $trace = self::backtrace();
assert(array_key_exists('line', $trace)); return $trace['line'] ?? 0;
}
return $trace['line']; /**
* @return array{function: string, line?: int, file: string, class?: class-string, type?: string, args?: mixed[], object?: object}
*/
private static function backtrace(): array
{
$backtrace = debug_backtrace(self::BACKTRACE_OPTIONS);
foreach ($backtrace as $trace) {
if (! isset($trace['file'])) {
continue;
}
if (str_contains($trace['file'], 'pest'.DIRECTORY_SEPARATOR.'src')) {
continue;
}
return $trace;
}
throw ShouldNotHappen::fromMessage('Backtrace not found.');
} }
} }

View File

@ -13,9 +13,25 @@ use Pest\Exceptions\ShouldNotHappen;
final class ChainableClosure final class ChainableClosure
{ {
/** /**
* Calls the given `$closure` and chains the `$next` closure. * Calls the given `$closure` when the given condition is true, "bound" to the same object.
*/ */
public static function from(Closure $closure, Closure $next): Closure public static function boundWhen(Closure $condition, Closure $next): Closure
{
return function () use ($condition, $next): void {
if (! is_object($this)) { // @phpstan-ignore-line
throw ShouldNotHappen::fromMessage('$this not bound to chainable closure.');
}
if (\Pest\Support\Closure::bind($condition, $this, self::class)(...func_get_args())) {
\Pest\Support\Closure::bind($next, $this, self::class)(...func_get_args());
}
};
}
/**
* Calls the given `$closure` and chains the `$next` closure, "bound" to the same object.
*/
public static function bound(Closure $closure, Closure $next): Closure
{ {
return function () use ($closure, $next): void { return function () use ($closure, $next): void {
if (! is_object($this)) { // @phpstan-ignore-line if (! is_object($this)) { // @phpstan-ignore-line
@ -28,9 +44,20 @@ final class ChainableClosure
} }
/** /**
* Call the given static `$closure` and chains the `$next` closure. * Calls the given `$closure` and chains the `$next` closure, "unbound" of any object.
*/ */
public static function fromStatic(Closure $closure, Closure $next): Closure public static function unbound(Closure $closure, Closure $next): Closure
{
return function () use ($closure, $next): void {
$closure(...func_get_args());
$next(...func_get_args());
};
}
/**
* Call the given static `$closure` and chains the `$next` closure, "bound" to the same object statically.
*/
public static function boundStatically(Closure $closure, Closure $next): Closure
{ {
return static function () use ($closure, $next): void { return static function () use ($closure, $next): void {
\Pest\Support\Closure::bind($closure, null, self::class)(...func_get_args()); \Pest\Support\Closure::bind($closure, null, self::class)(...func_get_args());

View File

@ -18,7 +18,7 @@ final class Closure
* *
* @throws ShouldNotHappen * @throws ShouldNotHappen
*/ */
public static function bind(BaseClosure|null $closure, ?object $newThis, object|string|null $newScope = 'static'): BaseClosure public static function bind(?BaseClosure $closure, ?object $newThis, object|string|null $newScope = 'static'): BaseClosure
{ {
if ($closure == null) { if ($closure == null) {
throw ShouldNotHappen::fromMessage('Could not bind null closure.'); throw ShouldNotHappen::fromMessage('Could not bind null closure.');

View File

@ -25,7 +25,7 @@ final class Container
*/ */
public static function getInstance(): self public static function getInstance(): self
{ {
if (self::$instance === null) { if (! self::$instance instanceof \Pest\Support\Container) {
self::$instance = new self(); self::$instance = new self();
} }
@ -72,7 +72,7 @@ final class Container
if ($reflectionClass->isInstantiable()) { if ($reflectionClass->isInstantiable()) {
$constructor = $reflectionClass->getConstructor(); $constructor = $reflectionClass->getConstructor();
if ($constructor !== null) { if ($constructor instanceof \ReflectionMethod) {
$params = array_map( $params = array_map(
function (ReflectionParameter $param) use ($id): object|string { function (ReflectionParameter $param) use ($id): object|string {
$candidate = Reflection::getParameterClassName($param); $candidate = Reflection::getParameterClassName($param);
@ -80,7 +80,7 @@ final class Container
if ($candidate === null) { if ($candidate === null) {
$type = $param->getType(); $type = $param->getType();
/* @phpstan-ignore-next-line */ /* @phpstan-ignore-next-line */
if ($type !== null && $type->isBuiltin()) { if ($type instanceof \ReflectionType && $type->isBuiltin()) {
$candidate = $param->getName(); $candidate = $param->getName();
} else { } else {
throw ShouldNotHappen::fromMessage(sprintf('The type of `$%s` in `%s` cannot be determined.', $id, $param->getName())); throw ShouldNotHappen::fromMessage(sprintf('The type of `$%s` in `%s` cannot be determined.', $id, $param->getName()));

View File

@ -42,6 +42,14 @@ final class Coverage
return false; return false;
} }
if ($runtime->hasPCOV()) {
return true;
}
if ($runtime->hasPHPDBGCodeCoverage()) {
return true;
}
if (! $runtime->hasXdebug()) { if (! $runtime->hasXdebug()) {
return true; return true;
} }
@ -151,10 +159,11 @@ final class Coverage
* ['11', '20..25', '50', '60..80']; * ['11', '20..25', '50', '60..80'];
* ``` * ```
* *
*
* @param File $file * @param File $file
* @return array<int, string> * @return array<int, string>
*/ */
public static function getMissingCoverage($file): array public static function getMissingCoverage(mixed $file): array
{ {
$shouldBeNewLine = true; $shouldBeNewLine = true;

View File

@ -5,6 +5,7 @@ declare(strict_types=1);
namespace Pest\Support; namespace Pest\Support;
use Closure; use Closure;
use PHPUnit\Framework\TestCase;
use Throwable; use Throwable;
/** /**
@ -15,21 +16,24 @@ final class ExceptionTrace
private const UNDEFINED_METHOD = 'Call to undefined method P\\'; private const UNDEFINED_METHOD = 'Call to undefined method P\\';
/** /**
* Ensures the given closure reports * Ensures the given closure reports the good execution context.
* the good execution context.
*
* @return mixed
* *
* @throws Throwable * @throws Throwable
*/ */
public static function ensure(Closure $closure) public static function ensure(Closure $closure): mixed
{ {
try { try {
return $closure(); return $closure();
} catch (Throwable $throwable) { } catch (Throwable $throwable) {
if (Str::startsWith($message = $throwable->getMessage(), self::UNDEFINED_METHOD)) { if (Str::startsWith($message = $throwable->getMessage(), self::UNDEFINED_METHOD)) {
$class = preg_match('/^Call to undefined method ([^:]+)::/', $message, $matches) === false ? null : $matches[1];
$message = str_replace(self::UNDEFINED_METHOD, 'Call to undefined method ', $message); $message = str_replace(self::UNDEFINED_METHOD, 'Call to undefined method ', $message);
if (class_exists((string) $class) && (is_countable(class_parents($class)) ? count(class_parents($class)) : 0) > 0 && array_values(class_parents($class))[0] === TestCase::class) { // @phpstan-ignore-line
$message .= '. Did you forget to use the [uses()] function? Read more at: https://pestphp.com/docs/configuring-tests';
}
Reflection::setPropertyValue($throwable, 'message', $message); Reflection::setPropertyValue($throwable, 'message', $message);
} }

View File

@ -84,6 +84,6 @@ final class ExpectationPipeline
*/ */
public function carry(): Closure public function carry(): Closure
{ {
return fn ($stack, $pipe): Closure => fn () => $pipe($stack, ...$this->passables); return fn (mixed $stack, callable $pipe): Closure => fn () => $pipe($stack, ...$this->passables);
} }
} }

View File

@ -77,6 +77,12 @@ final class Exporter
*/ */
public function shortenedExport(mixed $value): string public function shortenedExport(mixed $value): string
{ {
return (string) preg_replace(['#\.{3}#', '#\\\n\s*#'], ['…'], $this->exporter->shortenedExport($value)); $map = [
'#\.{3}#' => '…',
'#\\\n\s*#' => '',
'# Object \(…\)#' => '',
];
return (string) preg_replace(array_keys($map), array_values($map), $this->exporter->shortenedExport($value));
} }
} }

View File

@ -25,7 +25,7 @@ final class HigherOrderCallables
* *
* Create a new expectation. Callable values will be executed prior to returning the new expectation. * Create a new expectation. Callable values will be executed prior to returning the new expectation.
* *
* @param (Closure():TValue)|TValue $value * @param (Closure():TValue)|TValue $value
* @return Expectation<TValue> * @return Expectation<TValue>
*/ */
public function expect(mixed $value): Expectation public function expect(mixed $value): Expectation

View File

@ -62,7 +62,7 @@ final class HigherOrderMessage
Reflection::setPropertyValue($throwable, 'file', $this->filename); Reflection::setPropertyValue($throwable, 'file', $this->filename);
Reflection::setPropertyValue($throwable, 'line', $this->line); Reflection::setPropertyValue($throwable, 'line', $this->line);
if ($throwable->getMessage() === self::getUndefinedMethodMessage($target, $this->name)) { if ($throwable->getMessage() === $this->getUndefinedMethodMessage($target, $this->name)) {
/** @var ReflectionClass<TValue> $reflection */ /** @var ReflectionClass<TValue> $reflection */
$reflection = new ReflectionClass($target); $reflection = new ReflectionClass($target);
/* @phpstan-ignore-next-line */ /* @phpstan-ignore-next-line */
@ -94,7 +94,7 @@ final class HigherOrderMessage
return in_array($this->name, get_class_methods(HigherOrderCallables::class), true); return in_array($this->name, get_class_methods(HigherOrderCallables::class), true);
} }
private static function getUndefinedMethodMessage(object $target, string $methodName): string private function getUndefinedMethodMessage(object $target, string $methodName): string
{ {
if (\PHP_MAJOR_VERSION >= 8) { if (\PHP_MAJOR_VERSION >= 8) {
return sprintf(self::UNDEFINED_METHOD, sprintf('%s::%s()', $target::class, $methodName)); return sprintf(self::UNDEFINED_METHOD, sprintf('%s::%s()', $target::class, $methodName));

View File

@ -24,9 +24,8 @@ final class Reflection
* Calls the given method with args on the given object. * Calls the given method with args on the given object.
* *
* @param array<int, mixed> $args * @param array<int, mixed> $args
* @return mixed
*/ */
public static function call(object $object, string $method, array $args = []) public static function call(object $object, string $method, array $args = []): mixed
{ {
$reflectionClass = new ReflectionClass($object); $reflectionClass = new ReflectionClass($object);
@ -42,7 +41,7 @@ final class Reflection
} }
if (is_callable($method)) { if (is_callable($method)) {
return static::bindCallable($method, $args); return self::bindCallable($method, $args);
} }
throw $exception; throw $exception;
@ -53,9 +52,8 @@ final class Reflection
* Bind a callable to the TestCase and return the result. * Bind a callable to the TestCase and return the result.
* *
* @param array<int, mixed> $args * @param array<int, mixed> $args
* @return mixed
*/ */
public static function bindCallable(callable $callable, array $args = []) public static function bindCallable(callable $callable, array $args = []): mixed
{ {
return Closure::fromCallable($callable)->bindTo(TestSuite::getInstance()->test)(...$args); return Closure::fromCallable($callable)->bindTo(TestSuite::getInstance()->test)(...$args);
} }
@ -63,16 +61,14 @@ final class Reflection
/** /**
* Bind a callable to the TestCase and return the result, * Bind a callable to the TestCase and return the result,
* passing in the current dataset values as arguments. * passing in the current dataset values as arguments.
*
* @return mixed
*/ */
public static function bindCallableWithData(callable $callable) public static function bindCallableWithData(callable $callable): mixed
{ {
$test = TestSuite::getInstance()->test; $test = TestSuite::getInstance()->test;
return $test instanceof \PHPUnit\Framework\TestCase return $test instanceof \PHPUnit\Framework\TestCase
? Closure::fromCallable($callable)->bindTo($test)(...$test->providedData()) ? Closure::fromCallable($callable)->bindTo($test)(...$test->providedData())
: static::bindCallable($callable); : self::bindCallable($callable);
} }
/** /**
@ -87,10 +83,8 @@ final class Reflection
/** /**
* Gets the property value from of the given object. * Gets the property value from of the given object.
*
* @return mixed
*/ */
public static function getPropertyValue(object $object, string $property) public static function getPropertyValue(object $object, string $property): mixed
{ {
$reflectionClass = new ReflectionClass($object); $reflectionClass = new ReflectionClass($object);
@ -206,10 +200,7 @@ final class Reflection
return $arguments; return $arguments;
} }
/** public static function getFunctionVariable(Closure $function, string $key): mixed
* @return mixed
*/
public static function getFunctionVariable(Closure $function, string $key)
{ {
return (new ReflectionFunction($function))->getStaticVariables()[$key] ?? null; return (new ReflectionFunction($function))->getStaticVariables()[$key] ?? null;
} }

View File

@ -24,7 +24,7 @@ final class StateGenerator
foreach ($testResult->testErroredEvents() as $testResultEvent) { foreach ($testResult->testErroredEvents() as $testResultEvent) {
if ($testResultEvent instanceof Errored) { if ($testResultEvent instanceof Errored) {
$state->add(TestResult::fromTestCase( $state->add(TestResult::fromPestParallelTestCase(
$testResultEvent->test(), $testResultEvent->test(),
TestResult::FAIL, TestResult::FAIL,
$testResultEvent->throwable() $testResultEvent->throwable()
@ -35,7 +35,7 @@ final class StateGenerator
} }
foreach ($testResult->testFailedEvents() as $testResultEvent) { foreach ($testResult->testFailedEvents() as $testResultEvent) {
$state->add(TestResult::fromTestCase( $state->add(TestResult::fromPestParallelTestCase(
$testResultEvent->test(), $testResultEvent->test(),
TestResult::FAIL, TestResult::FAIL,
$testResultEvent->throwable() $testResultEvent->throwable()
@ -43,7 +43,7 @@ final class StateGenerator
} }
foreach ($testResult->testMarkedIncompleteEvents() as $testResultEvent) { foreach ($testResult->testMarkedIncompleteEvents() as $testResultEvent) {
$state->add(TestResult::fromTestCase( $state->add(TestResult::fromPestParallelTestCase(
$testResultEvent->test(), $testResultEvent->test(),
TestResult::INCOMPLETE, TestResult::INCOMPLETE,
$testResultEvent->throwable() $testResultEvent->throwable()
@ -52,7 +52,7 @@ final class StateGenerator
foreach ($testResult->testConsideredRiskyEvents() as $riskyEvents) { foreach ($testResult->testConsideredRiskyEvents() as $riskyEvents) {
foreach ($riskyEvents as $riskyEvent) { foreach ($riskyEvents as $riskyEvent) {
$state->add(TestResult::fromTestCase( $state->add(TestResult::fromPestParallelTestCase(
$riskyEvent->test(), $riskyEvent->test(),
TestResult::RISKY, TestResult::RISKY,
ThrowableBuilder::from(new TestOutcome($riskyEvent->message())) ThrowableBuilder::from(new TestOutcome($riskyEvent->message()))
@ -62,12 +62,12 @@ final class StateGenerator
foreach ($testResult->testSkippedEvents() as $testResultEvent) { foreach ($testResult->testSkippedEvents() as $testResultEvent) {
if ($testResultEvent->message() === '__TODO__') { if ($testResultEvent->message() === '__TODO__') {
$state->add(TestResult::fromTestCase($testResultEvent->test(), TestResult::TODO)); $state->add(TestResult::fromPestParallelTestCase($testResultEvent->test(), TestResult::TODO));
continue; continue;
} }
$state->add(TestResult::fromTestCase( $state->add(TestResult::fromPestParallelTestCase(
$testResultEvent->test(), $testResultEvent->test(),
TestResult::SKIPPED, TestResult::SKIPPED,
ThrowableBuilder::from(new SkippedWithMessageException($testResultEvent->message())) ThrowableBuilder::from(new SkippedWithMessageException($testResultEvent->message()))
@ -77,7 +77,7 @@ final class StateGenerator
foreach ($testResult->testTriggeredDeprecationEvents() as $testResultEvent) { foreach ($testResult->testTriggeredDeprecationEvents() as $testResultEvent) {
$testResultEvent = $testResultEvent[0]; $testResultEvent = $testResultEvent[0];
$state->add(TestResult::fromTestCase( $state->add(TestResult::fromPestParallelTestCase(
$testResultEvent->test(), $testResultEvent->test(),
TestResult::DEPRECATED, TestResult::DEPRECATED,
ThrowableBuilder::from(new TestOutcome($testResultEvent->message())) ThrowableBuilder::from(new TestOutcome($testResultEvent->message()))
@ -87,7 +87,7 @@ final class StateGenerator
foreach ($testResult->testTriggeredPhpDeprecationEvents() as $testResultEvent) { foreach ($testResult->testTriggeredPhpDeprecationEvents() as $testResultEvent) {
$testResultEvent = $testResultEvent[0]; $testResultEvent = $testResultEvent[0];
$state->add(TestResult::fromTestCase( $state->add(TestResult::fromPestParallelTestCase(
$testResultEvent->test(), $testResultEvent->test(),
TestResult::DEPRECATED, TestResult::DEPRECATED,
ThrowableBuilder::from(new TestOutcome($testResultEvent->message())) ThrowableBuilder::from(new TestOutcome($testResultEvent->message()))
@ -97,7 +97,7 @@ final class StateGenerator
foreach ($testResult->testTriggeredNoticeEvents() as $testResultEvent) { foreach ($testResult->testTriggeredNoticeEvents() as $testResultEvent) {
$testResultEvent = $testResultEvent[0]; $testResultEvent = $testResultEvent[0];
$state->add(TestResult::fromTestCase( $state->add(TestResult::fromPestParallelTestCase(
$testResultEvent->test(), $testResultEvent->test(),
TestResult::NOTICE, TestResult::NOTICE,
ThrowableBuilder::from(new TestOutcome($testResultEvent->message())) ThrowableBuilder::from(new TestOutcome($testResultEvent->message()))
@ -107,7 +107,7 @@ final class StateGenerator
foreach ($testResult->testTriggeredPhpNoticeEvents() as $testResultEvent) { foreach ($testResult->testTriggeredPhpNoticeEvents() as $testResultEvent) {
$testResultEvent = $testResultEvent[0]; $testResultEvent = $testResultEvent[0];
$state->add(TestResult::fromTestCase( $state->add(TestResult::fromPestParallelTestCase(
$testResultEvent->test(), $testResultEvent->test(),
TestResult::NOTICE, TestResult::NOTICE,
ThrowableBuilder::from(new TestOutcome($testResultEvent->message())) ThrowableBuilder::from(new TestOutcome($testResultEvent->message()))
@ -117,7 +117,7 @@ final class StateGenerator
foreach ($testResult->testTriggeredWarningEvents() as $testResultEvent) { foreach ($testResult->testTriggeredWarningEvents() as $testResultEvent) {
$testResultEvent = $testResultEvent[0]; $testResultEvent = $testResultEvent[0];
$state->add(TestResult::fromTestCase( $state->add(TestResult::fromPestParallelTestCase(
$testResultEvent->test(), $testResultEvent->test(),
TestResult::WARN, TestResult::WARN,
ThrowableBuilder::from(new TestOutcome($testResultEvent->message())) ThrowableBuilder::from(new TestOutcome($testResultEvent->message()))
@ -127,7 +127,7 @@ final class StateGenerator
foreach ($testResult->testTriggeredPhpWarningEvents() as $testResultEvent) { foreach ($testResult->testTriggeredPhpWarningEvents() as $testResultEvent) {
$testResultEvent = $testResultEvent[0]; $testResultEvent = $testResultEvent[0];
$state->add(TestResult::fromTestCase( $state->add(TestResult::fromPestParallelTestCase(
$testResultEvent->test(), $testResultEvent->test(),
TestResult::WARN, TestResult::WARN,
ThrowableBuilder::from(new TestOutcome($testResultEvent->message())) ThrowableBuilder::from(new TestOutcome($testResultEvent->message()))
@ -136,7 +136,7 @@ final class StateGenerator
// for each test that passed, we need to add it to the state // for each test that passed, we need to add it to the state
for ($i = 0; $i < $passedTests; $i++) { for ($i = 0; $i < $passedTests; $i++) {
$state->add(TestResult::fromTestCase( $state->add(TestResult::fromPestParallelTestCase(
new TestMethod( new TestMethod(
"$i", // @phpstan-ignore-line "$i", // @phpstan-ignore-line
'', // @phpstan-ignore-line '', // @phpstan-ignore-line

View File

@ -59,9 +59,12 @@ final class Str
*/ */
public static function evaluable(string $code): string public static function evaluable(string $code): string
{ {
$code = str_replace('_', '__', $code);
$code = self::PREFIX.str_replace(' ', '_', $code); $code = self::PREFIX.str_replace(' ', '_', $code);
return (string) preg_replace('/[^A-Z_a-z0-9]/', '_', $code); // sticks to PHP8.2 function naming rules https://www.php.net/manual/en/functions.user-defined.php
return (string) preg_replace('/[^a-zA-Z0-9_\x80-\xff]/', '_', $code);
} }
/** /**

View File

@ -16,7 +16,7 @@ final class GitDirtyTestCaseFilter implements TestCaseFilter
/** /**
* @var string[]|null * @var string[]|null
*/ */
private array|null $changedFiles = null; private ?array $changedFiles = null;
public function __construct(private readonly string $projectRoot) public function __construct(private readonly string $projectRoot)
{ {
@ -32,6 +32,7 @@ final class GitDirtyTestCaseFilter implements TestCaseFilter
assert(is_array($this->changedFiles)); assert(is_array($this->changedFiles));
$relativePath = str_replace($this->projectRoot, '', $testCaseFilename); $relativePath = str_replace($this->projectRoot, '', $testCaseFilename);
$relativePath = str_replace(DIRECTORY_SEPARATOR, '/', $relativePath);
if (str_starts_with($relativePath, '/')) { if (str_starts_with($relativePath, '/')) {
$relativePath = substr($relativePath, 1); $relativePath = substr($relativePath, 1);
@ -58,13 +59,18 @@ final class GitDirtyTestCaseFilter implements TestCaseFilter
$dirtyFiles[substr($dirtyFile, 3)] = trim(substr($dirtyFile, 0, 3)); $dirtyFiles[substr($dirtyFile, 3)] = trim(substr($dirtyFile, 0, 3));
} }
$dirtyFiles = array_filter($dirtyFiles, fn ($status): bool => $status !== 'D'); $dirtyFiles = array_filter($dirtyFiles, fn (string $status): bool => $status !== 'D');
$dirtyFiles = array_map(fn ($file, $status): string => in_array($status, ['R', 'RM'], true) ? explode(' -> ', $file)[1] : $file, array_keys($dirtyFiles), $dirtyFiles); $dirtyFiles = array_map(
fn (string $file, string $status): string => in_array($status, ['R', 'RM'], true)
? explode(' -> ', $file)[1]
: $file, array_keys($dirtyFiles), $dirtyFiles,
);
$dirtyFiles = array_filter( $dirtyFiles = array_filter(
$dirtyFiles, $dirtyFiles,
fn ($file): bool => str_starts_with('.'.DIRECTORY_SEPARATOR.$file, TestSuite::getInstance()->testPath) || str_starts_with($file, TestSuite::getInstance()->testPath) fn (string $file): bool => str_starts_with('.'.DIRECTORY_SEPARATOR.$file, TestSuite::getInstance()->testPath)
|| str_starts_with($file, TestSuite::getInstance()->testPath)
); );
$dirtyFiles = array_values($dirtyFiles); $dirtyFiles = array_values($dirtyFiles);

View File

@ -9,6 +9,7 @@ use Pest\Repositories\AfterAllRepository;
use Pest\Repositories\AfterEachRepository; use Pest\Repositories\AfterEachRepository;
use Pest\Repositories\BeforeAllRepository; use Pest\Repositories\BeforeAllRepository;
use Pest\Repositories\BeforeEachRepository; use Pest\Repositories\BeforeEachRepository;
use Pest\Repositories\SnapshotRepository;
use Pest\Repositories\TestRepository; use Pest\Repositories\TestRepository;
use PHPUnit\Framework\TestCase; use PHPUnit\Framework\TestCase;
@ -47,6 +48,11 @@ final class TestSuite
*/ */
public AfterAllRepository $afterAll; public AfterAllRepository $afterAll;
/**
* Holds the snapshots repository.
*/
public SnapshotRepository $snapshots;
/** /**
* Holds the root path. * Holds the root path.
*/ */
@ -69,8 +75,11 @@ final class TestSuite
$this->tests = new TestRepository(); $this->tests = new TestRepository();
$this->afterEach = new AfterEachRepository(); $this->afterEach = new AfterEachRepository();
$this->afterAll = new AfterAllRepository(); $this->afterAll = new AfterAllRepository();
$this->rootPath = (string) realpath($rootPath); $this->rootPath = (string) realpath($rootPath);
$this->snapshots = new SnapshotRepository(
implode(DIRECTORY_SEPARATOR, [$this->rootPath, $this->testPath]),
implode(DIRECTORY_SEPARATOR, ['.pest', 'snapshots']),
);
} }
/** /**

View File

@ -0,0 +1,7 @@
<div class="container">
<div class="row">
<div class="col-md-12">
<h1>Snapshot</h1>
</div>
</div>
</div>

View File

@ -0,0 +1,7 @@
<div class="container">
<div class="row">
<div class="col-md-12">
<h1>Snapshot</h1>
</div>
</div>
</div>

View File

@ -0,0 +1,7 @@
<div class="container">
<div class="row">
<div class="col-md-12">
<h1>Snapshot</h1>
</div>
</div>
</div>

View File

@ -0,0 +1,7 @@
<div class="container">
<div class="row">
<div class="col-md-12">
<h1>Snapshot</h1>
</div>
</div>
</div>

View File

@ -0,0 +1,7 @@
<div class="container">
<div class="row">
<div class="col-md-12">
<h1>Snapshot</h1>
</div>
</div>
</div>

View File

@ -0,0 +1,7 @@
<div class="container">
<div class="row">
<div class="col-md-12">
<h1>Snapshot</h1>
</div>
</div>
</div>

View File

@ -0,0 +1,3 @@
{
"key": " <div class=\"container\">\n <div class=\"row\">\n <div class=\"col-md-12\">\n <h1>Snapshot<\/h1>\n <\/div>\n <\/div>\n <\/div>"
}

View File

@ -0,0 +1,7 @@
<div class="container">
<div class="row">
<div class="col-md-12">
<h1>Snapshot</h1>
</div>
</div>
</div>

View File

@ -0,0 +1,3 @@
{
"key": " <div class=\"container\">\n <div class=\"row\">\n <div class=\"col-md-12\">\n <h1>Snapshot<\/h1>\n <\/div>\n <\/div>\n <\/div>"
}

View File

@ -0,0 +1,7 @@
<div class="container">
<div class="row">
<div class="col-md-12">
<h1>Snapshot</h1>
</div>
</div>
</div>

View File

@ -0,0 +1,23 @@
FAIL Tests\Fixtures\CollisionTest
error
✓ success
────────────────────────────────────────────────────────────────────────────
FAILED Tests\Fixtures\CollisionTest > error Exception
error
at tests/Fixtures/CollisionTest.php:4
1▕ <?php
2▕
3▕ test('error', function () {
➜ 4▕ throw new Exception('error');
5▕ })->skip(! isset($_SERVER['COLLISION_TEST']));
6▕
7▕ test('success', function () {
8▕ expect(true)->toBeTrue();
9▕ })->skip(! isset($_SERVER['COLLISION_TEST']));
1 tests/Fixtures/CollisionTest.php:4
Tests: 1 failed, 1 passed (1 assertions)

Some files were not shown because too many files have changed in this diff Show More