class MoveTest

Same name in other branches
  1. 8.9.x core/modules/file/tests/src/Kernel/MoveTest.php \Drupal\Tests\file\Kernel\MoveTest
  2. 10 core/modules/file/tests/src/Kernel/MoveTest.php \Drupal\Tests\file\Kernel\MoveTest
  3. 11.x core/modules/file/tests/src/Kernel/MoveTest.php \Drupal\Tests\file\Kernel\MoveTest

Tests the file move function.

@coversDefaultClass \Drupal\file\FileRepository @group file

Hierarchy

Expanded class hierarchy of MoveTest

File

core/modules/file/tests/src/Kernel/MoveTest.php, line 20

Namespace

Drupal\Tests\file\Kernel
View source
class MoveTest extends FileManagedUnitTestBase {
    
    /**
     * The file repository service under test.
     *
     * @var \Drupal\file\FileRepository
     */
    protected $fileRepository;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->fileRepository = $this->container
            ->get('file.repository');
    }
    
    /**
     * Move a normal file.
     *
     * @covers ::move
     */
    public function testNormal() {
        $contents = $this->randomMachineName(10);
        $source = $this->createFile(NULL, $contents);
        $desired_filepath = 'public://' . $this->randomMachineName();
        // Clone the object so we don't have to worry about the function changing
        // our reference copy.
        $result = $this->fileRepository
            ->move(clone $source, $desired_filepath, FileSystemInterface::EXISTS_ERROR);
        // Check the return status and that the contents changed.
        $this->assertNotFalse($result, 'File moved successfully.');
        $this->assertFileDoesNotExist($source->getFileUri());
        $this->assertEquals($contents, file_get_contents($result->getFileUri()), 'Contents of file correctly written.');
        // Check that the correct hooks were called.
        $this->assertFileHooksCalled([
            'move',
            'load',
            'update',
        ]);
        // Make sure we got the same file back.
        $this->assertEquals($source->id(), $result->id(), new FormattableMarkup("Source file id's' %fid is unchanged after move.", [
            '%fid' => $source->id(),
        ]));
        // Reload the file from the database and check that the changes were
        // actually saved.
        $loaded_file = File::load($result->id());
        $this->assertNotEmpty($loaded_file, 'File can be loaded from the database.');
        $this->assertFileUnchanged($result, $loaded_file);
    }
    
    /**
     * Tests renaming when moving onto a file that already exists.
     *
     * @covers ::move
     */
    public function testExistingRename() {
        // Setup a file to overwrite.
        $contents = $this->randomMachineName(10);
        $source = $this->createFile(NULL, $contents);
        $target = $this->createFile();
        $this->assertDifferentFile($source, $target);
        // Clone the object so we don't have to worry about the function changing
        // our reference copy.
        $result = $this->fileRepository
            ->move(clone $source, $target->getFileUri());
        // Check the return status and that the contents changed.
        $this->assertNotFalse($result, 'File moved successfully.');
        $this->assertFileDoesNotExist($source->getFileUri());
        $this->assertEquals($contents, file_get_contents($result->getFileUri()), 'Contents of file correctly written.');
        // Check that the correct hooks were called.
        $this->assertFileHooksCalled([
            'move',
            'load',
            'update',
        ]);
        // Compare the returned value to what made it into the database.
        $this->assertFileUnchanged($result, File::load($result->id()));
        // The target file should not have been altered.
        $this->assertFileUnchanged($target, File::load($target->id()));
        // Make sure we end up with two distinct files afterwards.
        $this->assertDifferentFile($target, $result);
        // Compare the source and results.
        $loaded_source = File::load($source->id());
        $this->assertEquals($result->id(), $loaded_source->id(), "Returned file's id matches the source.");
        $this->assertNotEquals($source->getFileUri(), $loaded_source->getFileUri(), 'Returned file path has changed from the original.');
    }
    
    /**
     * Tests replacement when moving onto a file that already exists.
     *
     * @covers ::move
     */
    public function testExistingReplace() {
        // Setup a file to overwrite.
        $contents = $this->randomMachineName(10);
        $source = $this->createFile(NULL, $contents);
        $target = $this->createFile();
        $this->assertDifferentFile($source, $target);
        // Clone the object so we don't have to worry about the function changing
        // our reference copy.
        $result = $this->fileRepository
            ->move(clone $source, $target->getFileUri(), FileSystemInterface::EXISTS_REPLACE);
        // Look at the results.
        $this->assertEquals($contents, file_get_contents($result->getFileUri()), 'Contents of file were overwritten.');
        $this->assertFileDoesNotExist($source->getFileUri());
        $this->assertNotEmpty($result, 'File moved successfully.');
        // Check that the correct hooks were called.
        $this->assertFileHooksCalled([
            'move',
            'update',
            'delete',
            'load',
        ]);
        // Reload the file from the database and check that the changes were
        // actually saved.
        $loaded_result = File::load($result->id());
        $this->assertFileUnchanged($result, $loaded_result);
        // Check that target was re-used.
        $this->assertSameFile($target, $loaded_result);
        // Source and result should be totally different.
        $this->assertDifferentFile($source, $loaded_result);
    }
    
    /**
     * Tests replacement when moving onto itself.
     *
     * @covers ::move
     */
    public function testExistingReplaceSelf() {
        // Setup a file to overwrite.
        $contents = $this->randomMachineName(10);
        $source = $this->createFile(NULL, $contents);
        // Copy the file over itself. Clone the object so we don't have to worry
        // about the function changing our reference copy.
        try {
            $result = $this->fileRepository
                ->move(clone $source, $source->getFileUri(), FileSystemInterface::EXISTS_ERROR);
            $this->fail('expected FileExistsException');
        } catch (FileExistsException $e) {
            // expected exception.
            $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($source->getFileUri()), 'Contents of file were not altered.');
        // Check that no hooks were called while failing.
        $this->assertFileHooksCalled([]);
        // Load the file from the database and make sure it is identical to what
        // was returned.
        $this->assertFileUnchanged($source, File::load($source->id()));
    }
    
    /**
     * Tests that moving onto an existing file fails when instructed to do so.
     *
     * @covers ::move
     */
    public function testExistingError() {
        $contents = $this->randomMachineName(10);
        $source = $this->createFile();
        $target = $this->createFile(NULL, $contents);
        $this->assertDifferentFile($source, $target);
        // Clone the object so we don't have to worry about the function changing
        // our reference copy.
        try {
            $result = $this->fileRepository
                ->move(clone $source, $target->getFileUri(), FileSystemInterface::EXISTS_ERROR);
            $this->fail('expected FileExistsException');
        } catch (FileExistsException $e) {
            // expected exception.
            $this->assertStringContainsString("could not be copied because a file by that name already exists in the destination directory", $e->getMessage());
        }
        // Check the return status and that the contents did not change.
        $this->assertFileExists($source->getFileUri());
        $this->assertEquals($contents, file_get_contents($target->getFileUri()), 'Contents of file were not altered.');
        // Check that no hooks were called while failing.
        $this->assertFileHooksCalled([]);
        // Load the file from the database and make sure it is identical to what
        // was returned.
        $this->assertFileUnchanged($source, File::load($source->id()));
        $this->assertFileUnchanged($target, File::load($target->id()));
    }
    
    /**
     * Tests for an invalid stream wrapper.
     *
     * @covers ::move
     */
    public function testInvalidStreamWrapper() {
        $this->expectException(InvalidStreamWrapperException::class);
        $this->expectExceptionMessage('Invalid stream wrapper: foo://');
        $source = $this->createFile();
        $this->fileRepository
            ->move($source, 'foo://');
    }
    
    /**
     * Tests for entity storage exception.
     *
     * @covers ::move
     */
    public function testEntityStorageException() {
        
        /** @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);
        $source = $this->createFile();
        $target = $this->createFile();
        $fileRepository->move($source, $target->getFileUri(), FileSystemInterface::EXISTS_REPLACE);
    }

}

Members

Title Sort descending Deprecated 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::getUrl protected function Get the current URL from the cURL handler. 1
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.
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated protected function
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.
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 enable. 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.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
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.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes
that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess 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::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 7
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 private function Bootstraps a kernel for a test.
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.
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. 3
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable 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 26
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. 3
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 5
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
MoveTest::$fileRepository protected property The file repository service under test.
MoveTest::setUp protected function Overrides FileManagedUnitTestBase::setUp
MoveTest::testEntityStorageException public function Tests for entity storage exception.
MoveTest::testExistingError public function Tests that moving onto an existing file fails when instructed to do so.
MoveTest::testExistingRename public function Tests renaming when moving onto a file that already exists.
MoveTest::testExistingReplace public function Tests replacement when moving onto a file that already exists.
MoveTest::testExistingReplaceSelf public function Tests replacement when moving onto itself.
MoveTest::testInvalidStreamWrapper public function Tests for an invalid stream wrapper.
MoveTest::testNormal public function Move a normal file.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
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. 1
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.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case.
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.