forked from sebastianbergmann/phpunit
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathMetadata.php
More file actions
826 lines (716 loc) · 20.9 KB
/
Copy pathMetadata.php
File metadata and controls
826 lines (716 loc) · 20.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
<?php declare(strict_types=1);
/*
* This file is part of PHPUnit.
*
* (c) Sebastian Bergmann <[email protected]>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Metadata;
use PHPUnit\Metadata\Version\Requirement;
use PHPUnit\Runner\Extension\Extension;
/**
* @immutable
*
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
abstract readonly class Metadata
{
private const CLASS_LEVEL = 0;
private const METHOD_LEVEL = 1;
/**
* @var 0|1
*/
private int $level;
/**
* @param non-negative-int $priority
*/
public static function after(int $priority): After
{
return new After(self::METHOD_LEVEL, $priority);
}
/**
* @param non-negative-int $priority
*/
public static function afterClass(int $priority): AfterClass
{
return new AfterClass(self::METHOD_LEVEL, $priority);
}
public static function backupGlobalsOnClass(bool $enabled): BackupGlobals
{
return new BackupGlobals(self::CLASS_LEVEL, $enabled);
}
public static function backupGlobalsOnMethod(bool $enabled): BackupGlobals
{
return new BackupGlobals(self::METHOD_LEVEL, $enabled);
}
public static function backupStaticPropertiesOnClass(bool $enabled): BackupStaticProperties
{
return new BackupStaticProperties(self::CLASS_LEVEL, $enabled);
}
public static function backupStaticPropertiesOnMethod(bool $enabled): BackupStaticProperties
{
return new BackupStaticProperties(self::METHOD_LEVEL, $enabled);
}
/**
* @param non-negative-int $priority
*/
public static function before(int $priority): Before
{
return new Before(self::METHOD_LEVEL, $priority);
}
/**
* @param non-negative-int $priority
*/
public static function beforeClass(int $priority): BeforeClass
{
return new BeforeClass(self::METHOD_LEVEL, $priority);
}
/**
* @param class-string $className
*/
public static function coversClass(string $className): CoversClass
{
return new CoversClass(self::CLASS_LEVEL, $className);
}
/**
* @param class-string $className
* @param non-empty-string $methodName
*/
public static function coversMethod(string $className, string $methodName): CoversMethod
{
return new CoversMethod(self::CLASS_LEVEL, $className, $methodName);
}
/**
* @param non-empty-string $functionName
*/
public static function coversFunction(string $functionName): CoversFunction
{
return new CoversFunction(self::CLASS_LEVEL, $functionName);
}
public static function coversNothingOnClass(): CoversNothing
{
return new CoversNothing(self::CLASS_LEVEL);
}
public static function coversNothingOnMethod(): CoversNothing
{
return new CoversNothing(self::METHOD_LEVEL);
}
/**
* @param class-string $className
* @param non-empty-string $methodName
*/
public static function dataProvider(string $className, string $methodName): DataProvider
{
return new DataProvider(self::METHOD_LEVEL, $className, $methodName);
}
/**
* @param class-string $className
*/
public static function dependsOnClass(string $className, bool $deepClone, bool $shallowClone): DependsOnClass
{
return new DependsOnClass(self::METHOD_LEVEL, $className, $deepClone, $shallowClone);
}
/**
* @param class-string $className
* @param non-empty-string $methodName
*/
public static function dependsOnMethod(string $className, string $methodName, bool $deepClone, bool $shallowClone): DependsOnMethod
{
return new DependsOnMethod(self::METHOD_LEVEL, $className, $methodName, $deepClone, $shallowClone);
}
public static function disableReturnValueGenerationForTestDoubles(): DisableReturnValueGenerationForTestDoubles
{
return new DisableReturnValueGenerationForTestDoubles(self::CLASS_LEVEL);
}
public static function doesNotPerformAssertionsOnClass(): DoesNotPerformAssertions
{
return new DoesNotPerformAssertions(self::CLASS_LEVEL);
}
public static function doesNotPerformAssertionsOnMethod(): DoesNotPerformAssertions
{
return new DoesNotPerformAssertions(self::METHOD_LEVEL);
}
/**
* @param non-empty-string $globalVariableName
*/
public static function excludeGlobalVariableFromBackupOnClass(string $globalVariableName): ExcludeGlobalVariableFromBackup
{
return new ExcludeGlobalVariableFromBackup(self::CLASS_LEVEL, $globalVariableName);
}
/**
* @param non-empty-string $globalVariableName
*/
public static function excludeGlobalVariableFromBackupOnMethod(string $globalVariableName): ExcludeGlobalVariableFromBackup
{
return new ExcludeGlobalVariableFromBackup(self::METHOD_LEVEL, $globalVariableName);
}
/**
* @param class-string $className
* @param non-empty-string $propertyName
*/
public static function excludeStaticPropertyFromBackupOnClass(string $className, string $propertyName): ExcludeStaticPropertyFromBackup
{
return new ExcludeStaticPropertyFromBackup(self::CLASS_LEVEL, $className, $propertyName);
}
/**
* @param class-string $className
* @param non-empty-string $propertyName
*/
public static function excludeStaticPropertyFromBackupOnMethod(string $className, string $propertyName): ExcludeStaticPropertyFromBackup
{
return new ExcludeStaticPropertyFromBackup(self::METHOD_LEVEL, $className, $propertyName);
}
/**
* @param non-empty-string $groupName
*/
public static function groupOnClass(string $groupName): Group
{
return new Group(self::CLASS_LEVEL, $groupName);
}
/**
* @param non-empty-string $groupName
*/
public static function groupOnMethod(string $groupName): Group
{
return new Group(self::METHOD_LEVEL, $groupName);
}
public static function ignoreDeprecationsOnClass(): IgnoreDeprecations
{
return new IgnoreDeprecations(self::CLASS_LEVEL);
}
public static function ignoreDeprecationsOnMethod(): IgnoreDeprecations
{
return new IgnoreDeprecations(self::METHOD_LEVEL);
}
/**
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public static function ignorePhpunitDeprecationsOnClass(): IgnorePhpunitDeprecations
{
return new IgnorePhpunitDeprecations(self::CLASS_LEVEL);
}
/**
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public static function ignorePhpunitDeprecationsOnMethod(): IgnorePhpunitDeprecations
{
return new IgnorePhpunitDeprecations(self::METHOD_LEVEL);
}
/**
* @param non-negative-int $priority
*/
public static function postCondition(int $priority): PostCondition
{
return new PostCondition(self::METHOD_LEVEL, $priority);
}
/**
* @param non-negative-int $priority
*/
public static function preCondition(int $priority): PreCondition
{
return new PreCondition(self::METHOD_LEVEL, $priority);
}
public static function preserveGlobalStateOnClass(bool $enabled): PreserveGlobalState
{
return new PreserveGlobalState(self::CLASS_LEVEL, $enabled);
}
public static function preserveGlobalStateOnMethod(bool $enabled): PreserveGlobalState
{
return new PreserveGlobalState(self::METHOD_LEVEL, $enabled);
}
/**
* @param non-empty-string $functionName
*/
public static function requiresFunctionOnClass(string $functionName): RequiresFunction
{
return new RequiresFunction(self::CLASS_LEVEL, $functionName);
}
/**
* @param non-empty-string $functionName
*/
public static function requiresFunctionOnMethod(string $functionName): RequiresFunction
{
return new RequiresFunction(self::METHOD_LEVEL, $functionName);
}
/**
* @param class-string $className
* @param non-empty-string $methodName
*/
public static function requiresMethodOnClass(string $className, string $methodName): RequiresMethod
{
return new RequiresMethod(self::CLASS_LEVEL, $className, $methodName);
}
/**
* @param class-string $className
* @param non-empty-string $methodName
*/
public static function requiresMethodOnMethod(string $className, string $methodName): RequiresMethod
{
return new RequiresMethod(self::METHOD_LEVEL, $className, $methodName);
}
/**
* @param non-empty-string $operatingSystem
*/
public static function requiresOperatingSystemOnClass(string $operatingSystem): RequiresOperatingSystem
{
return new RequiresOperatingSystem(self::CLASS_LEVEL, $operatingSystem);
}
/**
* @param non-empty-string $operatingSystem
*/
public static function requiresOperatingSystemOnMethod(string $operatingSystem): RequiresOperatingSystem
{
return new RequiresOperatingSystem(self::METHOD_LEVEL, $operatingSystem);
}
/**
* @param non-empty-string $operatingSystemFamily
*/
public static function requiresOperatingSystemFamilyOnClass(string $operatingSystemFamily): RequiresOperatingSystemFamily
{
return new RequiresOperatingSystemFamily(self::CLASS_LEVEL, $operatingSystemFamily);
}
/**
* @param non-empty-string $operatingSystemFamily
*/
public static function requiresOperatingSystemFamilyOnMethod(string $operatingSystemFamily): RequiresOperatingSystemFamily
{
return new RequiresOperatingSystemFamily(self::METHOD_LEVEL, $operatingSystemFamily);
}
public static function requiresPhpOnClass(Requirement $versionRequirement): RequiresPhp
{
return new RequiresPhp(self::CLASS_LEVEL, $versionRequirement);
}
public static function requiresPhpOnMethod(Requirement $versionRequirement): RequiresPhp
{
return new RequiresPhp(self::METHOD_LEVEL, $versionRequirement);
}
/**
* @param non-empty-string $extension
*/
public static function requiresPhpExtensionOnClass(string $extension, ?Requirement $versionRequirement): RequiresPhpExtension
{
return new RequiresPhpExtension(self::CLASS_LEVEL, $extension, $versionRequirement);
}
/**
* @param non-empty-string $extension
*/
public static function requiresPhpExtensionOnMethod(string $extension, ?Requirement $versionRequirement): RequiresPhpExtension
{
return new RequiresPhpExtension(self::METHOD_LEVEL, $extension, $versionRequirement);
}
public static function requiresPhpunitOnClass(Requirement $versionRequirement): RequiresPhpunit
{
return new RequiresPhpunit(self::CLASS_LEVEL, $versionRequirement);
}
public static function requiresPhpunitOnMethod(Requirement $versionRequirement): RequiresPhpunit
{
return new RequiresPhpunit(self::METHOD_LEVEL, $versionRequirement);
}
/**
* @param class-string<Extension> $extensionClass
*/
public static function requiresPhpunitExtensionOnClass(string $extensionClass): RequiresPhpunitExtension
{
return new RequiresPhpunitExtension(self::CLASS_LEVEL, $extensionClass);
}
/**
* @param class-string<Extension> $extensionClass
*/
public static function requiresPhpunitExtensionOnMethod(string $extensionClass): RequiresPhpunitExtension
{
return new RequiresPhpunitExtension(self::METHOD_LEVEL, $extensionClass);
}
/**
* @param non-empty-string $setting
* @param non-empty-string $value
*/
public static function requiresSettingOnClass(string $setting, string $value): RequiresSetting
{
return new RequiresSetting(self::CLASS_LEVEL, $setting, $value);
}
/**
* @param non-empty-string $setting
* @param non-empty-string $value
*/
public static function requiresSettingOnMethod(string $setting, string $value): RequiresSetting
{
return new RequiresSetting(self::METHOD_LEVEL, $setting, $value);
}
public static function runClassInSeparateProcess(): RunClassInSeparateProcess
{
return new RunClassInSeparateProcess(self::CLASS_LEVEL);
}
public static function runTestsInSeparateProcesses(): RunTestsInSeparateProcesses
{
return new RunTestsInSeparateProcesses(self::CLASS_LEVEL);
}
public static function runInSeparateProcess(): RunInSeparateProcess
{
return new RunInSeparateProcess(self::METHOD_LEVEL);
}
public static function test(): Test
{
return new Test(self::METHOD_LEVEL);
}
/**
* @param non-empty-string $text
*/
public static function testDoxOnClass(string $text): TestDox
{
return new TestDox(self::CLASS_LEVEL, $text);
}
/**
* @param non-empty-string $text
*/
public static function testDoxOnMethod(string $text): TestDox
{
return new TestDox(self::METHOD_LEVEL, $text);
}
/**
* @param array<array<mixed>> $data
* @param ?non-empty-string $name
*/
public static function testWith(array $data, ?string $name = null): TestWith
{
return new TestWith(self::METHOD_LEVEL, $data, $name);
}
/**
* @param class-string $className
*/
public static function usesClass(string $className): UsesClass
{
return new UsesClass(self::CLASS_LEVEL, $className);
}
/**
* @param non-empty-string $functionName
*/
public static function usesFunction(string $functionName): UsesFunction
{
return new UsesFunction(self::CLASS_LEVEL, $functionName);
}
/**
* @param class-string $className
* @param non-empty-string $methodName
*/
public static function usesMethod(string $className, string $methodName): UsesMethod
{
return new UsesMethod(self::CLASS_LEVEL, $className, $methodName);
}
public static function withoutErrorHandler(): WithoutErrorHandler
{
return new WithoutErrorHandler(self::METHOD_LEVEL);
}
/**
* @param 0|1 $level
*/
protected function __construct(int $level)
{
$this->level = $level;
}
public function isClassLevel(): bool
{
return $this->level === self::CLASS_LEVEL;
}
public function isMethodLevel(): bool
{
return $this->level === self::METHOD_LEVEL;
}
/**
* @phpstan-assert-if-true After $this
*/
public function isAfter(): bool
{
return false;
}
/**
* @phpstan-assert-if-true AfterClass $this
*/
public function isAfterClass(): bool
{
return false;
}
/**
* @phpstan-assert-if-true BackupGlobals $this
*/
public function isBackupGlobals(): bool
{
return false;
}
/**
* @phpstan-assert-if-true BackupStaticProperties $this
*/
public function isBackupStaticProperties(): bool
{
return false;
}
/**
* @phpstan-assert-if-true BeforeClass $this
*/
public function isBeforeClass(): bool
{
return false;
}
/**
* @phpstan-assert-if-true Before $this
*/
public function isBefore(): bool
{
return false;
}
/**
* @phpstan-assert-if-true CoversClass $this
*/
public function isCoversClass(): bool
{
return false;
}
/**
* @phpstan-assert-if-true CoversFunction $this
*/
public function isCoversFunction(): bool
{
return false;
}
/**
* @phpstan-assert-if-true CoversMethod $this
*/
public function isCoversMethod(): bool
{
return false;
}
/**
* @phpstan-assert-if-true CoversNothing $this
*/
public function isCoversNothing(): bool
{
return false;
}
/**
* @phpstan-assert-if-true DataProvider $this
*/
public function isDataProvider(): bool
{
return false;
}
/**
* @phpstan-assert-if-true DependsOnClass $this
*/
public function isDependsOnClass(): bool
{
return false;
}
/**
* @phpstan-assert-if-true DependsOnMethod $this
*/
public function isDependsOnMethod(): bool
{
return false;
}
/**
* @phpstan-assert-if-true DisableReturnValueGenerationForTestDoubles $this
*/
public function isDisableReturnValueGenerationForTestDoubles(): bool
{
return false;
}
/**
* @phpstan-assert-if-true DoesNotPerformAssertions $this
*/
public function isDoesNotPerformAssertions(): bool
{
return false;
}
/**
* @phpstan-assert-if-true ExcludeGlobalVariableFromBackup $this
*/
public function isExcludeGlobalVariableFromBackup(): bool
{
return false;
}
/**
* @phpstan-assert-if-true ExcludeStaticPropertyFromBackup $this
*/
public function isExcludeStaticPropertyFromBackup(): bool
{
return false;
}
/**
* @phpstan-assert-if-true Group $this
*/
public function isGroup(): bool
{
return false;
}
/**
* @phpstan-assert-if-true IgnoreDeprecations $this
*/
public function isIgnoreDeprecations(): bool
{
return false;
}
/**
* @phpstan-assert-if-true IgnorePhpunitDeprecations $this
*
* @internal This method is not covered by the backward compatibility promise for PHPUnit
*/
public function isIgnorePhpunitDeprecations(): bool
{
return false;
}
/**
* @phpstan-assert-if-true RunClassInSeparateProcess $this
*/
public function isRunClassInSeparateProcess(): bool
{
return false;
}
/**
* @phpstan-assert-if-true RunInSeparateProcess $this
*/
public function isRunInSeparateProcess(): bool
{
return false;
}
/**
* @phpstan-assert-if-true RunTestsInSeparateProcesses $this
*/
public function isRunTestsInSeparateProcesses(): bool
{
return false;
}
/**
* @phpstan-assert-if-true Test $this
*/
public function isTest(): bool
{
return false;
}
/**
* @phpstan-assert-if-true PreCondition $this
*/
public function isPreCondition(): bool
{
return false;
}
/**
* @phpstan-assert-if-true PostCondition $this
*/
public function isPostCondition(): bool
{
return false;
}
/**
* @phpstan-assert-if-true PreserveGlobalState $this
*/
public function isPreserveGlobalState(): bool
{
return false;
}
/**
* @phpstan-assert-if-true RequiresMethod $this
*/
public function isRequiresMethod(): bool
{
return false;
}
/**
* @phpstan-assert-if-true RequiresFunction $this
*/
public function isRequiresFunction(): bool
{
return false;
}
/**
* @phpstan-assert-if-true RequiresOperatingSystem $this
*/
public function isRequiresOperatingSystem(): bool
{
return false;
}
/**
* @phpstan-assert-if-true RequiresOperatingSystemFamily $this
*/
public function isRequiresOperatingSystemFamily(): bool
{
return false;
}
/**
* @phpstan-assert-if-true RequiresPhp $this
*/
public function isRequiresPhp(): bool
{
return false;
}
/**
* @phpstan-assert-if-true RequiresPhpExtension $this
*/
public function isRequiresPhpExtension(): bool
{
return false;
}
/**
* @phpstan-assert-if-true RequiresPhpunit $this
*/
public function isRequiresPhpunit(): bool
{
return false;
}
/**
* @phpstan-assert-if-true RequiresPhpunitExtension $this
*/
public function isRequiresPhpunitExtension(): bool
{
return false;
}
/**
* @phpstan-assert-if-true RequiresSetting $this
*/
public function isRequiresSetting(): bool
{
return false;
}
/**
* @phpstan-assert-if-true TestDox $this
*/
public function isTestDox(): bool
{
return false;
}
/**
* @phpstan-assert-if-true TestWith $this
*/
public function isTestWith(): bool
{
return false;
}
/**
* @phpstan-assert-if-true UsesClass $this
*/
public function isUsesClass(): bool
{
return false;
}
/**
* @phpstan-assert-if-true UsesFunction $this
*/
public function isUsesFunction(): bool
{
return false;
}
/**
* @phpstan-assert-if-true UsesMethod $this
*/
public function isUsesMethod(): bool
{
return false;
}
/**
* @phpstan-assert-if-true WithoutErrorHandler $this
*/
public function isWithoutErrorHandler(): bool
{
return false;
}
}