class DevelStateEditorTest

Same name in other branches
  1. 4.x tests/src/Functional/DevelStateEditorTest.php \Drupal\Tests\devel\Functional\DevelStateEditorTest

Tests devel state editor.

@group devel

Hierarchy

Expanded class hierarchy of DevelStateEditorTest

File

tests/src/Functional/DevelStateEditorTest.php, line 12

Namespace

Drupal\Tests\devel\Functional
View source
class DevelStateEditorTest extends DevelBrowserTestBase {
    
    /**
     * The state store.
     *
     * @var \Drupal\Core\State\StateInterface
     */
    protected $state;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->state = $this->container
            ->get('state');
        $this->drupalPlaceBlock('page_title_block');
    }
    
    /**
     * Tests state editor menu link.
     */
    public function testStateEditMenuLink() : void {
        $this->drupalPlaceBlock('system_menu_block:devel');
        $this->drupalLogin($this->develUser);
        // Ensures that the state editor link is present on the devel menu and that
        // it points to the correct page.
        $this->drupalGet('');
        $this->clickLink('State editor');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->addressEquals('/devel/state');
        $this->assertSession()
            ->pageTextContains('State editor');
    }
    
    /**
     * Tests state listing.
     */
    public function testStateListing() : void {
        $table_selector = 'table.devel-state-list';
        // Ensure that state listing page is accessible only by users with the
        // adequate permissions.
        $this->drupalGet('devel/state');
        $this->assertSession()
            ->statusCodeEquals(403);
        $this->drupalLogin($this->develUser);
        $this->drupalGet('devel/state');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->pageTextContains('State editor');
        // Ensure that the state variables table is visible.
        $table = $this->assertSession()
            ->elementExists('css', $table_selector);
        // Ensure that all state variables are listed in the table.
        $states = \Drupal::keyValue('state')->getAll();
        $rows = $table->findAll('css', 'tbody tr');
        $this->assertEquals(count($rows), count($states), 'All states are listed in the table.');
        // Ensure that the added state variables are listed in the table.
        $this->state
            ->set('devel.simple', 'Hello!');
        $this->drupalGet('devel/state');
        $table = $this->assertSession()
            ->elementExists('css', $table_selector);
        $this->assertSession()
            ->elementExists('css', sprintf('tbody td:contains("%s")', 'devel.simple'), $table);
        // Ensure that the operations column and the actions buttons are not
        // available for user without 'administer site configuration' permission.
        $headers = $table->findAll('css', 'thead th');
        $this->assertEquals(count($headers), 2, 'Correct number of table header cells found.');
        $this->assertElementsTextEquals($headers, [
            'Name',
            'Value',
        ]);
        $this->assertSession()
            ->elementNotExists('css', 'ul.dropbutton li a', $table);
        // Ensure that the operations column and the actions buttons are
        // available for user with 'administer site configuration' permission.
        $this->drupalLogin($this->adminUser);
        $this->drupalGet('devel/state');
        $table = $this->assertSession()
            ->elementExists('css', $table_selector);
        $headers = $table->findAll('css', 'thead th');
        $this->assertEquals(count($headers), 3, 'Correct number of table header cells found.');
        $this->assertElementsTextEquals($headers, [
            'Name',
            'Value',
            'Operations',
        ]);
        $this->assertSession()
            ->elementExists('css', 'ul.dropbutton li a', $table);
        // Test that the edit button works properly.
        $this->clickLink('Edit');
        $this->assertSession()
            ->statusCodeEquals(200);
    }
    
    /**
     * Tests state edit.
     */
    public function testStateEdit() : void {
        // Create some state variables for the test.
        $this->state
            ->set('devel.simple', 0);
        $this->state
            ->set('devel.array', [
            'devel' => 'value',
        ]);
        $this->state
            ->set('devel.object', $this->randomObject());
        // Ensure that state edit form is accessible only by users with the
        // adequate permissions.
        $this->drupalLogin($this->develUser);
        $this->drupalGet('devel/state/edit/devel.simple');
        $this->assertSession()
            ->statusCodeEquals(403);
        $this->drupalLogin($this->adminUser);
        // Ensure that accessing an un-existent state variable cause a warning
        // message.
        $this->drupalGet('devel/state/edit/devel.unknown');
        $this->assertSession()
            ->pageTextContains(strtr('State @name does not exist in the system.', [
            '@name' => 'devel.unknown',
        ]));
        // Ensure that state variables that contain simple type can be edited and
        // saved.
        $this->drupalGet('devel/state/edit/devel.simple');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->pageTextContains(strtr('Edit state variable: @name', [
            '@name' => 'devel.simple',
        ]));
        $input = $this->assertSession()
            ->fieldExists('edit-new-value');
        $this->assertFalse($input->hasAttribute('disabled'));
        $button = $this->assertSession()
            ->buttonExists('edit-submit');
        $this->assertFalse($button->hasAttribute('disabled'));
        $edit = [
            'new_value' => 1,
        ];
        $this->submitForm($edit, 'Save');
        $this->assertSession()
            ->pageTextContains(strtr('Variable @name was successfully edited.', [
            '@name' => 'devel.simple',
        ]));
        $this->assertEquals(1, $this->state
            ->get('devel.simple'));
        // Ensure that state variables that contain array can be edited and saved
        // and the new value is properly validated.
        $this->drupalGet('devel/state/edit/devel.array');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->pageTextContains(strtr('Edit state variable: @name', [
            '@name' => 'devel.array',
        ]));
        $input = $this->assertSession()
            ->fieldExists('edit-new-value');
        $this->assertFalse($input->hasAttribute('disabled'));
        $button = $this->assertSession()
            ->buttonExists('edit-submit');
        $this->assertFalse($button->hasAttribute('disabled'));
        // Try to save an invalid yaml input.
        $edit = [
            'new_value' => 'devel: \'value updated',
        ];
        $this->submitForm($edit, 'Save');
        $this->assertSession()
            ->pageTextContains('Invalid input:');
        $edit = [
            'new_value' => 'devel: \'value updated\'',
        ];
        $this->submitForm($edit, 'Save');
        $this->assertSession()
            ->pageTextContains(strtr('Variable @name was successfully edited.', [
            '@name' => 'devel.array',
        ]));
        $this->assertEquals([
            'devel' => 'value updated',
        ], $this->state
            ->get('devel.array'));
        // Ensure that state variables that contain objects cannot be edited.
        $this->drupalGet('devel/state/edit/devel.object');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->pageTextContains(strtr('Edit state variable: @name', [
            '@name' => 'devel.object',
        ]));
        $this->assertSession()
            ->pageTextContains(strtr('Only simple structures are allowed to be edited. State @name contains objects.', [
            '@name' => 'devel.object',
        ]));
        $this->assertSession()
            ->fieldDisabled('edit-new-value');
        $button = $this->assertSession()
            ->buttonExists('edit-submit');
        $this->assertTrue($button->hasAttribute('disabled'));
        // Ensure that the cancel link works as expected.
        $this->clickLink('Cancel');
        $this->assertSession()
            ->addressEquals('devel/state');
    }
    
    /**
     * Checks that the passed in elements have the expected text.
     *
     * @param \Behat\Mink\Element\NodeElement[] $elements
     *   The elements for which check the text.
     * @param array $expected_elements_text
     *   The expected text for the passed in elements.
     */
    protected function assertElementsTextEquals(array $elements, array $expected_elements_text) {
        $actual_text = array_map(static fn(NodeElement $element) => $element->getText(), $elements);
        $this->assertSame($expected_elements_text, $actual_text);
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for SettingsEditor::rewrite().
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 40
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between
code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the test environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Gets the Mink driver args from an environment variable. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the test site. 2
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__get public function
BrowserTestBase::__sleep public function Prevents serializing any properties.
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.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
DevelBrowserTestBase::$adminUser protected property Admin user.
DevelBrowserTestBase::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
DevelBrowserTestBase::$develUser protected property User with Devel acces but not site admin permission.
DevelBrowserTestBase::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules 5
DevelStateEditorTest::$state protected property The state store.
DevelStateEditorTest::assertElementsTextEquals protected function Checks that the passed in elements have the expected text.
DevelStateEditorTest::setUp protected function Overrides DevelBrowserTestBase::setUp
DevelStateEditorTest::testStateEdit public function Tests state edit.
DevelStateEditorTest::testStateEditMenuLink public function Tests state editor menu link.
DevelStateEditorTest::testStateListing public function Tests state listing.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 10
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 2
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 1
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed. 1
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when the test installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 28
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 4
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site. 1
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
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.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 2
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
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.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 2
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$databasePrefix protected property The database prefix of this test run.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$root protected property The app root.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection Deprecated public static function Returns the database connection to the site under test.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 1
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::$useOneTimeLoginLinks protected property Use one-time login links instead of submitting the login form. 3
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalResetSession protected function Resets the current active session back to Anonymous session.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
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. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
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.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.