class TermKernelTest

Same name in other branches
  1. 9 core/modules/taxonomy/tests/src/Kernel/TermKernelTest.php \Drupal\Tests\taxonomy\Kernel\TermKernelTest
  2. 8.9.x core/modules/taxonomy/tests/src/Kernel/TermKernelTest.php \Drupal\Tests\taxonomy\Kernel\TermKernelTest
  3. 11.x core/modules/taxonomy/tests/src/Kernel/TermKernelTest.php \Drupal\Tests\taxonomy\Kernel\TermKernelTest

Kernel tests for taxonomy term functions.

@group taxonomy

Hierarchy

Expanded class hierarchy of TermKernelTest

File

core/modules/taxonomy/tests/src/Kernel/TermKernelTest.php, line 17

Namespace

Drupal\Tests\taxonomy\Kernel
View source
class TermKernelTest extends KernelTestBase {
    use TaxonomyTestTrait;
    use UserCreationTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'filter',
        'taxonomy',
        'text',
        'user',
        'system',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->installConfig([
            'filter',
        ]);
        $this->installEntitySchema('taxonomy_term');
        $this->installEntitySchema('user');
    }
    
    /**
     * Tests that a deleted term is no longer in the vocabulary.
     */
    public function testTermDelete() : void {
        $vocabulary = $this->createVocabulary();
        $valid_term = $this->createTerm($vocabulary);
        // Delete a valid term.
        $valid_term->delete();
        $terms = \Drupal::entityTypeManager()->getStorage('taxonomy_term')
            ->loadByProperties([
            'vid' => $vocabulary->id(),
        ]);
        $this->assertEmpty($terms, 'Vocabulary is empty after deletion');
    }
    
    /**
     * Deleting a parent of a term with multiple parents does not delete the term.
     */
    public function testMultipleParentDelete() : void {
        $vocabulary = $this->createVocabulary();
        $parent_term1 = $this->createTerm($vocabulary);
        $parent_term2 = $this->createTerm($vocabulary);
        $child_term = $this->createTerm($vocabulary);
        $child_term->parent = [
            $parent_term1->id(),
            $parent_term2->id(),
        ];
        $child_term->save();
        $child_term_id = $child_term->id();
        $parent_term1->delete();
        $term_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('taxonomy_term');
        $term_storage->resetCache([
            $child_term_id,
        ]);
        $child_term = Term::load($child_term_id);
        $this->assertNotEmpty($child_term, 'Child term is not deleted if only one of its parents is removed.');
        $parent_term2->delete();
        $term_storage->resetCache([
            $child_term_id,
        ]);
        $child_term = Term::load($child_term_id);
        $this->assertEmpty($child_term, 'Child term is deleted if all of its parents are removed.');
    }
    
    /**
     * Tests a taxonomy with terms that have multiple parents of different depths.
     */
    public function testTaxonomyVocabularyTree() : void {
        // Create a new vocabulary with 6 terms.
        $vocabulary = $this->createVocabulary();
        $term = [];
        for ($i = 0; $i < 6; $i++) {
            $term[$i] = $this->createTerm($vocabulary);
        }
        // Get the taxonomy storage.
        $taxonomy_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('taxonomy_term');
        // Set the weight on $term[1] so it appears before $term[5] when fetching
        // the parents for $term[2], in order to test for a regression on
        // \Drupal\taxonomy\TermStorageInterface::loadAllParents().
        $term[1]->weight = -1;
        $term[1]->save();
        // $term[2] is a child of 1 and 5.
        $term[2]->parent = [
            $term[1]->id(),
            $term[5]->id(),
        ];
        $term[2]->save();
        // $term[3] is a child of 2.
        $term[3]->parent = [
            $term[2]->id(),
        ];
        $term[3]->save();
        // $term[5] is a child of 4.
        $term[5]->parent = [
            $term[4]->id(),
        ];
        $term[5]->save();
        
        /**
         * Expected tree:
         * term[0] | depth: 0
         * term[1] | depth: 0
         * -- term[2] | depth: 1
         * ---- term[3] | depth: 2
         * term[4] | depth: 0
         * -- term[5] | depth: 1
         * ---- term[2] | depth: 2
         * ------ term[3] | depth: 3
         */
        // Count $term[1] parents with $max_depth = 1.
        $tree = $taxonomy_storage->loadTree($vocabulary->id(), $term[1]->id(), 1);
        $this->assertCount(1, $tree, 'We have one parent with depth 1.');
        // Count all vocabulary tree elements.
        $tree = $taxonomy_storage->loadTree($vocabulary->id());
        $this->assertCount(8, $tree, 'We have all vocabulary tree elements.');
        // Count elements in every tree depth.
        foreach ($tree as $element) {
            if (!isset($depth_count[$element->depth])) {
                $depth_count[$element->depth] = 0;
            }
            $depth_count[$element->depth]++;
        }
        $this->assertEquals(3, $depth_count[0], 'Three elements in taxonomy tree depth 0.');
        $this->assertEquals(2, $depth_count[1], 'Two elements in taxonomy tree depth 1.');
        $this->assertEquals(2, $depth_count[2], 'Two elements in taxonomy tree depth 2.');
        $this->assertEquals(1, $depth_count[3], 'One element in taxonomy tree depth 3.');
        
        /** @var \Drupal\taxonomy\TermStorageInterface $storage */
        $storage = \Drupal::entityTypeManager()->getStorage('taxonomy_term');
        // Count parents of $term[2].
        $parents = $storage->loadParents($term[2]->id());
        $this->assertCount(2, $parents, 'The term has two parents.');
        // Count parents of $term[3].
        $parents = $storage->loadParents($term[3]->id());
        $this->assertCount(1, $parents, 'The term has one parent.');
        // Identify all ancestors of $term[2].
        $ancestors = $storage->loadAllParents($term[2]->id());
        $this->assertCount(4, $ancestors, 'The term has four ancestors including the term itself.');
        // Identify all ancestors of $term[3].
        $ancestors = $storage->loadAllParents($term[3]->id());
        $this->assertCount(5, $ancestors, 'The term has five ancestors including the term itself.');
    }
    
    /**
     * Tests that a Term is renderable when unsaved (preview).
     */
    public function testTermPreview() : void {
        $entity_manager = \Drupal::entityTypeManager();
        $vocabulary = $this->createVocabulary();
        // Create a unsaved term.
        $term = $entity_manager->getStorage('taxonomy_term')
            ->create([
            'vid' => $vocabulary->id(),
            'name' => 'Foo',
        ]);
        // Confirm we can get the view of unsaved term.
        $render_array = $entity_manager->getViewBuilder('taxonomy_term')
            ->view($term);
        $this->assertNotEmpty($render_array, 'Term view builder is built.');
        // Confirm we can render said view.
        $rendered = (string) \Drupal::service('renderer')->renderInIsolation($render_array);
        $this->assertNotEmpty(trim($rendered), 'Term is able to be rendered.');
    }
    
    /**
     * @covers \Drupal\taxonomy\TermStorage::deleteTermHierarchy
     * @group legacy
     */
    public function testDeleteTermHierarchyDeprecation() : void {
        $vocabulary = $this->createVocabulary();
        $term = $this->createTerm($vocabulary);
        
        /** @var \Drupal\taxonomy\TermStorageInterface $storage */
        $storage = \Drupal::entityTypeManager()->getStorage('taxonomy_term');
        $this->expectDeprecation('Drupal\\taxonomy\\TermStorage::deleteTermHierarchy() is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. It is a no-op since 8.6.0. Parent references are automatically cleared when deleting a taxonomy term. See https://www.drupal.org/node/2936675');
        $storage->deleteTermHierarchy([
            $term->tid,
        ]);
    }
    
    /**
     * @covers \Drupal\taxonomy\TermStorage::updateTermHierarchy
     * @group legacy
     */
    public function testUpdateTermHierarchyDeprecation() : void {
        $vocabulary = $this->createVocabulary();
        $term = $this->createTerm($vocabulary);
        
        /** @var \Drupal\taxonomy\TermStorageInterface $storage */
        $storage = \Drupal::entityTypeManager()->getStorage('taxonomy_term');
        $this->expectDeprecation('Drupal\\taxonomy\\TermStorage::updateTermHierarchy() is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. It is a no-op since 8.6.0. Parent references are automatically updated when updating a taxonomy term. See https://www.drupal.org/node/2936675');
        $storage->updateTermHierarchy($term);
    }
    
    /**
     * Tests revision log access.
     */
    public function testRevisionLogAccess() : void {
        $vocabulary = $this->createVocabulary();
        $entity = $this->createTerm($vocabulary, [
            'status' => TRUE,
        ]);
        $admin = $this->createUser([
            'administer taxonomy',
            'access content',
        ]);
        $editor = $this->createUser([
            'edit terms in ' . $vocabulary->id(),
            'access content',
        ]);
        $viewer = $this->createUser([
            'access content',
        ]);
        $this->assertTrue($entity->get('revision_log_message')
            ->access('view', $admin));
        $this->assertTrue($entity->get('revision_log_message')
            ->access('view', $editor));
        $this->assertFalse($entity->get('revision_log_message')
            ->access('view', $viewer));
    }
    
    /**
     * The "parent" field must restrict references to the same vocabulary.
     */
    public function testParentHandlerSettings() : void {
        $vocabulary = $this->createVocabulary();
        $vocabulary_fields = \Drupal::service('entity_field.manager')->getFieldDefinitions('taxonomy_term', $vocabulary->id());
        $parent_target_bundles = $vocabulary_fields['parent']->getSetting('handler_settings')['target_bundles'];
        $this->assertSame([
            $vocabulary->id() => $vocabulary->id(),
        ], $parent_target_bundles);
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title 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 raw text IS NOT found escaped on 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::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.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
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. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 3
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
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. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 7
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 protected function Bootstraps a kernel for a test. 1
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. 1
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. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable private static function Returns the modules to install 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::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 27
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 Deprecated 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 public function
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
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 Deprecated 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::createTaxonomyTermRevision protected function Creates a new revision for a given taxonomy term.
TaxonomyTestTrait::createTerm protected function Returns a new term with random properties given a vocabulary.
TaxonomyTestTrait::createVocabulary protected function Returns a new vocabulary with random properties.
TermKernelTest::$modules protected static property Modules to install. Overrides KernelTestBase::$modules
TermKernelTest::setUp protected function Overrides KernelTestBase::setUp
TermKernelTest::testDeleteTermHierarchyDeprecation public function @covers \Drupal\taxonomy\TermStorage::deleteTermHierarchy
@group legacy
TermKernelTest::testMultipleParentDelete public function Deleting a parent of a term with multiple parents does not delete the term.
TermKernelTest::testParentHandlerSettings public function The &quot;parent&quot; field must restrict references to the same vocabulary.
TermKernelTest::testRevisionLogAccess public function Tests revision log access.
TermKernelTest::testTaxonomyVocabularyTree public function Tests a taxonomy with terms that have multiple parents of different depths.
TermKernelTest::testTermDelete public function Tests that a deleted term is no longer in the vocabulary.
TermKernelTest::testTermPreview public function Tests that a Term is renderable when unsaved (preview).
TermKernelTest::testUpdateTermHierarchyDeprecation public function @covers \Drupal\taxonomy\TermStorage::updateTermHierarchy
@group legacy
TestRequirementsTrait::checkModuleRequirements Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated protected function Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions.
UserCreationTrait::createUser protected function Create a user with a given set of permissions.
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.