ActionControllerTest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * 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!
 */
 
namespace ‪TYPO3\CMS\Extensionmanager\Tests\Unit\Controller;
 
use PHPUnit\Framework\Attributes\Test;
use ‪TYPO3\CMS\Core\Core\Environment;
use ‪TYPO3\CMS\Core\Package\PackageActivationService;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\StringUtility;
use ‪TYPO3\CMS\Extensionmanager\Controller\ActionController;
use TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService;
use ‪TYPO3\CMS\Extensionmanager\Utility\InstallUtility;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
final class ‪ActionControllerTest extends UnitTestCase
{
    protected function ‪createFakeExtension(): array
    {
        $testRoot = ‪Environment::getVarPath() . '/tests';
        $this->testFilesToDelete[] = $testRoot;
        $extKey = strtolower(‪StringUtility::getUniqueId('testing'));
        $absExtPath = $testRoot . '/ext-' . $extKey . '/';
        ‪GeneralUtility::mkdir_deep($absExtPath);
        return [
            'extensionKey' => $extKey,
            'version' => '0.0.0',
            'packagePath' => $absExtPath,
        ];
    }
 
    #[Test]
    public function ‪createZipFileFromExtensionGeneratesCorrectArchive(): void
    {
        // 42 second of first day in 1970 - used to have achieve stable file names
        ‪$GLOBALS['EXEC_TIME'] = 42;
 
        // Create extension for testing:
        $fakeExtension = $this->‪createFakeExtension();
        $extKey = $fakeExtension['extensionKey'];
        $extensionRoot = $fakeExtension['packagePath'];
        $installUtility = $this->createMock(InstallUtility::class);
        $installUtility->method('enrichExtensionWithDetails')->with($extKey)->willReturn($fakeExtension);
        // Build mocked fileHandlingUtility:
        $subject = $this->getAccessibleMock(
            ActionController::class,
            null,
            [
                $installUtility,
                $this->createMock(ExtensionManagementService::class),
                $this->createMock(PackageActivationService::class),
            ]
        );
 
        // Add files and directories to extension:
        touch($extensionRoot . 'emptyFile.txt');
        file_put_contents($extensionRoot . 'notEmptyFile.txt', 'content');
        touch($extensionRoot . '.hiddenFile');
        mkdir($extensionRoot . 'emptyDir');
        mkdir($extensionRoot . 'notEmptyDir');
        touch($extensionRoot . 'notEmptyDir/file.txt');
 
        // Create zip-file from extension
        $filename = $subject->_call('createZipFileFromExtension', $extKey);
 
        $expectedFilename = ‪Environment::getVarPath() . '/transient/' . $extKey . '_0.0.0_' . date('YmdHi', 42) . '.zip';
        $this->testFilesToDelete[] = $filename;
        self::assertEquals($expectedFilename, $filename, 'Archive file name differs from expectation');
 
        // File was created
        self::assertFileExists($filename, 'Zip file not created');
 
        // Read archive and check its contents
        $archive = new \ZipArchive();
        self::assertTrue($archive->open($filename), 'Unable to open archive');
        self::assertEquals(0, $archive->statName('emptyFile.txt')['size'], 'Empty file not in archive');
        self::assertEquals('content', $archive->getFromName('notEmptyFile.txt'), 'Expected content not found');
        self::assertFalse($archive->statName('.hiddenFile'), 'Hidden file not in archive');
        self::assertIsArray($archive->statName('emptyDir/'), 'Empty directory not in archive');
        self::assertIsArray($archive->statName('notEmptyDir/'), 'Not empty directory not in archive');
        self::assertIsArray($archive->statName('notEmptyDir/file.txt'), 'File within directory not in archive');
 
        // Check that the archive has no additional content
        self::assertEquals(5, $archive->numFiles, 'Too many or too less files in archive');
    }
}