You are here

class MergeTermsConfirmTest in Term Merge 8

Tests the Merge terms confirm form.

@group term_merge

Hierarchy

Expanded class hierarchy of MergeTermsConfirmTest

File

tests/src/Kernel/Form/MergeTermsConfirmTest.php, line 17

Namespace

Drupal\Tests\term_merge\Kernel\Form
View source
class MergeTermsConfirmTest extends MergeTermsTestBase {

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    parent::setUp();
    \Drupal::getContainer()
      ->set('term_merge.term_merger', new TermMergerDummy());
  }

  /**
   * Returns possible merge options that can be selected in the interface.
   *
   * @return array
   *   An array of options. Each option has contains the following values:
   *   - terms: an array of source taxonomy term ids.
   *   - target: a string representing the target taxonomy term.
   */
  public function selectedTermsProvider() {
    $testData['no terms new target'] = [
      'terms' => [],
      'target' => 'New term',
    ];
    $testData['no terms existing target'] = [
      'terms' => [],
      'target' => '',
    ];
    $testData['one term new target'] = [
      'terms' => [
        1,
      ],
      'target' => 'New term',
    ];
    $testData['one term existing target'] = [
      'terms' => [
        1,
      ],
      'target' => '',
    ];
    $testData['two terms new target'] = [
      'terms' => [
        1,
        2,
      ],
      'target' => 'New term',
    ];
    $testData['two terms existing target'] = [
      'terms' => [
        1,
        2,
      ],
      'target' => '',
    ];
    $testData['three terms new target'] = [
      'terms' => [
        1,
        2,
        3,
      ],
      'target' => 'New term',
    ];
    $testData['three terms existing target'] = [
      'terms' => [
        1,
        2,
        3,
      ],
      'target' => '',
    ];
    $testData['four terms new target'] = [
      'terms' => [
        1,
        2,
        3,
        4,
      ],
      'target' => 'New term',
    ];
    $testData['four terms existing target'] = [
      'terms' => [
        1,
        2,
        3,
        4,
      ],
      'target' => '',
    ];
    return $testData;
  }

  /**
   * Tests the title callback for the confirm form.
   *
   * @test
   * @dataProvider selectedTermsProvider
   */
  public function titleCallback(array $selectedTerms) {
    $sut = $this
      ->createSubjectUnderTest();
    $this->privateTempStoreFactory
      ->get('term_merge')
      ->set('terms', $selectedTerms);
    $expected = new TranslatableMarkup('Are you sure you wish to merge %termCount terms?', [
      '%termCount' => count($selectedTerms),
    ]);
    self::assertEquals($expected, $sut
      ->titleCallback());
  }

  /**
   * Tests the form build for the confirm form.
   *
   * @test
   * @dataProvider selectedTermsProvider
   */
  public function buildForm(array $selectedTerms, $target) {
    $target = $this
      ->prepareTarget($target);
    $sut = $this
      ->createSubjectUnderTest();
    $this->privateTempStoreFactory
      ->get('term_merge')
      ->set('terms', $selectedTerms);
    $this->privateTempStoreFactory
      ->get('term_merge')
      ->set('target', $target);
    $actual = $sut
      ->buildForm([], new FormState(), $this->vocabulary);
    if (empty($selectedTerms)) {
      self::assertEquals([], $actual);
      $this
        ->assertSingleErrorMessage(new TranslatableMarkup("You must submit at least one term."));
    }
    else {
      $this
        ->assertConfirmationForm($selectedTerms, $actual, $target);
    }
  }

  /**
   * Tests the confirm form build structure for a given set of taxonomy terms.
   *
   * @param \Drupal\taxonomy\TermInterface[] $selectedTerms
   *   An array of selected taxonomy terms.
   * @param array $actual
   *   The form structure.
   * @param \Drupal\taxonomy\Entity\Term|string $target
   *   A newly created term if the target was an empty string, the original
   *   string otherwise.
   */
  private function assertConfirmationForm(array $selectedTerms, array $actual, $target) {
    $items = [];
    foreach ($selectedTerms as $termIndex) {
      $items[] = $this->terms[$termIndex]
        ->label();
    }
    $arguments = [
      '%termCount' => count($selectedTerms),
      '%termName' => is_string($target) ? $target : $target
        ->label(),
    ];
    if (is_string($target)) {
      $message = new TranslatableMarkup("You are about to merge %termCount terms into new term %termName. This action can't be undone. Are you sure you wish to continue with merging the terms below?", $arguments);
    }
    else {
      $message = new TranslatableMarkup("You are about to merge %termCount terms into existing term %termName. This action can't be undone. Are you sure you wish to continue with merging the terms below?", $arguments);
    }
    $expected = [
      'message' => [
        '#markup' => $message,
      ],
      'terms' => [
        '#title' => new TranslatableMarkup("Terms to be merged"),
        '#theme' => 'item_list',
        '#items' => $items,
      ],
      'actions' => [
        '#type' => 'actions',
        'submit' => [
          '#button_type' => 'primary',
          '#type' => 'submit',
          '#value' => new TranslatableMarkup('Confirm merge'),
        ],
      ],
    ];
    self::assertEquals($expected, $actual);
  }

  /**
   * Tests a status message is available.
   *
   * @param string $expectedMessage
   *   The status message text.
   */
  private function assertSingleErrorMessage($expectedMessage) {
    $messages = \Drupal::messenger()
      ->all();
    $errorMessages = \Drupal::messenger()
      ->messagesByType('error');
    self::assertCount(1, $messages);
    self::assertEquals($expectedMessage, array_pop($errorMessages));
  }

  /**
   * Tests an exception is thrown for for invalid target types.
   */
  public function incorrectTargetThrowsException() {
    $this
      ->expectException('\\LogicException', 'Invalid target type. Should be string or implement TermInterface');
    $sut = $this
      ->createSubjectUnderTest();
    $this->privateTempStoreFactory
      ->get('term_merge')
      ->set('terms', [
      1,
      2,
    ]);
    $this->privateTempStoreFactory
      ->get('term_merge')
      ->set('target', (object) []);
    $formState = new FormState();
    $build = $sut
      ->buildForm([], $formState, $this->vocabulary);
    $sut
      ->submitForm($build, $formState);
  }

  /**
   * Returns possible merge options that can be selected in the interface.
   *
   * @return array
   *   An array of options. Each option has contains the following values:
   *   - methodName: the method name associated with the selected merge option.
   *   - target: a string representing the target taxonomy term.
   */
  public function termMergerMethodProvider() {
    $methods['new term'] = [
      'methodName' => 'mergeIntoNewTerm',
      'target' => 'New term',
    ];
    $methods['existing term'] = [
      'methodName' => 'mergeIntoTerm',
      'target' => '',
    ];
    return $methods;
  }

  /**
   * Tests the correct method is invoked on the term merger after confirmation.
   *
   * @test
   * @dataProvider termMergerMethodProvider
   */
  public function submitFormInvokesCorrectTermMergerMethod($methodName, $target) {
    $termMergerSpy = new TermMergerSpy();
    \Drupal::getContainer()
      ->set('term_merge.term_merger', $termMergerSpy);
    $sut = $this
      ->createSubjectUnderTest();
    $terms = [
      reset($this->terms)
        ->id(),
      end($this->terms)
        ->id(),
    ];
    $this->privateTempStoreFactory
      ->get('term_merge')
      ->set('terms', $terms);
    $this->privateTempStoreFactory
      ->get('term_merge')
      ->set('target', $this
      ->prepareTarget($target));
    $formState = new FormState();
    $build = $sut
      ->buildForm([], $formState, $this->vocabulary);
    $sut
      ->submitForm($build, $formState);
    self::assertEquals([
      $methodName,
    ], $termMergerSpy
      ->calledFunctions());
  }

  /**
   * Tests the redirect after merging terms.
   *
   * @test
   * @dataProvider termMergerMethodProvider
   */
  public function submitRedirectsToMergeRoute($methodName, $target) {
    $sut = $this
      ->createSubjectUnderTest();
    $terms = [
      reset($this->terms)
        ->id(),
      end($this->terms)
        ->id(),
    ];
    $this->privateTempStoreFactory
      ->get('term_merge')
      ->set('terms', $terms);
    $this->privateTempStoreFactory
      ->get('term_merge')
      ->set('target', $this
      ->prepareTarget($target));
    $formState = new FormState();
    $build = $sut
      ->buildForm([], $formState, $this->vocabulary);
    $sut
      ->submitForm($build, $formState);
    $routeName = 'entity.taxonomy_vocabulary.merge_form';
    self::assertRedirect($formState, $routeName, $this->vocabulary
      ->id());
  }

  /**
   * Tests a status message is displayed after merging terms.
   *
   * @test
   */
  public function submitSetsSuccessMessage() {
    $sut = $this
      ->createSubjectUnderTest();
    $terms = [
      reset($this->terms)
        ->id(),
      end($this->terms)
        ->id(),
    ];
    $this->privateTempStoreFactory
      ->get('term_merge')
      ->set('terms', $terms);
    $this->privateTempStoreFactory
      ->get('term_merge')
      ->set('target', 'Target');
    $formState = new FormState();
    $build = $sut
      ->buildForm([], $formState, $this->vocabulary);
    $sut
      ->submitForm($build, $formState);
    $arguments = [
      '%count' => 2,
      '%target' => 'Target',
    ];
    $expected = [
      new TranslatableMarkup('Successfully merged %count terms into %target', $arguments),
    ];
    self::assertEquals($expected, \Drupal::messenger()
      ->messagesByType('status'));
  }

  /**
   * Creates the form class used for rendering the confirm form.
   *
   * @return \Drupal\term_merge\Form\MergeTermsConfirm
   *   The form class used for rendering the confirm form.
   */
  private function createSubjectUnderTest() {
    return new MergeTermsConfirm($this->entityTypeManager, $this->privateTempStoreFactory, \Drupal::service('term_merge.term_merger'));
  }

  /**
   * {@inheritdoc}
   */
  protected function numberOfTermsToSetUp() {
    return 4;
  }

}

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.
MergeTermsConfirmTest::assertConfirmationForm private function Tests the confirm form build structure for a given set of taxonomy terms.
MergeTermsConfirmTest::assertSingleErrorMessage private function Tests a status message is available.
MergeTermsConfirmTest::buildForm public function Tests the form build for the confirm form.
MergeTermsConfirmTest::createSubjectUnderTest private function Creates the form class used for rendering the confirm form.
MergeTermsConfirmTest::incorrectTargetThrowsException public function Tests an exception is thrown for for invalid target types.
MergeTermsConfirmTest::numberOfTermsToSetUp protected function Returns the number of terms that should be set up by the setUp function. Overrides MergeTermsTestBase::numberOfTermsToSetUp
MergeTermsConfirmTest::selectedTermsProvider public function Returns possible merge options that can be selected in the interface.
MergeTermsConfirmTest::setUp public function Overrides MergeTermsTestBase::setUp
MergeTermsConfirmTest::submitFormInvokesCorrectTermMergerMethod public function Tests the correct method is invoked on the term merger after confirmation.
MergeTermsConfirmTest::submitRedirectsToMergeRoute public function Tests the redirect after merging terms.
MergeTermsConfirmTest::submitSetsSuccessMessage public function Tests a status message is displayed after merging terms.
MergeTermsConfirmTest::termMergerMethodProvider public function Returns possible merge options that can be selected in the interface.
MergeTermsConfirmTest::titleCallback public function Tests the title callback for the confirm form.
MergeTermsTestBase::$entityTypeManager protected property The entity type manager.
MergeTermsTestBase::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules 1
MergeTermsTestBase::$privateTempStoreFactory protected property The tempstore factory.
MergeTermsTestBase::$terms protected property An array of taxonomy terms.
MergeTermsTestBase::$vocabulary protected property A vocabulary for testing purposes.
MergeTermsTestBase::assertRedirect protected function Asserts whether a given formState has its redirect set to a given route.
MergeTermsTestBase::createTerms protected function Create a given amount of taxonomy terms.
MergeTermsTestBase::createVocabulary public function Create a new vocabulary with random properties.
MergeTermsTestBase::prepareTarget protected function Prepares the target provided by mergeTermFunctionsProvider for use.
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.
TaxonomyTestTrait::createTerm public function Returns a new term with random properties given a vocabulary.
TaxonomyTestTrait::createVocabulary public function Returns a new vocabulary with random properties. Aliased as: traitCreateVocabulary
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.