You are here

class ExperimentalThemeTest in Drupal 10

Same name and namespace in other branches
  1. 8 core/modules/system/tests/src/Functional/Theme/ExperimentalThemeTest.php \Drupal\Tests\system\Functional\Theme\ExperimentalThemeTest
  2. 9 core/modules/system/tests/src/Functional/Theme/ExperimentalThemeTest.php \Drupal\Tests\system\Functional\Theme\ExperimentalThemeTest

Tests the installation of experimental themes.

@group Theme

Hierarchy

Expanded class hierarchy of ExperimentalThemeTest

File

core/modules/system/tests/src/Functional/Theme/ExperimentalThemeTest.php, line 12

Namespace

Drupal\Tests\system\Functional\Theme
View source
class ExperimentalThemeTest extends BrowserTestBase {

  /**
   * The admin user.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $adminUser;

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->adminUser = $this
      ->drupalCreateUser([
      'access administration pages',
      'administer themes',
    ]);
    $this
      ->drupalLogin($this->adminUser);
  }

  /**
   * Tests installing experimental themes and dependencies in the UI.
   *
   * @dataProvider providerTestExperimentalConfirmForm
   */
  public function testExperimentalConfirmForm(string $theme_name, string $dependency_theme_name, string $machine_theme_name, string $machine_dependency_theme_name) : void {

    // Only experimental themes should be marked as such with a parenthetical.
    $this
      ->drupalGet('admin/appearance');
    $this
      ->assertSession()
      ->responseContains(sprintf($theme_name . ' %s                (experimental theme)', \Drupal::VERSION));
    $this
      ->assertSession()
      ->responseContains(sprintf($dependency_theme_name . ' %s', \Drupal::VERSION));

    // First, test installing a non-experimental theme with no dependencies.
    // There should be no confirmation form and no experimental theme warning.
    $this
      ->cssSelect('a[title="Install <strong>Test theme</strong> theme"]')[0]
      ->click();
    $this
      ->assertSession()
      ->pageTextContains('The <strong>Test theme</strong> theme has been installed.');
    $this
      ->assertSession()
      ->pageTextNotContains('Experimental modules are provided for testing purposes only.');

    // Next, test installing an experimental theme with no dependencies.
    // There should be a confirmation form with an experimental warning, but no
    // list of dependencies.
    $this
      ->drupalGet('admin/appearance');
    $this
      ->cssSelect('a[title="Install ' . $theme_name . ' theme"]')[0]
      ->click();
    $this
      ->assertSession()
      ->pageTextContains('Experimental themes are provided for testing purposes only. Use at your own risk.');

    // The module should not be enabled and there should be a warning and a
    // list of the experimental modules with only this one.
    $this
      ->assertSession()
      ->pageTextNotContains('The ' . $theme_name . ' theme has been installed.');
    $this
      ->assertSession()
      ->pageTextContains('Experimental themes are provided for testing purposes only.');

    // There should be no message about enabling dependencies.
    $this
      ->assertSession()
      ->pageTextNotContains('You must enable');

    // Enable the theme and confirm that it worked.
    $this
      ->submitForm([], 'Continue');
    $this
      ->assertSession()
      ->pageTextContains('The ' . $theme_name . ' theme has been installed.');

    // Setting it as the default should not ask for another confirmation.
    $this
      ->cssSelect('a[title="Set ' . $theme_name . ' as default theme"]')[0]
      ->click();
    $this
      ->assertSession()
      ->pageTextNotContains('Experimental themes are provided for testing purposes only. Use at your own risk.');
    $this
      ->assertSession()
      ->pageTextContains($theme_name . ' is now the default theme.');
    $this
      ->assertSession()
      ->pageTextNotContains(sprintf($theme_name . ' %s                (experimental theme)', \Drupal::VERSION));
    $this
      ->assertSession()
      ->responseContains(sprintf($theme_name . ' %s                (default theme, administration theme, experimental theme)', \Drupal::VERSION));

    // Uninstall the theme.
    $this
      ->config('system.theme')
      ->set('default', 'test_theme')
      ->save();
    \Drupal::service('theme_handler')
      ->refreshInfo();
    \Drupal::service('theme_installer')
      ->uninstall([
      $machine_theme_name,
    ]);

    // Reinstall the same experimental theme, but this time immediately set it
    // as the default. This should again trigger a confirmation form with an
    // experimental warning.
    $this
      ->drupalGet('admin/appearance');
    $this
      ->cssSelect('a[title="Install ' . $theme_name . ' as default theme"]')[0]
      ->click();
    $this
      ->assertSession()
      ->pageTextContains('Experimental themes are provided for testing purposes only. Use at your own risk.');

    // Test enabling a theme that is not itself experimental, but that depends
    // on an experimental module.
    $this
      ->drupalGet('admin/appearance');
    $this
      ->cssSelect('a[title="Install ' . $dependency_theme_name . ' theme"]')[0]
      ->click();

    // The theme should not be enabled and there should be a warning and a
    // list of the experimental modules with only this one.
    $this
      ->assertSession()
      ->pageTextNotContains('The ' . $dependency_theme_name . ' theme has been installed.');
    $this
      ->assertSession()
      ->pageTextContains('Experimental themes are provided for testing purposes only. Use at your own risk.');
    $this
      ->assertSession()
      ->pageTextContains('The following themes are experimental: ' . $theme_name);

    // Ensure the non-experimental theme is not listed as experimental.
    $this
      ->assertSession()
      ->pageTextNotContains('The following themes are experimental: ' . $theme_name . ', ' . $dependency_theme_name);
    $this
      ->assertSession()
      ->pageTextNotContains('The following themes are experimental: ' . $dependency_theme_name);

    // There should be a message about enabling dependencies.
    $this
      ->assertSession()
      ->pageTextContains('You must enable the ' . $theme_name . ' theme to install ' . $dependency_theme_name);

    // Enable the theme and confirm that it worked.
    $this
      ->submitForm([], 'Continue');
    $this
      ->assertSession()
      ->pageTextContains('The ' . $dependency_theme_name . ' theme has been installed.');
    $this
      ->assertSession()
      ->responseContains(sprintf($theme_name . ' %s                (experimental theme)', \Drupal::VERSION));
    $this
      ->assertSession()
      ->responseContains(sprintf($dependency_theme_name . ' %s', \Drupal::VERSION));

    // Setting it as the default should not ask for another confirmation.
    $this
      ->cssSelect('a[title="Set ' . $dependency_theme_name . ' as default theme"]')[0]
      ->click();
    $this
      ->assertSession()
      ->pageTextNotContains('Experimental themes are provided for testing purposes only. Use at your own risk.');
    $this
      ->assertSession()
      ->pageTextContains($dependency_theme_name . ' is now the default theme.');
    $this
      ->assertSession()
      ->responseContains(sprintf($theme_name . ' %s                (experimental theme)', \Drupal::VERSION));
    $this
      ->assertSession()
      ->responseContains(sprintf($dependency_theme_name . ' %s                (default theme, administration theme)', \Drupal::VERSION));

    // Uninstall the theme.
    $this
      ->config('system.theme')
      ->set('default', 'test_theme')
      ->save();
    \Drupal::service('theme_handler')
      ->refreshInfo();
    \Drupal::service('theme_installer')
      ->uninstall([
      $machine_theme_name,
      $machine_dependency_theme_name,
    ]);

    // Reinstall the same theme, but this time immediately set it as the
    // default. This should again trigger a confirmation form with an
    // experimental warning for its dependency.
    $this
      ->drupalGet('admin/appearance');
    $this
      ->cssSelect('a[title="Install ' . $dependency_theme_name . ' as default theme"]')[0]
      ->click();
    $this
      ->assertSession()
      ->pageTextContains('Experimental themes are provided for testing purposes only. Use at your own risk.');
  }

  /**
   * Data provider for experimental test themes.
   *
   * @return string[][]
   *   An array with four items:
   *   - The theme name.
   *   - The dependency theme name.
   *   - The machine theme name.
   *   - The machine dependency theme name.
   *
   * @todo Turn the check for 'Testing legacy Key/Value pair
   * "experimental: true"' into a @legacy test triggering a deprecation as part
   * of https://www.drupal.org/node/3250342
   */
  public function providerTestExperimentalConfirmForm() : array {
    return [
      'Testing Key/Value pair "lifecycle: experimental"' => [
        'Experimental test',
        'Experimental dependency test',
        'experimental_theme_test',
        'experimental_theme_dependency_test',
      ],
      'Testing legacy Key/Value pair "experimental: true"' => [
        'Legacy experimental test',
        'Legacy experimental dependency test',
        'legacy_experimental_theme_test',
        'legacy_experimental_theme_dependency_test',
      ],
    ];
  }

}

Members

Namesort descending Modifiers Type Description 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 drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
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 enable. 213
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. 14
BrowserTestBase::$root protected property The app root.
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 Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. 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. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function
BrowserTestBase::tearDown protected function 2
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::__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
ExperimentalThemeTest::$adminUser protected property The admin user.
ExperimentalThemeTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
ExperimentalThemeTest::providerTestExperimentalConfirmForm public function Data provider for experimental test themes.
ExperimentalThemeTest::setUp protected function Overrides BrowserTestBase::setUp
ExperimentalThemeTest::testExperimentalConfirmForm public function Tests installing experimental themes and dependencies in the UI.
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::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation.
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.
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. 4
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 21
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. 3
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::$randomGenerator protected property The random generator.
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 public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 1
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 private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements 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.
TestSetupTrait::$container protected property The dependency injection container used in the test.
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::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 1
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 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::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.
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::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.