HookTest.php 11.1 KB
Newer Older
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
<?php
declare(strict_types=1);
namespace TYPO3\CMS\Core\Tests\Functional\DataHandling\DataHandler;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

use TYPO3\CMS\Core\Tests\Functional\DataHandling\AbstractDataHandlerActionTestCase;
use TYPO3\CMS\Core\Tests\Functional\DataHandling\DataHandler\Fixtures\HookFixture;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Utility\StringUtility;

/**
 * Tests triggering hook execution in DataHandler.
 */
class HookTest extends AbstractDataHandlerActionTestCase
{
    const VALUE_PageId = 89;
    const VALUE_ContentId = 297;
    const TABLE_Content = 'tt_content';
    const TABLE_Hotel = 'tx_irretutorial_1nff_hotel';
    const TABLE_Category = 'sys_category';
    const FIELD_ContentHotel = 'tx_irretutorial_1nff_hotels';
    const FIELD_Categories = 'categories';

    /**
     * @var HookFixture
     */
    protected $hookFixture;

    /**
     * @var string
     */
    protected $scenarioDataSetDirectory = 'typo3/sysext/core/Tests/Functional/DataHandling/DataHandler/DataSet/';

    protected function setUp()
    {
        parent::setUp();
        $this->importScenarioDataSet('LiveDefaultPages');
        $this->importScenarioDataSet('LiveDefaultElements');
        $this->backendUser->workspace = 0;

        $this->hookFixture = GeneralUtility::makeInstance(HookFixture::class);
        $this->hookFixture->purge();
        $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['processDatamapClass'][__CLASS__] = HookFixture::class;
        $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['processCmdmapClass'][__CLASS__] = HookFixture::class;
    }

    protected function tearDown()
    {
        parent::tearDown();

        unset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['processDatamapClass'][__CLASS__]);
        unset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['processCmdmapClass'][__CLASS__]);
        unset($this->hookFixture);
    }

    /**
     * @test
     */
    public function hooksAreExecutedForNewRecords()
    {
        $newTableIds = $this->actionService->createNewRecord(
            self::TABLE_Content,
            self::VALUE_PageId,
            ['header' => 'Testing #1']
        );
        $this->recordIds['newContentId'] = $newTableIds[self::TABLE_Content][0];

        $this->assertHookInvocationsCount([
                'processDatamap_beforeStart',
                'processDatamap_afterAllOperations'
        ], 1);

        $this->assertHookInvocationsPayload([
            'processDatamap_preProcessFieldArray',
            'processDatamap_postProcessFieldArray',
            'processDatamap_afterDatabaseOperations',
        ], [
            [
                'table' => self::TABLE_Content,
                'fieldArray' => [ 'header' => 'Testing #1', 'pid' => self::VALUE_PageId ]
            ]
        ]);
    }

    /**
     * @test
     */
    public function hooksAreExecutedForExistingRecords()
    {
        $this->actionService->modifyRecord(
            self::TABLE_Content,
            self::VALUE_ContentId,
            ['header' => 'Testing #1']
        );

        $this->assertHookInvocationsCount([
            'processDatamap_beforeStart',
            'processDatamap_afterAllOperations'
        ], 1);

        $this->assertHookInvocationsPayload([
            'processDatamap_preProcessFieldArray',
            'processDatamap_postProcessFieldArray',
            'processDatamap_afterDatabaseOperations',
        ], [
            [
                'table' => self::TABLE_Content,
                'fieldArray' => [ 'header' => 'Testing #1' ]
            ]
        ]);
    }

    /**
     * @test
     */
    public function hooksAreExecutedForNewRelations()
    {
        $contentNewId = StringUtility::getUniqueId('NEW');
        $hotelNewId = StringUtility::getUniqueId('NEW');
        $categoryNewId = StringUtility::getUniqueId('NEW');

        $this->actionService->modifyRecords(
            self::VALUE_PageId,
            [
                self::TABLE_Content => [
                    'uid' => $contentNewId,
                    'header' => 'Testing #1',
                    self::FIELD_ContentHotel => $hotelNewId,
                    self::FIELD_Categories => $categoryNewId,
                ],
                self::TABLE_Hotel => [
                    'uid' => $hotelNewId,
                    'title' => 'Hotel #1',
                ],
                self::TABLE_Category => [
                    'uid' => $categoryNewId,
                    'title' => 'Category #1',
                ],
            ]
        );

        $this->assertHookInvocationsCount([
            'processDatamap_beforeStart',
            'processDatamap_afterAllOperations'
        ], 1);

        $this->assertHookInvocationPayload(
            'processDatamap_preProcessFieldArray',
            [
                [
                    'table' => self::TABLE_Content,
                    'fieldArray' => [
                        'header' => 'Testing #1',
                        self::FIELD_ContentHotel => $hotelNewId,
                        self::FIELD_Categories => $categoryNewId,
                    ],
                ],
                [
                    'table' => self::TABLE_Hotel,
                    'fieldArray' => [ 'title' => 'Hotel #1' ],
                ],
                [
                    'table' => self::TABLE_Category,
                    'fieldArray' => [ 'title' => 'Category #1' ],
                ],
            ]
        );

        $this->assertHookInvocationPayload(
            'processDatamap_postProcessFieldArray',
            [
                [
                    'table' => self::TABLE_Content,
                    'fieldArray' => [ 'header' => 'Testing #1' ],
                ],
                [
                    'table' => self::TABLE_Hotel,
                    'fieldArray' => [ 'title' => 'Hotel #1' ],
                ],
                [
                    'table' => self::TABLE_Category,
                    'fieldArray' => [ 'title' => 'Category #1' ],
                ],
            ]
        );

        $this->assertHookInvocationPayload(
            'processDatamap_afterDatabaseOperations',
            [
                [
                    'table' => self::TABLE_Content,
                    'fieldArray' => [
                        'header' => 'Testing #1',
                        self::FIELD_ContentHotel => 1,
                        self::FIELD_Categories => 1,
                    ],
                ],
                [
                    'table' => self::TABLE_Hotel,
                    'fieldArray' => [ 'title' => 'Hotel #1' ],
                ],
                [
                    'table' => self::TABLE_Category,
                    'fieldArray' => [ 'title' => 'Category #1' ],
                ],
            ]
        );
    }

    /**
     * @test
     */
    public function hooksAreExecutedForExistingRelations()
    {
        $this->actionService->modifyRecord(
            self::TABLE_Content,
            self::VALUE_ContentId,
            [
                'header' => 'Testing #1',
                self::FIELD_ContentHotel => '3,4,5',
                self::FIELD_Categories => '28,29,30',
            ]
        );

        $this->assertHookInvocationsCount([
            'processDatamap_beforeStart',
            'processDatamap_afterAllOperations'
        ], 1);

        $this->assertHookInvocationPayload(
            'processDatamap_preProcessFieldArray',
            [
                [
                    'table' => self::TABLE_Content,
                    'fieldArray' => [
                        'header' => 'Testing #1',
                        self::FIELD_ContentHotel => '3,4,5',
                        self::FIELD_Categories => '28,29,30',
                    ]
                ]
            ]
        );

        $this->assertHookInvocationsPayload([
            'processDatamap_postProcessFieldArray',
            'processDatamap_afterDatabaseOperations',
        ], [
            [
                'table' => self::TABLE_Content,
                'fieldArray' => [
                    'header' => 'Testing #1',
                    self::FIELD_ContentHotel => 3,
                    self::FIELD_Categories => 3,
                ]
            ]
        ]);
    }

    /**
     * @param string[] $methodNames
     * @param int $count
     */
    protected function assertHookInvocationsCount(array $methodNames, int $count)
    {
        $message = 'Unexpected invocations of method "%s"';
        foreach ($methodNames as $methodName) {
            $invocations = $this->hookFixture->findInvocationsByMethodName($methodName);
            $this->assertCount(
                $count,
                $invocations,
                sprintf($message, $methodName)
            );
        }
    }

    /**
     * @param string[] $methodNames
     * @param array $assertions
     */
    protected function assertHookInvocationsPayload(array $methodNames, array $assertions)
    {
        foreach ($methodNames as $methodName) {
            $this->assertHookInvocationPayload($methodName, $assertions);
        }
    }

    /**
     * @param string $methodName
     * @param array $assertions
     */
    protected function assertHookInvocationPayload(string $methodName, array $assertions)
    {
        $message = 'Unexpected hook payload amount found for method "%s"';
        $invocations = $this->hookFixture->findInvocationsByMethodName($methodName);
        $this->assertNotNull($invocations);

        foreach ($assertions as $assertion) {
            $indexes = $this->findAllArrayValuesInHaystack($invocations, $assertion);
            $this->assertCount(
                1,
                $indexes,
                sprintf($message, $methodName)
            );
            $index = $indexes[0];
            unset($invocations[$index]);
        }
    }

    /**
     * @param array $haystack
     * @param array $assertion
     * @return int[]
     */
    protected function findAllArrayValuesInHaystack(array $haystack, array $assertion)
    {
        $found = [];
        foreach ($haystack as $index => $item) {
            if ($this->equals($assertion, $item)) {
                $found[] = $index;
            }
        }
        return $found;
    }

    /**
     * @param array $left
     * @param array $right
     * @return bool
     */
    protected function equals(array $left, array $right)
    {
        foreach ($left as $key => $leftValue) {
            $rightValue = $right[$key] ?? null;
            if (!is_array($leftValue) && (string)$leftValue !== (string)$rightValue) {
                return false;
348
349
            }
            if (is_array($leftValue)) {
350
351
352
353
354
355
356
357
                if (!$this->equals($leftValue, $rightValue)) {
                    return false;
                }
            }
        }
        return true;
    }
}