class UninstallDefaultContentTest

Same name in other branches
  1. 9 core/profiles/demo_umami/modules/demo_umami_content/tests/src/Functional/UninstallDefaultContentTest.php \Drupal\Tests\demo_umami_content\Functional\UninstallDefaultContentTest
  2. 8.9.x core/profiles/demo_umami/modules/demo_umami_content/tests/src/Functional/UninstallDefaultContentTest.php \Drupal\Tests\demo_umami_content\Functional\UninstallDefaultContentTest
  3. 11.x core/profiles/demo_umami/modules/demo_umami_content/tests/src/Functional/UninstallDefaultContentTest.php \Drupal\Tests\demo_umami_content\Functional\UninstallDefaultContentTest

Tests that uninstalling default content removes created content.

@group demo_umami_content

Hierarchy

Expanded class hierarchy of UninstallDefaultContentTest

File

core/profiles/demo_umami/modules/demo_umami_content/tests/src/Functional/UninstallDefaultContentTest.php, line 15

Namespace

Drupal\Tests\demo_umami_content\Functional
View source
class UninstallDefaultContentTest extends BrowserTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected $profile = 'demo_umami';
    
    /**
     * Tests uninstalling content removes created entities.
     */
    public function testReinstall() {
        $module_installer = $this->container
            ->get('module_installer');
        // Test imported blocks on profile install.
        $block_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('block_content');
        $this->assertImportedCustomBlock($block_storage);
        // Test imported nodes on profile install.
        $node_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('node');
        $this->assertRecipesImported($node_storage);
        $count = $node_storage->getQuery()
            ->accessCheck(FALSE)
            ->condition('type', 'article')
            ->count()
            ->execute();
        $this->assertGreaterThan(0, $count);
        // Uninstall the module.
        $module_installer->uninstall([
            'demo_umami_content',
        ]);
        // Reset storage cache.
        $block_storage->resetCache();
        $node_storage->resetCache();
        // Assert the removal of blocks on uninstall.
        foreach ($this->expectedBlocks() as $block_info) {
            $count = $block_storage->getQuery()
                ->accessCheck(FALSE)
                ->condition('type', $block_info['type'])
                ->count()
                ->execute();
            $this->assertEquals(0, $count);
            $block = $block_storage->loadByProperties([
                'uuid' => $block_info['uuid'],
            ]);
            $this->assertCount(0, $block);
        }
        // Assert the removal of nodes on uninstall.
        $count = $node_storage->getQuery()
            ->accessCheck(FALSE)
            ->condition('type', 'article')
            ->count()
            ->execute();
        $this->assertEquals(0, $count);
        $count = $node_storage->getQuery()
            ->accessCheck(FALSE)
            ->condition('type', 'recipe')
            ->count()
            ->execute();
        $this->assertEquals(0, $count);
        // Re-install and assert imported content.
        $module_installer->install([
            'demo_umami_content',
        ]);
        $this->assertRecipesImported($node_storage);
        $this->assertArticlesImported($node_storage);
        $this->assertImportedCustomBlock($block_storage);
    }
    
    /**
     * Assert recipes are imported.
     *
     * @param \Drupal\Core\Entity\EntityStorageInterface $node_storage
     *   Node storage.
     */
    protected function assertRecipesImported(EntityStorageInterface $node_storage) : void {
        $count = $node_storage->getQuery()
            ->accessCheck(FALSE)
            ->condition('type', 'recipe')
            ->count()
            ->execute();
        $this->assertGreaterThan(0, $count);
        $nodes = $node_storage->loadByProperties([
            'title' => 'Gluten free pizza',
        ]);
        $this->assertCount(1, $nodes);
        $node = reset($nodes);
        $this->assertStringContainsString('Mix some of the milk and water in a jug', $node->field_recipe_instruction->value);
    }
    
    /**
     * Assert articles are imported.
     *
     * @param \Drupal\Core\Entity\EntityStorageInterface $node_storage
     *   Node storage.
     */
    protected function assertArticlesImported(EntityStorageInterface $node_storage) : void {
        $count = $node_storage->getQuery()
            ->accessCheck(FALSE)
            ->condition('type', 'article')
            ->count()
            ->execute();
        $this->assertGreaterThan(0, $count);
        $nodes = $node_storage->loadByProperties([
            'title' => 'The umami guide to our favorite mushrooms',
        ]);
        $this->assertCount(1, $nodes);
        $node = reset($nodes);
        $this->assertStringContainsString('One of the best things about mushrooms is their versatility', $node->body->value);
    }
    
    /**
     * Assert block content are imported.
     *
     * @param \Drupal\Core\Entity\EntityStorageInterface $block_storage
     *   Block storage.
     */
    protected function assertImportedCustomBlock(EntityStorageInterface $block_storage) : void {
        $assert = $this->assertSession();
        foreach ($this->expectedBlocks() as $block_info) {
            $this->drupalGet($block_info['path']);
            // Verify that the block is placed.
            $assert->pageTextContains($block_info['unique_text']);
            // For blocks that have image alt text, also verify the presence of the
            // expected alt text.
            if (isset($block_info['image_alt_text'])) {
                $img_alt_text = $assert->elementExists('css', $block_info['image_css_selector'])
                    ->getAttribute('alt');
                $this->assertEquals($block_info['image_alt_text'], $img_alt_text);
            }
            // Verify that the block can be loaded.
            $count = $block_storage->getQuery()
                ->accessCheck(FALSE)
                ->condition('type', $block_info['type'])
                ->count()
                ->execute();
            $this->assertGreaterThan(0, $count);
            $block = $block_storage->loadByProperties([
                'uuid' => $block_info['uuid'],
            ]);
            $this->assertCount(1, $block);
        }
    }
    
    /**
     * Returns the expected properties of this profile's content blocks.
     */
    protected function expectedBlocks() {
        return [
            [
                'path' => '<front>',
                'type' => 'banner_block',
                'uuid' => '9aadf4a1-ded6-4017-a10d-a5e043396edf',
                'unique_text' => 'A wholesome pasta bake is the ultimate comfort food.',
                'image_css_selector' => '#block-umami-banner-home img',
                'image_alt_text' => 'Mouth watering vegetarian pasta bake with rich tomato sauce and cheese toppings',
            ],
            [
                'path' => '/recipes',
                'type' => 'banner_block',
                'uuid' => '4c7d58a3-a45d-412d-9068-259c57e40541',
                'unique_text' => 'These sumptuous brownies should be gooey on the inside and crisp on the outside. A perfect indulgence!',
                'image_css_selector' => '#block-umami-banner-recipes img',
                'image_alt_text' => 'A stack of chocolate and pecan brownies, sprinkled with pecan crumbs and crushed walnut, fresh out of the oven',
            ],
            [
                'path' => '/recipes',
                'type' => 'disclaimer_block',
                'uuid' => '9b4dcd67-99f3-48d0-93c9-2c46648b29de',
                'unique_text' => 'is a fictional magazine and publisher for illustrative purposes only',
            ],
            [
                'path' => '/recipes',
                'type' => 'footer_promo_block',
                'uuid' => '924ab293-8f5f-45a1-9c7f-2423ae61a241',
                'unique_text' => 'Magazine exclusive articles, recipes and plenty of reasons to get your copy today.',
                'image_css_selector' => '#block-umami-footer-promo img',
                'image_alt_text' => '3 issue bundle of the Umami food magazine',
            ],
        ];
    }

}

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. 1576
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. 718
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.
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.
UninstallDefaultContentTest::$profile protected property The profile to install as a basis for testing. Overrides BrowserTestBase::$profile
UninstallDefaultContentTest::assertArticlesImported protected function Assert articles are imported.
UninstallDefaultContentTest::assertImportedCustomBlock protected function Assert block content are imported.
UninstallDefaultContentTest::assertRecipesImported protected function Assert recipes are imported.
UninstallDefaultContentTest::expectedBlocks protected function Returns the expected properties of this profile&#039;s content blocks.
UninstallDefaultContentTest::testReinstall public function Tests uninstalling content removes created entities.
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.