class pmUpdateCode

  1. 8.0.x tests/pmUpdateCodeTest.php pmUpdateCode
  2. 6.x tests/pmUpdateCodeTest.php pmUpdateCode
  3. 7.x tests/pmUpdateCodeTest.php pmUpdateCode
  4. 4.x tests/pmUpdateCodeTest.php pmUpdateCode
  5. 5.x tests/pmUpdateCodeTest.php pmUpdateCode
  6. master tests/pmUpdateCodeTest.php pmUpdateCode

@group slow @group pm




Expanded class hierarchy of pmUpdateCode


Contains filters are case sensitive
Namesort descending Modifiers Type Description
CommandUnishTestCase::$coverage_data protected property Code coverage data collected during a single test.
CommandUnishTestCase::$defaultIdleTimeout private property Default idle timeout for commands.
CommandUnishTestCase::$defaultTimeout private property Default timeout for commands.
CommandUnishTestCase::$idleTimeout protected property Idle timeouts for commands.
CommandUnishTestCase::$process private property Process of last executed command.
CommandUnishTestCase::$timeout protected property Timeout for command.
CommandUnishTestCase::assertLogHasMessage function Ensure that an expected log message appears in the Drush log.
CommandUnishTestCase::drush function Invoke drush in via execute().
CommandUnishTestCase::drush_major_version function
CommandUnishTestCase::execute function Actually runs the command.
CommandUnishTestCase::EXIT_ERROR constant
CommandUnishTestCase::EXIT_SUCCESS constant
CommandUnishTestCase::getErrorOutput function Accessor for the last stderr output, trimmed.
CommandUnishTestCase::getErrorOutputAsList function Accessor for the last stderr output, rtrimmed and split on newlines.
CommandUnishTestCase::getErrorOutputRaw function Accessor for the last stderr output, non-trimmed.
CommandUnishTestCase::getOutput function Accessor for the last output, trimmed.
CommandUnishTestCase::getOutputAsList function Accessor for the last output, rtrimmed and split on newlines.
CommandUnishTestCase::getOutputFromJSON function Accessor for the last output, decoded from json.
CommandUnishTestCase::getOutputRaw function Accessor for the last output, non-trimmed.
CommandUnishTestCase::parse_backend_output function A slightly less functional copy of drush_backend_parse_output().
CommandUnishTestCase::run public function Override the run method, so we can add in our code coverage data after the test has run.
CommandUnishTestCase::UNISH_EXITCODE_USER_ABORT constant
pmUpdateCode::$modules public property
pmUpdateCode::getPreviousStable private function
pmUpdateCode::setUp public function Download old core and older contrib releases which will always need updating.
pmUpdateCode::testUpdateCode function
UnishTestCase::$sites private static property A list of Drupal sites that have been recently installed. They key is the site name and values are details about each site.
UnishTestCase::bit_bucket function Borrowed from Drush. Checks operating system and returns supported bit bucket folder.
UnishTestCase::convert_path function Converts a Windows path (dir1\dir2\dir3) into a Unix path (dir1/dir2/dir3). Also converts a cygwin "drive emulation" path (/cygdrive/c/dir1) into a proper drive path, still with Unix slashes (c:/dir1).
UnishTestCase::db_driver function
UnishTestCase::db_url function
UnishTestCase::directory_cache function
UnishTestCase::drupalSitewideDirectory function
UnishTestCase::escapeshellarg public static function
UnishTestCase::fetchInstallDrupal function
UnishTestCase::getSites function
UnishTestCase::get_tar_executable public static function
UnishTestCase::is_windows public static function
UnishTestCase::log function Print a log message to the console.
UnishTestCase::log_level function
UnishTestCase::mkdir public function
UnishTestCase::randomString public function Helper function to generate a random string of arbitrary length.
UnishTestCase::recursive_copy public function
UnishTestCase::setUpBeforeClass public static function Assure that each class starts with an empty sandbox directory and a clean environment -
UnishTestCase::setUpDrupal function
UnishTestCase::setUpFreshSandBox public static function Remove any pre-existing sandbox, then create a new one.
UnishTestCase::tearDownAfterClass public static function Runs after all tests in a class are run. Remove sandbox directory.
UnishTestCase::tick function Print out a tick mark.
UnishTestCase::unish_file_aliases function Prepare the contents of an aliases file.
UnishTestCase::webroot function
UnishTestCase::writeSiteAlias function
UnishTestCase::_escapeshellarg_windows public static function
UnishTestCase::__construct function


tests/pmUpdateCodeTest.php, line 15
Prepare a codebase and upgrade it in several stages, exercising updatecode's filters.

View source
class pmUpdateCode extends CommandUnishTestCase {

   * An array of modules to be downloaded and enabled.
  public $modules;

  private function getPreviousStable($project) {
    // Call drush pm-releases and get the output
    $this->drush('pm-releases', array($project), array('all' => NULL, 'fields' => 'Release'));
    $list = $this->getOutputAsList();
    // Line 0 is "Release"
    // Line 1 is "...-dev"
    // Line 2 is current best release
    // Line 3 is the previous release
    return trim($list[3]);

   * Download old core and older contrib releases which will always need updating.
  public function setUp() {
      // Make sure that we can still update from the previous release
      // to the current release.
      $core = $this->getPreviousStable("drupal-8");
      $modules_str = 'unish-8.x-1.2,honeypot-8.x-1.18-beta3';
      $this->modules = array('block', 'unish', 'honeypot');
    elseif (UNISH_DRUPAL_MAJOR_VERSION == 7) {
      $core = '7.0-rc3';
      $modules_str = 'devel-7.x-1.0-rc1,webform-7.x-3.4-beta1';
      $this->modules = array('menu', 'devel', 'webform');
    else {
      $core = '6.28';
      $modules_str = 'devel-6.x-1.26,webform-6.x-3.18';
      $this->modules = array('menu', 'devel', 'webform');

    $sites = $this->setUpDrupal(1, TRUE, $core);
    $options = array(
      'root' => $this->webroot(),
      'uri' => key($sites),
      'yes' => NULL,
      'quiet' => NULL,
      'cache' => NULL,
      'skip' => NULL, // No FirePHP
      'strict' => 0,

    $this->drush('pm-download', array($modules_str), $options);
    $this->drush('pm-enable', $this->modules, $options);

  function testUpdateCode() {
    $extension = UNISH_DRUPAL_MAJOR_VERSION == 8 ? '.info.yml' : '.info';
    $first = $this->modules[1];
    $second = $this->modules[2];

    $options = array(
      'root' => $this->webroot(),
      'uri' => key($this->getSites()),
      'yes' => NULL,
      'backup-dir' => UNISH_SANDBOX . '/backups',
      'cache' => NULL,
      'check-updatedb' => 0,
      // Needed in order to get 'Up to date' in the return value of updatestatus. See pm_project_filter().
      'verbose' => NULL,
      'strict' => 0,

    // Upgrade a specific module.
    $this->drush('pm-updatecode', array($first), $options + array());

    // Assure that first was upgraded and second was not.
    $this->drush('pm-updatestatus', array(), $options + array('format' => 'json'));
    $all = $this->getOutputFromJSON();
    $this->assertEquals($all->$first->existing_version, $all->$first->candidate_version);
    $this->assertNotEquals($all->$second->existing_version, $all->$second->candidate_version);

    // Lock second, and update core.
    $this->drush('pm-updatecode', array(), $options + array('lock' => $second));
    $list = $this->getOutputAsList(); // For debugging.
    $this->drush('pm-updatestatus', array(), $options + array('format' => 'json'));
    $all = $this->getOutputFromJSON();
    $this->assertEquals($all->drupal->existing_version, $all->drupal->candidate_version);
    $this->assertNotEquals($all->$second->existing_version, $all->$second->candidate_version);

    // Unlock second, update, and check.
    $this->drush('pm-updatecode', array(), $options + array('unlock' => $second, 'no-backup' => NULL));
    $list = $this->getOutputAsList();
    $this->drush('pm-updatestatus', array(), $options + array('format' => 'json'));
    $all = $this->getOutputFromJSON();
    $this->assertEquals($all->$second->existing_version, $all->$second->candidate_version);

    // Verify that we keep backups as instructed.
    $backup_dir = UNISH_SANDBOX . '/backups';
    $Directory = new \RecursiveDirectoryIterator($backup_dir);
    $Iterator = new \RecursiveIteratorIterator($Directory);
    $found = FALSE;
    foreach ($Iterator as $item) {
      if (basename($item) == $first . $extension) {
        $found = TRUE;
    $this->assertTrue($found, 'Backup exists and contains the first module.');

    $Iterator = new \RecursiveIteratorIterator($Directory);
    $found = FALSE;
    foreach ($Iterator as $item) {
      if (basename($item) == $second . '.module') {
        $found = TRUE;
    $this->assertFalse($found, 'Backup exists and does not contain the second module.');