MetsDocumentTest::canParseDmdAndAmdSec() - Code Metrics - Inspection of "[FEATURE] Integrate media player from slub_web_sac..." - kitodo/kitodo-presentation - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#818)

unknown

created 2022-07-06 13:31 UTC

MetsDocumentTest::canParseDmdAndAmdSec() A

↳ Parent: MetsDocumentTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	14
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	1
eloc	9
nc	1
nop	0
dl	0
loc	14
rs	9.9666
c	2
b	0
f	0

<?php

namespace Kitodo\Dlf\Tests\Functional\Common;

use Kitodo\Dlf\Common\Doc;
use Kitodo\Dlf\Tests\Functional\FunctionalTestCase;

class MetsDocumentTest extends FunctionalTestCase
{
    public function setUp(): void
    {
        parent::setUp();

        $this->importDataSet(__DIR__ . '/../../Fixtures/Common/metadata.xml');
        $this->importDataSet(__DIR__ . '/../../Fixtures/MetsDocument/metadata_mets.xml');
    }

    protected function doc(string $file)
    {
        $url = 'http://web:8001/Tests/Fixtures/MetsDocument/' . $file;
        $doc = Doc::getInstance($url);
        $this->assertNotNull($doc);
        return $doc;
    }

    /**
     * @test
     */
    public function canParseDmdAndAmdSec()
    {
        $doc = $this->doc('av_beispiel.xml');

        $titledata = $doc->getTitledata(20000);

        $this->assertEquals(['Odol-Mundwasser, 3 Werbespots'], $titledata['title']);
        $this->assertEquals(['24'], $titledata['frame_rate']);
        $this->assertEquals(['Sächsische Landesbibliothek - Staats- und Universitätsbibliothek Dresden'], $titledata['dvrights_owner']);
        $this->assertEquals(['https://katalog.slub-dresden.de/id/0-1703800435'], $titledata['dvlinks_reference']);

        $this->assertEquals([
            'DMDLOG_0000' => $doc->mdSec['DMDLOG_0000'],

        ], $doc->dmdSec);

    }

    /**
     * @test
     */
    public function canReadFileMetadata()
    {
        $doc = $this->doc('av_beispiel.xml');

        $thumbsMeta = $doc->getMetadata('FILE_0000_THUMBS', 20000);
        $this->assertEquals($thumbsMeta, []);

        $videoMeta = $doc->getMetadata('FILE_0000_DEFAULT_MOV', 20000);
        $this->assertArrayMatches([
            'frame_rate' => ['24'],
        ], $videoMeta);
    }

    /**
     * @test
     */
    public function canGetLogicalStructure()
    {
        $doc = $this->doc('av_beispiel.xml');

        $toc = $doc->tableOfContents[0] ?? [];

        $this->assertArrayMatches([
            'dmdId' => 'DMDLOG_0000',
            'admId' => 'AMD',
            'videoChapter' => [
                'fileIds' => ['FILE_0000_DEFAULT_MOV', 'FILE_0000_DEFAULT_MP4'],
                'timecode' => 0,
            ],
            'children' => [
                [
                    'id' => 'LOG_0001',
                    'dmdId' => '',
                    'admId' => '',
                    'videoChapter' => [
                        'fileIds' => ['FILE_0000_DEFAULT_MOV', 'FILE_0000_DEFAULT_MP4'],
                        'timecode' => 0,
                    ],
                ],
                [
                    'id' => 'LOG_0002',
                    'dmdId' => '',
                    'admId' => '',
                    'videoChapter' => [
                        'fileIds' => ['FILE_0000_DEFAULT_MOV', 'FILE_0000_DEFAULT_MP4'],
                        'timecode' => 20.5,
                    ],
                ],
                [
                    'id' => 'LOG_0003',
                    'dmdId' => '',
                    'admId' => '',
                    'videoChapter' => [
                        'fileIds' => ['FILE_0000_DEFAULT_MOV', 'FILE_0000_DEFAULT_MP4'],
                        'timecode' => 40,
                    ],
                ],
                [
                    'id' => 'LOG_0004',
                    'dmdId' => '',
                    'admId' => '',
                    'videoChapter' => [
                        'fileIds' => ['FILE_0000_DEFAULT_MOV', 'FILE_0000_DEFAULT_MP4'],
                        'timecode' => 60,
                    ],
                ],
            ],
        ], $toc, 'Expected TOC to contain the specified values');
    }

    /**
     * @test
     */
    public function canReadChapterArea()
    {
        $doc = $this->doc('av_beispiel.xml');

        $ch3_page = $doc->physicalStructureInfo[$doc->physicalStructure[3]];
        $this->assertArrayMatches([
            'DEFAULT' => 'FILE_0000_DEFAULT_MP4',
        ], $ch3_page['files']);
        $this->assertArrayMatches([
            'DEFAULT' => [
                'FILE_0000_DEFAULT_MOV',
                'FILE_0000_DEFAULT_MP4',
            ],
        ], $ch3_page['all_files']);
        $this->assertArrayMatches([
            'FILE_0000_DEFAULT_MP4' => [
                'area' => [
                    'begin' => '00:00:40',
                    'betype' => 'TIME',
                    'extent' => '00:00:20',
                    'exttype' => 'TIME',
                ],
            ],
        ], $ch3_page['fileInfos']);
    }

    /**
     * @test
     */
    public function doesNotOverwriteFirstDmdSec()
    {
        $doc = $this->doc('two_dmdsec.xml');

        $titledata = $doc->getTitledata(20000);
        $toc = $doc->tableOfContents[0] ?? [];

        $this->assertEquals('DMDLOG_0000 DMDLOG_0000b', $toc['dmdId']); // TODO: Do we want the raw (non-split) value here?
        $this->assertEquals('Test Value in DMDLOG_0000', $titledata['test_value'][0]);
    }

    /**
     * @test
     */
    public function returnsEmptyMetadataWhenNoDmdSec()
    {
        $doc = $this->doc('two_dmdsec.xml');

        // DMD and AMD works
        $metadata = $doc->getMetadata('LOG_0000', 20000);
        $this->assertEquals('Test Value in DMDLOG_0000', $metadata['test_value'][0]);

        // DMD only works
        $metadata = $doc->getMetadata('LOG_0001', 20000);
        $this->assertEquals(['Test Value in DMDLOG_0000b'], $metadata['test_value']);

        // AMD only does not work
        $metadata = $doc->getMetadata('LOG_0002', 20000);
        $this->assertEquals([], $metadata);
    }
}


1			<?php
2
3			namespace Kitodo\Dlf\Tests\Functional\Common;
4
5			use Kitodo\Dlf\Common\Doc;
6			use Kitodo\Dlf\Tests\Functional\FunctionalTestCase;
7
8			class MetsDocumentTest extends FunctionalTestCase
9			{
10			public function setUp(): void
11			{
12			parent::setUp();
13
14			$this->importDataSet(__DIR__ . '/../../Fixtures/Common/metadata.xml');
15			$this->importDataSet(__DIR__ . '/../../Fixtures/MetsDocument/metadata_mets.xml');
16			}
17
18			protected function doc(string $file)
19			{
20			$url = 'http://web:8001/Tests/Fixtures/MetsDocument/' . $file;
21			$doc = Doc::getInstance($url);
22			$this->assertNotNull($doc);
23			return $doc;
24			}
25
26			/**
27			* @test
28			*/
29			public function canParseDmdAndAmdSec()
30			{
31			$doc = $this->doc('av_beispiel.xml');
32
33			$titledata = $doc->getTitledata(20000);
34
35			$this->assertEquals(['Odol-Mundwasser, 3 Werbespots'], $titledata['title']);
36			$this->assertEquals(['24'], $titledata['frame_rate']);
37			$this->assertEquals(['Sächsische Landesbibliothek - Staats- und Universitätsbibliothek Dresden'], $titledata['dvrights_owner']);
38			$this->assertEquals(['https://katalog.slub-dresden.de/id/0-1703800435'], $titledata['dvlinks_reference']);
39
40			$this->assertEquals([
41			'DMDLOG_0000' => $doc->mdSec['DMDLOG_0000'],
			0 ignored issues – show Bug Best Practice introduced 2022-03-31 16:17 UTC by Report Bug Copy Issue Report The property `mdSec` does not exist on `Kitodo\Dlf\Common\Doc`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
42			], $doc->dmdSec);
			0 ignored issues – show Bug Best Practice introduced 2022-03-31 16:17 UTC by Report Bug Copy Issue Report The property `dmdSec` does not exist on `Kitodo\Dlf\Common\Doc`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
43			}
44
45			/**
46			* @test
47			*/
48			public function canReadFileMetadata()
49			{
50			$doc = $this->doc('av_beispiel.xml');
51
52			$thumbsMeta = $doc->getMetadata('FILE_0000_THUMBS', 20000);
53			$this->assertEquals($thumbsMeta, []);
54
55			$videoMeta = $doc->getMetadata('FILE_0000_DEFAULT_MOV', 20000);
56			$this->assertArrayMatches([
57			'frame_rate' => ['24'],
58			], $videoMeta);
59			}
60
61			/**
62			* @test
63			*/
64			public function canGetLogicalStructure()
65			{
66			$doc = $this->doc('av_beispiel.xml');
67
68			$toc = $doc->tableOfContents[0] ?? [];
69
70			$this->assertArrayMatches([
71			'dmdId' => 'DMDLOG_0000',
72			'admId' => 'AMD',
73			'videoChapter' => [
74			'fileIds' => ['FILE_0000_DEFAULT_MOV', 'FILE_0000_DEFAULT_MP4'],
75			'timecode' => 0,
76			],
77			'children' => [
78			[
79			'id' => 'LOG_0001',
80			'dmdId' => '',
81			'admId' => '',
82			'videoChapter' => [
83			'fileIds' => ['FILE_0000_DEFAULT_MOV', 'FILE_0000_DEFAULT_MP4'],
84			'timecode' => 0,
85			],
86			],
87			[
88			'id' => 'LOG_0002',
89			'dmdId' => '',
90			'admId' => '',
91			'videoChapter' => [
92			'fileIds' => ['FILE_0000_DEFAULT_MOV', 'FILE_0000_DEFAULT_MP4'],
93			'timecode' => 20.5,
94			],
95			],
96			[
97			'id' => 'LOG_0003',
98			'dmdId' => '',
99			'admId' => '',
100			'videoChapter' => [
101			'fileIds' => ['FILE_0000_DEFAULT_MOV', 'FILE_0000_DEFAULT_MP4'],
102			'timecode' => 40,
103			],
104			],
105			[
106			'id' => 'LOG_0004',
107			'dmdId' => '',
108			'admId' => '',
109			'videoChapter' => [
110			'fileIds' => ['FILE_0000_DEFAULT_MOV', 'FILE_0000_DEFAULT_MP4'],
111			'timecode' => 60,
112			],
113			],
114			],
115			], $toc, 'Expected TOC to contain the specified values');
116			}
117
118			/**
119			* @test
120			*/
121			public function canReadChapterArea()
122			{
123			$doc = $this->doc('av_beispiel.xml');
124
125			$ch3_page = $doc->physicalStructureInfo[$doc->physicalStructure[3]];
126			$this->assertArrayMatches([
127			'DEFAULT' => 'FILE_0000_DEFAULT_MP4',
128			], $ch3_page['files']);
129			$this->assertArrayMatches([
130			'DEFAULT' => [
131			'FILE_0000_DEFAULT_MOV',
132			'FILE_0000_DEFAULT_MP4',
133			],
134			], $ch3_page['all_files']);
135			$this->assertArrayMatches([
136			'FILE_0000_DEFAULT_MP4' => [
137			'area' => [
138			'begin' => '00:00:40',
139			'betype' => 'TIME',
140			'extent' => '00:00:20',
141			'exttype' => 'TIME',
142			],
143			],
144			], $ch3_page['fileInfos']);
145			}
146
147			/**
148			* @test
149			*/
150			public function doesNotOverwriteFirstDmdSec()
151			{
152			$doc = $this->doc('two_dmdsec.xml');
153
154			$titledata = $doc->getTitledata(20000);
155			$toc = $doc->tableOfContents[0] ?? [];
156
157			$this->assertEquals('DMDLOG_0000 DMDLOG_0000b', $toc['dmdId']); // TODO: Do we want the raw (non-split) value here?
158			$this->assertEquals('Test Value in DMDLOG_0000', $titledata['test_value'][0]);
159			}
160
161			/**
162			* @test
163			*/
164			public function returnsEmptyMetadataWhenNoDmdSec()
165			{
166			$doc = $this->doc('two_dmdsec.xml');
167
168			// DMD and AMD works
169			$metadata = $doc->getMetadata('LOG_0000', 20000);
170			$this->assertEquals('Test Value in DMDLOG_0000', $metadata['test_value'][0]);
171
172			// DMD only works
173			$metadata = $doc->getMetadata('LOG_0001', 20000);
174			$this->assertEquals(['Test Value in DMDLOG_0000b'], $metadata['test_value']);
175
176			// AMD only does not work
177			$metadata = $doc->getMetadata('LOG_0002', 20000);
178			$this->assertEquals([], $metadata);
179			}
180			}
181

Scrutinizer GitHub App not installed

GitHub Access Token became invalid

Pull Request — master (#818)

MetsDocumentTest::canParseDmdAndAmdSec() A

Complexity

Size

Duplication

Importance

kitodo / kitodo-presentation

Scrutinizer GitHub App not installed

GitHub Access Token became invalid

Pull Request — master (#818)

MetsDocumentTest::canParseDmdAndAmdSec() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like