X-Git-Url: https://scripts.mit.edu/gitweb/wizard.git/blobdiff_plain/906753036c02abb850c5a0157934f3a62f66fa05..aef4c25109a195042df0ab8cb979692c6077d36f:/wizard/command/upgrade.py diff --git a/wizard/command/upgrade.py b/wizard/command/upgrade.py index f077177..0850994 100644 --- a/wizard/command/upgrade.py +++ b/wizard/command/upgrade.py @@ -1,6 +1,7 @@ import sys import distutils.version import os +import os.path import shutil import logging.handlers import tempfile @@ -8,17 +9,18 @@ import itertools import time import errno -from wizard import app, command, deploy, merge, 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.set_git_env() upgrade = Upgrade(options) @@ -38,7 +40,7 @@ class Upgrade(object): 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 scripts version; i.e. "theirs" + #: 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``). @@ -75,27 +77,34 @@ class Upgrade(object): def execute(self, dir): """ - Executes an upgrade. This is the entry-point. + Executes an upgrade. This is the entry-point. This expects + that it's current working directory is the same as ``dir``. """ - with util.ChangeDirectory(dir): - try: - if self.options.continue_: - logging.info("Continuing upgrade...") - self.resume() - else: - logging.info("Upgrading %s" % os.getcwd()) - self.preflight() - self.merge() - 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) - finally: - if self.use_shm and self.temp_dir and os.path.exists(self.temp_dir): - shutil.rmtree(self.temp_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): """ @@ -105,39 +114,52 @@ class Upgrade(object): self.resumeChdir() self.resumeState() self.resumeLogging() - util.chdir(shell.eval("git", "config", "remote.origin.url")) self.resumeProd() def resumeChdir(self): """ - If we called ``--continue`` inside a production copy, check if - :file:`.scripts/pending` exists and change to that directory if so. + If we called ``--continue`` inside a working copy (the usual + situation), check if :file:`.wizard/pending` exists and change + to that directory if so. """ - if os.path.exists(".scripts/pending"): - newdir = open(".scripts/pending").read().strip() - logging.warning("Detected production copy; changing directory to %s", newdir) - os.chdir(newdir) - def resumeState(self): self.temp_wc_dir = os.getcwd() - 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 + 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): - 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() - command.setup_file_logger(options.log_file, options.debug) + 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() + command.setup_file_logger(options.log_file, options.debug) def resumeProd(self): """Restore :attr:`prod` attribute, and check if the production copy has drifted.""" - self.prod = deploy.ProductionCopy(".") try: - shell.call("git", "status") - raise LocalChangesError() + # 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 # Working copy is not anchored anywhere useful for git describe, @@ -150,31 +172,57 @@ class Upgrade(object): attempting anything. """ options = self.options - while True: + 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) - self.prod.verifyGit(options.srv_path) - self.prod.verifyConfigured() - shell.call("git", "fetch", "--tags") # XXX: hack since some installs have stale tags + try: + 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: + 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) - shell.call("git", "merge", "--strategy=ours", self.prod.application.makeVersion(str(e.real_version)).scripts_tag) + try: + 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 - self.prod.verifyWeb() + else: + raise VersionRematchFailed + self.verifyWeb() self.preflightAlreadyUpgraded() self.preflightQuota() def preflightBlacklist(self): - if os.path.exists(".scripts/blacklisted"): - reason = open(".scripts/blacklisted").read() + # XXX: should use deploy info + if os.path.exists(".wizard/blacklisted"): + reason = open(".wizard/blacklisted").read() # ignore blank blacklisted files if reason: print reason @@ -182,7 +230,7 @@ class Upgrade(object): else: logging.warning("Application was blacklisted, but no reason was found"); def preflightAlreadyUpgraded(self): - if self.version == self.prod.app_version.scripts_tag and not self.options.force: + 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 @@ -190,9 +238,12 @@ class Upgrade(object): sys.stderr.write("Traceback:\n (n/a)\nAlreadyUpgraded\n") sys.exit(2) def preflightQuota(self): - 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 + 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 merge(self): if not self.options.dry_run: @@ -201,21 +252,35 @@ class Upgrade(object): 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", "scripts", self.repo) - shell.call("git", "fetch", "-q", "scripts") + 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): - message = "Pre-commit of %s locker before autoinstall upgrade.\n\n%s" % (util.get_dir_owner(), util.get_git_footer()) + 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: + 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 @@ -234,13 +299,13 @@ class Upgrade(object): 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", "--shared", ".", 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(scripts.get_disk_usage())) + 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): @@ -258,7 +323,7 @@ class Upgrade(object): 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.scripts_tag, self.version, + merge.merge(self.wc.app_version.wizard_tag, self.version, prepare_config, resolve_conflicts) except merge.MergeError: self.mergeFail() @@ -272,7 +337,15 @@ class Upgrade(object): 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) - open(os.path.join(self.prod.location, ".scripts/pending"), "w").write(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 @@ -294,6 +367,10 @@ class Upgrade(object): print "Please resolve these conflicts (edit and then `git add`), and" 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: @@ -317,12 +394,9 @@ class Upgrade(object): def postflight(self): with util.ChangeDirectory(self.temp_wc_dir): - try: - shell.call("git", "status") - except shell.CallError: - pass - else: - shell.call("git", "commit", "--allow-empty", "-am", "throw-away commit") + 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() @@ -341,7 +415,7 @@ class Upgrade(object): self.wc.invalidateCache() self.wc.verifyVersion() def postflightCommitMessage(self): - message = "Upgraded autoinstall in %s to %s.\n\n%s" % (util.get_dir_owner(), self.version, util.get_git_footer()) + 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: @@ -352,18 +426,21 @@ class Upgrade(object): # 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 = scripts.get_disk_usage(self.temp_wc_dir) + post_size = util.disk_usage(self.temp_wc_dir) backup = self.prod.backup(self.options) - kib_usage, kib_limit = scripts.get_quota_usage_and_limit() - 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", shell.eval("wizard", "restore").splitlines()[0])) - raise QuotaTooLow + 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(".scripts-upgrade-lock"): + 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") @@ -371,7 +448,12 @@ class Upgrade(object): try: # run update script self.prod.upgrade(version_obj, self.options) - self.prod.verifyWeb() + 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) @@ -387,11 +469,19 @@ class Upgrade(object): def upgradeRollback(self, backup): # You don't want d.restore() because it doesn't perform # the file level backup - shell.call("wizard", "restore", backup) - try: + 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() - except deploy.WebVerificationError: - logging.critical("Web verification failed after rollback") + # utility functions @@ -412,9 +502,9 @@ def mv_shm_to_tmp(curdir, use_shm): 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", @@ -425,15 +515,22 @@ of the conflicted working tree to stdout, separated by a space.""" "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): @@ -476,6 +573,14 @@ The best way to resolve this is probably to attempt an upgrade again, 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 @@ -487,7 +592,10 @@ class BlacklistedError(Error): 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 @@ -499,3 +607,42 @@ 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))