class SaveDataTest in Drupal 8
Same name and namespace in other branches
- 9 core/modules/file/tests/src/Kernel/SaveDataTest.php \Drupal\Tests\file\Kernel\SaveDataTest
Tests the file_save_data() function.
@group file
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses AssertContentTrait, AssertLegacyTrait, AssertHelperTrait, ConfigTestTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait
- class \Drupal\Tests\file\Kernel\FileManagedUnitTestBase
- class \Drupal\Tests\file\Kernel\SaveDataTest
- class \Drupal\Tests\file\Kernel\FileManagedUnitTestBase
Expanded class hierarchy of SaveDataTest
File
- core/
modules/ file/ tests/ src/ Kernel/ SaveDataTest.php, line 14
Namespace
Drupal\Tests\file\KernelView source
class SaveDataTest extends FileManagedUnitTestBase {
/**
* Test the file_save_data() function when no filename is provided.
*/
public function testWithoutFilename() {
$contents = $this
->randomMachineName(8);
$result = file_save_data($contents);
$this
->assertNotFalse($result, 'Unnamed file saved correctly.');
$stream_wrapper_manager = \Drupal::service('stream_wrapper_manager');
assert($stream_wrapper_manager instanceof StreamWrapperManagerInterface);
$this
->assertEqual(\Drupal::config('system.file')
->get('default_scheme'), $stream_wrapper_manager::getScheme($result
->getFileUri()), "File was placed in Drupal's files directory.");
$this
->assertEqual($result
->getFilename(), \Drupal::service('file_system')
->basename($result
->getFileUri()), "Filename was set to the file's basename.");
$this
->assertEqual($contents, file_get_contents($result
->getFileUri()), 'Contents of the file are correct.');
$this
->assertEqual($result
->getMimeType(), 'application/octet-stream', '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()));
}
/**
* Test the file_save_data() function when a filename is provided.
*/
public function testWithFilename() {
$contents = $this
->randomMachineName(8);
// Using filename with non-latin characters.
$filename = 'Текстовый файл.txt';
$result = file_save_data($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
->assertEqual('public', $stream_wrapper_manager::getScheme($result
->getFileUri()), "File was placed in Drupal's files directory.");
$this
->assertEqual($filename, \Drupal::service('file_system')
->basename($result
->getFileUri()), 'File was named correctly.');
$this
->assertEqual($contents, file_get_contents($result
->getFileUri()), 'Contents of the file are correct.');
$this
->assertEqual($result
->getMimeType(), 'text/plain', '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()));
}
/**
* Test file_save_data() when renaming around an existing file.
*/
public function testExistingRename() {
// Setup a file to overwrite.
$existing = $this
->createFile();
$contents = $this
->randomMachineName(8);
$result = file_save_data($contents, $existing
->getFileUri(), FileSystemInterface::EXISTS_RENAME);
$this
->assertNotFalse($result, 'File saved successfully.');
$stream_wrapper_manager = \Drupal::service('stream_wrapper_manager');
assert($stream_wrapper_manager instanceof StreamWrapperManagerInterface);
$this
->assertEqual('public', $stream_wrapper_manager::getScheme($result
->getFileUri()), "File was placed in Drupal's files directory.");
$this
->assertEqual($result
->getFilename(), $existing
->getFilename(), 'Filename was set to the basename of the source, rather than that of the renamed file.');
$this
->assertEqual($contents, file_get_contents($result
->getFileUri()), 'Contents of the file are correct.');
$this
->assertEqual($result
->getMimeType(), 'application/octet-stream', '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()));
}
/**
* Test file_save_data() when replacing an existing file.
*/
public function testExistingReplace() {
// Setup a file to overwrite.
$existing = $this
->createFile();
$contents = $this
->randomMachineName(8);
$result = file_save_data($contents, $existing
->getFileUri(), FileSystemInterface::EXISTS_REPLACE);
$this
->assertNotFalse($result, 'File saved successfully.');
$stream_wrapper_manager = \Drupal::service('stream_wrapper_manager');
assert($stream_wrapper_manager instanceof StreamWrapperManagerInterface);
$this
->assertEqual('public', $stream_wrapper_manager::getScheme($result
->getFileUri()), "File was placed in Drupal's files directory.");
$this
->assertEqual($result
->getFilename(), $existing
->getFilename(), 'Filename was set to the basename of the existing file, rather than preserving the original name.');
$this
->assertEqual($contents, file_get_contents($result
->getFileUri()), 'Contents of the file are correct.');
$this
->assertEqual($result
->getMimeType(), 'application/octet-stream', '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()));
}
/**
* Test that file_save_data() fails overwriting an existing file.
*/
public function testExistingError() {
$contents = $this
->randomMachineName(8);
$existing = $this
->createFile(NULL, $contents);
// Check the overwrite error.
$result = file_save_data('asdf', $existing
->getFileUri(), FileSystemInterface::EXISTS_ERROR);
$this
->assertFalse($result, 'Overwriting a file fails when FileSystemInterface::EXISTS_ERROR is specified.');
$this
->assertEqual($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()));
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AssertContentTrait:: |
protected | property | The current raw content. | |
AssertContentTrait:: |
protected | property | The drupalSettings value from the current raw $content. | |
AssertContentTrait:: |
protected | property | The XML structure parsed from the current raw $content. | 1 |
AssertContentTrait:: |
protected | property | The plain-text content of raw $content (text nodes). | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page by the given XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page with a given Xpath result. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is found. | |
AssertContentTrait:: |
protected | function | Asserts that each HTML ID is used for just a single element. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href is not found in the main region. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page does not exist. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the perl regex pattern is not found in raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text is NOT found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) does not contains the text. | |
AssertContentTrait:: |
protected | function | Pass if the page title is not the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option with the visible text exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) contains the text. | |
AssertContentTrait:: |
protected | function | Helper for assertText and assertNoText. | |
AssertContentTrait:: |
protected | function | Asserts that a Perl regex pattern is found in the plain-text content. | |
AssertContentTrait:: |
protected | function | Asserts themed output. | |
AssertContentTrait:: |
protected | function | Pass if the page title is the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Helper for assertUniqueText and assertNoUniqueText. | |
AssertContentTrait:: |
protected | function | Builds an XPath query. | |
AssertContentTrait:: |
protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |
AssertContentTrait:: |
protected | function | Searches elements using a CSS selector in the raw content. | |
AssertContentTrait:: |
protected | function | Get all option elements, including nested options, in a select. | |
AssertContentTrait:: |
protected | function | Gets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Gets the current raw content. | |
AssertContentTrait:: |
protected | function | Get the selected value from a select field. | |
AssertContentTrait:: |
protected | function | Retrieves the plain-text content from the current raw content. | |
AssertContentTrait:: |
protected | function | Get the current URL from the cURL handler. | 1 |
AssertContentTrait:: |
protected | function | Parse content returned from curlExec using DOM and SimpleXML. | |
AssertContentTrait:: |
protected | function | Removes all white-space between HTML tags from the raw content. | |
AssertContentTrait:: |
protected | function | Sets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Sets the raw content (e.g. HTML). | |
AssertContentTrait:: |
protected | function | Performs an xpath search on the contents of the internal browser. | |
AssertHelperTrait:: |
protected static | function | Casts MarkupInterface objects into strings. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead. | |
AssertLegacyTrait:: |
protected | function | ||
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
FileManagedUnitTestBase:: |
public static | property |
Modules to enable. Overrides KernelTestBase:: |
|
FileManagedUnitTestBase:: |
public | function | Asserts that two files are not the same by comparing the fid and filepath. | |
FileManagedUnitTestBase:: |
public | function | Assert that a hook_file_* hook was called a certain number of times. | |
FileManagedUnitTestBase:: |
public | function | Assert that all of the specified hook_file_* hooks were called once, other values result in failure. | |
FileManagedUnitTestBase:: |
public | function | Asserts that two files have the same values (except timestamp). | |
FileManagedUnitTestBase:: |
public | function | Asserts that two files are the same by comparing the fid and filepath. | |
FileManagedUnitTestBase:: |
public | function | Create a file and save it to the files table and assert that it occurs correctly. | |
FileManagedUnitTestBase:: |
public | function | Creates a file and returns its URI. | |
FileManagedUnitTestBase:: |
protected | function |
Overrides KernelTestBase:: |
2 |
KernelTestBase:: |
protected | property | Back up and restore any global variables that may be changed by tests. | |
KernelTestBase:: |
protected | property | Back up and restore static class properties that may be changed by tests. | |
KernelTestBase:: |
protected | property | Contains a few static class properties for performance. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | @todo Move into Config test base class. | 7 |
KernelTestBase:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | Do not forward any global state from the parent process to the processes that run the actual tests. | |
KernelTestBase:: |
protected | property | The app root. | |
KernelTestBase:: |
protected | property | Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | Set to TRUE to strict check all configuration saved. | 6 |
KernelTestBase:: |
protected | property | The virtual filesystem root directory. | |
KernelTestBase:: |
protected | function | 1 | |
KernelTestBase:: |
protected | function | Bootstraps a basic test environment. | |
KernelTestBase:: |
private | function | Bootstraps a kernel for a test. | |
KernelTestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
KernelTestBase:: |
protected | function | Disables modules for this test. | |
KernelTestBase:: |
protected | function | Enables modules for this test. | |
KernelTestBase:: |
protected | function | Gets the config schema exclusions for this test. | |
KernelTestBase:: |
protected | function | Returns the Database connection info to be used for this test. | 1 |
KernelTestBase:: |
public | function | ||
KernelTestBase:: |
private | function | Returns Extension objects for $modules to enable. | |
KernelTestBase:: |
private static | function | Returns the modules to enable for this test. | |
KernelTestBase:: |
protected | function | Initializes the FileCache component. | |
KernelTestBase:: |
protected | function | Installs default configuration for a given list of modules. | |
KernelTestBase:: |
protected | function | Installs the storage schema for a specific entity type. | |
KernelTestBase:: |
protected | function | Installs database tables from a module schema definition. | |
KernelTestBase:: |
protected | function | Returns whether the current test method is running in a separate process. | |
KernelTestBase:: |
protected | function | ||
KernelTestBase:: |
public | function |
Registers test-specific services. Overrides ServiceProviderInterface:: |
26 |
KernelTestBase:: |
protected | function | Renders a render array. | 1 |
KernelTestBase:: |
protected | function | Sets the install profile and rebuilds the container to update it. | |
KernelTestBase:: |
protected | function | Sets an in-memory Settings variable. | |
KernelTestBase:: |
public static | function | 1 | |
KernelTestBase:: |
protected | function | Sets up the filesystem, so things like the file directory. | 2 |
KernelTestBase:: |
protected | function | Stops test execution. | |
KernelTestBase:: |
protected | function | 6 | |
KernelTestBase:: |
public | function | @after | |
KernelTestBase:: |
protected | function | Dumps the current state of the virtual filesystem to STDOUT. | |
KernelTestBase:: |
public | function | BC: Automatically resolve former KernelTestBase class properties. | |
KernelTestBase:: |
public | function | Prevents serializing any properties. | |
PhpunitCompatibilityTrait:: |
public | function | Returns a mock object for the specified class using the available method. | |
PhpunitCompatibilityTrait:: |
public | function | Compatibility layer for PHPUnit 6 to support PHPUnit 4 code. | |
RandomGeneratorTrait:: |
protected | property | The random generator. | |
RandomGeneratorTrait:: |
protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait:: |
protected | function | Generates a unique random string containing letters and numbers. | 1 |
RandomGeneratorTrait:: |
public | function | Generates a random PHP object. | |
RandomGeneratorTrait:: |
public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
RandomGeneratorTrait:: |
public | function | Callback for random string validation. | |
SaveDataTest:: |
public | function | Test that file_save_data() fails overwriting an existing file. | |
SaveDataTest:: |
public | function | Test file_save_data() when renaming around an existing file. | |
SaveDataTest:: |
public | function | Test file_save_data() when replacing an existing file. | |
SaveDataTest:: |
public | function | Test the file_save_data() function when a filename is provided. | |
SaveDataTest:: |
public | function | Test the file_save_data() function when no filename is provided. | |
StorageCopyTrait:: |
protected static | function | Copy the configuration from one storage to another and remove stale items. | |
TestRequirementsTrait:: |
private | function | Checks missing module requirements. | |
TestRequirementsTrait:: |
protected | function | Check module requirements for the Drupal use case. | 1 |
TestRequirementsTrait:: |
protected static | function | Returns the Drupal root directory. |