You are here

Home » API reference » Drupal 9 » UsageTest.php

class UsageTest in Drupal 9

Same name and namespace in other branches
  1. 8 core/modules/file/tests/src/Kernel/UsageTest.php \Drupal\Tests\file\Kernel\UsageTest

Tests file usage functions.

@group file

Hierarchy

Expanded class hierarchy of UsageTest

File

core/modules/file/tests/src/Kernel/UsageTest.php, line 18

Namespace

Drupal\Tests\file\Kernel
View source 
class UsageTest extends FileManagedUnitTestBase {

  /**
   * Tests \Drupal\file\FileUsage\DatabaseFileUsageBackend::listUsage().
   */
  public function testGetUsage() {
    $file = $this
      ->createFile();
    $connection = Database::getConnection();
    $connection
      ->insert('file_usage')
      ->fields([
      'fid' => $file
        ->id(),
      'module' => 'testing',
      'type' => 'foo',
      'id' => 1,
      'count' => 1,
    ])
      ->execute();
    $connection
      ->insert('file_usage')
      ->fields([
      'fid' => $file
        ->id(),
      'module' => 'testing',
      'type' => 'bar',
      'id' => 2,
      'count' => 2,
    ])
      ->execute();
    $usage = $this->container
      ->get('file.usage')
      ->listUsage($file);
    $this
      ->assertCount(2, $usage['testing'], 'Returned the correct number of items.');
    $this
      ->assertTrue(isset($usage['testing']['foo'][1]), 'Returned the correct id.');
    $this
      ->assertTrue(isset($usage['testing']['bar'][2]), 'Returned the correct id.');
    $this
      ->assertEquals(1, $usage['testing']['foo'][1], 'Returned the correct count.');
    $this
      ->assertEquals(2, $usage['testing']['bar'][2], 'Returned the correct count.');
  }

  /**
   * Tests \Drupal\file\FileUsage\DatabaseFileUsageBackend::add().
   */
  public function testAddUsage() {
    $file = $this
      ->createFile();
    $file_usage = $this->container
      ->get('file.usage');
    $file_usage
      ->add($file, 'testing', 'foo', 1);

    // Add the file twice to ensure that the count is incremented rather than
    // creating additional records.
    $file_usage
      ->add($file, 'testing', 'bar', 2);
    $file_usage
      ->add($file, 'testing', 'bar', 2);
    $usage = Database::getConnection()
      ->select('file_usage', 'f')
      ->fields('f')
      ->condition('f.fid', $file
      ->id())
      ->execute()
      ->fetchAllAssoc('id');
    $this
      ->assertCount(2, $usage, 'Created two records');
    $this
      ->assertEquals('testing', $usage[1]->module, 'Correct module');
    $this
      ->assertEquals('testing', $usage[2]->module, 'Correct module');
    $this
      ->assertEquals('foo', $usage[1]->type, 'Correct type');
    $this
      ->assertEquals('bar', $usage[2]->type, 'Correct type');
    $this
      ->assertEquals(1, $usage[1]->count, 'Correct count');
    $this
      ->assertEquals(2, $usage[2]->count, 'Correct count');
  }

  /**
   * Tests file usage deletion when files are made temporary.
   */
  public function testRemoveUsageTemporary() {
    $this
      ->config('file.settings')
      ->set('make_unused_managed_files_temporary', TRUE)
      ->save();
    $file = $this
      ->doTestRemoveUsage();
    $this
      ->assertTrue($file
      ->isTemporary());
  }

  /**
   * Tests file usage deletion when files are made temporary.
   */
  public function testRemoveUsageNonTemporary() {
    $this
      ->config('file.settings')
      ->set('make_unused_managed_files_temporary', FALSE)
      ->save();
    $file = $this
      ->doTestRemoveUsage();
    $this
      ->assertFalse($file
      ->isTemporary());
  }

  /**
   * Tests \Drupal\file\FileUsage\DatabaseFileUsageBackend::delete().
   */
  public function doTestRemoveUsage() {
    $file = $this
      ->createFile();
    $file
      ->setPermanent();
    $file_usage = $this->container
      ->get('file.usage');
    $connection = Database::getConnection();
    $connection
      ->insert('file_usage')
      ->fields([
      'fid' => $file
        ->id(),
      'module' => 'testing',
      'type' => 'bar',
      'id' => 2,
      'count' => 3,
    ])
      ->execute();

    // Normal decrement.
    $file_usage
      ->delete($file, 'testing', 'bar', 2);
    $count = $connection
      ->select('file_usage', 'f')
      ->fields('f', [
      'count',
    ])
      ->condition('f.fid', $file
      ->id())
      ->execute()
      ->fetchField();
    $this
      ->assertEquals(2, $count, 'The count was decremented correctly.');

    // Multiple decrement and removal.
    $file_usage
      ->delete($file, 'testing', 'bar', 2, 2);
    $count = $connection
      ->select('file_usage', 'f')
      ->fields('f', [
      'count',
    ])
      ->condition('f.fid', $file
      ->id())
      ->execute()
      ->fetchField();
    $this
      ->assertFalse($count, 'The count was removed entirely when empty.');

    // Non-existent decrement.
    $file_usage
      ->delete($file, 'testing', 'bar', 2);
    $count = $connection
      ->select('file_usage', 'f')
      ->fields('f', [
      'count',
    ])
      ->condition('f.fid', $file
      ->id())
      ->execute()
      ->fetchField();
    $this
      ->assertFalse($count, 'Decrementing non-exist record complete.');
    return $file;
  }

  /**
   * Create files for all the possible combinations of age and status.
   *
   * We are using UPDATE statements because using the API would set the
   * timestamp.
   */
  public function createTempFiles() {

    // Temporary file that is old.
    $temp_old = file_save_data('');
    $connection = Database::getConnection();
    $connection
      ->update('file_managed')
      ->fields([
      'status' => 0,
      'changed' => REQUEST_TIME - $this
        ->config('system.file')
        ->get('temporary_maximum_age') - 1,
    ])
      ->condition('fid', $temp_old
      ->id())
      ->execute();
    $this
      ->assertFileExists($temp_old
      ->getFileUri());

    // Temporary file that is new.
    $temp_new = file_save_data('');
    $connection
      ->update('file_managed')
      ->fields([
      'status' => 0,
    ])
      ->condition('fid', $temp_new
      ->id())
      ->execute();
    $this
      ->assertFileExists($temp_new
      ->getFileUri());

    // Permanent file that is old.
    $perm_old = file_save_data('');
    $connection
      ->update('file_managed')
      ->fields([
      'changed' => REQUEST_TIME - $this
        ->config('system.file')
        ->get('temporary_maximum_age') - 1,
    ])
      ->condition('fid', $temp_old
      ->id())
      ->execute();
    $this
      ->assertFileExists($perm_old
      ->getFileUri());

    // Permanent file that is new.
    $perm_new = file_save_data('');
    $this
      ->assertFileExists($perm_new
      ->getFileUri());
    return [
      $temp_old,
      $temp_new,
      $perm_old,
      $perm_new,
    ];
  }

  /**
   * Ensure that temporary files are removed by default.
   */
  public function testTempFileCleanupDefault() {
    list($temp_old, $temp_new, $perm_old, $perm_new) = $this
      ->createTempFiles();

    // Run cron and then ensure that only the old, temp file was deleted.
    $this->container
      ->get('cron')
      ->run();
    $this
      ->assertFileDoesNotExist($temp_old
      ->getFileUri());
    $this
      ->assertFileExists($temp_new
      ->getFileUri());
    $this
      ->assertFileExists($perm_old
      ->getFileUri());
    $this
      ->assertFileExists($perm_new
      ->getFileUri());
  }

  /**
   * Ensure that temporary files are kept as configured.
   */
  public function testTempFileNoCleanup() {
    list($temp_old, $temp_new, $perm_old, $perm_new) = $this
      ->createTempFiles();

    // Set the max age to 0, meaning no temporary files will be deleted.
    $this
      ->config('system.file')
      ->set('temporary_maximum_age', 0)
      ->save();

    // Run cron and then ensure that no file was deleted.
    $this->container
      ->get('cron')
      ->run();
    $this
      ->assertFileExists($temp_old
      ->getFileUri());
    $this
      ->assertFileExists($temp_new
      ->getFileUri());
    $this
      ->assertFileExists($perm_old
      ->getFileUri());
    $this
      ->assertFileExists($perm_new
      ->getFileUri());
  }

  /**
   * Ensure that temporary files are kept as configured.
   */
  public function testTempFileCustomCleanup() {
    list($temp_old, $temp_new, $perm_old, $perm_new) = $this
      ->createTempFiles();

    // Set the max age to older than default.
    $this
      ->config('system.file')
      ->set('temporary_maximum_age', 21600 + 2)
      ->save();

    // Run cron and then ensure that more files were deleted.
    $this->container
      ->get('cron')
      ->run();
    $this
      ->assertFileExists($temp_old
      ->getFileUri());
    $this
      ->assertFileExists($temp_new
      ->getFileUri());
    $this
      ->assertFileExists($perm_old
      ->getFileUri());
    $this
      ->assertFileExists($perm_new
      ->getFileUri());
  }

  /**
   * Tests file usage with translated entities.
   */
  public function testFileUsageWithEntityTranslation() {

    /** @var \Drupal\file\FileUsage\FileUsageInterface $file_usage */
    $file_usage = $this->container
      ->get('file.usage');
    $this
      ->enableModules([
      'node',
      'language',
    ]);
    $this
      ->installEntitySchema('node');
    $this
      ->installSchema('node', [
      'node_access',
    ]);

    // Activate English and Romanian languages.
    ConfigurableLanguage::create([
      'id' => 'en',
    ])
      ->save();
    ConfigurableLanguage::create([
      'id' => 'ro',
    ])
      ->save();
    NodeType::create([
      'type' => 'page',
    ])
      ->save();
    ContentLanguageSettings::loadByEntityTypeBundle('node', 'page')
      ->setLanguageAlterable(FALSE)
      ->setDefaultLangcode('en')
      ->save();

    // Create a file field attached to 'page' node-type.
    FieldStorageConfig::create([
      'type' => 'file',
      'entity_type' => 'node',
      'field_name' => 'file',
    ])
      ->save();
    FieldConfig::create([
      'entity_type' => 'node',
      'bundle' => 'page',
      'field_name' => 'file',
      'label' => 'File',
    ])
      ->save();

    // Create a node, attach a file and add a Romanian translation.
    $node = Node::create([
      'type' => 'page',
      'title' => 'Page',
    ]);
    $node
      ->set('file', $file = $this
      ->createFile())
      ->addTranslation('ro', $node
      ->getTranslation('en')
      ->toArray())
      ->save();

    // Check that the file is used twice.
    $usage = $file_usage
      ->listUsage($file);
    $this
      ->assertEquals(2, $usage['file']['node'][$node
      ->id()]);

    // Remove the Romanian translation.
    $node
      ->removeTranslation('ro');
    $node
      ->save();

    // Check that one usage has been removed and is used only once now.
    $usage = $file_usage
      ->listUsage($file);
    $this
      ->assertEquals(1, $usage['file']['node'][$node
      ->id()]);
  }

}

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. 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 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::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 Assert that all of the specified hook_file_* hooks were called once, other values result in failure.
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 Create a file and save it to the files table and assert that it occurs correctly.
FileManagedUnitTestBase::createUri public function Creates a file and returns its URI.
FileManagedUnitTestBase::setUp protected function Overrides KernelTestBase::setUp 2
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. 7
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::$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. 6
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::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 24
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 4
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.
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. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
UsageTest::createTempFiles public function Create files for all the possible combinations of age and status.
UsageTest::doTestRemoveUsage public function Tests \Drupal\file\FileUsage\DatabaseFileUsageBackend::delete().
UsageTest::testAddUsage public function Tests \Drupal\file\FileUsage\DatabaseFileUsageBackend::add().
UsageTest::testFileUsageWithEntityTranslation public function Tests file usage with translated entities.
UsageTest::testGetUsage public function Tests \Drupal\file\FileUsage\DatabaseFileUsageBackend::listUsage().
UsageTest::testRemoveUsageNonTemporary public function Tests file usage deletion when files are made temporary.
UsageTest::testRemoveUsageTemporary public function Tests file usage deletion when files are made temporary.
UsageTest::testTempFileCleanupDefault public function Ensure that temporary files are removed by default.
UsageTest::testTempFileCustomCleanup public function Ensure that temporary files are kept as configured.
UsageTest::testTempFileNoCleanup public function Ensure that temporary files are kept as configured.