summaryrefslogtreecommitdiff
path: root/tests/views/AbstractViewTest.php
blob: c8ec5979328adb0a563c6b7d55fc679ed3032ad5 (plain)
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
<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2023 webtrees development team
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace Fisharebest\Webtrees;

use DOMDocument;

use function str_starts_with;

use const LIBXML_PEDANTIC;

/**
 * Common functions for testing views
 */
abstract class AbstractViewTest extends TestCase
{
    protected const EVIL_VALUE = '<script>evil()</script>';

    /**
     * Check the view runs without error and generates valid HTML
     *
     * @param string $view
     * @param array<array<string,array<string,mixed>>>  $data
     */
    protected function doTestView(string $view, array $data): void
    {
        foreach ($this->cartesian($data) as $datum) {
            $html = view($view, $datum);

            $this->validateHTML($html);
        }
    }

    /**
     * @param array<string,array<string,mixed>> $input
     *
     * @return array<array<string,array<string,mixed>>>
     */
    private function cartesian(array $input): array
    {
        $result = [[]];

        foreach ($input as $key => $values) {
            $append = [];

            foreach ($result as $product) {
                foreach ($values as $item) {
                    $product[$key] = $item;
                    $append[]      = $product;
                }
            }

            $result = $append;
        }

        return $result;
    }

    /**
     * @param string $html
     */
    protected function validateHTML(string $html): void
    {
        if (str_starts_with($html, '<!DOCTYPE html>')) {
            $xml = $html;
        } else {
            $xml = '<!DOCTYPE html><html lang="en"><body>' . $html . '</body></html>';
        }

        $doc = new DOMDocument();
        $doc->validateOnParse = true;

        self::assertTrue($doc->loadXML($xml, LIBXML_PEDANTIC), $html);
    }
}