class PrepareUninstallTest

Same name in other branches
  1. 9 core/modules/system/tests/src/Functional/Module/PrepareUninstallTest.php \Drupal\Tests\system\Functional\Module\PrepareUninstallTest
  2. 8.9.x core/modules/system/tests/src/Functional/Module/PrepareUninstallTest.php \Drupal\Tests\system\Functional\Module\PrepareUninstallTest
  3. 11.x core/modules/system/tests/src/Functional/Module/PrepareUninstallTest.php \Drupal\Tests\system\Functional\Module\PrepareUninstallTest

Tests that modules which provide entity types can be uninstalled.

@group Module

Hierarchy

Expanded class hierarchy of PrepareUninstallTest

File

core/modules/system/tests/src/Functional/Module/PrepareUninstallTest.php, line 16

Namespace

Drupal\Tests\system\Functional\Module
View source
class PrepareUninstallTest extends BrowserTestBase {
    use TaxonomyTestTrait;
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * An array of node objects.
     *
     * @var \Drupal\node\NodeInterface[]
     */
    protected $nodes;
    
    /**
     * An array of taxonomy term objects.
     *
     * @var \Drupal\taxonomy\TermInterface[]
     */
    protected $terms;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'node',
        'taxonomy',
        'entity_test',
        'node_access_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $admin_user = $this->drupalCreateUser([
            'administer modules',
        ]);
        $this->drupalLogin($admin_user);
        $this->drupalCreateContentType([
            'type' => 'article',
            'name' => 'Article',
        ]);
        node_access_rebuild();
        node_access_test_add_field(NodeType::load('article'));
        \Drupal::state()->set('node_access_test.private', TRUE);
        // Create 10 nodes.
        for ($i = 1; $i <= 5; $i++) {
            $this->nodes[] = $this->drupalCreateNode([
                'type' => 'page',
            ]);
            // These 5 articles are inaccessible to the admin user doing the uninstalling.
            $this->nodes[] = $this->drupalCreateNode([
                'type' => 'article',
                'uid' => 0,
                'private' => TRUE,
            ]);
        }
        // Create 3 top-level taxonomy terms, each with 11 children.
        $vocabulary = $this->createVocabulary();
        for ($i = 1; $i <= 3; $i++) {
            $term = $this->createTerm($vocabulary);
            $this->terms[] = $term;
            for ($j = 1; $j <= 11; $j++) {
                $this->terms[] = $this->createTerm($vocabulary, [
                    'parent' => [
                        'target_id' => $term->id(),
                    ],
                ]);
            }
        }
    }
    
    /**
     * Tests that Node and Taxonomy can be uninstalled.
     */
    public function testUninstall() : void {
        // Check that Taxonomy cannot be uninstalled yet.
        $this->drupalGet('admin/modules/uninstall');
        $this->assertSession()
            ->pageTextContains('Remove content items');
        $this->assertSession()
            ->linkByHrefExists('admin/modules/uninstall/entity/taxonomy_term');
        // Delete Taxonomy term data.
        $this->drupalGet('admin/modules/uninstall/entity/taxonomy_term');
        $term_count = count($this->terms);
        for ($i = 1; $i < 11; $i++) {
            $this->assertSession()
                ->pageTextContains($this->terms[$term_count - $i]
                ->label());
        }
        $term_count = $term_count - 10;
        $this->assertSession()
            ->pageTextContains("And {$term_count} more taxonomy terms.");
        $this->assertSession()
            ->pageTextContains('This action cannot be undone.');
        $this->assertSession()
            ->pageTextContains('Make a backup of your database if you want to be able to restore these items.');
        $this->submitForm([], 'Delete all taxonomy terms');
        // Check that we are redirected to the uninstall page and data has been
        // removed.
        $this->assertSession()
            ->addressEquals('admin/modules/uninstall');
        $this->assertSession()
            ->pageTextContains('All taxonomy terms have been deleted.');
        // Check that there is no more data to be deleted, Taxonomy is ready to be
        // uninstalled.
        $this->assertSession()
            ->pageTextContains('Enables the categorization of content.');
        $this->assertSession()
            ->linkByHrefNotExists('admin/modules/uninstall/entity/taxonomy_term');
        // Uninstall the Taxonomy module.
        $this->drupalGet('admin/modules/uninstall');
        $this->submitForm([
            'uninstall[taxonomy]' => TRUE,
        ], 'Uninstall');
        $this->submitForm([], 'Uninstall');
        $this->assertSession()
            ->pageTextContains('The selected modules have been uninstalled.');
        $this->assertSession()
            ->pageTextNotContains('Enables the categorization of content.');
        // Check Node cannot be uninstalled yet, there is content to be removed.
        $this->drupalGet('admin/modules/uninstall');
        $this->assertSession()
            ->pageTextContains('Remove content items');
        $this->assertSession()
            ->linkByHrefExists('admin/modules/uninstall/entity/node');
        // Delete Node data.
        $this->drupalGet('admin/modules/uninstall/entity/node');
        // Only the 5 pages should be listed as the 5 articles are initially inaccessible.
        foreach ($this->nodes as $node) {
            if ($node->bundle() === 'page') {
                $this->assertSession()
                    ->pageTextContains($node->label());
            }
            else {
                $node->set('private', FALSE)
                    ->save();
            }
        }
        $this->assertSession()
            ->pageTextContains('And 5 more content items.');
        // All 10 nodes should now be listed as none are still inaccessible.
        $this->drupalGet('admin/modules/uninstall/entity/node');
        foreach ($this->nodes as $node) {
            $this->assertSession()
                ->pageTextContains($node->label());
        }
        // Ensures there is no more count when not necessary.
        $this->assertSession()
            ->pageTextNotContains('And 0 more content');
        $this->assertSession()
            ->pageTextContains('This action cannot be undone.');
        $this->assertSession()
            ->pageTextContains('Make a backup of your database if you want to be able to restore these items.');
        // Create another node so we have 11.
        $this->nodes[] = $this->drupalCreateNode([
            'type' => 'page',
        ]);
        $this->drupalGet('admin/modules/uninstall/entity/node');
        // Ensures singular case is used when a single entity is left after listing
        // the first 10's labels.
        $this->assertSession()
            ->pageTextContains('And 1 more content item.');
        // Create another node so we have 12, with one private.
        $this->nodes[] = $this->drupalCreateNode([
            'type' => 'article',
            'private' => TRUE,
        ]);
        $this->drupalGet('admin/modules/uninstall/entity/node');
        // Ensures singular case is used when a single entity is left after listing
        // the first 10's labels.
        $this->assertSession()
            ->pageTextContains('And 2 more content items.');
        $this->submitForm([], 'Delete all content items');
        // Check we are redirected to the uninstall page and data has been removed.
        $this->assertSession()
            ->addressEquals('admin/modules/uninstall');
        $this->assertSession()
            ->pageTextContains('All content items have been deleted.');
        // Check there is no more data to be deleted, Node is ready to be
        // uninstalled.
        $this->assertSession()
            ->pageTextContains('Manages the creation, configuration, and display of the main site content.');
        $this->assertSession()
            ->linkByHrefNotExists('admin/modules/uninstall/entity/node');
        // Uninstall Node module.
        $this->drupalGet('admin/modules/uninstall');
        $this->submitForm([
            'uninstall[node]' => TRUE,
        ], 'Uninstall');
        $this->submitForm([], 'Uninstall');
        $this->assertSession()
            ->pageTextContains('The selected modules have been uninstalled.');
        $this->assertSession()
            ->pageTextNotContains('Manages the creation, configuration, and display of the main site content.');
        // Ensure a 404 is returned when accessing a non-existent entity type.
        $this->drupalGet('admin/modules/uninstall/entity/node');
        $this->assertSession()
            ->statusCodeEquals(403);
        // Test an entity type which does not have any existing entities.
        $this->drupalGet('admin/modules/uninstall/entity/entity_test_no_label');
        $this->assertSession()
            ->pageTextContains('There are 0 entity test without label entities to delete.');
        $this->assertSession()
            ->buttonNotExists("Delete all entity test without label entities");
        // Test an entity type without a label.
        
        /** @var \Drupal\Core\Entity\EntityStorageInterface $storage */
        $storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('entity_test_no_label');
        $storage->create([
            'id' => $this->randomMachineName(),
            'name' => $this->randomMachineName(),
        ])
            ->save();
        $this->drupalGet('admin/modules/uninstall/entity/entity_test_no_label');
        $this->assertSession()
            ->pageTextContains('This will delete 1 entity test without label.');
        $this->assertSession()
            ->buttonExists("Delete all entity test without label entities");
        $storage->create([
            'id' => $this->randomMachineName(),
            'name' => $this->randomMachineName(),
        ])
            ->save();
        $this->drupalGet('admin/modules/uninstall/entity/entity_test_no_label');
        $this->assertSession()
            ->pageTextContains('This will delete 2 entity test without label entities.');
    }

}

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
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.
PrepareUninstallTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
PrepareUninstallTest::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules
PrepareUninstallTest::$nodes protected property An array of node objects.
PrepareUninstallTest::$terms protected property An array of taxonomy term objects.
PrepareUninstallTest::setUp protected function Overrides BrowserTestBase::setUp
PrepareUninstallTest::testUninstall public function Tests that Node and Taxonomy can be uninstalled.
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.
TaxonomyTestTrait::createTaxonomyTermRevision protected function Creates a new revision for a given taxonomy term.
TaxonomyTestTrait::createTerm protected function Returns a new term with random properties given a vocabulary.
TaxonomyTestTrait::createVocabulary protected function Returns a new vocabulary with random properties.
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.

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