import sys
import distutils.version
import os
+import os.path
import shutil
import logging.handlers
import tempfile
import itertools
import time
+import errno
-from wizard import app, command, deploy, scripts, shell, util
+# XXX: read().strip() is an accident waiting to happen if anyone ever
+# makes a directory with a trailing or leading space. Unlikely, but yeah.
-kib_buffer = 1024 * 30 # 30 MiB we will always leave available
+from wizard import app, command, deploy, merge, shell, user, util
+
+buffer = 1024 * 1024 * 30 # 30 MiB we will always leave available
errno_blacklisted = 64
def main(argv, baton):
options, args = parse_args(argv, baton)
- if args:
- dir = args[0]
- else:
- dir = "."
+ dir = os.path.abspath(args[0]) if args else os.getcwd()
+ os.chdir(dir)
shell.drop_priviledges(dir, options.log_file)
- util.chdir(dir)
- sh = shell.Shell()
util.set_git_env()
- use_shm = False # if you are running --continue, this is guaranteed to be False
+ upgrade = Upgrade(options)
+ upgrade.execute(dir)
+ if not options.non_interactive:
+ print "Upgrade complete"
+
+class Upgrade(object):
+ """
+ Represents the algorithm for upgrading an application. This is in
+ a class and not a function because it's a multi-step process that
+ requires state betweens steps. Steps are represented as methods
+ in this object.
+ """
+
+ #: Version of application we are upgrading to, i.e. the latest version.
+ version = None # XXX: This is a string... I'm not convinced it should be
+ #: String commit ID of the user's latest wc; i.e. "ours"
+ user_commit = None
+ #: String commit ID of the latest, greatest wizard version; i.e. "theirs"
+ next_commit = None
+ #: The temporary directory that the system gave us; may stay as ``None``
+ #: if we don't ever make ourselves a temporary directory (e.g. ``--continue``).
+ #: While we should clean this up if it is set to something, it may
+ #: not correspond to anything useful.
temp_dir = None
- try: # global try-finally for cleaning up /dev/shm if it's being used
- if options.continue_:
- temp_wc_dir = os.getcwd()
- wc = deploy.WorkingCopy(".")
- user_commit, next_commit = open(".git/WIZARD_PARENTS", "r").read().split()
- repo = open(".git/WIZARD_REPO", "r").read()
- version = open(".git/WIZARD_UPGRADE_VERSION", "r").read()
+ #: The temporary directory containing our working copy for merging
+ temp_wc_dir = None
+ #: We place the temporary repositories inside a tmpfs while merging;
+ #: this makes merges not disk-bound and affords a modest speed increase.
+ #: If you are running ``--continue``, this is guaranteed to be ``False``.
+ use_shm = None
+ #: Upstream repository to use. This does not need to be saved.
+ repo = None
+
+ #: Instance of :class:`wizard.deploy.WorkingCopy` for this upgrade
+ wc = None
+ #: Instance of :class:`wizard.deploy.ProductionCopy` for this upgrade
+ prod = None
+
+ #: Options object that the installer was called with
+ options = None
+
+ def __init__(self, options):
+ self.version = None
+ self.user_commit = None
+ self.next_commit = None
+ self.temp_dir = None
+ self.temp_wc_dir = None
+ self.use_shm = False # False until proven otherwise.
+ self.wc = None
+ self.prod = None
+ self.options = options
+
+ def execute(self, dir):
+ """
+ Executes an upgrade. This is the entry-point. This expects
+ that it's current working directory is the same as ``dir``.
+ """
+ assert os.path.abspath(dir) == os.getcwd()
+ try:
+ if self.options.continue_:
+ logging.info("Continuing upgrade...")
+ self.resume()
+ else:
+ logging.info("Upgrading %s" % os.getcwd())
+ self.preflight()
+ self.merge()
+ # Note invariant: we expect you to be in the production
+ # directory at this point, even if you --continue'd from
+ # the temporary directory!
+ self.postflight()
+ # Till now, all of our operations were in a tmp sandbox.
+ if self.options.dry_run:
+ logging.info("Dry run, bailing. See results at %s" % self.temp_wc_dir)
+ return
+ backup = self.backup()
+ self.upgrade(backup)
+ # Note: disable_rollback assumes that upgrade is the last
+ # step, if you add another setp you may have to modify this
+ # to accomodate that.
+ finally:
+ if self.use_shm and self.temp_dir and os.path.exists(self.temp_dir):
+ shutil.rmtree(self.temp_dir)
+
+ def resume(self):
+ """
+ In the event of a ``--continue`` flag, we have to restore state and
+ perform some sanity checks.
+ """
+ self.resumeChdir()
+ self.resumeState()
+ self.resumeLogging()
+ self.resumeProd()
+ def resumeChdir(self):
+ """
+ If we called ``--continue`` inside a working copy (the usual
+ situation), check if :file:`.wizard/pending` exists and change
+ to that directory if so.
+ """
+ self.temp_wc_dir = os.getcwd()
+ didChdir = command.chdir_to_production()
+ self.prod = deploy.ProductionCopy(".")
+ pending_dir = open(self.prod.pending_file).read().strip()
+ if not didChdir:
+ logging.warning("Continued from a production copy; using working copy at %s", pending_dir)
+ self.temp_wc_dir = pending_dir
+ elif self.temp_wc_dir != pending_dir:
+ # prefer the original working copy, but warn that someone
+ # else someone a started an upgrade in the meantime (XXX:
+ # actually, that someone else should bug out, not clobber)
+ logging.warning("Someone else appears to have started an upgrade at %s", pending_dir)
+ def resumeState(self):
+ with util.ChangeDirectory(self.temp_wc_dir):
+ self.wc = deploy.WorkingCopy(".")
+ try:
+ self.user_commit, self.next_commit = open(".git/WIZARD_PARENTS", "r").read().split()
+ self.version = open(".git/WIZARD_UPGRADE_VERSION", "r").read()
+ except IOError as e:
+ if e.errno == errno.ENOENT:
+ raise CannotResumeError()
+ else:
+ raise
+ def resumeLogging(self):
+ with util.ChangeDirectory(self.temp_wc_dir):
+ options = self.options
if not options.log_file and os.path.exists(".git/WIZARD_LOG_FILE"):
options.log_file = open(".git/WIZARD_LOG_FILE", "r").read()
- # reload logging
command.setup_file_logger(options.log_file, options.debug)
- logging.info("Continuing upgrade...")
- util.chdir(sh.eval("git", "config", "remote.origin.url"))
- d = deploy.ProductionCopy(".")
- try:
- sh.call("git", "status")
+ def resumeProd(self):
+ """Restore :attr:`prod` attribute, and check if the production copy has drifted."""
+ try:
+ # simulate the action of `git status`, based on cmd_status()'s call to
+ # refresh_cache() in builtin-commit.c
+ shell.call("git", "update-index", "-q", "--unmerged", "--refresh")
+ r1 = shell.eval("git", "diff-files", "--name-only").strip()
+ r2 = shell.eval("git", "diff-index", "--name-only", "HEAD").strip()
+ if r1 or r2:
raise LocalChangesError()
- except shell.CallError:
- pass
- else:
- d = deploy.ProductionCopy(".")
- if os.path.exists(".scripts/blacklisted"):
- reason = open(".scripts/blacklisted").read()
- # ignore blank blacklisted files
- if reason:
- print reason
- raise BlacklistedError(reason)
- else:
- logging.warning("Application was blacklisted, but no reason was found");
- # before doing verification, do a quick pull of tags
- d.verify()
- d.verifyTag(options.srv_path)
- d.verifyGit(options.srv_path)
- d.verifyConfigured()
- sh.call("git", "fetch", "--tags")
- d.verifyVersion()
- if not options.dry_run:
- d.verifyWeb()
- repo = d.application.repository(options.srv_path)
- version = calculate_newest_version(sh, repo)
- if version == d.app_version.scripts_tag and not options.force:
- # don't log this error
- # XXX: maybe we should build this in as a flag to add
- # to exceptions w/ our exception handler
- sys.stderr.write("Traceback:\n (n/a)\nAlreadyUpgraded\n")
- sys.exit(1)
- logging.info("Upgrading %s" % os.getcwd())
- kib_usage, kib_limit = scripts.get_quota_usage_and_limit()
- if kib_limit is not None and (kib_limit - kib_usage) < kib_buffer:
- raise QuotaTooLow
- if not options.dry_run:
- perform_pre_commit(sh)
- # If /dev/shm exists, it's a tmpfs and we can use it
- # to do a fast git merge. Don't forget to move it to
- # /tmp if it fails.
- if not options.dry_run and not options.debug:
- use_shm = os.path.exists("/dev/shm")
- temp_dir, temp_wc_dir = perform_tmp_clone(sh, use_shm)
- logging.debug("Temporary WC dir is %s", temp_wc_dir)
- with util.ChangeDirectory(temp_wc_dir):
- wc = deploy.WorkingCopy(".")
- sh.call("git", "remote", "add", "scripts", repo)
- sh.call("git", "fetch", "-q", "scripts")
- user_commit, next_commit = calculate_parents(sh, version)
- # save variables so that --continue will work
- # yeah yeah no trailing newline whatever
- open(".git/WIZARD_REPO", "w").write(repo)
- open(".git/WIZARD_UPGRADE_VERSION", "w").write(version)
- open(".git/WIZARD_PARENTS", "w").write("%s\n%s" % (user_commit, next_commit))
- open(".git/WIZARD_SIZE", "w").write(str(scripts.get_disk_usage()))
- if options.log_file:
- open(".git/WIZARD_LOG_FILE", "w").write(options.log_file)
- temp_wc_dir = perform_merge(sh, repo, d, wc, version, use_shm, kib_limit and kib_limit - kib_usage or None, options.non_interactive)
- wc.location = temp_wc_dir
- # variables: version, user_commit, next_commit, temp_wc_dir
- with util.ChangeDirectory(temp_wc_dir):
+ except shell.CallError:
+ pass
+ # Working copy is not anchored anywhere useful for git describe,
+ # so we need to give it a hint.
+ self.wc.setAppVersion(self.prod.app_version)
+
+ def preflight(self):
+ """
+ Make sure that a number of pre-upgrade invariants are met before
+ attempting anything.
+ """
+ options = self.options
+ for i in range(0,2):
+ self.prod = deploy.ProductionCopy(".")
+ self.prod.verify()
+ self.repo = self.prod.application.repository(options.srv_path)
+ # XXX: put this in Application
+ self.version = shell.eval("git", "--git-dir="+self.repo, "describe", "--tags", "master")
+ self.preflightBlacklist()
+ self.prod.verify()
+ self.prod.verifyDatabase()
+ self.prod.verifyTag(options.srv_path)
try:
- sh.call("git", "status")
- except shell.CallError:
- pass
- else:
- sh.call("git", "commit", "--allow-empty", "-am", "throw-away commit")
- message = make_commit_message(version)
- new_tree = sh.eval("git", "rev-parse", "HEAD^{tree}")
- final_commit = sh.eval("git", "commit-tree", new_tree,
- "-p", user_commit, "-p", next_commit, input=message, log=True)
- # a master branch may not necessarily exist if the user
- # was manually installed to an earlier version
+ self.prod.verifyGit(options.srv_path)
+ except deploy.InconsistentWizardTagError:
+ shell.call("git", "fetch")
+ shell.call("git", "fetch", "--tags")
+ shell.call("wizard", "remaster")
+ self.prod.verifyGit(options.srv_path)
+ except deploy.HeadNotDescendantError:
+ shell.call("wizard", "remaster")
+ self.prod.verifyGit(options.srv_path)
+ if not options.skip_verification:
+ self.prod.verifyConfigured()
try:
- sh.call("git", "checkout", "-q", "-b", "master", "--")
- except shell.CallError:
- sh.call("git", "checkout", "-q", "master", "--")
- sh.call("git", "reset", "-q", "--hard", final_commit)
- # This is a quick sanity check to make sure we didn't completely
- # mess up the merge
- wc.invalidateCache()
- wc.verifyVersion()
- # Till now, all of our operations were in a tmp sandbox.
- if options.dry_run:
- logging.info("Dry run, bailing. See results at %s" % temp_wc_dir)
- return
- # Ok, now we have to do a crazy complicated dance to see if we're
- # going to have enough quota to finish what we need
- pre_size = int(open(os.path.join(temp_wc_dir, ".git/WIZARD_SIZE"), "r").read())
- post_size = scripts.get_disk_usage(temp_wc_dir)
- kib_usage, kib_limit = scripts.get_quota_usage_and_limit()
- backup = d.backup(options)
- if kib_limit is not None and (kib_limit - kib_usage) - (post_size - pre_size) / 1024 < kib_buffer:
- shutil.rmtree(os.path.join(".scripts/backups", sh.eval("wizard", "restore").splitlines()[0]))
- raise QuotaTooLow
- # XXX: frob .htaccess to make site inaccessible
- with util.IgnoreKeyboardInterrupts():
- with util.LockDirectory(".scripts-upgrade-lock"):
- sh.call("git", "fetch", "--tags")
- # git merge (which performs a fast forward)
- sh.call("git", "pull", "-q", temp_wc_dir, "master")
- version_obj = distutils.version.LooseVersion(version.partition('-')[2])
+ shell.call("git", "fetch", "--tags") # XXX: hack since some installs have stale tags
+ except shell.CallError as e:
+ if "Disk quota exceeded" in e.stderr:
+ raise QuotaTooLow
+ raise
+ try:
+ self.prod.verifyVersion()
+ except deploy.VersionMismatchError as e:
+ # XXX: kind of hacky, mainly it does change the Git working copy
+ # state (although /very/ non-destructively)
try:
- # run update script
- d.upgrade(version_obj, options)
- d.verifyWeb()
- except app.UpgradeFailure:
- logging.warning("Upgrade failed: rolling back")
- perform_restore(d, backup)
- raise
- except deploy.WebVerificationError as e:
- logging.warning("Web verification failed: rolling back")
- perform_restore(d, backup)
- raise app.UpgradeVerificationFailure()
- # XXX: frob .htaccess to make site accessible
- # to do this, check if .htaccess changed, first. Upgrade
- # process might have frobbed it. Don't be
- # particularly worried if the segment disappeared
- finally:
- if use_shm and temp_dir and os.path.exists(temp_dir):
- shutil.rmtree(temp_dir)
- if not options.non_interactive:
- print "Upgrade complete"
+ shell.call("git", "merge", "--strategy=ours", self.prod.application.makeVersion(str(e.real_version)).wizard_tag)
+ except shell.CallError as e2:
+ if "does not point to a commit" in e2.stderr:
+ raise UnknownVersionError(e.real_version)
+ else:
+ raise
+ continue
+ break
+ else:
+ raise VersionRematchFailed
+ self.verifyWeb()
+ self.preflightAlreadyUpgraded()
+ self.preflightQuota()
+ def preflightBlacklist(self):
+ # XXX: should use deploy info
+ if os.path.exists(".wizard/blacklisted"):
+ reason = open(".wizard/blacklisted").read()
+ # ignore blank blacklisted files
+ if reason:
+ print reason
+ raise BlacklistedError(reason)
+ else:
+ logging.warning("Application was blacklisted, but no reason was found");
+ def preflightAlreadyUpgraded(self):
+ if self.version == self.prod.app_version.wizard_tag and not self.options.force:
+ # don't log this error; we need to have the traceback line
+ # so that the parsing code can catch it
+ # XXX: maybe we should build this in as a flag to add
+ # to exceptions w/ our exception handler
+ sys.stderr.write("Traceback:\n (n/a)\nAlreadyUpgraded\n")
+ sys.exit(2)
+ def preflightQuota(self):
+ r = user.quota()
+ if r is not None:
+ usage, limit = r
+ if limit is not None and (limit - usage) < buffer:
+ logging.info("preflightQuota: limit = %d, usage = %d, buffer = %d", limit, usage, buffer)
+ raise QuotaTooLow
-def perform_restore(d, backup):
- # You don't want d.restore() because it doesn't perform
- # the file level backup
- shell.Shell().call("wizard", "restore", backup)
- try:
- d.verifyWeb()
- except deploy.WebVerificationError:
- logging.critical("Web verification failed after rollback")
-
-def make_commit_message(version):
- message = "Upgraded autoinstall in %s to %s.\n\n%s" % (util.get_dir_owner(), version, util.get_git_footer())
- try:
- message += "\nUpgraded-by: " + util.get_operator_git()
- except util.NoOperatorInfo:
- pass
- return message
-
-def calculate_newest_version(sh, repo):
- # XXX: put this in Application
- return sh.eval("git", "--git-dir="+repo, "describe", "--tags", "master")
-
-def calculate_parents(sh, version):
- user_commit = sh.eval("git", "rev-parse", "HEAD")
- next_commit = sh.eval("git", "rev-parse", version)
- return user_commit, next_commit
-
-def perform_pre_commit(sh):
- message = "Pre-commit of %s locker before autoinstall upgrade.\n\n%s" % (util.get_dir_owner(), util.get_git_footer())
- try:
- message += "\nPre-commit-by: " + util.get_operator_git()
- except util.NoOperatorInfo:
- pass
- try:
- sh.call("git", "commit", "-a", "-m", message)
- except shell.CallError:
- logging.info("No changes detected")
-
-def perform_tmp_clone(sh, use_shm):
- if use_shm:
- dir = "/dev/shm/wizard"
- if not os.path.exists(dir):
- os.mkdir(dir)
- os.chmod(dir, 0o777)
- else:
- dir = None
- temp_dir = tempfile.mkdtemp(prefix="wizard", dir=dir)
- temp_wc_dir = os.path.join(temp_dir, "repo")
- logging.info("Using temporary directory: " + temp_wc_dir)
- sh.call("git", "clone", "-q", "--shared", ".", temp_wc_dir)
- return temp_dir, temp_wc_dir
-
-def perform_merge(sh, repo, d, wc, version, use_shm, kib_avail, non_interactive):
- # Note: avail_quota == None means unlimited
- # naive merge algorithm:
- # sh.call("git", "merge", "-m", message, "scripts/master")
- # crazy merge algorithm:
- def make_virtual_commit(tag, parents = []):
- """WARNING: Changes state of Git repository"""
- sh.call("git", "checkout", "-q", tag, "--")
- wc.parametrize(d)
- for file in wc.application.parametrized_files:
- try:
- sh.call("git", "add", "--", file)
- except shell.CallError:
- pass
- virtual_tree = sh.eval("git", "write-tree", log=True)
- parent_args = itertools.chain(*(["-p", p] for p in parents))
- virtual_commit = sh.eval("git", "commit-tree", virtual_tree,
- *parent_args, input="", log=True)
- sh.call("git", "reset", "--hard")
- return virtual_commit
- user_tree = sh.eval("git", "rev-parse", "HEAD^{tree}")
- base_virtual_commit = make_virtual_commit(wc.app_version.scripts_tag)
- next_virtual_commit = make_virtual_commit(version, [base_virtual_commit])
- user_virtual_commit = sh.eval("git", "commit-tree", user_tree,
- "-p", base_virtual_commit, input="", log=True)
- sh.call("git", "checkout", user_virtual_commit, "--")
- wc.prepareMerge()
- try:
- sh.call("git", "commit", "--amend", "-a", "-m", "amendment")
- except shell.CallError as e:
- pass
- try:
- sh.call("git", "config", "merge.conflictstyle", "diff3")
- sh.call("git", "merge", next_virtual_commit)
- except shell.CallError as e:
- logging.info("Merge failed with these messages:\n\n" + e.stderr)
- # Run the application's specific merge resolution algorithms
- # and see if we can salvage it
- curdir = os.getcwd()
- if wc.resolveConflicts():
- logging.info("Resolved conflicts with application specific knowledge")
- sh.call("git", "commit", "-a", "-m", "merge")
- return os.getcwd()
- logging.info("Conflict info:\n" + sh.eval("git", "diff"))
- outlines = sh.eval("git", "ls-files", "--unmerged").splitlines()
+ def merge(self):
+ if not self.options.dry_run:
+ self.mergePreCommit()
+ self.mergeClone()
+ logging.debug("Temporary WC dir is %s", self.temp_wc_dir)
+ with util.ChangeDirectory(self.temp_wc_dir):
+ self.wc = deploy.WorkingCopy(".")
+ shell.call("git", "remote", "add", "wizard", self.repo)
+ shell.call("git", "fetch", "-q", "wizard")
+ self.user_commit = shell.eval("git", "rev-parse", "HEAD")
+ self.next_commit = shell.eval("git", "rev-parse", self.version)
+ self.mergeSaveState()
+ self.mergePerform()
+ def mergePreCommit(self):
+ def get_file_set(rev):
+ return set(shell.eval("git", "ls-tree", "-r", "--name-only", rev).split("\n"))
+ # add all files that are unversioned but would be replaced by the pull,
+ # and generate a new commit
+ old_files = get_file_set("HEAD")
+ new_files = get_file_set(self.version)
+ added_files = new_files - old_files
+ for f in added_files:
+ if os.path.lexists(f): # broken symbolic links count too!
+ shell.call("git", "add", f)
+ message = "Pre-commit before autoinstall upgrade.\n\n%s" % util.get_git_footer()
+ try:
+ message += "\nPre-commit-by: " + util.get_operator_git()
+ except util.NoOperatorInfo:
+ pass
+ try:
+ shell.call("git", "commit", "-a", "-m", message)
+ except shell.CallError as e:
+ if "Permission denied" in e.stderr:
+ raise util.PermissionsError
+ elif e.stderr:
+ raise
+ logging.info("No changes detected")
+ def mergeClone(self):
+ # If /dev/shm exists, it's a tmpfs and we can use it
+ # to do a fast git merge. Don't forget to move it to
+ # /tmp if it fails.
+ if not self.options.dry_run and not self.options.debug:
+ self.use_shm = os.path.exists("/dev/shm")
+ if self.use_shm:
+ dir = "/dev/shm/wizard"
+ if not os.path.exists(dir):
+ os.mkdir(dir)
+ # XXX: race
+ os.chmod(dir, 0o777)
+ else:
+ dir = None
+ self.temp_dir = tempfile.mkdtemp(prefix="wizard", dir=dir)
+ self.temp_wc_dir = os.path.join(self.temp_dir, "repo")
+ logging.info("Using temporary directory: " + self.temp_wc_dir)
+ shell.call("git", "clone", "-q", ".", self.temp_wc_dir)
+ def mergeSaveState(self):
+ """Save variables so that ``--continue`` will work."""
+ # yeah yeah no trailing newline whatever
+ open(".git/WIZARD_UPGRADE_VERSION", "w").write(self.version)
+ open(".git/WIZARD_PARENTS", "w").write("%s\n%s" % (self.user_commit, self.next_commit))
+ open(".git/WIZARD_SIZE", "w").write(str(util.disk_usage()))
+ if self.options.log_file:
+ open(".git/WIZARD_LOG_FILE", "w").write(self.options.log_file)
+ def mergePerform(self):
+ def prepare_config():
+ self.wc.prepareConfig()
+ shell.call("git", "add", ".")
+ def resolve_conflicts():
+ return self.wc.resolveConflicts()
+ shell.call("git", "config", "merge.conflictstyle", "diff3")
+ # setup rerere
+ if self.options.rr_cache is None:
+ self.options.rr_cache = os.path.join(self.prod.location, ".git", "rr-cache")
+ if not os.path.exists(self.options.rr_cache):
+ os.mkdir(self.options.rr_cache)
+ os.symlink(self.options.rr_cache, os.path.join(self.wc.location, ".git", "rr-cache"))
+ shell.call("git", "config", "rerere.enabled", "true")
+ try:
+ merge.merge(self.wc.app_version.wizard_tag, self.version,
+ prepare_config, resolve_conflicts)
+ except merge.MergeError:
+ self.mergeFail()
+ def mergeFail(self):
files = set()
- for line in outlines:
- _, _, _, name = line.split(None, 3)
- files.add(name)
+ for line in shell.eval("git", "ls-files", "--unmerged").splitlines():
+ files.add(line.split(None, 3)[-1])
conflicts = len(files)
- curdir = mv_shm_to_tmp(curdir, use_shm)
- os.chdir(curdir)
- open(os.path.join(d.location, ".scripts/pending"), "w").write(curdir)
- if non_interactive:
- print "%d %s" % (conflicts, curdir)
+ # XXX: this is kind of fiddly; note that temp_dir still points at the OLD
+ # location after this code.
+ self.temp_wc_dir = mv_shm_to_tmp(os.getcwd(), self.use_shm)
+ self.wc.location = self.temp_wc_dir
+ os.chdir(self.temp_wc_dir)
+ if os.path.exists(self.prod.pending_file):
+ mtime = os.path.getmtime(self.prod.pending_file)
+ pending_location = open(self.prod.pending_file).read().strip()
+ # don't complain if .wizard/pending is a day old
+ if mtime > (time.time() - 60 * 60 * 24):
+ raise UpgradeInProgressError(pending_location, mtime)
+ else:
+ logging.warning("Probably harmless old pending upgrade at %s from %s", pending_location, time.ctime(mtime))
+ open(self.prod.pending_file, "w").write(self.temp_wc_dir)
+ if self.options.non_interactive:
+ print "%d %s" % (conflicts, self.temp_wc_dir)
raise MergeFailed
else:
user_shell = os.getenv("SHELL")
if not user_shell: user_shell = "/bin/bash"
+ # XXX: scripts specific hack, since mbash doesn't respect the current working directory
+ # When the revolution comes (i.e. $ATHENA_HOMEDIR/Scripts is your Scripts home
+ # directory) this isn't strictly necessary, but we'll probably need to support
+ # web_scripts directories ad infinitum.
+ if user_shell == "/usr/local/bin/mbash": user_shell = "/bin/bash"
while 1:
print
print "ERROR: The merge failed with %d conflicts in these files:" % conflicts
print " * %s" % file
print
print "Please resolve these conflicts (edit and then `git add`), and"
- print "then type 'exit'."
- sh.call(user_shell, "-i", interactive=True)
- if sh.eval("git", "ls-files", "--unmerged").strip():
+ print "then type 'exit'. You will now be dropped into a shell whose working"
+ print "directory is %s" % self.temp_wc_dir
+ print
+ print "NOTE: If you resolve these conflicts, and then the upgrade fails for"
+ print "an unrelated reason, you can run 'wizard upgrade --continue' from this"
+ print "directory to try again."
+ try:
+ shell.call(user_shell, "-i", interactive=True)
+ except shell.CallError as e:
+ logging.warning("Shell returned non-zero exit code %d" % e.code)
+ if shell.eval("git", "ls-files", "--unmerged").strip():
print
print "WARNING: There are still unmerged files."
out = raw_input("Continue editing? [y/N]: ")
else:
print "Aborting. The conflicted working copy can be found at:"
print
- print " %s" % os.getcwd()
+ print " %s" % self.temp_wc_dir
print
print "and you can resume the upgrade process by running in that directory:"
print
print " wizard upgrade --continue"
sys.exit(1)
break
- return os.getcwd()
+
+ def postflight(self):
+ with util.ChangeDirectory(self.temp_wc_dir):
+ if shell.eval("git", "ls-files", "-u").strip():
+ raise UnmergedChangesError
+ shell.call("git", "commit", "--allow-empty", "-am", "throw-away commit")
+ self.wc.parametrize(self.prod)
+ shell.call("git", "add", ".")
+ message = self.postflightCommitMessage()
+ new_tree = shell.eval("git", "write-tree")
+ final_commit = shell.eval("git", "commit-tree", new_tree,
+ "-p", self.user_commit, "-p", self.next_commit, input=message, log=True)
+ # a master branch may not necessarily exist if the user
+ # was manually installed to an earlier version
+ try:
+ shell.call("git", "checkout", "-q", "-b", "master", "--")
+ except shell.CallError:
+ shell.call("git", "checkout", "-q", "master", "--")
+ shell.call("git", "reset", "-q", "--hard", final_commit)
+ # This is a quick sanity check to make sure we didn't completely
+ # mess up the merge
+ self.wc.invalidateCache()
+ self.wc.verifyVersion()
+ def postflightCommitMessage(self):
+ message = "Upgraded autoinstall to %s.\n\n%s" % (self.version, util.get_git_footer())
+ try:
+ message += "\nUpgraded-by: " + util.get_operator_git()
+ except util.NoOperatorInfo:
+ pass
+ return message
+
+ def backup(self):
+ # Ok, now we have to do a crazy complicated dance to see if we're
+ # going to have enough quota to finish what we need
+ pre_size = int(open(os.path.join(self.temp_wc_dir, ".git/WIZARD_SIZE"), "r").read())
+ post_size = util.disk_usage(self.temp_wc_dir)
+ backup = self.prod.backup(self.options)
+ r = user.quota()
+ if r is not None:
+ usage, limit = r
+ if limit is not None and (limit - usage) - (post_size - pre_size) < buffer:
+ shutil.rmtree(os.path.join(self.prod.backup_dir, shell.eval("wizard", "restore").splitlines()[0]))
+ raise QuotaTooLow
+ return backup
+
+ def upgrade(self, backup):
+ # XXX: frob .htaccess to make site inaccessible
+ # XXX: frob Git to disallow Git operations after the pull
+ with util.IgnoreKeyboardInterrupts():
+ with util.LockDirectory(".wizard-upgrade-lock"):
+ shell.call("git", "fetch", "--tags")
+ # git merge (which performs a fast forward)
+ shell.call("git", "pull", "-q", self.temp_wc_dir, "master")
+ version_obj = distutils.version.LooseVersion(self.version.partition('-')[2])
+ try:
+ # run update script
+ self.prod.upgrade(version_obj, self.options)
+ self.verifyWeb()
+ try:
+ os.unlink(self.prod.pending_file)
+ except OSError as e:
+ if e.errno != errno.ENOENT:
+ raise
+ except app.UpgradeFailure:
+ logging.warning("Upgrade failed: rolling back")
+ self.upgradeRollback(backup)
+ raise
+ except deploy.WebVerificationError as e:
+ logging.warning("Web verification failed: rolling back")
+ self.upgradeRollback(backup)
+ raise app.UpgradeVerificationFailure()
+ # XXX: frob .htaccess to make site accessible
+ # to do this, check if .htaccess changed, first. Upgrade
+ # process might have frobbed it. Don't be
+ # particularly worried if the segment disappeared
+ def upgradeRollback(self, backup):
+ # You don't want d.restore() because it doesn't perform
+ # the file level backup
+ if not self.options.disable_rollback:
+ shell.call("wizard", "restore", backup)
+ try:
+ self.verifyWeb()
+ except deploy.WebVerificationError:
+ logging.critical("Web verification failed after rollback")
+ else:
+ logging.warning("Rollback was disabled; you can rollback with `wizard restore %s`", backup)
+
+ def verifyWeb(self):
+ if not self.options.skip_verification:
+ self.prod.verifyWeb()
+
+
+# utility functions
def mv_shm_to_tmp(curdir, use_shm):
if not use_shm: return curdir
def parse_args(argv, baton):
usage = """usage: %prog upgrade [ARGS] [DIR]
-Upgrades an autoinstall to the latest version. This involves
-updating files and running .scripts/update. If the merge fails,
-this program will write the number of conflicts and the directory
+Upgrades an autoinstall to the latest version. This involves updating
+files the upgrade script associated with this application. If the merge
+fails, this program will write the number of conflicts and the directory
of the conflicted working tree to stdout, separated by a space."""
parser = command.WizardOptionParser(usage)
parser.add_option("--dry-run", dest="dry_run", action="store_true",
"resolved using the current working directory as the resolved copy.")
parser.add_option("--force", dest="force", action="store_true",
default=False, help="Force running upgrade even if it's already at latest version.")
+ parser.add_option("--skip-verification", dest="skip_verification", action="store_true",
+ default=False, help="Skip running configuration and web verification checks.")
parser.add_option("--non-interactive", dest="non_interactive", action="store_true",
default=False, help="Don't drop to shell in event of conflict.")
+ parser.add_option("--rr-cache", dest="rr_cache", metavar="PATH",
+ default=None, help="Use this folder to reuse recorded merge resolutions. Defaults to"
+ "your production copy's rr-cache, if it exists.")
+ parser.add_option("--disable-rollback", dest="disable_rollback", action="store_true",
+ default=util.boolish(os.getenv("WIZARD_DISABLE_ROLLBACK")),
+ help="Skips rollback in the event of a failed upgrade. Envvar is WIZARD_DISABLE_ROLLBACK.")
baton.push(parser, "srv_path")
options, args = parser.parse_all(argv)
if len(args) > 1:
parser.error("too many arguments")
+ if options.skip_verification:
+ logging.warning("Verification is disabled; Wizard may break your application and will not tell you about it")
return options, args
class Error(command.Error):
with git rerere to remember merge resolutions (XXX: not sure if
this actually works)."""
+class UnmergedChangesError(Error):
+ def __str__(self):
+ return """
+
+ERROR: You attempted to continue an upgrade, but there were
+still local unmerged changes in your working copy. Please resolve
+them all and try again."""
+
class BlacklistedError(Error):
#: Reason why the autoinstall was blacklisted
reason = None
ERROR: This autoinstall was manually blacklisted against errors;
if the user has not been notified of this, please send them
-mail.
+mail. If you know that this application is blacklisted and
+would like to attempt an upgrade anyway, run:
+
+ wizard blacklist --delete
The reason was: %s""" % self.reason
+
+class CannotResumeError(Error):
+ def __str__(self):
+ return """
+
+ERROR: We cannot resume the upgrade process; either this working
+copy is missing essential metadata, or you've attempt to continue
+from a production copy that does not have any pending upgrades.
+"""
+
+class VersionRematchFailed(Error):
+ def __str__(self):
+ return """
+
+ERROR: Your Git version information was not consistent with your
+files on the system, and we were unable to create a fake merge
+to make the two consistent."""
+
+class UnknownVersionError(Error):
+ #: Version that we didn't have
+ version = None
+ def __init__(self, version):
+ self.version = version
+ def __str__(self):
+ return """
+
+ERROR: The version you are attempting to upgrade from (%s)
+is unknown to the repository Wizard is using.""" % str(self.version)
+
+class UpgradeInProgressError(Error):
+ #: Location of pending upgrade
+ location = None
+ #: Time of pending upgrade
+ time = None
+ def __init__(self, location, time):
+ self.location = location
+ self.time = time
+ def __str__(self):
+ return """
+
+ERROR: There is already an upgrade in progress at
+
+ %s
+
+which was last started at %s.
+
+To ignore and start another upgrade anyway, remove the file
+.wizard/pending and try again.""" % (self.location, time.ctime(self.time))
scripts.mit.edu / wizard.git / blobdiff