class FileCopyTest

Same name in this branch
  1. 11.x core/modules/migrate/tests/src/Unit/process/FileCopyTest.php \Drupal\Tests\migrate\Unit\process\FileCopyTest
  2. 11.x core/tests/Drupal/KernelTests/Core/File/FileCopyTest.php \Drupal\KernelTests\Core\File\FileCopyTest
Same name in other branches
  1. 7.x modules/simpletest/tests/file.test \FileCopyTest
  2. 9 core/modules/migrate/tests/src/Unit/process/FileCopyTest.php \Drupal\Tests\migrate\Unit\process\FileCopyTest
  3. 9 core/modules/migrate/tests/src/Kernel/process/FileCopyTest.php \Drupal\Tests\migrate\Kernel\process\FileCopyTest
  4. 9 core/tests/Drupal/KernelTests/Core/File/FileCopyTest.php \Drupal\KernelTests\Core\File\FileCopyTest
  5. 8.9.x core/modules/migrate/tests/src/Unit/process/FileCopyTest.php \Drupal\Tests\migrate\Unit\process\FileCopyTest
  6. 8.9.x core/modules/migrate/tests/src/Kernel/process/FileCopyTest.php \Drupal\Tests\migrate\Kernel\process\FileCopyTest
  7. 8.9.x core/tests/Drupal/KernelTests/Core/File/FileCopyTest.php \Drupal\KernelTests\Core\File\FileCopyTest
  8. 10 core/modules/migrate/tests/src/Unit/process/FileCopyTest.php \Drupal\Tests\migrate\Unit\process\FileCopyTest
  9. 10 core/modules/migrate/tests/src/Kernel/process/FileCopyTest.php \Drupal\Tests\migrate\Kernel\process\FileCopyTest
  10. 10 core/tests/Drupal/KernelTests/Core/File/FileCopyTest.php \Drupal\KernelTests\Core\File\FileCopyTest

Tests the file_copy process plugin.

@coversDefaultClass \Drupal\migrate\Plugin\migrate\process\FileCopy

@group migrate

Hierarchy

  • class \Drupal\Tests\migrate\Kernel\process\FileCopyTest extends \Drupal\KernelTests\Core\File\FileTestBase

Expanded class hierarchy of FileCopyTest

File

core/modules/migrate/tests/src/Kernel/process/FileCopyTest.php, line 23

Namespace

Drupal\Tests\migrate\Kernel\process
View source
class FileCopyTest extends FileTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'migrate',
        'system',
    ];
    
    /**
     * The file system service.
     *
     * @var \Drupal\Core\File\FileSystemInterface
     */
    protected $fileSystem;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->fileSystem = $this->container
            ->get('file_system');
        $this->container
            ->get('stream_wrapper_manager')
            ->registerWrapper('temporary', 'Drupal\\Core\\StreamWrapper\\TemporaryStream', StreamWrapperInterface::LOCAL_NORMAL);
    }
    
    /**
     * Tests successful imports/copies.
     */
    public function testSuccessfulCopies() : void {
        $file = $this->createUri(NULL, NULL, 'temporary');
        $file_absolute = $this->fileSystem
            ->realpath($file);
        $data_sets = [
            // Test a local to local copy.
[
                $this->root . '/core/tests/fixtures/files/image-test.jpg',
                'public://file1.jpg',
            ],
            // Test a temporary file using an absolute path.
[
                $file_absolute,
                'temporary://test.jpg',
            ],
            // Test a temporary file using a relative path.
[
                $file_absolute,
                'temporary://core/tests/fixtures/files/test.jpg',
            ],
        ];
        foreach ($data_sets as $data) {
            [
                $source_path,
                $destination_path,
            ] = $data;
            $actual_destination = $this->doTransform($source_path, $destination_path);
            $this->assertFileExists($destination_path);
            // Make sure we didn't accidentally do a move.
            $this->assertFileExists($source_path);
            $this->assertSame($actual_destination, $destination_path, 'The import returned the copied filename.');
        }
    }
    
    /**
     * Tests successful file reuse.
     *
     * @dataProvider providerSuccessfulReuse
     *
     * @param string $source_path
     *   Source path to copy from.
     * @param string $destination_path
     *   The destination path to copy to.
     */
    public function testSuccessfulReuse($source_path, $destination_path) : void {
        $file_reuse = $this->doTransform($source_path, $destination_path);
        clearstatcache(TRUE, $destination_path);
        $timestamp = (new \SplFileInfo($file_reuse))->getMTime();
        $this->assertIsInt($timestamp);
        // We need to make sure the modified timestamp on the file is sooner than
        // the attempted migration.
        sleep(1);
        $configuration = [
            'file_exists' => 'use existing',
        ];
        $this->doTransform($source_path, $destination_path, $configuration);
        clearstatcache(TRUE, $destination_path);
        $modified_timestamp = (new \SplFileInfo($destination_path))->getMTime();
        $this->assertEquals($timestamp, $modified_timestamp);
        $this->doTransform($source_path, $destination_path);
        clearstatcache(TRUE, $destination_path);
        $modified_timestamp = (new \SplFileInfo($destination_path))->getMTime();
        $this->assertGreaterThan($timestamp, $modified_timestamp);
    }
    
    /**
     * Provides the source and destination path files.
     */
    public static function providerSuccessfulReuse() {
        return [
            [
                'source_path' => static::getDrupalRoot() . '/core/tests/fixtures/files/image-test.jpg',
                'destination_path' => 'public://file1.jpg',
            ],
            [
                'source_path' => 'https://www.drupal.org/favicon.ico',
                'destination_path' => 'public://file2.jpg',
            ],
        ];
    }
    
    /**
     * Tests successful moves.
     */
    public function testSuccessfulMoves() : void {
        $file_1 = $this->createUri(NULL, NULL, 'temporary');
        $file_1_absolute = $this->fileSystem
            ->realpath($file_1);
        $file_2 = $this->createUri(NULL, NULL, 'temporary');
        $file_2_absolute = $this->fileSystem
            ->realpath($file_2);
        $local_file = $this->createUri(NULL, NULL, 'public');
        $data_sets = [
            // Test a local to local copy.
[
                $local_file,
                'public://file1.jpg',
            ],
            // Test a temporary file using an absolute path.
[
                $file_1_absolute,
                'temporary://test.jpg',
            ],
            // Test a temporary file using a relative path.
[
                $file_2_absolute,
                'temporary://core/tests/fixtures/files/test.jpg',
            ],
        ];
        foreach ($data_sets as $data) {
            [
                $source_path,
                $destination_path,
            ] = $data;
            $actual_destination = $this->doTransform($source_path, $destination_path, [
                'move' => TRUE,
            ]);
            $this->assertFileExists($destination_path);
            $this->assertFileDoesNotExist($source_path);
            $this->assertSame($actual_destination, $destination_path, 'The importer returned the moved filename.');
        }
    }
    
    /**
     * Tests that non-existent files throw an exception.
     */
    public function testNonExistentSourceFile() : void {
        $source = '/non/existent/file';
        $this->expectException(MigrateException::class);
        $this->expectExceptionMessage("File '/non/existent/file' does not exist");
        $this->doTransform($source, 'public://foo.jpg');
    }
    
    /**
     * Tests that non-writable destination throw an exception.
     *
     * @covers ::transform
     */
    public function testNonWritableDestination() : void {
        $source = $this->createUri('file.txt', NULL, 'temporary');
        // Create the parent location.
        $this->createDirectory('public://dir');
        // Copy the file under public://dir/subdir1/.
        $this->doTransform($source, 'public://dir/subdir1/file.txt');
        // Check that 'subdir1' was created and the file was successfully migrated.
        $this->assertFileExists('public://dir/subdir1/file.txt');
        // Remove all permissions from public://dir to trigger a failure when
        // trying to create a subdirectory 'subdir2' inside public://dir.
        $this->fileSystem
            ->chmod('public://dir', 0);
        // Check that the proper exception is raised.
        $this->expectException(MigrateException::class);
        $this->expectExceptionMessage("Could not create or write to directory 'public://dir/subdir2'");
        $this->doTransform($source, 'public://dir/subdir2/file.txt');
    }
    
    /**
     * Tests the 'rename' overwrite mode.
     */
    public function testRenameFile() : void {
        $source = $this->createUri(NULL, NULL, 'temporary');
        $destination = $this->createUri('foo.txt', NULL, 'public');
        $expected_destination = 'public://foo_0.txt';
        $actual_destination = $this->doTransform($source, $destination, [
            'file_exists' => 'rename',
        ]);
        $this->assertFileExists($expected_destination);
        $this->assertSame($actual_destination, $expected_destination, 'The importer returned the renamed filename.');
    }
    
    /**
     * Tests that remote URIs are delegated to the download plugin.
     */
    public function testDownloadRemoteUri() : void {
        $download_plugin = $this->createMock(MigrateProcessInterface::class);
        $download_plugin->expects($this->once())
            ->method('transform');
        $plugin = new FileCopy([], $this->randomMachineName(), [], $this->container
            ->get('stream_wrapper_manager'), $this->container
            ->get('file_system'), $download_plugin);
        $plugin->transform([
            'http://drupal.org/favicon.ico',
            '/destination/path',
        ], $this->createMock(MigrateExecutableInterface::class), new Row([], []), $this->randomMachineName());
    }
    
    /**
     * Do an import using the destination.
     *
     * @param string $source_path
     *   Source path to copy from.
     * @param string $destination_path
     *   The destination path to copy to.
     * @param array $configuration
     *   Process plugin configuration settings.
     *
     * @return string
     *   The URI of the copied file.
     */
    protected function doTransform($source_path, $destination_path, $configuration = []) {
        // Prepare a mock HTTP client.
        $this->container
            ->set('http_client', $this->createMock(Client::class));
        $plugin = FileCopy::create($this->container, $configuration, 'file_copy', []);
        $executable = $this->prophesize(MigrateExecutableInterface::class)
            ->reveal();
        $row = new Row([], []);
        return $plugin->transform([
            $source_path,
            $destination_path,
        ], $executable, $row, 'foo');
    }

}

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.
FileCopyTest::$fileSystem protected property The file system service.
FileCopyTest::$modules protected static property Overrides FileTestBase::$modules
FileCopyTest::doTransform protected function Do an import using the destination.
FileCopyTest::providerSuccessfulReuse public static function Provides the source and destination path files.
FileCopyTest::setUp protected function Overrides FileTestBase::setUp
FileCopyTest::testDownloadRemoteUri public function Tests that remote URIs are delegated to the download plugin.
FileCopyTest::testNonExistentSourceFile public function Tests that non-existent files throw an exception.
FileCopyTest::testNonWritableDestination public function Tests that non-writable destination throw an exception.
FileCopyTest::testRenameFile public function Tests the 'rename' overwrite mode.
FileCopyTest::testSuccessfulCopies public function Tests successful imports/copies.
FileCopyTest::testSuccessfulMoves public function Tests successful moves.
FileCopyTest::testSuccessfulReuse public function Tests successful file reuse.
FileTestBase::$classname protected property A fully-qualified stream wrapper class name to register for the test. 9
FileTestBase::$scheme protected property A stream wrapper scheme to register for the test. 9
FileTestBase::assertDirectoryPermissions public function Helper function to test the permissions of a directory.
FileTestBase::assertFilePermissions public function Helper function to test the permissions of a file.
FileTestBase::createDirectory public function Create a directory and assert it exists.
FileTestBase::createUri public function Create a file and return the URI of it.
FileTestBase::register public function Overrides KernelTestBase::register
FileTestBase::setUpFilesystem protected function Overrides KernelTestBase::setUpFilesystem
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::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::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.