File: ArraysAreEqualTest.php

package info (click to toggle)
phpunit 13.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 52,072 kB
  • sloc: php: 106,613; xml: 2,216; makefile: 116; sh: 88
file content (188 lines) | stat: -rw-r--r-- 6,010 bytes parent folder | download | duplicates (2)
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
<?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 PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Group;
use PHPUnit\Framework\Attributes\Small;
use PHPUnit\Framework\ExpectationFailedException;
use PHPUnit\Framework\TestCase;

#[CoversClass(ArraysAreEqual::class)]
#[CoversClass(Constraint::class)]
#[Small]
#[Group('framework')]
#[Group('framework/constraints')]
final class ArraysAreEqualTest extends TestCase
{
    public static function provider(): array
    {
        return [
            'empty arrays, keys and order matter' => [
                true,
                '',
                [],
                [],
                true,
                true,
            ],
            'identical arrays, keys and order matter' => [
                true,
                '',
                ['a' => 1, 'b' => 2],
                ['a' => 1, 'b' => 2],
                true,
                true,
            ],
            'equal arrays with type coercion, keys and order matter' => [
                true,
                '',
                ['a' => 1, 'b' => '2'],
                ['a' => '1', 'b' => 2],
                true,
                true,
            ],
            'numeric indexed arrays, keys and order matter' => [
                true,
                '',
                [1, 2, 3],
                [1, 2, 3],
                true,
                true,
            ],
            'same key-value pairs different order, keys matter, order does not matter' => [
                true,
                '',
                ['a' => 1, 'b' => 2],
                ['b' => 2, 'a' => 1],
                true,
                false,
            ],
            'empty arrays, keys matter, order does not matter' => [
                true,
                '',
                [],
                [],
                true,
                false,
            ],
            'same values different keys, keys do not matter, order matters' => [
                true,
                '',
                ['a' => 1, 'b' => 2],
                ['x' => 1, 'y' => 2],
                false,
                true,
            ],
            'numeric arrays same values, keys do not matter, order matters' => [
                true,
                '',
                [1, 2, 3],
                [1, 2, 3],
                false,
                true,
            ],
            'different order and keys, neither keys nor order matter' => [
                true,
                '',
                ['a' => 1, 'b' => 2, 'c' => 3],
                ['z' => 3, 'y' => 1, 'x' => 2],
                false,
                false,
            ],
            'empty arrays, neither keys nor order matter' => [
                true,
                '',
                [],
                [],
                false,
                false,
            ],
            'different values, keys and order matter' => [
                false,
                'Failed asserting that two arrays are equal',
                ['a' => 1, 'b' => 2],
                ['a' => 1, 'b' => 3],
                true,
                true,
            ],
            'different number of elements' => [
                false,
                'Failed asserting that two arrays are equal',
                [1, 2, 3],
                [1, 2],
                true,
                true,
            ],
            'different order when order matters' => [
                false,
                'Failed asserting that two arrays are equal',
                [1, 2, 3],
                [3, 2, 1],
                true,
                true,
            ],
            'different keys when keys matter' => [
                false,
                'Failed asserting that two arrays are equal while ignoring order',
                ['a' => 1, 'b' => 2],
                ['x' => 1, 'y' => 2],
                true,
                false,
            ],
            'different order when only order matters' => [
                false,
                'Failed asserting that two arrays are equal while ignoring keys',
                [1, 2, 3],
                [3, 2, 1],
                false,
                true,
            ],
        ];
    }

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

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

        if ($result) {
            return;
        }

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

        $constraint->evaluate($actual);
    }

    public function testRejectActualThatIsNotAnArray(): void
    {
        $constraint = new ArraysAreEqual([], false, false);

        $this->assertFalse($constraint->evaluate('string', returnResult: true));
    }

    public function testCanBeRepresentedAsString(): void
    {
        $this->assertSame('two arrays are equal while ignoring keys and order', new ArraysAreEqual([], false, false)->toString());
        $this->assertSame('two arrays are equal while ignoring order', new ArraysAreEqual([], true, false)->toString());
        $this->assertSame('two arrays are equal while ignoring keys', new ArraysAreEqual([], false, true)->toString());
        $this->assertSame('two arrays are equal', new ArraysAreEqual([], true, true)->toString());
    }

    public function testIsCountable(): void
    {
        $this->assertCount(1, new ArraysAreEqual([], false, false));
    }
}