class EntityMethodConfigActionsTest

Same name in other branches
  1. 10 core/tests/Drupal/KernelTests/Core/Recipe/EntityMethodConfigActionsTest.php \Drupal\KernelTests\Core\Recipe\EntityMethodConfigActionsTest

@group Recipe

Hierarchy

Expanded class hierarchy of EntityMethodConfigActionsTest

File

core/tests/Drupal/KernelTests/Core/Recipe/EntityMethodConfigActionsTest.php, line 16

Namespace

Drupal\KernelTests\Core\Recipe
View source
class EntityMethodConfigActionsTest extends KernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'config_test',
        'entity_test',
        'system',
    ];
    private readonly ConfigActionManager $configActionManager;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        EntityTestBundle::create([
            'id' => 'test',
            'label' => $this->randomString(),
        ])
            ->save();
        $this->container
            ->get(EntityDisplayRepositoryInterface::class)
            ->getViewDisplay('entity_test_with_bundle', 'test')
            ->save();
        $this->configActionManager = $this->container
            ->get('plugin.manager.config_action');
    }
    public function testSetSingleThirdPartySetting() : void {
        $this->configActionManager
            ->applyAction('entity_method:core.entity_view_display:setThirdPartySetting', 'core.entity_view_display.entity_test_with_bundle.test.default', [
            'module' => 'entity_test',
            'key' => 'verb',
            'value' => 'Save',
        ]);
        
        /** @var \Drupal\Core\Config\Entity\ThirdPartySettingsInterface $display */
        $display = $this->container
            ->get(EntityDisplayRepositoryInterface::class)
            ->getViewDisplay('entity_test_with_bundle', 'test');
        $this->assertSame('Save', $display->getThirdPartySetting('entity_test', 'verb'));
    }
    public function testSetMultipleThirdPartySettings() : void {
        $this->configActionManager
            ->applyAction('entity_method:core.entity_view_display:setThirdPartySettings', 'core.entity_view_display.entity_test_with_bundle.test.default', [
            [
                'module' => 'entity_test',
                'key' => 'noun',
                'value' => 'Spaceship',
            ],
            [
                'module' => 'entity_test',
                'key' => 'verb',
                'value' => 'Explode',
            ],
        ]);
        
        /** @var \Drupal\Core\Config\Entity\ThirdPartySettingsInterface $display */
        $display = $this->container
            ->get(EntityDisplayRepositoryInterface::class)
            ->getViewDisplay('entity_test_with_bundle', 'test');
        $this->assertSame('Spaceship', $display->getThirdPartySetting('entity_test', 'noun'));
        $this->assertSame('Explode', $display->getThirdPartySetting('entity_test', 'verb'));
    }
    
    /**
     * @testWith ["set", {"property_name": "protected_property", "value": "Here be sandworms..."}]
     *   ["setMultiple", [{"property_name": "protected_property", "value": "Here be sandworms..."}, {"property_name": "label", "value": "New face"}]]
     */
    public function testSet(string $action_name, array $value) : void {
        $storage = $this->container
            ->get(EntityTypeManagerInterface::class)
            ->getStorage('config_test');
        $entity = $storage->create([
            'id' => 'foo',
            'label' => 'Behold!',
            'protected_property' => 'Here be dragons...',
        ]);
        $this->assertSame('Behold!', $entity->get('label'));
        $this->assertSame('Here be dragons...', $entity->get('protected_property'));
        $entity->save();
        $this->configActionManager
            ->applyAction("entity_method:config_test.dynamic:{$action_name}", $entity->getConfigDependencyName(), $value);
        $expected_values = array_is_list($value) ? $value : [
            $value,
        ];
        $entity = $storage->load('foo');
        foreach ($expected_values as [
            'property_name' => $name,
            'value' => $value,
        ]) {
            $this->assertSame($value, $entity->get($name));
        }
    }
    
    /**
     * @testWith [true, "setStatus", false, false]
     *   [false, "setStatus", true, true]
     *   [true, "disable", [], false]
     *   [false, "enable", [], true]
     */
    public function testSetStatus(bool $initial_status, string $action_name, array|bool $value, bool $expected_status) : void {
        $storage = $this->container
            ->get(EntityTypeManagerInterface::class)
            ->getStorage('config_test');
        $entity = $storage->create([
            'id' => 'foo',
            'label' => 'Behold!',
            'status' => $initial_status,
        ]);
        $this->assertSame($initial_status, $entity->status());
        $entity->save();
        $this->configActionManager
            ->applyAction("entity_method:config_test.dynamic:{$action_name}", $entity->getConfigDependencyName(), $value);
        $this->assertSame($expected_status, $storage->load('foo')
            ->status());
    }
    
    /**
     * @testWith ["hideComponent"]
     *   ["hideComponents"]
     */
    public function testRemoveComponentFromDisplay(string $action_name) : void {
        $this->assertStringStartsWith('hideComponent', $action_name);
        
        /** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $repository */
        $repository = $this->container
            ->get(EntityDisplayRepositoryInterface::class);
        $view_display = $repository->getViewDisplay('entity_test_with_bundle', 'test');
        $this->assertIsArray($view_display->getComponent('name'));
        // The `hideComponent` action is an alias for `removeComponent`, proving
        // that entity methods can be aliased.
        $this->configActionManager
            ->applyAction("entity_method:core.entity_view_display:{$action_name}", $view_display->getConfigDependencyName(), $action_name === 'hideComponents' ? [
            'name',
        ] : 'name');
        $view_display = $repository->getViewDisplay('entity_test_with_bundle', 'test');
        $this->assertNull($view_display->getComponent('name'));
        // The underlying action name should not be available. It should be hidden
        // by the alias.
        $plugin_id = str_replace('hide', 'remove', $action_name);
        $this->assertFalse($this->configActionManager
            ->hasDefinition($plugin_id));
    }

}

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 Deprecated 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 Deprecated 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 Deprecated 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 Deprecated protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked Deprecated 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 Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion Deprecated protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption Deprecated protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected Deprecated 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 Deprecated 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 Deprecated protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector Deprecated 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 Deprecated 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 Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper Deprecated 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.
EntityMethodConfigActionsTest::$configActionManager private property
EntityMethodConfigActionsTest::$modules protected static property Overrides KernelTestBase::$modules
EntityMethodConfigActionsTest::setUp protected function Overrides KernelTestBase::setUp
EntityMethodConfigActionsTest::testRemoveComponentFromDisplay public function @testWith ["hideComponent"]
["hideComponents"]
EntityMethodConfigActionsTest::testSet public function @testWith ["set", {"property_name": "protected_property", "value": "Here be sandworms..."}]
["setMultiple", [{"property_name": "protected_property", "value":…
EntityMethodConfigActionsTest::testSetMultipleThirdPartySettings public function
EntityMethodConfigActionsTest::testSetSingleThirdPartySetting public function
EntityMethodConfigActionsTest::testSetStatus public function @testWith [true, "setStatus", false, false]
[false, "setStatus", true, true]
[true, "disable", [], false]
[false, "enable", [], true]
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
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. 4
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$root protected property The app root.
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. 3
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. 2
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 28
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. 3
KernelTestBase::tearDown protected function 7
KernelTestBase::tearDownCloseDatabaseConnection public function Additional tear down method to close the connection at the end.
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__construct public function
KernelTestBase::__sleep public function Prevents serializing any properties.
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.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.

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