Drupal 7's upgrade path

upgradepath.drush.inc

<?php

// NOTE This has been moved to https://www.drupal.org/project/upgradepath
/**
 * @file
 * Runs a set of steps to upgrade a database to be in line with code.
 */

/**
 * Implements hook_drush_command().
 */
function upgradepath_drush_command() {
  $items = array();
  $items['upgradepath'] = array(
    'description' => 'Runs the upgrade path in the bootstrapped site performing tasks such as database upgrades, reverting features, etc.',
    'drush dependencies' => array('registry_rebuild', 'features'),
    'examples' => array(
      'drush upgradepath' => 'Runs the upgradepath in the current Drupal project.',
      'drush @example.dev upgradepath' => 'Runs the upgradepath in the Drupal project referenced by @example.dev.',
    ),
  );
  return $items;
}

/**
 * Implements drush_hook_pre_command().
 */
function drush_upgradepath_pre_upgradepath() {
  drush_log('Enabling maintenance mode and killing active sessions.', 'status');
  $return = drush_invoke_process('@self', 'variable-set', array('maintenance_mode', 1), array(
    'yes' => TRUE,
    'always-set' => TRUE,
  ));
  if ($return['error_status']) {
    return drush_set_error('UPGRADEPATH_PRE_MAINTENANCE', 'Could not enable maintenance mode.');
  }
  $return = drush_invoke_process('@self', 'sql-query', array('truncate table sessions'));
  if ($return['error_status']) {
    return drush_set_error('UPGRADEPATH_PRE_SESSIONS', 'Could not truncate user sessions.');
  }
}

/**
 * Implements drush_hook_command().
 */
function drush_upgradepath() {
  // Registry rebuild.
  $return = drush_invoke_process('@self', 'registry-rebuild');
  if ($return['error_status']) {
    return drush_set_error('UPGRADEPATH_RR', 'registry-rebuild failed.');
  }

  // Database updates.
  drush_invoke_process('@self', 'updatedb', array(), array('yes' => true));
  if ($return['error_status']) {
    return drush_set_error('UPGRADEPATH_UPDB', 'updatedb failed.');
  }

  // Clear Drush cache (sometimes needed before reverting Features components).
  drush_invoke_process('@self', 'cache-clear', array('type' => 'drush'));
  if ($return['error_status']) {
    return drush_set_error('UPGRADEPATH_CC_DRUSH', 'cache-clear failed.');
  }

  // Revert all Features components.
  drush_invoke_process('@self', 'features-revert-all', array(), array(
    'yes' => TRUE,
  ));
  if ($return['error_status']) {
    return drush_set_error('UPGRADEPATH_FRA', 'features-revert-all failed.');
  }

  // Clear all caches.
  drush_invoke_process('@self', 'cache-clear', array('type' => 'all'));
  if ($return['error_status']) {
    return drush_set_error('UPGRADEPATH_CC_ALL', 'cache-clear failed.');
  }
}

/**
 * Implements drush_hook_post_command().
 */
function drush_upgradepath_post_upgradepath() {
  drush_log('Disabling maintenance mode.', 'success');
  $return = drush_invoke_process('@self', 'variable-delete', array('maintenance_mode'), array(
   'yes' => TRUE,
   'exact' => TRUE,
  ));
  if ($return['error_status']) {
    return drush_set_error('UPGRADEPATH_POST_MAINTENANCE', 'Could not disable maintenance mode.');
  }
}

/**
 * Implements drush_hook_command_rollback().
 */
function drush_upgradepath_rollback() {
  drush_log('Oh no! Something went wrong. Review the above log and disable maintenance mode when done.', 'error');
  drush_set_context('UPGRADEPATH_ROLLBACK', TRUE);
}

/**
 * Implements drush_hook_pre_command_rollback().
 */
function drush_upgradepath_pre_upgradepath_rollback() {
  if (!drush_get_context('UPGRADEPATH_ROLLBACK')) {
    drush_log('Oh no! Something went wrong prior to start the upgrade path. Check the status of the maintenance mode and the sessions table.', 'error');
  }
}

I thought drush rr and drush updb call drush cc all anyway?

I thought so @xurizaemon, but sometimes an extra cc all is needed because of Drupal registry's black magic.

Little mistake on line 7, missing an h on drush:

drush --verbose cache-clear drush

@DavidHernandez, I must have fixed that in a later edit because I do not see it now. Thanks though!

Love this, @juampy72!

One thing I found... If the code needs the drush rr, like if you move a critical module, the command fails.

I can run drush rr by itself first, then drush upgradepath and it will work.

I think this is because drush is bootstrapping the whole site for the upgradepath command, causing a fatal error when it doesn't find the modules it needs.

I wonder if it would be possible to set 'bootstrap' => DRUSH_BOOTSTRAP_DRUSH, and then "re-bootstrap" the site once the registry rebuild runs?

@jonpugh, I will see if I can reproduce that. I have just created a project at Drupal.org so more people in the community can chime in https://www.drupal.org/project/upgradepath.