class StandardRecipeTest

Same name in other branches
  1. 11.x core/tests/Drupal/FunctionalTests/Core/Recipe/StandardRecipeTest.php \Drupal\FunctionalTests\Core\Recipe\StandardRecipeTest

Tests Standard recipe installation expectations.

@group #slow @group Recipe

Hierarchy

Expanded class hierarchy of StandardRecipeTest

File

core/tests/Drupal/FunctionalTests/Core/Recipe/StandardRecipeTest.php, line 18

Namespace

Drupal\FunctionalTests\Core\Recipe
View source
class StandardRecipeTest extends StandardTest {
    use RecipeTestTrait;
    
    /**
     * Tests Standard installation recipe.
     */
    public function testStandard() : void {
        // Install some modules that Standard has optional integrations with.
        \Drupal::service('module_installer')->install([
            'media_library',
            'content_moderation',
        ]);
        // Export all the configuration so we can compare later.
        $this->copyConfig(\Drupal::service('config.storage'), \Drupal::service('config.storage.sync'));
        // Set theme to stark and uninstall the other themes.
        $theme_installer = \Drupal::service('theme_installer');
        $theme_installer->install([
            'stark',
        ]);
        $this->config('system.theme')
            ->set('admin', '')
            ->set('default', 'stark')
            ->save();
        $theme_installer->uninstall([
            'claro',
            'olivero',
        ]);
        // Determine which modules to uninstall.
        $uninstall = array_diff(array_keys(\Drupal::moduleHandler()->getModuleList()), [
            'user',
            'system',
            'path_alias',
            \Drupal::database()->getProvider(),
        ]);
        foreach ([
            'shortcut',
            'field_config',
            'filter_format',
            'field_storage_config',
        ] as $entity_type) {
            $storage = \Drupal::entityTypeManager()->getStorage($entity_type);
            $storage->delete($storage->loadMultiple());
        }
        // Uninstall all the modules including the Standard profile.
        \Drupal::service('module_installer')->uninstall($uninstall);
        // Clean up entity displays before recipe import.
        foreach ([
            'entity_form_display',
            'entity_view_display',
        ] as $entity_type) {
            $storage = \Drupal::entityTypeManager()->getStorage($entity_type);
            $storage->delete($storage->loadMultiple());
        }
        // Clean up roles before recipe import.
        $storage = \Drupal::entityTypeManager()->getStorage('user_role');
        $roles = $storage->loadMultiple();
        // Do not delete the administrator role. There would be no user with the
        // permissions to create content.
        unset($roles[RoleInterface::ANONYMOUS_ID], $roles[RoleInterface::AUTHENTICATED_ID], $roles['administrator']);
        $storage->delete($roles);
        $this->applyRecipe('core/recipes/standard');
        // These recipes provide functionality that is only optionally part of the
        // Standard profile, so we need to explicitly apply them.
        $this->applyRecipe('core/recipes/editorial_workflow');
        $this->applyRecipe('core/recipes/audio_media_type');
        $this->applyRecipe('core/recipes/document_media_type');
        $this->applyRecipe('core/recipes/image_media_type');
        $this->applyRecipe('core/recipes/local_video_media_type');
        $this->applyRecipe('core/recipes/remote_video_media_type');
        // Remove the theme we had to install.
        \Drupal::service('theme_installer')->uninstall([
            'stark',
        ]);
        // Add a Home link to the main menu as Standard expects "Main navigation"
        // block on the page.
        $this->drupalLogin($this->rootUser);
        $this->drupalGet('admin/structure/menu/manage/main/add');
        $this->submitForm([
            'title[0][value]' => 'Home',
            'link[0][uri]' => '<front>',
        ], 'Save');
        // Standard expects to set the contact form's recipient email to the
        // system's email address, but our feedback_contact_form recipe hard-codes
        // it to another value.
        // @todo This can be removed after https://drupal.org/i/3303126, which
        //   should make it possible for a recipe to reuse an already-set config
        //   value.
        ContactForm::load('feedback')?->setRecipients([
            'simpletest@example.com',
        ])->save();
        // Update sync directory config to have the same UUIDs so we can compare.
        
        /** @var \Drupal\Core\Config\StorageInterface $sync */
        $sync = \Drupal::service('config.storage.sync');
        
        /** @var \Drupal\Core\Config\StorageInterface $active */
        $active = \Drupal::service('config.storage');
        // @todo https://www.drupal.org/i/3439749 Determine if the the _core unset
        //   is correct.
        foreach ($active->listAll() as $name) {
            
            /** @var mixed[] $active_data */
            $active_data = $active->read($name);
            if ($sync->exists($name)) {
                
                /** @var mixed[] $sync_data */
                $sync_data = $sync->read($name);
                if (isset($sync_data['uuid'])) {
                    $sync_data['uuid'] = $active_data['uuid'];
                }
                if (isset($sync_data['_core'])) {
                    unset($sync_data['_core']);
                }
                
                /** @var array $sync_data */
                $sync->write($name, $sync_data);
            }
            if (isset($active_data['_core'])) {
                unset($active_data['_core']);
                $active->write($name, $active_data);
            }
            // @todo Remove this once https://drupal.org/i/3427564 lands.
            if ($name === 'node.settings') {
                unset($active_data['langcode']);
                $active->write($name, $active_data);
            }
        }
        // Ensure we have truly rebuilt the standard profile using recipes.
        // Uncomment the code below to see the differences in a single file.
        // $this->assertSame($sync->read('node.settings'), $active->read('node.settings'));
        $comparer = $this->configImporter()
            ->getStorageComparer();
        $expected_list = $comparer->getEmptyChangelist();
        // We expect core.extension to be different because standard is no longer
        // installed.
        $expected_list['update'] = [
            'core.extension',
        ];
        $this->assertSame($expected_list, $comparer->getChangelist());
        // Standard ships two shortcuts; ensure they exist.
        $this->assertCount(2, Shortcut::loadMultiple());
        parent::testStandard();
    }
    
    /**
     * {@inheritdoc}
     */
    protected function installResponsiveImage() : void {
        // Overrides StandardTest::installResponsiveImage() in order to use the
        // recipe.
        $this->applyRecipe('core/recipes/standard_responsive_images');
    }

}

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::$defaultTheme protected property The theme to install as the default for testing. 1579
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::$modules protected static property Modules to install. 721
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
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::setUp protected function 544
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
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 &#039;apcu_ensure_unique_prefix&#039; setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The &quot;#1&quot; 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.
RecipeTestTrait::applyRecipe protected function Applies a recipe to the site.
RecipeTestTrait::createRecipe protected function Creates a recipe in a temporary directory.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 2
RequirementsPageTrait::assertErrorSummaries protected function Asserts the given error summaries are present on the page.
RequirementsPageTrait::assertRequirementSummaries protected function Asserts the given requirements section summaries are present on the page.
RequirementsPageTrait::assertWarningSummaries protected function Asserts the given warning summaries are present on the page.
RequirementsPageTrait::continueOnExpectedWarnings protected function Continues installation when the expected warnings are found.
RequirementsPageTrait::updateRequirementsProblem protected function Handles the update requirements page.
SchemaCheckTestTrait::assertConfigSchema public function Asserts the TypedConfigManager has a valid schema for the configuration.
SchemaCheckTestTrait::assertConfigSchemaByName public function Asserts configuration, specified by name, has a valid schema.
SchemaCheckTrait::$configName protected property The configuration object name under test.
SchemaCheckTrait::$ignoredPropertyPaths protected static property The ignored property paths.
SchemaCheckTrait::$schema protected property The config schema wrapper object for the configuration object under test.
SchemaCheckTrait::checkConfigSchema public function Checks the TypedConfigManager has a valid schema for the configuration.
SchemaCheckTrait::checkValue protected function Helper method to check data type.
SchemaCheckTrait::isViolationForIgnoredPropertyPath protected static function Determines whether this violation is for an ignored Config property path.
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.
StandardRecipeTest::installResponsiveImage protected function Installs the responsive image module. Overrides StandardTestTrait::installResponsiveImage
StandardRecipeTest::testStandard public function Tests Standard installation recipe. Overrides StandardTestTrait::testStandard
StandardTest::$profile protected property The profile to install as a basis for testing. Overrides BrowserTestBase::$profile
StandardTestTrait::$adminUser protected property The admin user.
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. 5
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.

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