DocumentationFileTest.php

Go to the documentation of this file.

<?php
declare(strict_types = 1);

namespace TYPO3\CMS\Install\Tests\Unit\UpgradeAnalysis;

/*
 * 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 org\bovigo\vfs\vfsStream;
use org\bovigo\vfs\vfsStreamDirectory;
use Prophecy\Argument;
use TYPO3\CMS\Core\Registry;
use TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile;

class DocumentationFileTest extends \TYPO3\TestingFramework\Core\Unit\UnitTestCase
{
    protected $documentationFileService;

    protected $docRoot;

    protected $registry;

    public function setUp()
    {
        $content_12345 = [
            '====',
            'Breaking: #12345 - Issue',
            '====',
            '',
            'some text content',
        ];
        $content_45678 = [
            '====',
            'Important: #45678 - Issue',
            '====',
            '',
            'Some more text content',
        ];

        $content_98574 = [
            '====',
            'Important: #98574 - Issue',
            '====',
            '',
            'Something else',
            '',
            '.. index:: unittest'
        ];
        $content_13579 = [
            '====',
            'Breaking: #13579 - Issue',
            '====',
            '',
            'Some more content'
        ];

        $structure = [
            'Changelog' => [
                '1.2' => [
                    'Breaking-12345-Issue.rst' => implode("\n", $content_12345),
                    'Important-45678-Issue.rst' => implode("\n", $content_45678),

                ],
                '2.0' => [
                    'Important-98574-Issue.rst' => implode("\n", $content_98574),
                ],
                'master' => [
                    'Breaking-13579-Issue.rst' => implode("\n", $content_13579),
                    'Important-13579-Issue.rst' => implode("\n", $content_13579),
                    'Index.rst' => '',
                ],
            ],
        ];

        $this->docRoot = vfsStream::setup('root', null, $structure);

        $this->registry = $this->prophesize(Registry::class);
        $this->documentationFileService = new DocumentationFile(
            $this->registry->reveal(),
            vfsStream::url('root/Changelog')
        );
    }

    public function invalidDirProvider()
    {
        return [
            [
                'root' => '/'
            ],
            [
                'etc' => '/etc'
            ],
            [
                'etc/passwd' => '/etc/passwd'
            ],
        ];
    }

    public function findDocumentationFilesThrowsExceptionIfPathIsNotInGivenChangelogDir(string $path)
    {
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1485425530);
        $documentationFileService = new DocumentationFile($this->registry->reveal());
        $documentationFileService->findDocumentationFiles($path);
    }

    public function findDocumentationFilesReturnsArrayOfFiles()
    {
        $expected = [
            '1.2' => [],
            '2.0' => [],
            'master' => [],
        ];

        $result = $this->documentationFileService->findDocumentationFiles(vfsStream::url('root/Changelog'));
        self::assertEquals(array_keys($expected), array_keys($result));
    }

    public function findDocumentsRespectsFilesWithSameIssueNumber()
    {
        $result = $this->documentationFileService->findDocumentationFiles(vfsStream::url('root/Changelog'));
        $this->assertCount(2, $result['master']);
    }

    public function extractingTagsProvidesTagsAsDesired()
    {
        $expected = [
            'unittest',
            'Important',
        ];
        $result = $this->documentationFileService->findDocumentationFiles(vfsStream::url('root/Changelog'));
        $key = md5('vfs://root/Changelog/2.0/Important-98574-Issue.rst');
        self::assertEquals($expected, $result['2.0'][$key]['tags']);
    }

    public function filesAreFilteredByUsersChoice()
    {
        $ignoredFiles = ['vfs://root/Changelog/1.2/Breaking-12345-Issue.rst'];
        $this->registry->get(
            'upgradeAnalysisIgnoreFilter',
            'ignoredDocumentationFiles',
            Argument::any()
        )->willReturn($ignoredFiles);

        $result = $this->documentationFileService->findDocumentationFiles(vfsStream::url('root/Changelog'));
        self::assertArrayNotHasKey(12345, $result['1.2']);
    }

    public function invalidFilesProvider(): array
    {
        return [
            ['/etc/passwd' => '/etc/passwd'],
            ['root' => '/'],
        ];
    }

    public function getListEntryThrowsExceptionForFilesNotBelongToChangelogDir(string $path)
    {
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1485425531);
        $this->documentationFileService->getListEntry($path);
    }
}