class UpdateUploadTest

Same name and namespace in other branches
  1. 9 core/modules/update/tests/src/Functional/UpdateUploadTest.php \Drupal\Tests\update\Functional\UpdateUploadTest
  2. 8.9.x core/modules/update/tests/src/Functional/UpdateUploadTest.php \Drupal\Tests\update\Functional\UpdateUploadTest
  3. 10 core/modules/update/tests/src/Functional/UpdateUploadTest.php \Drupal\Tests\update\Functional\UpdateUploadTest

Tests the Update Manager module's upload and extraction functionality.

@group update

Hierarchy

Expanded class hierarchy of UpdateUploadTest

File

core/modules/update/tests/src/Functional/UpdateUploadTest.php, line 17

Namespace

Drupal\Tests\update\Functional
View source
class UpdateUploadTest extends UpdateUploaderTestBase {
    use TestFileCreationTrait {
        getTestFiles as drupalGetTestFiles;
    }
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    protected static $modules = [
        'file',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $admin_user = $this->drupalCreateUser([
            'administer modules',
            'administer software updates',
            'administer site configuration',
        ]);
        $this->drupalLogin($admin_user);
    }
    
    /**
     * Tests upload, extraction, and update of a module.
     */
    public function testUploadModule() : void {
        // Ensure that the update information is correct before testing.
        update_get_available(TRUE);
        // Images are not valid archives, so get one and try to install it. We
        // need an extra variable to store the result of drupalGetTestFiles()
        // since reset() takes an argument by reference and passing in a constant
        // emits a notice in strict mode.
        $imageTestFiles = $this->drupalGetTestFiles('image');
        $invalidArchiveFile = reset($imageTestFiles);
        $edit = [
            'files[project_upload]' => $invalidArchiveFile->uri,
        ];
        // This also checks that the correct archive extensions are allowed.
        $this->drupalGet('admin/modules/install');
        $this->submitForm($edit, 'Continue');
        $extensions = \Drupal::service('plugin.manager.archiver')->getExtensions();
        $this->assertSession()
            ->pageTextContains("Only files with the following extensions are allowed: {$extensions}.");
        $this->assertSession()
            ->addressEquals('admin/modules/install');
        // Check to ensure an existing module can't be reinstalled. Also checks that
        // the archive was extracted since we can't know if the module is already
        // installed until after extraction.
        $validArchiveFile = __DIR__ . '/../../aaa_update_test.tar.gz';
        $edit = [
            'files[project_upload]' => $validArchiveFile,
        ];
        $this->drupalGet('admin/modules/install');
        $this->submitForm($edit, 'Continue');
        $this->assertSession()
            ->pageTextContains('AAA Update test is already present.');
        $this->assertSession()
            ->addressEquals('admin/modules/install');
        // Ensure that a new module can be extracted and installed.
        $updaters = drupal_get_updaters();
        $moduleUpdater = $updaters['module']['class'];
        $installedInfoFilePath = $this->container
            ->get('update.root') . '/' . $moduleUpdater::getRootDirectoryRelativePath() . '/update_test_new_module/update_test_new_module.info.yml';
        $this->assertFileDoesNotExist($installedInfoFilePath);
        $validArchiveFile = __DIR__ . '/../../update_test_new_module/8.x-1.0/update_test_new_module.tar.gz';
        $edit = [
            'files[project_upload]' => $validArchiveFile,
        ];
        $this->drupalGet('admin/modules/install');
        $this->submitForm($edit, 'Continue');
        // Check that submitting the form takes the user to authorize.php.
        $this->assertSession()
            ->addressEquals('core/authorize.php');
        $this->assertSession()
            ->titleEquals('Update manager | Drupal');
        // Check for a success message on the page, and check that the installed
        // module now exists in the expected place in the filesystem.
        $this->assertSession()
            ->pageTextContains("Added / updated update_test_new_module successfully");
        $this->assertFileExists($installedInfoFilePath);
        // Ensure the links are relative to the site root and not
        // core/authorize.php.
        $this->assertSession()
            ->linkExists('Add another module');
        $this->assertSession()
            ->linkByHrefExists(Url::fromRoute('update.module_install')->toString());
        $this->assertSession()
            ->linkExists('Install newly added modules');
        $this->assertSession()
            ->linkByHrefExists(Url::fromRoute('system.modules_list')->toString());
        $this->assertSession()
            ->linkExists('Administration pages');
        $this->assertSession()
            ->linkByHrefExists(Url::fromRoute('system.admin')->toString());
        // Ensure we can reach the "Add another module" link.
        $this->clickLink('Add another module');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->addressEquals('admin/modules/install');
        // Check that the module has the correct version before trying to update
        // it. Since the module is installed in sites/simpletest, which only the
        // child site has access to, standard module API functions won't find it
        // when called here. To get the version, the info file must be parsed
        // directly instead.
        $info_parser = new InfoParserDynamic(DRUPAL_ROOT);
        $info = $info_parser->parse($installedInfoFilePath);
        $this->assertEquals('8.x-1.0', $info['version']);
        // Install the module.
        $this->drupalGet('admin/modules');
        $this->submitForm([
            'modules[update_test_new_module][enable]' => TRUE,
        ], 'Install');
        // Define the update XML such that the new module downloaded above needs an
        // update from 8.x-1.0 to 8.x-1.1.
        $this->mockInstalledExtensionsInfo([
            'update_test_new_module' => [
                'project' => 'update_test_new_module',
            ],
        ]);
        $xml_mapping = [
            'update_test_new_module' => '1_1',
        ];
        $this->refreshUpdateStatus($xml_mapping);
        // Run the updates for the new module.
        $this->drupalGet('admin/reports/updates/update');
        $this->submitForm([
            'projects[update_test_new_module]' => TRUE,
        ], 'Download these updates');
        $this->submitForm([
            'maintenance_mode' => FALSE,
        ], 'Continue');
        $this->assertSession()
            ->pageTextContains('Update was completed successfully.');
        $this->assertSession()
            ->pageTextContains("Added / updated update_test_new_module successfully");
        // Parse the info file again to check that the module has been updated to
        // 8.x-1.1.
        $info = $info_parser->parse($installedInfoFilePath);
        $this->assertEquals('8.x-1.1', $info['version']);
    }
    
    /**
     * Ensures that archiver extensions are properly merged in the UI.
     */
    public function testFileNameExtensionMerging() : void {
        $this->drupalGet('admin/modules/install');
        // Make sure the bogus extension supported by update_test.module is there.
        $this->assertSession()
            ->responseMatches('/file extensions are supported:.*update-test-extension/');
        // Make sure it didn't clobber the first option from core.
        $this->assertSession()
            ->responseMatches('/file extensions are supported:.*tar/');
    }
    
    /**
     * Checks the messages on update manager pages when missing a security update.
     */
    public function testUpdateManagerCoreSecurityUpdateMessages() : void {
        $this->mockDefaultExtensionsInfo([
            'version' => '8.0.0',
        ]);
        $this->mockReleaseHistory([
            'drupal' => '0.2-sec',
        ]);
        $this->config('update.settings')
            ->set('fetch.url', Url::fromRoute('update_test.update_test')->setAbsolute()
            ->toString())
            ->save();
        // Initialize the update status.
        $this->drupalGet('admin/reports/updates');
        // Now, make sure none of the Update manager pages have duplicate messages
        // about core missing a security update.
        $this->drupalGet('admin/modules/install');
        $this->assertSession()
            ->pageTextNotContains('There is a security update available for your version of Drupal.');
        $this->drupalGet('admin/modules/update');
        $this->assertSession()
            ->pageTextNotContains('There is a security update available for your version of Drupal.');
        $this->drupalGet('admin/appearance/install');
        $this->assertSession()
            ->pageTextNotContains('There is a security update available for your version of Drupal.');
        $this->drupalGet('admin/appearance/update');
        $this->assertSession()
            ->pageTextNotContains('There is a security update available for your version of Drupal.');
        $this->drupalGet('admin/reports/updates/install');
        $this->assertSession()
            ->pageTextNotContains('There is a security update available for your version of Drupal.');
        $this->drupalGet('admin/reports/updates/update');
        $this->assertSession()
            ->pageTextNotContains('There is a security update available for your version of Drupal.');
        $this->drupalGet('admin/update/ready');
        $this->assertSession()
            ->pageTextNotContains('There is a security update available for your version of Drupal.');
    }
    
    /**
     * Tests only an *.info.yml file are detected without supporting files.
     */
    public function testUpdateDirectory() : void {
        $type = Updater::getUpdaterFromDirectory($this->root . '/core/modules/update/tests/modules/aaa_update_test');
        $this->assertEquals('Drupal\\Core\\Updater\\Module', $type, 'Detected a Module');
        $type = Updater::getUpdaterFromDirectory($this->root . '/core/modules/update/tests/themes/update_test_basetheme');
        $this->assertEquals('Drupal\\Core\\Updater\\Theme', $type, 'Detected a Theme.');
    }

}

Members

Title Sort descending 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::$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::$profile protected property The profile to install as a basis for testing. 40
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::__construct 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
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 19
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. 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
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.
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.
TestFileCreationTrait::$generatedTestFiles protected property Whether the files were copied to the test files directory.
TestFileCreationTrait::compareFiles protected function Compares two files based on size and file name.
TestFileCreationTrait::generateFile public static function Generates a test file.
TestFileCreationTrait::getTestFiles protected function Gets a list of files that can be used in tests. Aliased as: drupalGetTestFiles
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::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. 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.
UpdateTestBase::$updateProject protected property The project that is being tested. 3
UpdateTestBase::$updateTableLocator protected property The CSS locator for the update table run asserts on. 3
UpdateTestBase::assertSecurityUpdates protected function Asserts the expected security updates are displayed correctly on the page.
UpdateTestBase::assertUpdateTableElementContains protected function Asserts that the update table element HTML contains the specified text.
UpdateTestBase::assertUpdateTableElementNotContains protected function Asserts that the update table element HTML contains the specified text.
UpdateTestBase::assertUpdateTableTextContains protected function Asserts that the update table text contains the specified text.
UpdateTestBase::assertUpdateTableTextNotContains protected function Asserts that the update table text does not contain the specified text.
UpdateTestBase::assertVersionUpdateLinks protected function Asserts that an update version has the correct links.
UpdateTestBase::confirmRevokedStatus protected function Confirms messages are correct when a release has been unpublished/revoked.
UpdateTestBase::confirmUnsupportedStatus protected function Confirms messages are correct when a release has been marked unsupported.
UpdateTestBase::findUpdateElementByLabel protected function Finds an update page element by label.
UpdateTestBase::refreshUpdateStatus protected function Refreshes the update status based on the desired available update scenario. 1
UpdateTestBase::SECURITY_UPDATE_REQUIRED constant Denotes a security update will be required in the test case.
UpdateTestBase::standardTests protected function Runs a series of assertions that are applicable to all update statuses.
UpdateTestBase::UPDATE_AVAILABLE constant Denotes an update will be available in the test case.
UpdateTestBase::UPDATE_NONE constant Denotes no update will be available in the test case.
UpdateTestTrait::mockDefaultExtensionsInfo protected function Sets default information about installed extensions.
UpdateTestTrait::mockInstalledExtensionsInfo protected function Sets information about installed extensions.
UpdateTestTrait::mockReleaseHistory protected function Sets available release history.
UpdateUploadTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
UpdateUploadTest::$modules protected static property Modules to enable. Overrides UpdateTestBase::$modules
UpdateUploadTest::setUp protected function Overrides UpdateUploaderTestBase::setUp
UpdateUploadTest::testFileNameExtensionMerging public function Ensures that archiver extensions are properly merged in the UI.
UpdateUploadTest::testUpdateDirectory public function Tests only an *.info.yml file are detected without supporting files.
UpdateUploadTest::testUpdateManagerCoreSecurityUpdateMessages public function Checks the messages on update manager pages when missing a security update.
UpdateUploadTest::testUploadModule public function Tests upload, extraction, and update of a module.
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.