Skip to content

Commit

Permalink
Add functional tests
Browse files Browse the repository at this point in the history 
We use a local minio instance to run the tests against.

Run them with
./Build/Scripts/runTests.sh -p 8.2 -d sqlite -s functional -e "--display-warnings --display-notices --display-errors"
  • Loading branch information
@cweiske
cweiske committed Sep 6, 2024
1 parent ee2f027 commit f83394a
Show file tree
Hide file tree
Showing 4 changed files with 336 additions and 0 deletions.
13 changes: 13 additions & 0 deletions Build/FunctionalTests.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?xml version="1.0"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.4/phpunit.xsd" backupGlobals="true" bootstrap="FunctionalTestsBootstrap.php" cacheResult="false" colors="true" processIsolation="false" stopOnError="false" stopOnFailure="false" stopOnIncomplete="false" stopOnSkipped="false" beStrictAboutTestsThatDoNotTestAnything="false" failOnWarning="true" cacheDirectory=".phpunit.cache" requireCoverageMetadata="false">
<testsuites>
<testsuite name="Functional tests">
<directory>../Tests/Functional/</directory>
</testsuite>
</testsuites>
<php>
<const name="TYPO3_MODE" value="BE"/>
<ini name="display_errors" value="1"/>
<env name="TYPO3_CONTEXT" value="Testing"/>
</php>
</phpunit>
30 changes: 30 additions & 0 deletions Build/FunctionalTestsBootstrap.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<?php
/*
* 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!
*/

/**
* Boilerplate for a functional test phpunit bootstrap file.
*
* This file is loosely maintained within TYPO3 testing-framework, extensions
* are encouraged to not use it directly, but to copy it to an own place,
* usually in parallel to a FunctionalTests.xml file.
*
* This file is defined in FunctionalTests.xml and called by phpunit
* before instantiating the test suites.
*/
(static function () {
$testbase = new \TYPO3\TestingFramework\Core\Testbase();
$testbase->defineOriginalRootPath();
$testbase->createDirectory(ORIGINAL_ROOT . 'typo3temp/var/tests');
$testbase->createDirectory(ORIGINAL_ROOT . 'typo3temp/var/transient');
})();
9 changes: 9 additions & 0 deletions Build/testing-docker/docker-compose.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,13 @@ services:
tmpfs:
- /var/lib/postgresql/data:rw,noexec,nosuid

minio:
image: minio/minio
user: ${HOST_UID}
command: server /minio-data
volumes:
- ../../.Build/minio-data:/minio-data

composer_install:
image: typo3/core-testing-${DOCKER_PHP_IMAGE}:latest
user: ${HOST_UID}
Expand Down Expand Up @@ -236,6 +243,8 @@ services:
functional_sqlite:
image: typo3/core-testing-${DOCKER_PHP_IMAGE}:latest
user: ${HOST_UID}
links:
- minio
volumes:
- ${ROOT_DIR}:${ROOT_DIR}
- ${HOST_HOME}:${HOST_HOME}
Expand Down
284 changes: 284 additions & 0 deletions Tests/Functional/Driver/AmazonS3DriverTest.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,284 @@
<?php

namespace AUS\AusDriverAmazonS3\Tests\Functional\Driver;

use AUS\AusDriverAmazonS3\Driver\AmazonS3Driver;
use TYPO3\CMS\Core\Cache\CacheManager;
use TYPO3\CMS\Core\Core\ApplicationContext;
use TYPO3\CMS\Core\Core\Environment;
use TYPO3\CMS\Core\Core\SystemEnvironmentBuilder;
use TYPO3\CMS\Core\EventDispatcher\NoopEventDispatcher;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\TestingFramework\Core\Functional\FunctionalTestCase;
use Prophecy\PhpUnit\ProphecyTrait;

class AmazonS3DriverTest extends FunctionalTestCase
{
use ProphecyTrait;

protected bool $initializeDatabase = false;

/**
* @var AmazonS3Driver
*/
protected $driver = null;

/**
* @var string[]
*/
protected $testConfiguration = [
'bucket' => 'test-bucket',
'region' => 'eu-central-1',
'customHost' => 'http://minio:9000',
'pathStyleEndpoint' => 1,
'key' => 'test-key',
'secretKey' => 'test-secretkey',
'publicBaseUrl' => 'minio',
'baseFolder' => '',
'cacheHeaderDuration' => 0,
'protocol' => 'http://',
'signature' => 0,
'caseSensitive' => 1,
];

public function setUp(): void
{
parent::setUp();
$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS'][AmazonS3Driver::EXTENSION_KEY] = [
'dnsPrefetch' => '1',
'doNotLoadAmazonLib' => '0',
'enablePermissionsCheck' => '0',
];

$cacheManager = GeneralUtility::makeInstance(CacheManager::class);
$cacheManager->setCacheConfigurations([
'ausdriveramazons3_metainfocache' => [
'backend' => \TYPO3\CMS\Core\Cache\Backend\TransientMemoryBackend::class,
'frontend' => \TYPO3\CMS\Core\Cache\Frontend\VariableFrontend::class,
],
'ausdriveramazons3_requestcache' => [
'backend' => \TYPO3\CMS\Core\Cache\Backend\TransientMemoryBackend::class,
'frontend' => \TYPO3\CMS\Core\Cache\Frontend\VariableFrontend::class,
]
]);
$this->driver = new AmazonS3Driver(
$this->testConfiguration,
null,
GeneralUtility::makeInstance(NoopEventDispatcher::class)
);
$this->driver->setStorageUid(42);
$this->driver->initialize();
}

public function testDeleteFile()
{
$localPath = __DIR__ . '/tmp.txt';
file_put_contents($localPath, '42');
$this->assertTrue(file_exists($localPath));
$this->assertFalse($this->driver->fileExists('tmp-uploaded.txt'));

$this->assertEquals(
'tmp-uploaded.txt',
$this->driver->addFile(
$localPath,
$this->driver->getRootLevelFolder(),
'tmp-uploaded.txt'
)
);
$this->assertFalse(file_exists($localPath));

$this->assertTrue($this->driver->deleteFile('tmp-uploaded.txt'));
$this->assertFalse($this->driver->fileExists('tmp-uploaded.txt'));
}

public function testDeleteFolder()
{
$this->assertFalse($this->driver->folderExists('tmp-dir'));

$this->assertEquals('/tmp-dir/', $this->driver->createFolder('tmp-dir'));
$this->assertTrue($this->driver->folderExists('tmp-dir'));

$this->assertTrue($this->driver->deleteFolder('tmp-dir/'));
$this->assertFalse($this->driver->folderExists('tmp-dir'));

$this->markTestSkipped('deleteFolder("tmp-dir/") fails currently');
}

public function testFileExists()
{
$this->assertFalse($this->driver->fileExists('doesnotexist.txt'));
$this->assertTrue($this->driver->fileExists('23.txt'));
$this->assertTrue($this->driver->fileExists('images/bytes-1009.png'));
}

public function testFolderExists()
{
$this->assertTrue(
$this->driver->folderExists($this->driver->getDefaultFolder())
);

$this->assertFalse($this->driver->folderExists('doesnotexist'));
$this->assertFalse($this->driver->folderExists('doesnotexist/'));

$this->assertTrue($this->driver->folderExists('images'));
$this->assertTrue($this->driver->folderExists('images/'));
}

public function testFolderExistsInFolder()
{
$this->markTestSkipped('Currently broken: leading slash must be removed');
$this->assertTrue(
$this->driver->folderExistsInFolder(
'images',
$this->driver->getDefaultFolder()
)
);
}

public function testGetFileContents()
{
$this->assertEquals("42\n", $this->driver->getFileContents('23.txt'));
}

public function testGetPublicUrl()
{
$this->assertEquals(
'http://minio/file.txt',
$this->driver->getPublicUrl('file.txt')
);
}

public function testGetFilesInFolderRoot()
{
$this->assertEquals(
[
'23.txt' => '23.txt',
],
$this->driver->getFilesInFolder($this->driver->getDefaultFolder())
);
}

public function testGetFilesInFolder()
{
$this->assertEquals(
[
'images/bytes-1009.png' => 'images/bytes-1009.png',
],
$this->driver->getFilesInFolder('images/')
);
}

public function testGetFileInfoByIdentifierAllProperties()
{
$info = $this->driver->getFileInfoByIdentifier('images/bytes-1009.png');
$this->assertEquals('bytes-1009.png', $info['name']);
$this->assertEquals('images/bytes-1009.png', $info['identifier']);
$this->assertEquals('8b6249ec878b12d3f014e616336fefaac0b4d0dd', $info['identifier_hash']);
$this->assertEquals('c1a406ab82b5588738d1587da2761746ec584a6c', $info['folder_hash']);
$this->assertEquals('png', $info['extension']);
$this->assertEquals(42, $info['storage']);
$this->assertEquals('image/png', $info['mimetype']);
$this->assertEquals(1009, $info['size']);
}

public function testGetFileInfoByIdentifierOnlyMimetype()
{
$info = $this->driver->getFileInfoByIdentifier('images/bytes-1009.png', ['mimetype']);
$this->assertEquals('image/png', $info['mimetype']);
}

public function testGetFoldersInFolderRoot()
{
$this->markTestSkipped('need sys_file_storage for this');
$this->assertEquals(
[],
$this->driver->getFoldersInFolder($this->driver->getRootLevelFolder())
);
}

public function testIsFolderEmptySlash()
{
$this->markTestSkipped('Currently broken');
$this->assertCount(1, $this->driver->getFilesInFolder('images/'));
$this->assertFalse($this->driver->isFolderEmpty('images/'));
}

public function testIsFolderEmptyNoSlash()
{
$this->markTestSkipped('Slash is not added automatically');
$this->assertCount(1, $this->driver->getFilesInFolder('images'));
$this->assertFalse($this->driver->isFolderEmpty('images'));
}

public function testCopyFileWithinStorage()
{
$this->assertFalse($this->driver->fileExists('copytarget.txt'));
$this->assertEquals(
'copytarget.txt',
$this->driver->copyFileWithinStorage('23.txt', '', 'copytarget.txt')
);
$this->assertTrue($this->driver->fileExists('copytarget.txt'));

$this->assertTrue($this->driver->deleteFile('copytarget.txt'));
}

public function testMoveFileWithinStorageRoot()
{
$this->assertTrue($this->driver->fileExists('23.txt'));
$this->assertFalse($this->driver->fileExists('movetarget.txt'));
$this->assertEquals(
'movetarget.txt',
$this->driver->moveFileWithinStorage('23.txt', '', 'movetarget.txt')
);
$this->assertTrue($this->driver->fileExists('movetarget.txt'));
$this->assertFalse($this->driver->fileExists('23.txt'));

$this->assertEquals(
'23.txt',
$this->driver->moveFileWithinStorage('movetarget.txt', '', '23.txt')
);
}

public function testMoveFileWithinStorageSubfolder()
{
$this->assertTrue($this->driver->fileExists('23.txt'));
$this->assertFalse($this->driver->fileExists('images/movetarget.txt'));
$this->assertEquals(
'images/movetarget.txt',
$this->driver->moveFileWithinStorage('23.txt', 'images/', 'movetarget.txt')
);
$this->assertTrue($this->driver->fileExists('images/movetarget.txt'));
$this->assertFalse($this->driver->fileExists('23.txt'));

$this->assertEquals(
'23.txt',
$this->driver->moveFileWithinStorage('images/movetarget.txt', '', '23.txt')
);
}

public function testMoveFileWithinStorageSubfolderNoSlash()
{
$this->markTestSkipped('moving to "images" folder with slash fails currently');

$this->assertTrue($this->driver->fileExists('23.txt'));
$this->assertFalse($this->driver->fileExists('images/movetarget.txt'));
$this->assertEquals(
'images/movetarget.txt',
$this->driver->moveFileWithinStorage('23.txt', 'images', 'movetarget.txt')
);
$this->assertTrue($this->driver->fileExists('images/movetarget.txt'));
$this->assertFalse($this->driver->fileExists('23.txt'));

$this->assertEquals(
'23.txt',
$this->driver->moveFileWithinStorage('images/movetarget.txt', '', '23.txt')
);
}

public function testSetFileContents()
{
$this->assertEquals(5, $this->driver->setFileContents('write.txt', 'write'));
$this->assertEquals('write', $this->driver->getFileContents('write.txt'));
$this->assertTrue($this->driver->deleteFile('write.txt'));
}
}

0 comments on commit f83394a

Please sign in to comment.