behat-tableassert/src/AssertTable.php at c591b2da70b6ee93e024f9f8a4941cfb5b654449 · mharmuth/behat-tableassert · GitHub

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
<?php
/**
 * @author    Andrew Coulton <andrew@ingenerator.com>
 * @licence   BSD-3-Clause
 */

namespace Ingenerator\BehatTableAssert;


use Behat\Gherkin\Node\TableNode;
use Ingenerator\BehatTableAssert\TableDiffer\DiffFormatter;
use Ingenerator\BehatTableAssert\TableDiffer\TableDiffer;

/**
 * Perform assertions on a pair of tables
 *
 * @package Ingenerator\BehatTableAssert
 */
class AssertTable
{

    /**
     * @var \Ingenerator\BehatTableAssert\TableDiffer\TableDiffer
     */
    protected $differ;

    /**
     * @var \Ingenerator\BehatTableAssert\TableDiffer\DiffFormatter
     */
    protected $formatter;

    /**
     * @param \Ingenerator\BehatTableAssert\TableDiffer\TableDiffer|null   $differ
     * @param \Ingenerator\BehatTableAssert\TableDiffer\DiffFormatter|null $formatter
     */
    public function __construct(?TableDiffer $differ = NULL, ?DiffFormatter $formatter = NULL)
    {
        $this->differ    = $differ ?: new TableDiffer;
        $this->formatter = $formatter ?: new DiffFormatter;
    }

    /**
     * Assert that two tables are identical, with the same columns in the same sequence
     *
     * @param \Behat\Gherkin\Node\TableNode $expected
     * @param \Behat\Gherkin\Node\TableNode $actual
     * @param string                        $message
     *
     * @throws \Ingenerator\BehatTableAssert\TableAssertionFailureException
     * @return void
     */
    public function isSame(TableNode $expected, TableNode $actual, $message = NULL)
    {
        $this->doAssert(
            'Failed asserting that two tables were identical: ',
            [],
            $expected,
            $actual,
            $message
        );
    }

    /**
     * @param string                        $message_prefix
     * @param array                         $diff_options
     * @param \Behat\Gherkin\Node\TableNode $expected
     * @param \Behat\Gherkin\Node\TableNode $actual
     * @param string                        $message
     */
    protected function doAssert(
        $message_prefix,
        $diff_options,
        TableNode $expected,
        TableNode $actual,
        $message
    ) {
        $diff = $this->differ->diff($expected, $actual, $diff_options);
        if ($diff['different']) {
            throw new TableAssertionFailureException(
                $message_prefix.$message,
                $diff,
                $this->formatter->format($diff, $actual)
            );
        }
    }

    /**
     * Assert that two tables are equivalent ignoring column sequence
     *
     * @param \Behat\Gherkin\Node\TableNode $expected
     * @param \Behat\Gherkin\Node\TableNode $actual
     * @param string                        $message
     *
     * @throws \Ingenerator\BehatTableAssert\TableAssertionFailureException
     * @return void
     */
    public function isEqual(TableNode $expected, TableNode $actual, $message = NULL)
    {
        $this->doAssert(
            'Failed asserting that two tables were equivalent: ',
            ['ignoreColumnSequence' => TRUE],
            $expected,
            $actual,
            $message
        );
    }

    /**
     * Assert that a table contains correct values in the provided columns, ignoring any extra columns
     *
     * @param \Behat\Gherkin\Node\TableNode $expected
     * @param \Behat\Gherkin\Node\TableNode $actual
     * @param string                        $message
     *
     * @throws \Ingenerator\BehatTableAssert\TableAssertionFailureException
     * @return void
     */
    public function containsColumns(TableNode $expected, TableNode $actual, $message = NULL)
    {
        $this->doAssert(
            'Failed asserting that a table contained expected data: ',
            ['ignoreColumnSequence' => TRUE, 'ignoreExtraColumns' => TRUE],
            $expected,
            $actual,
            $message
        );

    }

    /**
     * Assert any custom comparison between two tables. Provide an array of comparator functions to
     * support custom comparisons between cell values. The callback should return true if the two
     * values match and false otherwise.
     *
     *   $tableassert->isComparable(
     *     $expected_table,
     *     $actual_table,
     *     [
     *       'comparators' => [
     *         'date' => function ($expected, $actual) { return new \DateTime($expected) === new \DateTime($actual); },
     *       ]
     *     ],
     *     'Should have same stuff',
     *   );
     *
     * @param \Behat\Gherkin\Node\TableNode $expected
     * @param \Behat\Gherkin\Node\TableNode $actual
     * @param array                         $diff_options
     * @param string                        $message
     *
     * @throws \Ingenerator\BehatTableAssert\TableAssertionFailureException
     * @return void
     */
    public function isComparable(
        TableNode $expected,
        TableNode $actual,
        array $diff_options,
        $message = NULL
    ) {
        $this->doAssert(
            'Failed comparing two tables: ',
            $diff_options,
            $expected,
            $actual,
            $message
        );
    }
}