class MergeTermsConfirmTest in Term Merge 8
Tests the Merge terms confirm form.
@group term_merge
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses AssertContentTrait, AssertLegacyTrait, AssertHelperTrait, ConfigTestTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait
- class \Drupal\Tests\term_merge\Kernel\MergeTermsTestBase uses TaxonomyTestTrait
- class \Drupal\Tests\term_merge\Kernel\Form\MergeTermsConfirmTest
- class \Drupal\Tests\term_merge\Kernel\MergeTermsTestBase uses TaxonomyTestTrait
Expanded class hierarchy of MergeTermsConfirmTest
File
- tests/
src/ Kernel/ Form/ MergeTermsConfirmTest.php, line 17
Namespace
Drupal\Tests\term_merge\Kernel\FormView 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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AssertContentTrait:: |
protected | property | The current raw content. | |
AssertContentTrait:: |
protected | property | The drupalSettings value from the current raw $content. | |
AssertContentTrait:: |
protected | property | The XML structure parsed from the current raw $content. | 1 |
AssertContentTrait:: |
protected | property | The plain-text content of raw $content (text nodes). | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page by the given XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page with a given Xpath result. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is found. | |
AssertContentTrait:: |
protected | function | Asserts that each HTML ID is used for just a single element. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href is not found in the main region. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page does not exist. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the perl regex pattern is not found in raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text is NOT found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) does not contains the text. | |
AssertContentTrait:: |
protected | function | Pass if the page title is not the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option with the visible text exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) contains the text. | |
AssertContentTrait:: |
protected | function | Helper for assertText and assertNoText. | |
AssertContentTrait:: |
protected | function | Asserts that a Perl regex pattern is found in the plain-text content. | |
AssertContentTrait:: |
protected | function | Asserts themed output. | |
AssertContentTrait:: |
protected | function | Pass if the page title is the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Helper for assertUniqueText and assertNoUniqueText. | |
AssertContentTrait:: |
protected | function | Builds an XPath query. | |
AssertContentTrait:: |
protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |
AssertContentTrait:: |
protected | function | Searches elements using a CSS selector in the raw content. | |
AssertContentTrait:: |
protected | function | Get all option elements, including nested options, in a select. | |
AssertContentTrait:: |
protected | function | Gets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Gets the current raw content. | |
AssertContentTrait:: |
protected | function | Get the selected value from a select field. | |
AssertContentTrait:: |
protected | function | Retrieves the plain-text content from the current raw content. | |
AssertContentTrait:: |
protected | function | Get the current URL from the cURL handler. | 1 |
AssertContentTrait:: |
protected | function | Parse content returned from curlExec using DOM and SimpleXML. | |
AssertContentTrait:: |
protected | function | Removes all white-space between HTML tags from the raw content. | |
AssertContentTrait:: |
protected | function | Sets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Sets the raw content (e.g. HTML). | |
AssertContentTrait:: |
protected | function | Performs an xpath search on the contents of the internal browser. | |
AssertHelperTrait:: |
protected static | function | Casts MarkupInterface objects into strings. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead. | |
AssertLegacyTrait:: |
protected | function | ||
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
KernelTestBase:: |
protected | property | Back up and restore any global variables that may be changed by tests. | |
KernelTestBase:: |
protected | property | Back up and restore static class properties that may be changed by tests. | |
KernelTestBase:: |
protected | property | Contains a few static class properties for performance. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | @todo Move into Config test base class. | 7 |
KernelTestBase:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | Do not forward any global state from the parent process to the processes that run the actual tests. | |
KernelTestBase:: |
protected | property | The app root. | |
KernelTestBase:: |
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:: |
protected | property | ||
KernelTestBase:: |
protected | property | Set to TRUE to strict check all configuration saved. | 6 |
KernelTestBase:: |
protected | property | The virtual filesystem root directory. | |
KernelTestBase:: |
protected | function | 1 | |
KernelTestBase:: |
protected | function | Bootstraps a basic test environment. | |
KernelTestBase:: |
private | function | Bootstraps a kernel for a test. | |
KernelTestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
KernelTestBase:: |
protected | function | Disables modules for this test. | |
KernelTestBase:: |
protected | function | Enables modules for this test. | |
KernelTestBase:: |
protected | function | Gets the config schema exclusions for this test. | |
KernelTestBase:: |
protected | function | Returns the Database connection info to be used for this test. | 1 |
KernelTestBase:: |
public | function | ||
KernelTestBase:: |
private | function | Returns Extension objects for $modules to enable. | |
KernelTestBase:: |
private static | function | Returns the modules to enable for this test. | |
KernelTestBase:: |
protected | function | Initializes the FileCache component. | |
KernelTestBase:: |
protected | function | Installs default configuration for a given list of modules. | |
KernelTestBase:: |
protected | function | Installs the storage schema for a specific entity type. | |
KernelTestBase:: |
protected | function | Installs database tables from a module schema definition. | |
KernelTestBase:: |
protected | function | Returns whether the current test method is running in a separate process. | |
KernelTestBase:: |
protected | function | ||
KernelTestBase:: |
public | function |
Registers test-specific services. Overrides ServiceProviderInterface:: |
26 |
KernelTestBase:: |
protected | function | Renders a render array. | 1 |
KernelTestBase:: |
protected | function | Sets the install profile and rebuilds the container to update it. | |
KernelTestBase:: |
protected | function | Sets an in-memory Settings variable. | |
KernelTestBase:: |
public static | function | 1 | |
KernelTestBase:: |
protected | function | Sets up the filesystem, so things like the file directory. | 2 |
KernelTestBase:: |
protected | function | Stops test execution. | |
KernelTestBase:: |
protected | function | 6 | |
KernelTestBase:: |
public | function | @after | |
KernelTestBase:: |
protected | function | Dumps the current state of the virtual filesystem to STDOUT. | |
KernelTestBase:: |
public | function | BC: Automatically resolve former KernelTestBase class properties. | |
KernelTestBase:: |
public | function | Prevents serializing any properties. | |
MergeTermsConfirmTest:: |
private | function | Tests the confirm form build structure for a given set of taxonomy terms. | |
MergeTermsConfirmTest:: |
private | function | Tests a status message is available. | |
MergeTermsConfirmTest:: |
public | function | Tests the form build for the confirm form. | |
MergeTermsConfirmTest:: |
private | function | Creates the form class used for rendering the confirm form. | |
MergeTermsConfirmTest:: |
public | function | Tests an exception is thrown for for invalid target types. | |
MergeTermsConfirmTest:: |
protected | function |
Returns the number of terms that should be set up by the setUp function. Overrides MergeTermsTestBase:: |
|
MergeTermsConfirmTest:: |
public | function | Returns possible merge options that can be selected in the interface. | |
MergeTermsConfirmTest:: |
public | function |
Overrides MergeTermsTestBase:: |
|
MergeTermsConfirmTest:: |
public | function | Tests the correct method is invoked on the term merger after confirmation. | |
MergeTermsConfirmTest:: |
public | function | Tests the redirect after merging terms. | |
MergeTermsConfirmTest:: |
public | function | Tests a status message is displayed after merging terms. | |
MergeTermsConfirmTest:: |
public | function | Returns possible merge options that can be selected in the interface. | |
MergeTermsConfirmTest:: |
public | function | Tests the title callback for the confirm form. | |
MergeTermsTestBase:: |
protected | property | The entity type manager. | |
MergeTermsTestBase:: |
protected static | property |
Modules to enable. Overrides KernelTestBase:: |
1 |
MergeTermsTestBase:: |
protected | property | The tempstore factory. | |
MergeTermsTestBase:: |
protected | property | An array of taxonomy terms. | |
MergeTermsTestBase:: |
protected | property | A vocabulary for testing purposes. | |
MergeTermsTestBase:: |
protected | function | Asserts whether a given formState has its redirect set to a given route. | |
MergeTermsTestBase:: |
protected | function | Create a given amount of taxonomy terms. | |
MergeTermsTestBase:: |
public | function | Create a new vocabulary with random properties. | |
MergeTermsTestBase:: |
protected | function | Prepares the target provided by mergeTermFunctionsProvider for use. | |
PhpunitCompatibilityTrait:: |
public | function | Returns a mock object for the specified class using the available method. | |
PhpunitCompatibilityTrait:: |
public | function | Compatibility layer for PHPUnit 6 to support PHPUnit 4 code. | |
RandomGeneratorTrait:: |
protected | property | The random generator. | |
RandomGeneratorTrait:: |
protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait:: |
protected | function | Generates a unique random string containing letters and numbers. | 1 |
RandomGeneratorTrait:: |
public | function | Generates a random PHP object. | |
RandomGeneratorTrait:: |
public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
RandomGeneratorTrait:: |
public | function | Callback for random string validation. | |
StorageCopyTrait:: |
protected static | function | Copy the configuration from one storage to another and remove stale items. | |
TaxonomyTestTrait:: |
public | function | Returns a new term with random properties given a vocabulary. | |
TaxonomyTestTrait:: |
public | function | Returns a new vocabulary with random properties. Aliased as: traitCreateVocabulary | |
TestRequirementsTrait:: |
private | function | Checks missing module requirements. | |
TestRequirementsTrait:: |
protected | function | Check module requirements for the Drupal use case. | 1 |
TestRequirementsTrait:: |
protected static | function | Returns the Drupal root directory. |