xref: /webtrees/tests/app/Module/RelatedIndividualsReportModuleTest.php (revision 8d018ab2fe3b6881cab8124d97e1a69e0be79d32) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2023 webtrees development team
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <https://www.gnu.org/licenses/>.
16 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Module;
21
22use Fisharebest\Webtrees\Auth;
23use Fisharebest\Webtrees\Contracts\UserInterface;
24use Fisharebest\Webtrees\Report\HtmlRenderer;
25use Fisharebest\Webtrees\Report\PdfRenderer;
26use Fisharebest\Webtrees\Report\ReportParserGenerate;
27use Fisharebest\Webtrees\Report\ReportParserSetup;
28use Fisharebest\Webtrees\Services\ModuleService;
29use Fisharebest\Webtrees\Services\UserService;
30use Fisharebest\Webtrees\TestCase;
31
32/**
33 * Test harness for the class RelatedIndividualsReportModule
34 */
35class RelatedIndividualsReportModuleTest extends TestCase
36{
37    protected static bool $uses_database = true;
38
39    /**
40     * @covers \Fisharebest\Webtrees\Module\ModuleReportTrait
41     * @covers \Fisharebest\Webtrees\Module\PedigreeReportModule
42     * @covers \Fisharebest\Webtrees\Report\AbstractRenderer
43     * @covers \Fisharebest\Webtrees\Report\HtmlRenderer
44     * @covers \Fisharebest\Webtrees\Report\PdfRenderer
45     * @covers \Fisharebest\Webtrees\Report\ReportBaseCell
46     * @covers \Fisharebest\Webtrees\Report\ReportBaseElement
47     * @covers \Fisharebest\Webtrees\Report\ReportBaseFootnote
48     * @covers \Fisharebest\Webtrees\Report\ReportBaseImage
49     * @covers \Fisharebest\Webtrees\Report\ReportBaseLine
50     * @covers \Fisharebest\Webtrees\Report\ReportBaseText
51     * @covers \Fisharebest\Webtrees\Report\ReportBaseTextbox
52     * @covers \Fisharebest\Webtrees\Report\ReportExpressionLanguageProvider
53     * @covers \Fisharebest\Webtrees\Report\ReportHtmlCell
54     * @covers \Fisharebest\Webtrees\Report\ReportHtmlFootnote
55     * @covers \Fisharebest\Webtrees\Report\ReportHtmlImage
56     * @covers \Fisharebest\Webtrees\Report\ReportHtmlLine
57     * @covers \Fisharebest\Webtrees\Report\ReportHtmlText
58     * @covers \Fisharebest\Webtrees\Report\ReportHtmlTextbox
59     * @covers \Fisharebest\Webtrees\Report\ReportParserBase
60     * @covers \Fisharebest\Webtrees\Report\ReportParserGenerate
61     * @covers \Fisharebest\Webtrees\Report\ReportParserSetup
62     * @covers \Fisharebest\Webtrees\Report\ReportPdfCell
63     * @covers \Fisharebest\Webtrees\Report\ReportPdfFootnote
64     * @covers \Fisharebest\Webtrees\Report\ReportPdfImage
65     * @covers \Fisharebest\Webtrees\Report\ReportPdfLine
66     * @covers \Fisharebest\Webtrees\Report\ReportPdfText
67     * @covers \Fisharebest\Webtrees\Report\ReportPdfTextBox
68     * @covers \Fisharebest\Webtrees\Report\TcpdfWrapper
69     *
70     * @return void
71     */
72    public function testReportRunsWithoutError(): void
73    {
74        $module_service = new ModuleService();
75
76        $user = (new UserService())->create('user', 'User', 'user@example.com', 'secret');
77        $user->setPreference(UserInterface::PREF_IS_ADMINISTRATOR, '1');
78        Auth::login($user);
79
80        $tree   = $this->importTree('demo.ged');
81        $module = $module_service->findByInterface(RelatedIndividualsReportModule::class)->first();
82        $xml    = 'resources/' . $module->xmlFilename();
83        $vars   = [
84            'pid'       => ['id' => 'X1030'],
85            'relatives' => ['id' => 'child-family'],
86            'maxgen'    => ['id' => '4'],
87            'sortby'    => ['id' => 'BIRT:DATE'],
88            'sources'   => ['id' => 'on'],
89            'notes'     => ['id' => 'on'],
90            'photos'    => ['id' => 'all'],
91            'colors'    => ['id' => 'on'],
92            'pageSize'  => ['id' => 'A4'],
93        ];
94
95        $report = new ReportParserSetup($xml);
96        self::assertIsArray($report->reportProperties());
97
98        ob_start();
99        new ReportParserGenerate($xml, new HtmlRenderer(), $vars, $tree);
100        $html = ob_get_clean();
101        self::assertStringStartsWith('<', $html);
102        self::assertStringEndsWith('>', $html);
103
104        ob_start();
105        new ReportParserGenerate($xml, new PdfRenderer(), $vars, $tree);
106        $pdf = ob_get_clean();
107        self::assertStringStartsWith('%PDF', $pdf);
108        self::assertStringEndsWith("%%EOF\n", $pdf);
109    }
110}
111