xref: /webtrees/tests/app/Module/RelatedIndividualsReportModuleTest.php (revision 168400f22362127abf035db7b1fd5277b3e460d8)

<?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\Module;

use Fisharebest\Webtrees\Auth;
use Fisharebest\Webtrees\Contracts\UserInterface;
use Fisharebest\Webtrees\Report\AbstractRenderer;
use Fisharebest\Webtrees\Report\HtmlRenderer;
use Fisharebest\Webtrees\Report\PdfRenderer;
use Fisharebest\Webtrees\Report\ReportBaseCell;
use Fisharebest\Webtrees\Report\ReportBaseElement;
use Fisharebest\Webtrees\Report\ReportBaseFootnote;
use Fisharebest\Webtrees\Report\ReportBaseImage;
use Fisharebest\Webtrees\Report\ReportBaseLine;
use Fisharebest\Webtrees\Report\ReportBaseText;
use Fisharebest\Webtrees\Report\ReportBaseTextbox;
use Fisharebest\Webtrees\Report\ReportExpressionLanguageProvider;
use Fisharebest\Webtrees\Report\ReportHtmlCell;
use Fisharebest\Webtrees\Report\ReportHtmlFootnote;
use Fisharebest\Webtrees\Report\ReportHtmlImage;
use Fisharebest\Webtrees\Report\ReportHtmlLine;
use Fisharebest\Webtrees\Report\ReportHtmlText;
use Fisharebest\Webtrees\Report\ReportHtmlTextbox;
use Fisharebest\Webtrees\Report\ReportParserBase;
use Fisharebest\Webtrees\Report\ReportParserGenerate;
use Fisharebest\Webtrees\Report\ReportParserSetup;
use Fisharebest\Webtrees\Report\ReportPdfCell;
use Fisharebest\Webtrees\Report\ReportPdfFootnote;
use Fisharebest\Webtrees\Report\ReportPdfImage;
use Fisharebest\Webtrees\Report\ReportPdfLine;
use Fisharebest\Webtrees\Report\ReportPdfText;
use Fisharebest\Webtrees\Report\ReportPdfTextBox;
use Fisharebest\Webtrees\Report\TcpdfWrapper;
use Fisharebest\Webtrees\Services\UserService;
use Fisharebest\Webtrees\TestCase;
use PHPUnit\Framework\Attributes\CoversClass;

#[CoversTrait(ModuleReportTrait::class)]
#[CoversClass(PedigreeReportModule::class)]
#[CoversClass(AbstractRenderer::class)]
#[CoversClass(HtmlRenderer::class)]
#[CoversClass(PdfRenderer::class)]
#[CoversClass(ReportBaseCell::class)]
#[CoversClass(ReportBaseElement::class)]
#[CoversClass(ReportBaseFootnote::class)]
#[CoversClass(ReportBaseImage::class)]
#[CoversClass(ReportBaseLine::class)]
#[CoversClass(ReportBaseText::class)]
#[CoversClass(ReportBaseTextbox::class)]
#[CoversClass(ReportExpressionLanguageProvider::class)]
#[CoversClass(ReportHtmlCell::class)]
#[CoversClass(ReportHtmlFootnote::class)]
#[CoversClass(ReportHtmlImage::class)]
#[CoversClass(ReportHtmlLine::class)]
#[CoversClass(ReportHtmlText::class)]
#[CoversClass(ReportHtmlTextbox::class)]
#[CoversClass(ReportParserBase::class)]
#[CoversClass(ReportParserGenerate::class)]
#[CoversClass(ReportParserSetup::class)]
#[CoversClass(ReportPdfCell::class)]
#[CoversClass(ReportPdfFootnote::class)]
#[CoversClass(ReportPdfImage::class)]
#[CoversClass(ReportPdfLine::class)]
#[CoversClass(ReportPdfText::class)]
#[CoversClass(ReportPdfTextBox::class)]
#[CoversClass(TcpdfWrapper::class)]
class RelatedIndividualsReportModuleTest extends TestCase
{
    protected static bool $uses_database = true;

    public function testReportRunsWithoutError(): void
    {
        $user = (new UserService())->create('user', 'User', 'user@example.com', 'secret');
        $user->setPreference(UserInterface::PREF_IS_ADMINISTRATOR, '1');
        Auth::login($user);

        $tree   = $this->importTree('demo.ged');
        $module = new RelatedIndividualsReportModule();
        $module->setName('relative_ext_report');

        $xml  = 'resources/' . $module->xmlFilename();
        $vars = [
            'pid'       => ['id' => 'X1030'],
            'relatives' => ['id' => 'child-family'],
            'maxgen'    => ['id' => '4'],
            'sortby'    => ['id' => 'BIRT:DATE'],
            'sources'   => ['id' => 'on'],
            'notes'     => ['id' => 'on'],
            'photos'    => ['id' => 'all'],
            'colors'    => ['id' => 'on'],
            'pageSize'  => ['id' => 'A4'],
        ];

        $report = new ReportParserSetup($xml);
        self::assertNotEmpty($report->reportProperties());

        ob_start();
        new ReportParserGenerate($xml, new HtmlRenderer(), $vars, $tree);
        $html = ob_get_clean();
        self::assertStringStartsWith('<', $html);
        self::assertStringEndsWith('>', $html);

        ob_start();
        new ReportParserGenerate($xml, new PdfRenderer(), $vars, $tree);
        $pdf = ob_get_clean();
        self::assertStringStartsWith('%PDF', $pdf);
        self::assertStringEndsWith("%%EOF\n", $pdf);
    }
}