def apply(self, installpath, backuppath=None):
"""
Apply the manifest against the given installation path.
"""
self.installpath = installpath
manifest = self.manifest
# fetch and verify package
if "package-uri" in manifest:
packageuri = URI(manifest["package-uri"])
packagename = path.basename(packageuri["path"])
packagepath = path.join(tempfile.gettempdir(), packagename)
packageformat = None
if "package-format" in manifest:
packageformat = manifest["package-format"]
# download package file
log.info("Fetching update package from {0}".format(packageuri.uri))
packageuri.fetch(packagepath)
packageuri.close()
# integrity check
if "package-sha1" in manifest:
packagesha1 = sha1(packagepath)
if not packagesha1 == manifest["package-sha1"]:
raise Exception("Package integrity check failed")
self.package = Package(packagepath, packageformat)
# create spot for backup files
if backuppath is None:
self.backuppath = tempfile.mkdtemp(prefix="update_")
else:
self.backuppath = backuppath
if not path.isdir(self.backuppath):
log.debug("Backup path {0} does not exist; creating".format(self.backuppath))
os.mkdir(self.backuppath)
# start applying actions
try:
for info in manifest.actions:
self._action(info)
# handle update errors by rolling back
except Exception as err:
log.exception("Exception eaten; beginning rollback")
for root, dirs, files in os.walk(self.backuppath):
relpath = path.relpath(root, self.backuppath)
if relpath == ".":
relpath = ""
for filename in files:
filepath = path.join(relpath, filename)
log.info("Rolling back file %s" % (filepath))
self._restore(filepath)
log.info("Rollback completed; raising exception")
raise
# clean up
finally:
self.cleanup = False
shutil.rmtree(self.backuppath, onerror=self._onerror)
self.package.close()
os.remove(packagepath)
if self.cleanup:
return self.backuppath
class Update:
def __init__(self, currentver, manifest=None, manifesturi=None):
"""
Fetch a manifest and verify that it matches the given version.
"""
# fetch the manifest
if manifest is None:
if manifesturi is None:
raise Exception("Update not given manifest object or URI")
with URI(manifesturi) as uri:
manifest = Manifest.from_yaml(uri.read())
# verify versions match
if currentver != manifest["current-version"]:
log.error("Current version '{0}' does not match manifest '{1}'".format(
currentver, manifest["current-version"]))
raise Exception("Current version does not match manifest")
self.manifest = manifest
self.package = None
def apply(self, installpath, backuppath=None):
"""
Apply the manifest against the given installation path.
"""
self.installpath = installpath
manifest = self.manifest
# fetch and verify package
if "package-uri" in manifest:
packageuri = URI(manifest["package-uri"])
packagename = path.basename(packageuri["path"])
packagepath = path.join(tempfile.gettempdir(), packagename)
packageformat = None
if "package-format" in manifest:
packageformat = manifest["package-format"]
# download package file
log.info("Fetching update package from {0}".format(packageuri.uri))
packageuri.fetch(packagepath)
packageuri.close()
# integrity check
if "package-sha1" in manifest:
packagesha1 = sha1(packagepath)
if not packagesha1 == manifest["package-sha1"]:
raise Exception("Package integrity check failed")
self.package = Package(packagepath, packageformat)
# create spot for backup files
if backuppath is None:
self.backuppath = tempfile.mkdtemp(prefix="update_")
else:
self.backuppath = backuppath
if not path.isdir(self.backuppath):
log.debug("Backup path {0} does not exist; creating".format(self.backuppath))
os.mkdir(self.backuppath)
# start applying actions
try:
for info in manifest.actions:
self._action(info)
# handle update errors by rolling back
except Exception as err:
log.exception("Exception eaten; beginning rollback")
for root, dirs, files in os.walk(self.backuppath):
relpath = path.relpath(root, self.backuppath)
if relpath == ".":
relpath = ""
for filename in files:
filepath = path.join(relpath, filename)
log.info("Rolling back file %s" % (filepath))
self._restore(filepath)
log.info("Rollback completed; raising exception")
raise
# clean up
finally:
self.cleanup = False
shutil.rmtree(self.backuppath, onerror=self._onerror)
self.package.close()
os.remove(packagepath)
if self.cleanup:
return self.backuppath
def _onerror(self, func, filepath, error):
self.cleanup = True
def _backup(self, filename, move=True):
ipath = path.normpath(path.join(self.installpath, filename))
bpath = path.normpath(path.join(self.backuppath, filename))
if not path.isfile(ipath):
return
bdir = path.dirname(bpath)
if not path.isdir(bdir):
os.makedirs(bdir)
try:
if move:
log.debug("Backing up file {0} by moving to backup directory".format(filename))
shutil.move(ipath, bpath)
else:
log.debug("Backing up file {0} by copying to backup directory".format(filename))
shutil.copy(ipath, bpath)
except:
log.debug("Backup failed for {0}".format(filename))
def _restore(self, filename):
ipath = path.normpath(path.join(self.installpath, filename))
bpath = path.normpath(path.join(self.backuppath, filename))
idir = path.dirname(ipath)
if not path.isdir(idir):
os.makedirs(idir)
try:
if path.isfile(ipath):
log.debug("Removing file {0} before restoring old version".format(filename))
os.remove(ipath)
log.debug("Restoring file {0} by moving from backup directory".format(filename))
shutil.move(bpath, ipath)
except:
log.debug("Restore failed for {0}".format(filename))
def _action(self, info):
action = info["action"]
filename = info["filename"]
fullpath = path.join(self.installpath, filename)
# verify file integrity and attempt to repair if corrupted
if action == "verify":
log.info("Action: verify {0}".format(filename))
hash = info["sha1-before"]
if not sha1(fullpath) == hash:
if "full-uri" in info:
fullformat = None
if "full-format" in info:
fullformat = info["full-format"]
self._backup(filename)
log.info("Extract replacement file from {0}".format(info["full-uri"]))
with URI(info["full-uri"], package=self.package, format=fullformat,
target=fullpath):
if not sha1(fullpath) == hash:
raise Exception("Integrity check and repair failed")
else:
raise Exception("Integrity check failed with no repair")
# create a new file and verify integrity
elif action == "create":
log.info("Action: create {0}".format(filename))
hash = info["sha1-after"]
if "full-uri" in info:
fullformat = None
if "full-format" in info:
fullformat = info["full-format"]
log.info("Extract new file from {0}".format(info["full-uri"]))
with URI(info["full-uri"], package=self.package, format=fullformat,
target=fullpath):
if not sha1(fullpath) == hash:
raise Exception("Created file failed integrity check")
else:
raise Exception("Create action has no URI")
# replace file and verify replacement integrity
elif action == "replace":
log.info("Action: replace {0}".format(filename))
hash = info["sha1-after"]
if "full-uri" in info:
fullformat = None
if "full-format" in info:
fullformat = info["full-format"]
self._backup(filename)
log.info("Extract replacement file from {0}".format(info["full-uri"]))
with URI(info["full-uri"], package=self.package, format=fullformat,
target=fullpath):
if not sha1(fullpath) == hash:
raise Exception("Replacement file failed integrity check")
else:
raise Exception("Replacement action has no URI")
# delete a file with little recourse
elif action == "delete":
log.info("Action: delete {0}".format(filename))
self._backup(filename)
# intentional exception to test rollbacks
elif action == "exception":
log.warning("Action: exception")
raise Exception("Intentional exception raised")
# /shrug
else:
raise Exception("Unsupported action %s" % (action))
