import os.path
-import math
import fileinput
import dateutil.parser
import distutils.version
import wizard
+from wizard import log
-def getInstallLines(global_options):
+## -- Global Functions --
+
+def getInstallLines(vs):
"""Retrieves a list of lines from the version directory that
can be passed to Deployment.parse()"""
- vs = global_options.versions
if os.path.isfile(vs):
return fileinput.input([vs])
return fileinput.input([vs + "/" + f for f in os.listdir(vs)])
+def parse_install_lines(show, options, yield_errors = False):
+ if not show: show = applications()
+ show = frozenset(show)
+ for line in getInstallLines(options.versions_path):
+ # construction
+ try:
+ d = Deployment.parse(line)
+ name = d.application.name
+ except deploy.NoSuchApplication as e:
+ if yield_errors:
+ yield e
+ continue
+ except deploy.Error:
+ # we consider this a worse error
+ logging.warning("Error with '%s'" % line.rstrip())
+ continue
+ # filter
+ if name + "-" + str(d.version) in show or name in show:
+ pass
+ else:
+ continue
+ # yield
+ yield d
+
+## -- Model Objects --
+
class Deployment(object):
"""Represents a deployment of an autoinstall; i.e. a concrete
directory in web_scripts that has .scripts-version in it."""
`version` ApplicationVersion of the app (this is cached info)
`log` DeployLog of the app"""
self.location = location
- self._version = version
+ self._app_version = version
self._log = log
+ self._read_cache = {}
+ def read(self, file, force = False):
+ """Reads a file's contents and stuffs it in a cache"""
+ if force or file not in self._read_cache:
+ f = open(os.path.join(self.location, file))
+ self._read_cache[file] = f.read()
+ f.close()
+ return self._read_cache[file]
+ def extract(self):
+ return self.application.extract(self)
+ def updateVersion(self, version=None):
+ """`version` Version string to update to, or leave out to simply
+ force the creation of .scripts/version file"""
+ if not version:
+ version = str(self.version)
+ else:
+ self._app_version = self.application.makeVersion(version)
+ f = open(os.path.join(self.scripts_dir, 'version'), 'w')
+ f.write(self.application.name + '-' + version + "\n")
+ f.close()
+ @property
+ def scripts_dir(self):
+ return os.path.join(self.location, '.scripts')
+ @property
+ def version_file(self):
+ return os.path.join(self.location, '.scripts-version')
+ @property
+ def application(self):
+ return self.app_version.application
+ @property
+ def log(self):
+ if not self._log:
+ self._log = log.DeployLog.load(self.version_file)
+ return self._log
+ @property
+ def version(self):
+ """Returns the distutils Version of the deployment"""
+ return self.app_version.version
+ @property
+ def app_version(self, force = False):
+ """Returns the ApplicationVersion of the deployment"""
+ if self._app_version and not force: return self._app_version
+ else: return self.log[-1].version
@staticmethod
def parse(line):
"""Parses a line from the results of parallel-find.pl.
location, deploydir = line.split(":")
except ValueError:
return Deployment(line) # lazy loaded version
- return Deployment(location, version=ApplicationVersion.parse(deploydir))
- @staticmethod
- def fromDir(dir):
- """Lazily creates a deployment from a directory"""
- return Deployment(dir)
- def getVersionFile(self):
- return os.path.join(self.location, '.scripts-version')
- def getApplication(self):
- return self.getAppVersion().application
- def getLog(self):
- if not self._log:
- self._log = DeployLog.load(self.getVersionFile())
- return self._log
- def getVersion(self):
- """Returns the distutils Version of the deployment"""
- return self.getAppVersion().version
- def getAppVersion(self, force = False):
- """Returns the ApplicationVersion of the deployment"""
- if self._version and not force: return self._version
- else: return self.getLog()[-1].version
- def count(self):
- """Simple method which registers the deployment as a +1 on the
- appropriate version. No further inspection is done."""
- self.getAppVersion().count(self)
- return True
- def count_exists(self, file):
- """Checks if the codebase has a certain file/directory in it."""
- if os.path.exists(self.location + "/" + file):
- self.getAppVersion().count_exists(self, file)
- return True
- return False
+ return Deployment(location, version=ApplicationVersion.parse(deploydir, location))
class Application(object):
"""Represents the generic notion of an application, i.e.
def __init__(self, name):
self.name = name
self.versions = {}
- # This is 'wizard summary' specific code
- self._total = 0
- self._max = 0
- self._c_exists = {}
- def getRepository(self):
+ self._extractors = {}
+ @property
+ def repository(self):
"""Returns the Git repository that would contain this application."""
- repo = os.path.join("/afs/athena.mit.edu/contrib/scripts/wizard/srv", self.name + ".git")
+ repo = os.path.join("/afs/athena.mit.edu/contrib/scripts/git/autoinstalls", self.name + ".git")
if not os.path.isdir(repo):
raise NoRepositoryError(app)
return repo
- def getVersion(self, version):
+ def makeVersion(self, version):
if version not in self.versions:
self.versions[version] = ApplicationVersion(distutils.version.LooseVersion(version), self)
return self.versions[version]
- # XXX: This code should go in summary.py; maybe as a mixin, maybe as
- # a visitor acceptor
- HISTOGRAM_WIDTH = 30
- def _graph(self, v):
- return '+' * int(math.ceil(float(v)/self._max * self.HISTOGRAM_WIDTH))
- def report(self):
- if not self.versions: return "%-11s no installs" % self.name
- ret = \
- ["%-16s %3d installs" % (self.name, self._total)] + \
- [v.report() for v in sorted(self.versions.values())]
- for f,c in self._c_exists.items():
- ret.append("%d users have %s" % (c,f))
- return "\n".join(ret)
-
-class DeployLog(list):
- # As per #python; if you decide to start overloading magic methods,
- # we should remove this subclass
- """Equivalent to .scripts-version: a series of DeployRevisions."""
- def __init__(self, revs = []):
- """`revs` List of DeployRevision objects"""
- list.__init__(self, revs) # pass to list
+ def extract(self, deployment):
+ """Extracts wizard variables from a deployment."""
+ result = {}
+ for k,extractor in self.extractors.items():
+ result[k] = extractor(deployment)
+ return result
+ @property
+ def extractors(self):
+ return {}
@staticmethod
- def load(file):
- """Loads a scripts version file and parses it into
- DeployLog and DeployRevision objects"""
- # XXX: DIRTY DIRTY HACK
- # What we should actually do is parse the git logs
- scriptsdir = os.path.join(os.path.dirname(file), ".scripts")
- if os.path.isdir(scriptsdir):
- file = os.path.join(scriptsdir, "old-version")
- i = 0
- rev = DeployRevision()
- revs = []
- def append(rev):
- if i:
- if i != 4:
- raise ScriptsVersionNotEnoughFieldsError()
- revs.append(rev)
+ def make(name):
+ """Makes an application, but uses the correct subtype if available."""
try:
- fh = open(file)
- except IOError:
- raise ScriptsVersionNoSuchFile(file)
- # XXX: possibly rewrite this parsing code. This might
- # be legacy soon
- for line in fh:
- line = line.rstrip()
- if not line:
- append(rev)
- i = 0
- rev = DeployRevision()
- continue
- if i == 0:
- # we need the dateutil parser in order to
- # be able to parse time offsets
- rev.datetime = dateutil.parser.parse(line)
- elif i == 1:
- rev.user = line
- elif i == 2:
- rev.source = DeploySource.parse(line)
- elif i == 3:
- rev.version = ApplicationVersion.parse(line)
- else:
- # ruh oh
- raise ScriptsVersionTooManyFieldsError()
- i += 1
- append(rev)
- return DeployLog(revs)
- def __repr__(self):
- return '<DeployLog %s>' % list.__repr__(self)
-
-class DeployRevision(object):
- """A single entry in the .scripts-version file. Contains who deployed
- this revision, what application version this is, etc."""
- def __init__(self, datetime=None, user=None, source=None, version=None):
- """ `datetime` Time this revision was deployed
- `user` Person who deployed this revision, in user@host format.
- `source` Instance of DeploySource
- `version` Instance of ApplicationVersion
- Note: This object is typically built incrementally."""
- self.datetime = datetime
- self.user = user
- self.source = source
- self.version = version
-
-class DeploySource(object):
- """Source of the deployment; see subclasses for examples"""
- def __init__(self):
- raise NotImplementedError # abstract class
- @staticmethod
- def parse(line):
- # munge out common prefix
- rel = os.path.relpath(line, "/afs/athena.mit.edu/contrib/scripts/")
- parts = rel.split("/")
- if parts[0] == "wizard":
- return WizardUpdate()
- elif parts[0] == "deploy" or parts[0] == "deploydev":
- isDev = ( parts[0] == "deploydev" )
- try:
- if parts[1] == "updates":
- return OldUpdate(isDev)
- else:
- return TarballInstall(line, isDev)
- except IndexError:
- pass
- return UnknownDeploySource(line)
-
-class TarballInstall(DeploySource):
- """Original installation from tarball, characterized by
- /afs/athena.mit.edu/contrib/scripts/deploy/APP-x.y.z.tar.gz
- """
- def __init__(self, location, isDev):
- self.location = location
- self.isDev = isDev
-
-class OldUpdate(DeploySource):
- """Upgrade using old upgrade infrastructure, characterized by
- /afs/athena.mit.edu/contrib/scripts/deploydev/updates/update-scripts-version.pl
- """
- def __init__(self, isDev):
- self.isDev = isDev
-
-class WizardUpdate(DeploySource):
- """Upgrade using wizard infrastructure, characterized by
- /afs/athena.mit.edu/contrib/scripts/wizard/bin/wizard HASHGOBBLEDYGOOK
- """
- def __init__(self):
- pass
-
-class UnknownDeploySource(DeploySource):
- """Deployment that we don't know the meaning of. Wot!"""
- def __init__(self, line):
- self.line = line
+ __import__("wizard.app." + name)
+ return getattr(wizard.app, name).Application(name)
+ except ImportError:
+ return Application(name)
class ApplicationVersion(object):
"""Represents an abstract notion of a version for an application"""
on the application you want, so that this version gets registered."""
self.version = version
self.application = application
- self.c = 0
- self.c_exists = {}
- def getScriptsTag(self):
+ @property
+ def scripts_tag(self):
"""Returns the name of the Git tag for this version"""
# XXX: This assumes that there's only a -scripts version
- # which will not be true in the future.
+ # which will not be true in the future. Unfortunately, finding
+ # the "true" latest version is computationally expensive
return "v%s-scripts" % self.version
def __cmp__(x, y):
return cmp(x.version, y.version)
@staticmethod
- def parse(deploydir,applookup=None):
+ def parse(deploydir,location,applookup=None):
# The version of the deployment, will be:
# /afs/athena.mit.edu/contrib/scripts/deploy/APP-x.y.z for old style installs
- # /afs/athena.mit.edu/contrib/scripts/wizard/srv/APP.git vx.y.z-scripts for new style installs
name = deploydir.split("/")[-1]
try:
if name.find(" ") != -1:
version = raw_version[1:] # remove leading v
app, _ = raw_app.split(".") # remove trailing .git
elif name.find("-") != -1:
- app, version = name.split("-")
- # XXX: this should be removed after the next parallel-find run
- elif name == "deploy":
- # Assume that it's django, since those were botched
- app = "django"
- version = "0.1-scripts"
+ app, _, version = name.partition("-")
else:
- raise DeploymentParseError(deploydir)
+ app = name
+ version = "trunk"
except ValueError: # mostly from the a, b = foo.split(' ')
- raise DeploymentParseError(deploydir)
- if not applookup: applookup = applications
+ raise DeploymentParseError(deploydir, location)
+ if not applookup: applookup = applications()
try:
# defer to the application for version creation
- return applookup[app].getVersion(version)
+ return applookup[app].makeVersion(version)
except KeyError:
- raise NoSuchApplication
- # This is summary specific code
- def count(self, deployment):
- self.c += 1
- self.application._total += 1
- if self.c > self.application._max:
- self.application._max = self.c
- def count_exists(self, deployment, n):
- if n in self.c_exists: self.c_exists[n] += 1
- else: self.c_exists[n] = 1
- if n in self.application._c_exists: self.application._c_exists[n] += 1
- else: self.application._c_exists[n] = 1
- def report(self):
- return " %-12s %3d %s" \
- % (self.version, self.c, self.application._graph(self.c))
+ raise NoSuchApplication(app, location)
+
+## -- Exceptions --
-class Error(wizard.Error):
- """Base error class for deploy errors"""
+class Error(Exception):
+ """Base error class for this module"""
pass
class NoSuchApplication(Error):
- pass
+ def __init__(self, name, location):
+ self.name = name
+ self.location = location
+ def __str__(self):
+ return "ERROR: Unrecognized app '%s' at %s" % (self.name, self.location)
class DeploymentParseError(Error):
- def __init__(self, malformed):
+ def __init__(self, malformed, location):
self.malformed = malformed
+ self.location = location
def __str__(self):
- return """
-
-ERROR: Could not parse deployment string:
-%s
-""" % self.malformed
-
-class ScriptsVersionTooManyFieldsError(Error):
- def __str__(self):
- return """
-
-ERROR: Could not parse .scripts-version file. It
-contained too many fields.
-"""
-
-class ScriptsVersionNotEnoughFieldsError(Error):
- def __str__(self):
- return """
+ return """ERROR: Unparseable '%s' at %s""" % (self.malformed, self.location)
-ERROR: Could not parse .scripts-version file. It
-didn't contain enough fields.
-"""
-
-class ScriptsVersionNoSuchFile(Error):
- def __init__(self, file):
- self.file = file
+class NoRepositoryError(Error):
+ def __init__(self, app):
+ self.app = app
+ self.location = "unknown"
def __str__(self):
return """
-ERROR: File %s didn't exist.
-""" % self.file
+ERROR: Could not find repository for this application. Have
+you converted the repository over? Is the name %s
+the same as the name of the .git folder?
+""" % self.app
# If you want, you can wrap this up into a registry and access things
# through that, but it's not really necessary
# these are technically deprecated
"advancedpoll", "gallery",
]
-
-"""Hash table for looking up string application name to instance"""
-applications = dict([(n,Application(n)) for n in application_list ])
+_applications = None
+
+def applications():
+ """Hash table for looking up string application name to instance"""
+ global _applications
+ if not _applications:
+ _applications = dict([(n,Application.make(n)) for n in application_list ])
+ return _applications
scripts.mit.edu / wizard.git / blobdiff