You are here

Home » API reference » Zircon Profile 8 » EntityFileTest.php

class EntityFileTest in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/file/src/Tests/Migrate/EntityFileTest.php \Drupal\file\Tests\Migrate\EntityFileTest

Tests the entity file destination plugin.

@group file

Hierarchy

Expanded class hierarchy of EntityFileTest

File

core/modules/file/src/Tests/Migrate/EntityFileTest.php, line 23
Contains \Drupal\file\Tests\Migrate\EntityFileTest.

Namespace

Drupal\file\Tests\Migrate
View source 
class EntityFileTest extends KernelTestBase {

  /**
   * Modules to install.
   *
   * @var array
   */
  public static $modules = array(
    'system',
    'entity_test',
    'user',
    'file',
  );

  /**
   * @var \Drupal\file\Tests\Migrate\TestEntityFile $destination
   */
  protected $destination;

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    parent::setUp();
    $this->destination = new TestEntityFile([]);
    $this->destination->streamWrapperManager = \Drupal::getContainer()
      ->get('stream_wrapper_manager');
    $this->destination->fileSystem = \Drupal::getContainer()
      ->get('file_system');
    $this
      ->installEntitySchema('file');
    file_put_contents('/tmp/test-file.jpg', '');
  }

  /**
   * Test successful imports/copies.
   */
  public function testSuccessfulCopies() {
    foreach ($this
      ->localFileDataProvider() as $data) {
      list($row_values, $destination_path, $expected, $source_base_path) = $data;
      $this
        ->doImport($row_values, $destination_path, $source_base_path);
      $message = $expected ? sprintf('File %s exists', $destination_path) : sprintf('File %s does not exist', $destination_path);
      $this
        ->assertIdentical($expected, is_file($destination_path), $message);
    }
  }

  /**
   * The data provider for testing the file destination.
   *
   * @return array
   *   An array of file permutations to test.
   */
  protected function localFileDataProvider() {
    global $base_url;
    return [
      // Test a local to local copy.
      [
        [
          'filepath' => 'core/modules/simpletest/files/image-test.jpg',
        ],
        'public://file1.jpg',
        TRUE,
        DRUPAL_ROOT . '/',
      ],
      // Test a temporary file using an absolute path.
      [
        [
          'filepath' => '/tmp/test-file.jpg',
        ],
        'temporary://test.jpg',
        TRUE,
        '',
      ],
      // Test a temporary file using a relative path.
      [
        [
          'filepath' => 'test-file.jpg',
        ],
        'temporary://core/modules/simpletest/files/test.jpg',
        TRUE,
        '/tmp/',
      ],
      // Test a remote path to local.
      [
        [
          'filepath' => 'core/modules/simpletest/files/image-test.jpg',
        ],
        'public://remote-file.jpg',
        TRUE,
        $base_url . '/',
      ],
      // Test a remote path to local inside a folder that doesn't exist.
      [
        [
          'filepath' => 'core/modules/simpletest/files/image-test.jpg',
        ],
        'public://folder/remote-file.jpg',
        TRUE,
        DRUPAL_ROOT . '/',
      ],
    ];
  }

  /**
   * Test that non-existent files throw an exception.
   */
  public function testNonExistentSourceFile() {
    $destination = '/non/existent/file';
    try {

      // If this test passes, doImport() will raise a MigrateException and
      // we'll never reach fail().
      $this
        ->doImport([
        'filepath' => $destination,
      ], 'public://wontmatter.jpg');
      $this
        ->fail('Expected Drupal\\migrate\\MigrateException when importing ' . $destination);
    } catch (MigrateException $e) {
      $this
        ->assertIdentical($e
        ->getMessage(), "File '{$destination}' does not exist.");
    }
  }

  /**
   * Tests various invocations of the writeFile() method.
   */
  public function testWriteFile() {
    $plugin = $this->destination;
    $method = new \ReflectionMethod($plugin, 'writeFile');
    $method
      ->setAccessible(TRUE);
    touch('temporary://baz.txt');

    // Moving an actual file should return TRUE.
    $plugin->configuration['move'] = TRUE;
    $this
      ->assertTrue($method
      ->invoke($plugin, 'temporary://baz.txt', 'public://foo.txt'));

    // Trying to move a non-existent file should return FALSE.
    $this
      ->assertFalse($method
      ->invoke($plugin, 'temporary://invalid.txt', 'public://invalid.txt'));

    // Copying over a file that already exists should replace the existing file.
    $plugin->configuration['move'] = FALSE;
    touch('temporary://baz.txt');
    $this
      ->assertTrue($method
      ->invoke($plugin, 'temporary://baz.txt', 'public://foo.txt'));

    // Copying over a file that already exists should rename the resulting file
    // if FILE_EXISTS_RENAME is specified.
    $method
      ->invoke($plugin, 'temporary://baz.txt', 'public://foo.txt', FILE_EXISTS_RENAME);
    $this
      ->assertTrue(file_exists('public://foo_0.txt'));

    // Trying to copy a non-existent file should return FALSE.
    $this
      ->assertFalse($method
      ->invoke($plugin, 'temporary://invalid.txt', 'public://invalid.txt'));
  }

  /**
   * Tests various invocations of the getOverwriteMode() method.
   */
  public function testGetOverwriteMode() {
    $plugin = $this->destination;
    $method = new \ReflectionMethod($plugin, 'getOverwriteMode');
    $method
      ->setAccessible(TRUE);
    $row = new Row([], []);

    // If the plugin is not configured to rename the destination file, we should
    // always get FILE_EXISTS_REPLACE.
    $this
      ->assertIdentical(FILE_EXISTS_REPLACE, $method
      ->invoke($plugin, $row));

    // When the plugin IS configured to rename the destination file, it should
    // return FILE_EXISTS_RENAME if the destination entity already exists,
    // and FILE_EXISTS_REPLACE otherwise.
    $plugin->configuration['rename'] = TRUE;
    $plugin->storage = \Drupal::entityManager()
      ->getStorage('file');

    /** @var \Drupal\file\FileInterface $file */
    $file = $plugin->storage
      ->create();
    touch('public://foo.txt');
    $file
      ->setFileUri('public://foo.txt');
    $file
      ->save();
    $row
      ->setDestinationProperty($plugin->storage
      ->getEntityType()
      ->getKey('id'), $file
      ->id());
    $this
      ->assertIdentical(FILE_EXISTS_RENAME, $method
      ->invoke($plugin, $row));
    unlink('public://foo.txt');
  }

  /**
   * Tests various invocations of the getDirectory() method.
   */
  public function testGetDirectory() {
    $plugin = $this->destination;
    $method = new \ReflectionMethod($plugin, 'getDirectory');
    $method
      ->setAccessible(TRUE);
    $this
      ->assertEqual('public://foo', $method
      ->invoke($plugin, 'public://foo/baz.txt'));
    $this
      ->assertEqual('/path/to', $method
      ->invoke($plugin, '/path/to/foo.txt'));

    // A directory like public:// (no path) needs to resolve to a physical path.
    $fs = \Drupal::getContainer()
      ->get('file_system');
    $this
      ->assertEqual($fs
      ->realpath(Settings::get('file_public_path')), $method
      ->invoke($plugin, 'public://foo.txt'));
  }

  /**
   * Tests various invocations of the isLocationUnchanged() method.
   */
  public function testIsLocationUnchanged() {
    $plugin = $this->destination;
    $method = new \ReflectionMethod($plugin, 'isLocationUnchanged');
    $method
      ->setAccessible(TRUE);
    $public_dir = Settings::get('file_public_path');

    // Due to the limitations of realpath(), the source file must exist.
    touch('public://foo.txt');
    $this
      ->assertTrue($method
      ->invoke($plugin, $public_dir . '/foo.txt', 'public://foo.txt'));
    unlink('public://foo.txt');
    $temporary_file = '/tmp/foo.txt';
    touch($temporary_file);
    $this
      ->assertTrue($method
      ->invoke($plugin, $temporary_file, 'temporary://foo.txt'));
    unlink($temporary_file);
  }

  /**
   * Tests various invocations of the isLocalUri() method.
   */
  public function testIsLocalUri() {
    $plugin = $this->destination;
    $method = new \ReflectionMethod($plugin, 'isLocalUri');
    $method
      ->setAccessible(TRUE);
    $this
      ->assertTrue($method
      ->invoke($plugin, 'public://foo.txt'));
    $this
      ->assertTrue($method
      ->invoke($plugin, 'public://path/to/foo.txt'));
    $this
      ->assertTrue($method
      ->invoke($plugin, 'temporary://foo.txt'));
    $this
      ->assertTrue($method
      ->invoke($plugin, 'temporary://path/to/foo.txt'));
    $this
      ->assertTrue($method
      ->invoke($plugin, 'foo.txt'));
    $this
      ->assertTrue($method
      ->invoke($plugin, '/path/to/files/foo.txt'));
    $this
      ->assertTrue($method
      ->invoke($plugin, 'relative/path/to/foo.txt'));
    $this
      ->assertFalse($method
      ->invoke($plugin, 'http://www.example.com/foo.txt'));
  }

  /**
   * Do an import using the destination.
   *
   * @param array $row_values
   *   An array of row values.
   * @param string $destination_path
   *   The destination path to copy to.
   * @param string $source_base_path
   *   The source base path.
   * @return array
   *   An array of saved entities ids.
   *
   * @throws \Drupal\migrate\MigrateException
   */
  protected function doImport($row_values, $destination_path, $source_base_path = '') {
    $row = new Row($row_values, []);
    $row
      ->setDestinationProperty('uri', $destination_path);
    $this->destination->configuration['source_base_path'] = $source_base_path;

    // Importing asserts there are no errors, then we just check the file has
    // been copied into place.
    return $this->destination
      ->import($row, array());
  }

}

Members

Namesort descending Modifiers Type Description 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. 2
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 the raw text IS NOT found escaped on the 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::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.
AssertHelperTrait::castSafeStrings protected function Casts MarkupInterface objects into strings.
EntityFileTest::$destination protected property
EntityFileTest::$modules public static property Modules to install. Overrides KernelTestBase::$modules
EntityFileTest::doImport protected function Do an import using the destination.
EntityFileTest::localFileDataProvider protected function The data provider for testing the file destination.
EntityFileTest::setUp public function Performs setup tasks before each individual test method is run. Overrides KernelTestBase::setUp
EntityFileTest::testGetDirectory public function Tests various invocations of the getDirectory() method.
EntityFileTest::testGetOverwriteMode public function Tests various invocations of the getOverwriteMode() method.
EntityFileTest::testIsLocalUri public function Tests various invocations of the isLocalUri() method.
EntityFileTest::testIsLocationUnchanged public function Tests various invocations of the isLocationUnchanged() method.
EntityFileTest::testNonExistentSourceFile public function Test that non-existent files throw an exception.
EntityFileTest::testSuccessfulCopies public function Test successful imports/copies.
EntityFileTest::testWriteFile public function Tests various invocations of the writeFile() method.
KernelTestBase::$configDirectories protected property The configuration directories for this test run.
KernelTestBase::$keyValueFactory protected property A KeyValueMemoryFactory instance to use when building the container.
KernelTestBase::$moduleFiles private property
KernelTestBase::$streamWrappers protected property Array of registered stream wrappers.
KernelTestBase::$themeFiles private property
KernelTestBase::beforePrepareEnvironment protected function Act on global state information before the environment is altered for a test. Overrides TestBase::beforePrepareEnvironment
KernelTestBase::containerBuild public function Sets up the base service container for this test. 12
KernelTestBase::defaultLanguageData protected function Provides the data for setting the default language on the container. 1
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
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 a specific table from a module schema definition.
KernelTestBase::prepareConfigDirectories protected function Create and set new configuration directories. 1
KernelTestBase::registerStreamWrapper protected function Registers a stream wrapper for this test.
KernelTestBase::render protected function Renders a render array.
KernelTestBase::tearDown protected function Performs cleanup tasks after each individual test method has been run. Overrides TestBase::tearDown
KernelTestBase::__construct function Constructor for Test. Overrides TestBase::__construct
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.
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.
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
TestBase::$assertions protected property Assertions thrown in that test case.
TestBase::$configImporter protected property The config importer that can used in a test. 5
TestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestBase::$container protected property The dependency injection container used in the test.
TestBase::$databasePrefix protected property The database prefix of this test run.
TestBase::$dieOnFail public property Whether to die in case any test assertion fails.
TestBase::$httpAuthCredentials protected property HTTP authentication credentials (<username>:<password>).
TestBase::$httpAuthMethod protected property HTTP authentication method (specified as a CURLAUTH_* constant).
TestBase::$kernel protected property The DrupalKernel instance used in the test. 1
TestBase::$originalConf protected property The original configuration (variables), if available.
TestBase::$originalConfig protected property The original configuration (variables).
TestBase::$originalConfigDirectories protected property The original configuration directories.
TestBase::$originalContainer protected property The original container.
TestBase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
TestBase::$originalLanguage protected property The original language.
TestBase::$originalPrefix protected property The original database prefix when running inside Simpletest.
TestBase::$originalProfile protected property The original installation profile.
TestBase::$originalSessionName protected property The name of the session cookie of the test-runner.
TestBase::$originalSettings protected property The settings array.
TestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks. 1
TestBase::$originalSite protected property The site directory of the original parent site.
TestBase::$originalUser protected property The original user, before testing began. 1
TestBase::$privateFilesDirectory protected property The private file directory for the test environment.
TestBase::$publicFilesDirectory protected property The public file directory for the test environment.
TestBase::$results public property Current results of this test case.
TestBase::$siteDirectory protected property The site directory of this test run.
TestBase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
TestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
TestBase::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestBase::$testId protected property The test run ID.
TestBase::$timeLimit protected property Time limit for the test.
TestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
TestBase::$verbose public property TRUE if verbose debugging is enabled.
TestBase::$verboseClassName protected property Safe class name for use in verbose output filenames.
TestBase::$verboseDirectory protected property Directory where verbose output files are put.
TestBase::$verboseDirectoryUrl protected property URL to the verbose output file directory.
TestBase::$verboseId protected property Incrementing identifier for verbose output filenames.
TestBase::assert protected function Internal helper: stores the assert.
TestBase::assertEqual protected function Check to see if two values are equal.
TestBase::assertErrorLogged protected function Asserts that a specific error has been logged to the PHP error log.
TestBase::assertFalse protected function Check to see if a value is false.
TestBase::assertIdentical protected function Check to see if two values are identical.
TestBase::assertIdenticalObject protected function Checks to see if two objects are identical.
TestBase::assertNoErrorsLogged protected function Asserts that no errors have been logged to the PHP error.log thus far.
TestBase::assertNotEqual protected function Check to see if two values are not equal.
TestBase::assertNotIdentical protected function Check to see if two values are not identical.
TestBase::assertNotNull protected function Check to see if a value is not NULL.
TestBase::assertNull protected function Check to see if a value is NULL.
TestBase::assertTrue protected function Check to see if a value is not false.
TestBase::changeDatabasePrefix private function Changes the database connection to the prefixed one.
TestBase::checkRequirements protected function Checks the matching requirements for Test. 2
TestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
TestBase::configImporter public function Returns a ConfigImporter object to import test importing of configuration. 5
TestBase::copyConfig public function Copies configuration objects from source storage to target storage.
TestBase::deleteAssert public static function Delete an assertion record by message ID.
TestBase::error protected function Fire an error assertion. 3
TestBase::errorHandler public function Handle errors during test runs.
TestBase::exceptionHandler protected function Handle exceptions.
TestBase::fail protected function Fire an assertion that is always negative.
TestBase::filePreDeleteCallback public static function Ensures test files are deletable within file_unmanaged_delete_recursive().
TestBase::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
TestBase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
TestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestBase::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestBase::getDatabasePrefix public function Gets the database prefix.
TestBase::getTempFilesDirectory public function Gets the temporary files directory.
TestBase::insertAssert public static function Store an assertion from outside the testing context.
TestBase::pass protected function Fire an assertion that is always positive.
TestBase::prepareDatabasePrefix private function Generates a database prefix for running tests.
TestBase::prepareEnvironment private function Prepares the current environment for running the test.
TestBase::restoreEnvironment private function Cleans up the test environment and restores the original environment.
TestBase::run public function Run all tests in this class. 1
TestBase::settingsSet protected function Changes in memory settings.
TestBase::storeAssertion protected function Helper method to store an assertion record in the configured database.
TestBase::verbose protected function Logs a verbose message in a text file.