class FileRepositoryTest
Same name in other branches
- 9 core/modules/file/tests/src/Kernel/FileRepositoryTest.php \Drupal\Tests\file\Kernel\FileRepositoryTest
- 10 core/modules/file/tests/src/Kernel/FileRepositoryTest.php \Drupal\Tests\file\Kernel\FileRepositoryTest
Tests the FileRepository.
@coversDefaultClass \Drupal\file\FileRepository @group file
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements \Drupal\Core\DependencyInjection\ServiceProviderInterface uses \Drupal\KernelTests\AssertContentTrait, \Drupal\Tests\RandomGeneratorTrait, \Drupal\Tests\ConfigTestTrait, \Drupal\Tests\ExtensionListTestTrait, \Drupal\Tests\TestRequirementsTrait, \Drupal\Tests\PhpUnitCompatibilityTrait, \Prophecy\PhpUnit\ProphecyTrait, \Drupal\TestTools\Extension\DeprecationBridge\ExpectDeprecationTrait
- class \Drupal\Tests\file\Kernel\FileManagedUnitTestBase extends \Drupal\KernelTests\KernelTestBase
- class \Drupal\Tests\file\Kernel\FileRepositoryTest extends \Drupal\Tests\file\Kernel\FileManagedUnitTestBase
- class \Drupal\Tests\file\Kernel\FileManagedUnitTestBase extends \Drupal\KernelTests\KernelTestBase
Expanded class hierarchy of FileRepositoryTest
File
-
core/
modules/ file/ tests/ src/ Kernel/ FileRepositoryTest.php, line 22
Namespace
Drupal\Tests\file\KernelView source
class FileRepositoryTest extends FileManagedUnitTestBase {
/**
* The file repository service under test.
*
* @var \Drupal\file\FileRepository
*/
protected $fileRepository;
/**
* The file system service.
*
* @var \Drupal\Core\File\FileSystemInterface
*/
protected $fileSystem;
/**
* {@inheritdoc}
*/
protected function setUp() : void {
parent::setUp();
$this->fileRepository = $this->container
->get('file.repository');
$this->fileSystem = $this->container
->get('file_system');
}
/**
* Tests the writeData() method.
*
* @covers ::writeData
*/
public function testWithFilename() : void {
$contents = $this->randomMachineName();
// Using filename with non-latin characters.
// cSpell:disable-next-line
$filename = 'Текстовый файл.txt';
$result = $this->fileRepository
->writeData($contents, 'public://' . $filename);
$this->assertNotFalse($result, 'Unnamed file saved correctly.');
$stream_wrapper_manager = \Drupal::service('stream_wrapper_manager');
assert($stream_wrapper_manager instanceof StreamWrapperManagerInterface);
$this->assertEquals('public', $stream_wrapper_manager::getScheme($result->getFileUri()), "File was placed in Drupal's files directory.");
$this->assertEquals($filename, \Drupal::service('file_system')->basename($result->getFileUri()), 'File was named correctly.');
$this->assertEquals($contents, file_get_contents($result->getFileUri()), 'Contents of the file are correct.');
$this->assertEquals('text/plain', $result->getMimeType(), 'A MIME type was set.');
$this->assertTrue($result->isPermanent(), "The file's status was set to permanent.");
// Check that the correct hooks were called.
$this->assertFileHooksCalled([
'insert',
]);
// Verify that what was returned is what's in the database.
$this->assertFileUnchanged($result, File::load($result->id()));
}
/**
* Tests writeData() when renaming around an existing file.
*
* @covers ::writeData
*/
public function testExistingRename() : void {
// Setup a file to overwrite.
$existing = $this->createFile();
$contents = $this->randomMachineName();
$result = $this->fileRepository
->writeData($contents, $existing->getFileUri());
$this->assertNotFalse($result, 'File saved successfully.');
$stream_wrapper_manager = \Drupal::service('stream_wrapper_manager');
assert($stream_wrapper_manager instanceof StreamWrapperManagerInterface);
$this->assertEquals('public', $stream_wrapper_manager::getScheme($result->getFileUri()), "File was placed in Drupal's files directory.");
$this->assertEquals($existing->getFilename(), $result->getFilename(), 'Filename was set to the basename of the source, rather than that of the renamed file.');
$this->assertEquals($contents, file_get_contents($result->getFileUri()), 'Contents of the file are correct.');
$this->assertEquals('application/octet-stream', $result->getMimeType(), 'A MIME type was set.');
$this->assertTrue($result->isPermanent(), "The file's status was set to permanent.");
// Check that the correct hooks were called.
$this->assertFileHooksCalled([
'insert',
]);
// Ensure that the existing file wasn't overwritten.
$this->assertDifferentFile($existing, $result);
$this->assertFileUnchanged($existing, File::load($existing->id()));
// Verify that was returned is what's in the database.
$this->assertFileUnchanged($result, File::load($result->id()));
}
/**
* Tests writeData() when replacing an existing file.
*
* @covers ::writeData
*/
public function testExistingReplace() : void {
// Setup a file to overwrite.
$existing = $this->createFile();
$contents = $this->randomMachineName();
$result = $this->fileRepository
->writeData($contents, $existing->getFileUri(), FileExists::Replace);
$this->assertNotFalse($result, 'File saved successfully.');
$stream_wrapper_manager = \Drupal::service('stream_wrapper_manager');
assert($stream_wrapper_manager instanceof StreamWrapperManagerInterface);
$this->assertEquals('public', $stream_wrapper_manager::getScheme($result->getFileUri()), "File was placed in Drupal's files directory.");
$this->assertEquals($existing->getFilename(), $result->getFilename(), 'Filename was set to the basename of the existing file, rather than preserving the original name.');
$this->assertEquals($contents, file_get_contents($result->getFileUri()), 'Contents of the file are correct.');
$this->assertEquals('application/octet-stream', $result->getMimeType(), 'A MIME type was set.');
$this->assertTrue($result->isPermanent(), "The file's status was set to permanent.");
// Check that the correct hooks were called.
$this->assertFileHooksCalled([
'load',
'update',
]);
// Verify that the existing file was re-used.
$this->assertSameFile($existing, $result);
// Verify that what was returned is what's in the database.
$this->assertFileUnchanged($result, File::load($result->id()));
}
/**
* Tests that writeData() fails overwriting an existing file.
*
* @covers ::writeData
*/
public function testExistingError() : void {
$contents = $this->randomMachineName();
$existing = $this->createFile(NULL, $contents);
// Check the overwrite error.
try {
$this->fileRepository
->writeData('asdf', $existing->getFileUri(), FileExists::Error);
$this->fail('expected FileExistsException');
} catch (FileExistsException $e) {
$this->assertStringContainsString("could not be copied because a file by that name already exists in the destination directory", $e->getMessage());
}
$this->assertEquals($contents, file_get_contents($existing->getFileUri()), 'Contents of existing file were unchanged.');
// Check that no hooks were called while failing.
$this->assertFileHooksCalled([]);
// Ensure that the existing file wasn't overwritten.
$this->assertFileUnchanged($existing, File::load($existing->id()));
}
/**
* Tests for an invalid stream wrapper.
*
* @covers ::writeData
*/
public function testInvalidStreamWrapper() : void {
$this->expectException(InvalidStreamWrapperException::class);
$this->expectExceptionMessage('Invalid stream wrapper: foo://');
$this->fileRepository
->writeData('asdf', 'foo://');
}
/**
* Tests for entity storage exception.
*
* @covers ::writeData
*/
public function testEntityStorageException() : void {
/** @var \Drupal\Core\Entity\EntityTypeManager $entityTypeManager */
$entityTypeManager = $this->prophesize(EntityTypeManager::class);
$entityTypeManager->getStorage('file')
->willThrow(EntityStorageException::class);
$fileRepository = new FileRepository($this->container
->get('file_system'), $this->container
->get('stream_wrapper_manager'), $entityTypeManager->reveal(), $this->container
->get('module_handler'), $this->container
->get('file.usage'), $this->container
->get('current_user'));
$this->expectException(EntityStorageException::class);
$target = $this->createFile();
$fileRepository->writeData('asdf', $target->getFileUri(), FileExists::Replace);
}
/**
* Tests loading a file by URI.
*
* @covers ::loadByUri
*/
public function testLoadByUri() : void {
$source = $this->createFile();
$result = $this->fileRepository
->loadByUri($source->getFileUri());
$this->assertSameFile($source, $result);
}
/**
* Tests loading a file by case-sensitive URI.
*
* @covers ::loadByUri
*/
public function testLoadByUriCaseSensitive() : void {
$source = $this->createFile('FooBar.txt');
$result = $this->fileRepository
->loadByUri('public://FooBar.txt');
$this->assertSameFile($source, $result);
$result = $this->fileRepository
->loadByUri('public://foobar.txt');
$this->assertNull($result);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
AssertContentTrait::$content | protected | property | The current raw content. | ||
AssertContentTrait::$drupalSettings | protected | property | The drupalSettings value from the current raw $content. | ||
AssertContentTrait::$elements | protected | property | The XML structure parsed from the current raw $content. | 1 | |
AssertContentTrait::$plainTextContent | protected | property | The plain-text content of raw $content (text nodes). | ||
AssertContentTrait::assertEscaped | protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | ||
AssertContentTrait::assertField | protected | function | Asserts that a field exists with the given name or ID. | ||
AssertContentTrait::assertFieldById | protected | function | Asserts that a field exists with the given ID and value. | ||
AssertContentTrait::assertFieldByName | protected | function | Asserts that a field exists with the given name and value. | ||
AssertContentTrait::assertFieldByXPath | protected | function | Asserts that a field exists in the current page by the given XPath. | ||
AssertContentTrait::assertFieldChecked | protected | function | Asserts that a checkbox field in the current page is checked. | ||
AssertContentTrait::assertFieldsByValue | protected | function | Asserts that a field exists in the current page with a given Xpath result. | ||
AssertContentTrait::assertLink | protected | function | Passes if a link with the specified label is found. | ||
AssertContentTrait::assertLinkByHref | protected | function | Passes if a link containing a given href (part) is found. | ||
AssertContentTrait::assertNoDuplicateIds | protected | function | Asserts that each HTML ID is used for just a single element. | ||
AssertContentTrait::assertNoEscaped | protected | function | Passes if raw text IS NOT found escaped on loaded page, fail otherwise. | ||
AssertContentTrait::assertNoField | protected | function | Asserts that a field does not exist with the given name or ID. | ||
AssertContentTrait::assertNoFieldById | protected | function | Asserts that a field does not exist with the given ID and value. | ||
AssertContentTrait::assertNoFieldByName | protected | function | Asserts that a field does not exist with the given name and value. | ||
AssertContentTrait::assertNoFieldByXPath | protected | function | Asserts that a field does not exist or its value does not match, by XPath. | ||
AssertContentTrait::assertNoFieldChecked | protected | function | Asserts that a checkbox field in the current page is not checked. | ||
AssertContentTrait::assertNoLink | protected | function | Passes if a link with the specified label is not found. | ||
AssertContentTrait::assertNoLinkByHref | protected | function | Passes if a link containing a given href (part) is not found. | ||
AssertContentTrait::assertNoLinkByHrefInMainRegion | protected | function | Passes if a link containing a given href is not found in the main region. | ||
AssertContentTrait::assertNoOption | protected | function | Asserts that a select option in the current page does not exist. | ||
AssertContentTrait::assertNoOptionSelected | protected | function | Asserts that a select option in the current page is not checked. | ||
AssertContentTrait::assertNoPattern | protected | function | Triggers a pass if the perl regex pattern is not found in raw content. | ||
AssertContentTrait::assertNoRaw | protected | function | Passes if the raw text is NOT found on the loaded page, fail otherwise. | ||
AssertContentTrait::assertNoText | protected | function | Passes if the page (with HTML stripped) does not contains the text. | ||
AssertContentTrait::assertNoTitle | protected | function | Pass if the page title is not the given string. | ||
AssertContentTrait::assertNoUniqueText | protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | ||
AssertContentTrait::assertOption | protected | function | Asserts that a select option in the current page exists. | ||
AssertContentTrait::assertOptionByText | protected | function | Asserts that a select option with the visible text exists. | ||
AssertContentTrait::assertOptionSelected | protected | function | Asserts that a select option in the current page is checked. | ||
AssertContentTrait::assertOptionSelectedWithDrupalSelector | protected | function | Asserts that a select option in the current page is checked. | ||
AssertContentTrait::assertOptionWithDrupalSelector | protected | function | Asserts that a select option in the current page exists. | ||
AssertContentTrait::assertPattern | protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | ||
AssertContentTrait::assertRaw | protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | ||
AssertContentTrait::assertText | protected | function | Passes if the page (with HTML stripped) contains the text. | ||
AssertContentTrait::assertTextHelper | protected | function | Helper for assertText and assertNoText. | ||
AssertContentTrait::assertTextPattern | protected | function | Asserts that a Perl regex pattern is found in the plain-text content. | ||
AssertContentTrait::assertThemeOutput | protected | function | Asserts themed output. | ||
AssertContentTrait::assertTitle | protected | function | Pass if the page title is the given string. | ||
AssertContentTrait::assertUniqueText | protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | ||
AssertContentTrait::assertUniqueTextHelper | protected | function | Helper for assertUniqueText and assertNoUniqueText. | ||
AssertContentTrait::buildXPathQuery | protected | function | Builds an XPath query. | ||
AssertContentTrait::constructFieldXpath | protected | function | Helper: Constructs an XPath for the given set of attributes and value. | ||
AssertContentTrait::cssSelect | protected | function | Searches elements using a CSS selector in the raw content. | ||
AssertContentTrait::getAllOptions | protected | function | Get all option elements, including nested options, in a select. | ||
AssertContentTrait::getDrupalSettings | protected | function | Gets the value of drupalSettings for the currently-loaded page. | ||
AssertContentTrait::getRawContent | protected | function | Gets the current raw content. | ||
AssertContentTrait::getSelectedItem | protected | function | Get the selected value from a select field. | ||
AssertContentTrait::getTextContent | protected | function | Retrieves the plain-text content from the current raw content. | ||
AssertContentTrait::parse | protected | function | Parse content returned from curlExec using DOM and SimpleXML. | ||
AssertContentTrait::removeWhiteSpace | protected | function | Removes all white-space between HTML tags from the raw content. | ||
AssertContentTrait::setDrupalSettings | protected | function | Sets the value of drupalSettings for the currently-loaded page. | ||
AssertContentTrait::setRawContent | protected | function | Sets the raw content (e.g. HTML). | ||
AssertContentTrait::xpath | protected | function | Performs an xpath search on the contents of the internal browser. | ||
ConfigTestTrait::configImporter | protected | function | Returns a ConfigImporter object to import test configuration. | ||
ConfigTestTrait::copyConfig | protected | function | Copies configuration objects from source storage to target storage. | ||
ExpectDeprecationTrait::expectDeprecation | public | function | Adds an expected deprecation. | ||
ExpectDeprecationTrait::getCallableName | private static | function | Returns a callable as a string suitable for inclusion in a message. | ||
ExpectDeprecationTrait::setUpErrorHandler | public | function | Sets up the test error handler. | ||
ExpectDeprecationTrait::tearDownErrorHandler | public | function | Tears down the test error handler. | ||
ExtensionListTestTrait::getModulePath | protected | function | Gets the path for the specified module. | ||
ExtensionListTestTrait::getThemePath | protected | function | Gets the path for the specified theme. | ||
FileManagedUnitTestBase::$modules | protected static | property | Modules to install. | Overrides KernelTestBase::$modules | |
FileManagedUnitTestBase::assertDifferentFile | public | function | Asserts that two files are not the same by comparing the fid and filepath. | ||
FileManagedUnitTestBase::assertFileHookCalled | public | function | Assert that a hook_file_* hook was called a certain number of times. | ||
FileManagedUnitTestBase::assertFileHooksCalled | public | function | Asserts that the specified file hooks were called only once. | ||
FileManagedUnitTestBase::assertFileUnchanged | public | function | Asserts that two files have the same values (except timestamp). | ||
FileManagedUnitTestBase::assertSameFile | public | function | Asserts that two files are the same by comparing the fid and filepath. | ||
FileManagedUnitTestBase::createFile | public | function | Creates and saves a file, asserting that it was saved. | ||
FileManagedUnitTestBase::createUri | public | function | Creates a file and returns its URI. | ||
FileRepositoryTest::$fileRepository | protected | property | The file repository service under test. | ||
FileRepositoryTest::$fileSystem | protected | property | The file system service. | ||
FileRepositoryTest::setUp | protected | function | Overrides FileManagedUnitTestBase::setUp | ||
FileRepositoryTest::testEntityStorageException | public | function | Tests for entity storage exception. | ||
FileRepositoryTest::testExistingError | public | function | Tests that writeData() fails overwriting an existing file. | ||
FileRepositoryTest::testExistingRename | public | function | Tests writeData() when renaming around an existing file. | ||
FileRepositoryTest::testExistingReplace | public | function | Tests writeData() when replacing an existing file. | ||
FileRepositoryTest::testInvalidStreamWrapper | public | function | Tests for an invalid stream wrapper. | ||
FileRepositoryTest::testLoadByUri | public | function | Tests loading a file by URI. | ||
FileRepositoryTest::testLoadByUriCaseSensitive | public | function | Tests loading a file by case-sensitive URI. | ||
FileRepositoryTest::testWithFilename | public | function | Tests the writeData() method. | ||
KernelTestBase::$backupStaticAttributes | protected | property | Back up and restore static class properties that may be changed by tests. | ||
KernelTestBase::$backupStaticAttributesBlacklist | protected | property | Contains a few static class properties for performance. | ||
KernelTestBase::$classLoader | protected | property | |||
KernelTestBase::$configImporter | protected | property | @todo Move into Config test base class. | 6 | |
KernelTestBase::$configSchemaCheckerExclusions | protected static | property | An array of config object names that are excluded from schema checking. | 4 | |
KernelTestBase::$container | protected | property | |||
KernelTestBase::$databasePrefix | protected | property | |||
KernelTestBase::$keyValue | protected | property | The key_value service that must persist between container rebuilds. | ||
KernelTestBase::$root | protected | property | The app root. | ||
KernelTestBase::$siteDirectory | protected | property | |||
KernelTestBase::$strictConfigSchema | protected | property | Set to TRUE to strict check all configuration saved. | 9 | |
KernelTestBase::$usesSuperUserAccessPolicy | protected | property | Set to TRUE to make user 1 a super user. | 3 | |
KernelTestBase::$vfsRoot | protected | property | The virtual filesystem root directory. | ||
KernelTestBase::assertPostConditions | protected | function | 1 | ||
KernelTestBase::bootEnvironment | protected | function | Bootstraps a basic test environment. | ||
KernelTestBase::bootKernel | protected | function | Bootstraps a kernel for a test. | 1 | |
KernelTestBase::config | protected | function | Configuration accessor for tests. Returns non-overridden configuration. | ||
KernelTestBase::disableModules | protected | function | Disables modules for this test. | ||
KernelTestBase::enableModules | protected | function | Enables modules for this test. | 1 | |
KernelTestBase::getConfigSchemaExclusions | protected | function | Gets the config schema exclusions for this test. | ||
KernelTestBase::getDatabaseConnectionInfo | protected | function | Returns the Database connection info to be used for this test. | 2 | |
KernelTestBase::getDatabasePrefix | public | function | |||
KernelTestBase::getExtensionsForModules | private | function | Returns Extension objects for $modules to install. | ||
KernelTestBase::getModulesToEnable | private static | function | Returns the modules to install for this test. | ||
KernelTestBase::initFileCache | protected | function | Initializes the FileCache component. | ||
KernelTestBase::installConfig | protected | function | Installs default configuration for a given list of modules. | ||
KernelTestBase::installEntitySchema | protected | function | Installs the storage schema for a specific entity type. | ||
KernelTestBase::installSchema | protected | function | Installs database tables from a module schema definition. | ||
KernelTestBase::register | public | function | Registers test-specific services. | Overrides ServiceProviderInterface::register | 27 |
KernelTestBase::render | protected | function | Renders a render array. | 1 | |
KernelTestBase::setInstallProfile | protected | function | Sets the install profile and rebuilds the container to update it. | ||
KernelTestBase::setSetting | protected | function | Sets an in-memory Settings variable. | ||
KernelTestBase::setUpBeforeClass | public static | function | 1 | ||
KernelTestBase::setUpFilesystem | protected | function | Sets up the filesystem, so things like the file directory. | 2 | |
KernelTestBase::tearDown | protected | function | 7 | ||
KernelTestBase::tearDownCloseDatabaseConnection | public | function | Additional tear down method to close the connection at the end. | ||
KernelTestBase::vfsDump | protected | function | Dumps the current state of the virtual filesystem to STDOUT. | ||
KernelTestBase::__construct | public | function | |||
KernelTestBase::__sleep | public | function | Prevents serializing any properties. | ||
RandomGeneratorTrait::getRandomGenerator | protected | function | Gets the random generator for the utility methods. | ||
RandomGeneratorTrait::randomMachineName | protected | function | Generates a unique random string containing letters and numbers. | ||
RandomGeneratorTrait::randomObject | public | function | Generates a random PHP object. | ||
RandomGeneratorTrait::randomString | public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | ||
StorageCopyTrait::replaceStorageContents | protected static | function | Copy the configuration from one storage to another and remove stale items. | ||
TestRequirementsTrait::getDrupalRoot | protected static | function | Returns the Drupal root directory. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.