You are here

Home » API reference » Acquia Content Hub 8.2 » S3FileMapTest.php

class S3FileMapTest in Acquia Content Hub 8.2

Tests the S3FileMap.

@group acquia_contenthub_s3 @coversDefaultClass \Drupal\acquia_contenthub_s3\S3FileMap

@requires module depcalc @requires module s3fs

@package Drupal\Tests\acquia_contenthub_s3\Kernel

Hierarchy

Expanded class hierarchy of S3FileMapTest

File

modules/acquia_contenthub_s3/tests/src/Kernel/S3FileMapTest.php, line 18

Namespace

Drupal\Tests\acquia_contenthub_s3\Kernel
View source 
class S3FileMapTest extends S3FileKernelTestBase {
  use S3FileTestTrait;
  use S3FileMapTestTrait;

  /**
   * The s3 file map object to test.
   *
   * @var \Drupal\acquia_contenthub_s3\S3FileMap
   */
  protected $s3FileMap;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this->s3FileMap = new S3FileMap($this->container
      ->get('database'));
  }

  /**
   * @covers ::isNew
   */
  public function testIsNew() {
    $uuid = 'd2ded609-c7eb-4ca0-97cc-5bb0ddbbbf5a';
    $this
      ->assertTrue($this->s3FileMap
      ->isNew($uuid), 'Table does not contain the data.');
    $this->s3FileMap
      ->record($uuid, 'bucket', 'root_folder', '314d45d0-7b4b-4a46-860b-28f0258bb618');
    $this
      ->assertFalse($this->s3FileMap
      ->isNew($uuid), 'Table contains the data.');
  }

  /**
   * @covers ::record
   */
  public function testRecordDataValidity() {
    $valid = [
      'd2ded609-c7eb-4ca0-97cc-5bb0ddbbbf5a',
      'custom-bucket',
      'custom-root-folder',
      'd2ded609-c7eb-4ca0-97cc-5bb0ddbbbf55',
    ];
    $records = $this
      ->fetchAllData();
    $this
      ->assertCount(0, $records, 'Table is empty.');
    $this->s3FileMap
      ->record(...$valid);
    $records = $this
      ->fetchAllData();
    $this
      ->assertCount(1, $records, 'File was successfully recorded.');
    $invalid_uuid = [
      'd2ded609-c7eb-4ca0-97cc-5bb0ddbbbf5',
      'custom-bucket',
      'custom-root-folder',
      'd2ded609-c7eb-4ca0-97cc-5bb0ddbbbf55',
    ];
    $this
      ->expectException(\Exception::class);
    $this->s3FileMap
      ->record(...$invalid_uuid);
    $invalid_uuid = [
      'd2ded609-c7eb-4ca0-97cc-5bb0ddbbbf55',
      'custom-bucket',
      'custom-root-folder',
      'invalid',
    ];
    $this
      ->expectException(\InvalidArgumentException::class);
    $this->s3FileMap
      ->record(...$invalid_uuid);
  }

  /**
   * @covers ::record
   */
  public function testRecordUpdate() {
    $data = [
      'd2ded609-c7eb-4ca0-97cc-5bb0ddbbbf5a',
      'custom-bucket',
      'custom-root-folder',
      'd2ded609-c7eb-4ca0-97cc-5bb0ddbbbf55',
    ];
    $this->s3FileMap
      ->record(...$data);
    $updated = [
      'd2ded609-c7eb-4ca0-97cc-5bb0ddbbbf5a',
      'other-bucket',
      'other-root',
      '88e438dd-e7a3-4c08-b7a1-6158c404d30b',
    ];
    $this->s3FileMap
      ->record(...$updated);
    $records = $this
      ->fetchAllData();
    $this
      ->assertCount(1, $records, 'No new entry was added.');
    $this
      ->assertEqual($updated, array_values(current($records)), 'Data was successfully updated.');
  }

  /**
   * @covers ::remove
   */
  public function testRemove() {
    $data = [
      'd2ded609-c7eb-4ca0-97cc-5bb0ddbbbf5a',
      'custom-bucket',
      'custom-root-folder',
      'd2ded609-c7eb-4ca0-97cc-5bb0ddbbbf55',
    ];
    $this->s3FileMap
      ->record(...$data);
    $data2 = [
      'b553c81e-cc33-4f07-bce7-e4478332fe26',
      'custom-bucket',
      'custom-root-folder',
      'b553c81e-cc33-4f07-bce7-e4478332fe27',
    ];
    $this->s3FileMap
      ->record(...$data2);
    $this->s3FileMap
      ->remove('d2ded609-c7eb-4ca0-97cc-5bb0ddbbbf5a');
    $records = $this
      ->fetchAllData();
    $this
      ->assertCount(1, $records, 'Data was successfully deleted.');
    $this
      ->assertEqual($data2, array_values(current($records)), 'Non targeted data preserved');
  }

  /**
   * @covers ::getFileByUri
   */
  public function testGetFileByUri() {
    $file = $this
      ->createFileEntity('thelocation/test.jpg', 's3');
    $this->s3FileMap
      ->record($file
      ->uuid(), 'bucket', 'root_folder', '23623525-fb2f-4035-b5ca-a6d64e212ed9');
    $object = $this->s3FileMap
      ->getFileByUri($file
      ->getFileUri());
    $this
      ->assertInstanceOf('stdClass', $object, 'Returned data is of type stdClass.');
    $this
      ->assertEqual($object->uuid, $file
      ->uuid(), 'File uuid match.');
    $this
      ->assertEqual($object->bucket, 'bucket', 'Bucket match.');
    $this
      ->assertEqual($object->root_folder, 'root_folder', 'Root folder match.');
    $this
      ->assertEqual($object->origin_uuid, '23623525-fb2f-4035-b5ca-a6d64e212ed9', 'Origin uuid match.');
    $object = $this->s3FileMap
      ->getFileByUri('s3://non-existent-file.jpg');
    $this
      ->assertNull($object, 'Non existent file, return value is NULL.');
  }

  /**
   * @covers ::getFileByUuid
   */
  public function testGetFileByUuid() {
    $uuid = 'd2ded609-c7eb-4ca0-97cc-5bb0ddbbbf5a';
    $bucket = 'custom-bucket';
    $root = 'custom-root-folder';
    $origin = 'd2ded609-c7eb-4ca0-97cc-5bb0ddbbbf55';
    $this->s3FileMap
      ->record($uuid, $bucket, $root, $origin);
    $object = $this->s3FileMap
      ->getFileByUuid($uuid);
    $this
      ->assertInstanceOf('stdClass', $object, 'Returned data is of type stdClass.');
    $this
      ->assertEqual($object->file_uuid, $uuid, 'File uuid match.');
    $this
      ->assertEqual($object->bucket, $bucket, 'Bucket match.');
    $this
      ->assertEqual($object->root_folder, $root, 'Root folder match.');
    $this
      ->assertEqual($object->origin_uuid, $origin, 'Origin uuid match.');
    $object = $this->s3FileMap
      ->getFileByUuid('c0512f3c-f305-4dce-a114-6d47bcb051a4');
    $this
      ->assertNull($object, 'Non existent file, return value is NULL.');
  }

}

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.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose 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.
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. 1
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::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
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. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
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.
S3FileKernelTestBase::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules 4
S3FileMapTest::$s3FileMap protected property The s3 file map object to test.
S3FileMapTest::setUp protected function Overrides S3FileKernelTestBase::setUp
S3FileMapTest::testGetFileByUri public function @covers ::getFileByUri
S3FileMapTest::testGetFileByUuid public function @covers ::getFileByUuid
S3FileMapTest::testIsNew public function @covers ::isNew
S3FileMapTest::testRecordDataValidity public function @covers ::record
S3FileMapTest::testRecordUpdate public function @covers ::record
S3FileMapTest::testRemove public function @covers ::remove
S3FileMapTestTrait::fetchAllData protected function Returns every entry from S3FileMap table.
S3FileMapTestTrait::truncateS3FileMap protected function Clears s3 file map table.
S3FileTestTrait::assertCdfAttribute protected function Asserts CDF attribute values.
S3FileTestTrait::createFileEntity protected function Saves and returns a file entity based on the file name and scheme.
S3FileTestTrait::getFileFixture protected function Returns the contents of an arbitrary file fixture.
S3FileTestTrait::setS3fsConfig protected function Configures s3fs.settings.
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.