You are here

Home » API reference » GatherContent 8.4 » ContentProcessorTest.php

class ContentProcessorTest in GatherContent 8.4

Class for testing core node import functionality.

  • basic fields import.
  • paragraph fields import.
  • entity translation import.
  • metatag import.
  • paragraph taxonomy term import.

@group gathercontent

Hierarchy

Expanded class hierarchy of ContentProcessorTest

File

tests/src/Kernel/ContentProcessorTest.php, line 28

Namespace

Drupal\Tests\gathercontent\Kernel
View source 
class ContentProcessorTest extends GcImportTestBase {

  /**
   * Data provider for createNodeTest.
   *
   * Unfortunately real data providers get called before any other method.
   *
   * I couldn't find a better way to generate test cases
   * based on the bootstrapped Drupal installation (done in setUp)
   * than creating my own "data provider" like test function.
   */
  public function testCreateNode() {
    $mapping = MockData::getMapping();
    $item = MockData::createItem($mapping, [
      TRUE,
      FALSE,
      TRUE,
    ], [
      TRUE,
      FALSE,
      FALSE,
    ]);
    $importOptions = new ImportOptions(NodeUpdateMethod::ALWAYS_CREATE);
    $cases = [
      'no checkboxes, no radioboxes' => [
        MockData::createItem($mapping, [
          FALSE,
          FALSE,
          FALSE,
        ], [
          FALSE,
          FALSE,
          FALSE,
        ]),
        $importOptions,
        [],
      ],
      'no checkboxes, 1 radiobox' => [
        MockData::createItem($mapping, [
          FALSE,
          FALSE,
          FALSE,
        ], [
          TRUE,
          FALSE,
          FALSE,
        ]),
        $importOptions,
        [],
      ],
      'no checkboxes, 3 radioboxes' => [
        MockData::createItem($mapping, [
          FALSE,
          FALSE,
          FALSE,
        ], [
          TRUE,
          TRUE,
          TRUE,
        ]),
        $importOptions,
        [],
      ],
      'all checkboxes, no radioboxes' => [
        MockData::createItem($mapping, [
          TRUE,
          TRUE,
          TRUE,
        ], [
          FALSE,
          FALSE,
          FALSE,
        ]),
        $importOptions,
        [],
      ],
      '1 file' => [
        $item,
        $importOptions,
        MockData::createFile($item),
      ],
      '3 files' => [
        $item,
        $importOptions,
        MockData::createFile($item) + MockData::createFile($item) + MockData::createFile($item),
      ],
    ];
    foreach ($cases as $caseName => $params) {
      print $caseName . PHP_EOL;
      call_user_func_array([
        static::class,
        'createNodeTest',
      ], $params);
    }
  }

  /**
   * Test if entities are created correctly based on GC Items.
   */
  public static function createNodeTest(Item $gcItem, ImportOptions $importOptions, array $files) {
    $operation = Operation::create([
      'type' => 'import',
    ]);
    $importOptions
      ->setOperationUuid($operation
      ->uuid());
    $node = static::getProcessor()
      ->createNode($gcItem, $importOptions, $files);
    $node
      ->save();
    static::assertNodeEqualsGcItem($node
      ->getTranslation('en'), $gcItem, $files);
  }

  /**
   * Checks whether a node and a GC item contains the same data.
   */
  public static function assertNodeEqualsGcItem(NodeInterface $node, Item $gcItem, array $files) {

    /** @var \Drupal\gathercontent\Entity\Mapping $mapping */
    $mapping = MappingLoader::load($gcItem);
    $tabs = unserialize($mapping
      ->getData());
    $metatagTab = $tabs[MockData::METATAG_TAB]['elements'];
    unset($tabs[MockData::METATAG_TAB]);
    $fields = $node
      ->toArray();
    $translation = $node
      ->getTranslation('hu');
    $translatedFields = $translation
      ->toArray();
    foreach ($tabs as $tabId => $tab) {

      /** @var \Cheppers\GatherContent\DataTypes\Element[] $elements */
      $elements = $gcItem->config[$tabId]->elements;
      $itemMapping = $tab['elements'];
      foreach ($itemMapping as $gcId => $fieldId) {
        $ids = explode('||', $fieldId);
        $filesMatchingThisElement = array_filter($files, function ($file) use ($gcId) {
          return $file->field == $gcId;
        });
        if (count($ids) > 1) {

          // Paragraph.
          if ($tabId === MockData::TRANSLATED_TAB) {
            $field = static::loadFieldFromNode($translation, $ids, $tab['language']);
            static::assertFieldEqualsElement($field, $elements[$gcId], $filesMatchingThisElement);
          }
          else {
            $field = static::loadFieldFromNode($node, $ids, $tab['language']);
            static::assertFieldEqualsElement($field, $elements[$gcId], $filesMatchingThisElement);
          }
        }
        else {
          if ($fieldId === 'title') {
            static::assertTranslatedEquals($node
              ->getTitle(), $translation
              ->getTitle());
            static::assertEquals($node
              ->getTitle(), $gcItem->name);
          }
          else {

            // Basic fields.
            if ($tabId === MockData::TRANSLATED_TAB) {
              $fieldName = explode('.', $fieldId)[2];
              static::assertFieldEqualsElement($translatedFields[$fieldName], $elements[$gcId], $filesMatchingThisElement);
            }
            else {
              $fieldName = explode('.', $fieldId)[2];
              static::assertFieldEqualsElement($fields[$fieldName], $elements[$gcId], $filesMatchingThisElement);
            }
          }
        }
      }
    }

    // Metatags.
    $insertedMetatags = unserialize(reset($fields[MockData::METATAG_FIELD])['value']);
    $metatagElements = $gcItem->config[MockData::METATAG_TAB]->elements;
    foreach ($metatagTab as $gcId => $fieldName) {
      static::assertEquals($metatagElements[$gcId]->value, $insertedMetatags[$fieldName], 'Metatag was inserted incorrectly.');
    }
  }

  /**
   * Function for asserting that a translated value matches the original one.
   */
  public static function assertTranslatedEquals($original, $translated) {
    static::assertEquals($translated, $original . ' translated');
  }

  /**
   * Read field from id like "node.mytype.myfiled||paragraph.myptype.mypfield".
   */
  public static function loadFieldFromNode(NodeInterface $node, array $ids, $language) {
    if (count($ids) == 1) {
      throw new \InvalidArgumentException('"$ids" is not a nested id');
    }
    $currentEntity = $node;
    for ($i = 0; $i < count($ids) - 1; $i++) {
      $currentFieldName = explode('.', $ids[$i])[2];
      $value = $currentEntity
        ->get($currentFieldName)
        ->getValue();
      $targetField = reset($value);
      $currentEntity = Paragraph::load($targetField['target_id']);
    }
    $lastFieldName = explode('.', end($ids))[2];
    $currentEntity = $currentEntity
      ->getTranslation($language);
    return $currentEntity
      ->toArray()[$lastFieldName];
  }

  /**
   * Assertion for Drupal field and GC element.
   */
  public static function assertFieldEqualsElement(array $field, Element $element, array $files) {
    switch ($element->type) {
      case 'text':
        static::assertEquals($element->value, reset($field)['value']);
        break;
      case 'section':
        $section = '<h3>' . $element->title . '</h3>' . $element->subtitle;
        static::assertEquals($section, reset($field)['value']);
        break;
      case 'files':
        static::assertFileFieldEqualsResponseFiles($field, $files);
        break;
      case 'choice_checkbox':
        static::assertCheckboxFieldEqualsOptions($field, $element->options);
        break;
      case 'choice_radio':
        static::assertRadioFieldEqualsOptions($field, $element->options);
        break;
      default:
        throw new \Exception("Unexpected element type: {$element->type}");
    }
  }

  /**
   * Assertion for file elements.
   */
  public static function assertFileFieldEqualsResponseFiles(array $field, array $files) {

    // No files attached to GC item.
    if (empty($files)) {
      static::assertEmpty($field, 'No files should be inserted.');
      return;
    }

    // Always insert the latest file gotten from API.
    static::assertEquals(1, count($field), 'There must only be one image in the field.');
    $fileId = reset($field)['target_id'];
    $fileField = File::load($fileId);
    static::assertNotNull($fileField, 'File was not saved.');

    /** @var \Cheppers\GatherContent\DataTypes\File $fileResponse */
    $fileResponse = end($files);
    static::assertEquals($fileResponse->url, $fileField
      ->get('uri')
      ->getValue()[0]['value'], 'Incorrect field value.');
    static::assertEquals($fileResponse->id, $fileField
      ->get('gc_id')
      ->getValue()[0]['value'], 'Incorrect field value.');
    static::assertEquals($fileResponse->fileName, $fileField
      ->get('filename')
      ->getValue()[0]['value'], 'Incorrect field value.');
  }

  /**
   * Assertion for checkbox elements.
   */
  public static function assertCheckboxFieldEqualsOptions(array $field, array $options) {
    $termIds = array_map(function ($fieldTerm) {
      return $fieldTerm['target_id'];
    }, $field);
    $terms = Term::loadMultiple($termIds);
    foreach ($options as $option) {
      $termsMatchingThisOption = array_filter($terms, function ($term) use ($option) {
        $termOptionIdsMatchingThisOption = array_filter($term
          ->get('gathercontent_option_ids')
          ->getValue(), function ($optionId) use ($option) {
          return $optionId['value'] === $option['name'];
        });
        $isSameOptionId = 1 === count($termOptionIdsMatchingThisOption);
        $isSameName = $term
          ->get('name')
          ->getValue()[0]['value'] == $option['label'];
        $isCheckboxTaxonomy = $term
          ->get('vid')
          ->getValue()[0]['target_id'] === MockData::CHECKBOX_TAXONOMY_NAME;
        return $isSameOptionId && $isSameName && $isCheckboxTaxonomy;
      });
      if ($option['selected']) {
        static::assertEquals(1, count($termsMatchingThisOption), 'Term was not imported correctly.');
      }
      else {
        static::assertEmpty($termsMatchingThisOption, 'Term should not be imported.');
      }
    }
  }

  /**
   * Assertion for radio elements.
   */
  public static function assertRadioFieldEqualsOptions(array $field, array $options) {
    $selectedOptions = array_filter($options, function ($option) {
      return $option['selected'];
    });

    // No radios selected.
    if (empty($field)) {
      static::assertEmpty($selectedOptions, "No taxonomy term inserted in node.\nExpected radio item:\n" . print_r($selectedOptions, TRUE));
      return;
    }
    static::assertEquals(1, count($field), 'There must only be one radio taxonomy term imported.');
    $termId = reset($field)['target_id'];
    static::assertTrue(is_string($termId), 'Term id should be a string, but it is a(n) "' . gettype($termId) . '".');
    $term = Term::load($termId);
    static::assertEquals(MockData::RADIO_TAXONOMY_NAME, $term
      ->get('vid')
      ->getValue()[0]['target_id'], 'Term was imported in the wrong taxonomy.');
    static::assertNotEmpty($selectedOptions, 'No taxonomy term should be imported.');
    $optionsMatchingThisTerm = array_filter($selectedOptions, function ($option) use ($term) {
      $isSameName = $term
        ->get('name')
        ->getValue()[0]['value'] == $option['label'];
      $termOptionIdsMatchingThisOption = array_filter($term
        ->get('gathercontent_option_ids')
        ->getValue(), function ($optionId) use ($option) {
        return $optionId['value'] === $option['name'];
      });
      $isSameOptionId = 1 === count($termOptionIdsMatchingThisOption);
      return $isSameName && $isSameOptionId;
    });
    static::assertEquals(1, count($optionsMatchingThisTerm), 'Term was incorrectly imported.');
  }

}

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.
ContentProcessorTest::assertCheckboxFieldEqualsOptions public static function Assertion for checkbox elements.
ContentProcessorTest::assertFieldEqualsElement public static function Assertion for Drupal field and GC element.
ContentProcessorTest::assertFileFieldEqualsResponseFiles public static function Assertion for file elements.
ContentProcessorTest::assertNodeEqualsGcItem public static function Checks whether a node and a GC item contains the same data.
ContentProcessorTest::assertRadioFieldEqualsOptions public static function Assertion for radio elements.
ContentProcessorTest::assertTranslatedEquals public static function Function for asserting that a translated value matches the original one.
ContentProcessorTest::createNodeTest public static function Test if entities are created correctly based on GC Items.
ContentProcessorTest::loadFieldFromNode public static function Read field from id like "node.mytype.myfiled||paragraph.myptype.mypfield".
ContentProcessorTest::testCreateNode public function Data provider for createNodeTest.
GcImportTestBase::$modules public static property Modules to enable. Overrides KernelTestBase::$modules
GcImportTestBase::getClient public static function Get singleton Mock client.
GcImportTestBase::getImporter public static function Get singleton Importer injected with mock object.
GcImportTestBase::getMetatag public static function Get singleton MetatagQuery object.
GcImportTestBase::getProcessor public static function Get singleton ContentProcessor injected with mock object.
GcImportTestBase::setUp protected function Overrides KernelTestBase::setUp
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.
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.