File: CountTest.php

package info (click to toggle)
phpunit 12.3.5-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 50,160 kB
  • sloc: php: 101,772; xml: 2,084; makefile: 124; sh: 99
file content (218 lines) | stat: -rw-r--r-- 5,914 bytes parent folder | download | duplicates (3)
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
<?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\Framework\Constraint;

use ArrayIterator;
use ArrayObject;
use EmptyIterator;
use Generator;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Small;
use PHPUnit\Framework\Exception;
use PHPUnit\Framework\ExpectationFailedException;
use PHPUnit\Framework\GeneratorNotSupportedException;
use PHPUnit\Framework\TestCase;
use PHPUnit\TestFixture\ExceptionThrowingIteratorAggregate;
use PHPUnit\TestFixture\TestIterator;
use PHPUnit\TestFixture\TestIterator2;
use PHPUnit\TestFixture\TestIteratorAggregate;
use PHPUnit\TestFixture\TestIteratorAggregate2;

#[CoversClass(Count::class)]
#[CoversClass(Constraint::class)]
#[Small]
final class CountTest extends TestCase
{
    public static function provider(): array
    {
        return [
            [
                true,
                '',
                0,
                [],
            ],

            [
                true,
                '',
                1,
                ['value'],
            ],

            [
                true,
                '',
                0,
                new EmptyIterator,
            ],

            [
                true,
                '',
                5,
                new ArrayObject([1, 2, 3, 4, 5]),
            ],

            [
                true,
                '',
                1,
                new ArrayIterator(['value']),
            ],

            [
                true,
                '',
                2,
                new TestIterator(['value', 'value']),
            ],

            [
                true,
                '',
                2,
                new TestIteratorAggregate(new TestIterator(['value', 'value'])),
            ],

            [
                true,
                '',
                2,
                new TestIteratorAggregate2(new TestIteratorAggregate(new TestIterator(['value', 'value']))),
            ],

            [
                false,
                'Failed asserting that actual size 0 matches expected size 1.',
                1,
                1,
            ],
        ];
    }

    #[DataProvider('provider')]
    public function testCanBeEvaluated(bool $result, string $failureDescription, int $expected, mixed $actual): void
    {
        $constraint = new Count($expected);

        $this->assertSame($result, $constraint->evaluate($actual, returnResult: true));

        if ($result) {
            return;
        }

        $this->expectException(ExpectationFailedException::class);
        $this->expectExceptionMessage($failureDescription);

        $constraint->evaluate($actual);
    }

    public function testCanBeRepresentedAsString(): void
    {
        $this->assertSame('count matches 1', (new Count(1))->toString());
    }

    public function testIsCountable(): void
    {
        $this->assertCount(1, (new Count(1)));
    }

    public function testCountDoesNotChangeIteratorKey(): void
    {
        $countConstraint = new Count(2);

        // test with 1st implementation of Iterator
        $it = new TestIterator([1, 2]);

        $countConstraint->evaluate($it, returnResult: true);
        $this->assertSame(1, $it->current());

        $it->next();
        $countConstraint->evaluate($it, returnResult: true);
        $this->assertSame(2, $it->current());

        $it->next();
        $countConstraint->evaluate($it, returnResult: true);
        $this->assertFalse($it->valid());

        // test with 2nd implementation of Iterator
        $it = new TestIterator2([1, 2]);

        $countConstraint = new Count(2);
        $countConstraint->evaluate($it, returnResult: true);
        $this->assertSame(1, $it->current());

        $it->next();
        $countConstraint->evaluate($it, returnResult: true);
        $this->assertSame(2, $it->current());

        $it->next();
        $countConstraint->evaluate($it, returnResult: true);
        $this->assertFalse($it->valid());

        // test with IteratorAggregate
        $it = new TestIterator([1, 2]);
        $ia = new TestIteratorAggregate($it);

        $countConstraint = new Count(2);
        $countConstraint->evaluate($ia, returnResult: true);
        $this->assertSame(1, $it->current());

        $it->next();
        $countConstraint->evaluate($ia, returnResult: true);
        $this->assertSame(2, $it->current());

        $it->next();
        $countConstraint->evaluate($ia, returnResult: true);
        $this->assertFalse($it->valid());

        // test with nested IteratorAggregate
        $it  = new TestIterator([1, 2]);
        $ia  = new TestIteratorAggregate($it);
        $ia2 = new TestIteratorAggregate2($ia);

        $countConstraint = new Count(2);
        $countConstraint->evaluate($ia2, returnResult: true);
        $this->assertSame(1, $it->current());

        $it->next();
        $countConstraint->evaluate($ia2, returnResult: true);
        $this->assertSame(2, $it->current());

        $it->next();
        $countConstraint->evaluate($ia2, returnResult: true);
        $this->assertFalse($it->valid());
    }

    public function testDoesNotAcceptGenerators(): void
    {
        $constraint = new Count(0);

        $this->expectException(GeneratorNotSupportedException::class);

        $constraint->evaluate($this->generator());
    }

    public function testWrapsExceptionFromIteratorAggregate(): void
    {
        $constraint = new Count(0);

        $this->expectException(Exception::class);

        $constraint->evaluate(new ExceptionThrowingIteratorAggregate);
    }

    private function generator(): Generator
    {
        yield 1;
    }
}