+"""
+Object model for querying information and manipulating deployments
+of autoinstalls. Every :class:`Deployment` has an :class:`ApplicationVersion`
+which in turn has an :class:`Application`.
+"""
+
import os.path
import fileinput
import dateutil.parser
import distutils.version
import tempfile
+import logging
+import shutil
import wizard
-from wizard import log
+from wizard import git, old_log, scripts, shell, util
## -- Global Functions --
-def getInstallLines(vs):
- """Retrieves a list of lines from the version directory that
- can be passed to Deployment.parse()"""
- 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):
+def get_install_lines(versions_store, user=None):
+ """
+ Low level function that retrieves a list of lines from the
+ :term:`versions store` that can be passed to :meth:`Deployment.parse`.
+ """
+ if os.path.isfile(versions_store):
+ return fileinput.input([versions_store])
+ if user:
+ return fileinput.input([versions_store + "/" + user])
+ return fileinput.input([versions_store + "/" + f for f in sorted(os.listdir(versions_store))])
+
+def parse_install_lines(show, versions_store, yield_errors = False, user = None):
+ """
+ Generator function for iterating through all autoinstalls.
+ Each item is an instance of :class:`Deployment`, or possibly
+ a :class:`wizard.deploy.Error` if ``yield_errors`` is ``True``. You can
+ filter out applications and versions by specifying ``app``
+ or ``app-1.2.3`` in ``show``. This function may generate
+ log output.
+ """
+ if not show:
+ show = applications()
+ elif isinstance(show, str):
+ # otherwise, frozenset will treat string as an iterable
+ show = frozenset([show])
+ else:
+ show = frozenset(show)
+ for line in get_install_lines(versions_store, user):
# construction
try:
d = Deployment.parse(line)
## -- 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."""
+ """
+ Represents a deployment of an autoinstall, e.g. directory in a user's
+ web_scripts that has ``.scripts`` directory or ``.scripts-version``
+ file in it. Supply ``version`` with an :class:`ApplicationVersion` only if
+ you were reading from the :term:`versions store` and care about
+ speed (data from there can be stale).
+ """
+ #: Absolute path to the deployment
+ location = None
def __init__(self, location, version=None):
- """ `location` Location of the deployment
- `version` ApplicationVersion of the app. ONLY supply this
- if you don't mind having stale data; generally
- 'wizard list' and commands that operate of of the
- versions store will set this."""
- self.location = os.path.realpath(location)
+ self.location = os.path.abspath(location)
self._app_version = version
# some cache variables
self._read_cache = {}
- self._log = None
+ self._old_log = None
def read(self, file, force = False):
- """Reads a file's contents, possibly from cache unless force is True."""
+ """
+ Reads a file's contents, possibly from cache unless ``force``
+ is ``True``.
+ """
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):
- """Extracts all the values of all variables from deployment."""
+ """
+ Extracts all the values of all variables from deployment.
+ These variables may be used for parametrizing generic parent
+ commits and include things such as database access credentials
+ and local configuration.
+ """
return self.application.extract(self)
def parametrize(self, dir):
- """Edits files in dir to replace WIZARD_* variables with literal
+ """
+ Edits files in ``dir`` to replace WIZARD_* variables with literal
instances. This is used for constructing virtual merge bases, and
- as such dir will generally not equal self.location."""
+ as such dir will generally not equal :attr:`location`.
+ """
return self.application.parametrize(self, dir)
- def updateVersion(self, version):
- """Bump the version of this deployment.
-
- This method will update the version of this deployment in memory
- and on disk. It doesn't actually do an upgrade. The version
- string you pass here should probably have '-scripts' as a suffix."""
- 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()
- def scriptsifyVersion(self):
- """Converts from v1.0 to v1.0-scripts; use at end of migration."""
- self.updateVersion(str(self.version) + '-scripts')
+ def upgrade(self, version, options):
+ """
+ Performs an upgrae of database schemas and other non-versioned data.
+ """
+ with util.ChangeDirectory(self.location):
+ return self.application.upgrade(self, version, options)
+ def backup(self, options):
+ """
+ Performs a backup of database schemas and other non-versioned data.
+ """
+ with util.ChangeDirectory(self.location):
+ return self.application.backup(self, options)
+ def restore(self, backup, options):
+ """
+ Restores a backup. Destroys state, so be careful! Also, this does
+ NOT restore the file-level backup, which is what 'wizard restore'
+ does, so you probably do NOT want to call this elsewhere unless
+ you know what you're doing.
+ """
+ with util.ChangeDirectory(self.location):
+ return self.application.restore(self, backup, options)
+ def prepareConfig(self):
+ """
+ Edits files in the deployment such that any user-specific configuration
+ is replaced with generic WIZARD_* variables.
+ """
+ return self.application.prepareConfig(self)
+ def checkConfig(self, deployment):
+ """
+ Checks if the application is configured.
+ """
+ raise NotImplemented
+
+ def verify(self):
+ """
+ Checks if this is an autoinstall, throws an exception if there
+ are problems.
+ """
+ with util.ChangeDirectory(self.location):
+ has_git = os.path.isdir(".git")
+ has_scripts = os.path.isdir(".scripts")
+ if not has_git and has_scripts:
+ raise CorruptedAutoinstallError(self.location)
+ elif has_git and not has_scripts:
+ raise AlreadyVersionedError(self.location)
+ elif not has_git and not has_scripts:
+ if os.path.isfile(".scripts-version"):
+ raise NotMigratedError(self.location)
+
+ def verifyTag(self, srv_path):
+ """
+ Checks if the purported version has a corresponding tag
+ in the upstream repository.
+ """
+ repo = self.application.repository(srv_path)
+ try:
+ shell.Shell().eval("git", "--git-dir", repo, "rev-parse", self.app_version.scripts_tag, '--')
+ except shell.CallError:
+ raise NoTagError(self.app_version.scripts_tag)
+
+ def verifyGit(self, srv_path):
+ """
+ Checks if the autoinstall's Git repository makes sense,
+ checking if the tag is parseable and corresponds to
+ a real application, and if the tag in this repository
+ corresponds to the one in the remote repository.
+ """
+ with util.ChangeDirectory(self.location):
+ sh = shell.Shell()
+ repo = self.application.repository(srv_path)
+ def repo_rev_parse(tag):
+ return sh.eval("git", "--git-dir", repo, "rev-parse", tag)
+ def self_rev_parse(tag):
+ try:
+ return sh.safeCall("git", "rev-parse", tag, strip=True)
+ except shell.CallError:
+ raise NoLocalTagError(tag)
+ def compare_tags(tag):
+ return repo_rev_parse(tag) == self_rev_parse(tag)
+ if not compare_tags(self.app_version.pristine_tag):
+ raise InconsistentPristineTagError(self.app_version.pristine_tag)
+ if not compare_tags(self.app_version.scripts_tag):
+ raise InconsistentScriptsTagError(self.app_version.scripts_tag)
+ parent = repo_rev_parse(self.app_version.scripts_tag)
+ merge_base = sh.safeCall("git", "merge-base", parent, "HEAD", strip=True)
+ if merge_base != parent:
+ raise HeadNotDescendantError(self.app_version.scripts_tag)
+
+ def verifyConfigured(self):
+ """
+ Checks if the autoinstall is configured running.
+ """
+ if not self.configured:
+ raise NotConfiguredError(self.location)
+
+ def verifyVersion(self):
+ """
+ Checks if our version and the version number recorded in a file
+ are consistent.
+ """
+ real = self.application.detectVersion(self)
+ if not real:
+ raise VersionDetectionError
+ elif not str(real) == self.app_version.pristine_tag.partition('-')[2]:
+ raise VersionMismatchError(real, self.version)
+
+ def verifyWeb(self):
+ """
+ Checks if the autoinstall is viewable from the web.
+ """
+ out = []
+ if not self.application.checkWeb(self, out):
+ raise WebVerificationError(out[0])
+
+ def fetch(self, path, post=None):
+ """
+ Performs a HTTP request on the website.
+ """
+ try:
+ host, basepath = scripts.get_web_host_and_path(self.location)
+ except (ValueError, TypeError):
+ raise UnknownWebPath
+ return util.fetch(host, basepath, path, post)
+
+ @property
+ def configured(self):
+ """Whether or not an autoinstall has been configured/installed for use."""
+ return self.application.checkConfig(self)
+ @property
+ def migrated(self):
+ """Whether or not the autoinstalls has been migrated."""
+ return os.path.isdir(self.scripts_dir)
@property
def scripts_dir(self):
+ """The absolute path of the ``.scripts`` directory."""
return os.path.join(self.location, '.scripts')
@property
def old_version_file(self):
- """Use of this is discouraged for migrated installs."""
- if os.path.isdir(self.scripts_dir):
- return os.path.join(self.scripts_dir, 'old-version')
- else:
- return os.path.join(self.location, '.scripts-version')
+ """
+ The absolute path of either ``.scripts-version`` (for unmigrated
+ installs) or ``.scripts/version``.
+
+ .. note::
+
+ Use of this is discouraged for migrated installs.
+ """
+ return os.path.join(self.location, '.scripts-version')
@property
def version_file(self):
+ """The absolute path of the ``.scripts/version`` file."""
return os.path.join(self.scripts_dir, 'version')
@property
def application(self):
+ """The :class:`Application` of this deployment."""
return self.app_version.application
@property
- def log(self):
- if not self._log:
- self._log = log.DeployLog.load(self)
- return self._log
+ def old_log(self):
+ """
+ The :class:`wizard.old_log.Log` of this deployment. This
+ is only applicable to un-migrated autoinstalls.
+ """
+ if not self._old_log:
+ self._old_log = old_log.DeployLog.load(self)
+ return self._old_log
@property
def version(self):
- """Returns the distutils Version of the deployment"""
+ """
+ The :class:`distutils.version.LooseVersion` of this
+ deployment.
+ """
return self.app_version.version
@property
def app_version(self):
- """Returns the ApplicationVersion of the deployment"""
+ """The :class:`ApplicationVersion` of this deployment."""
if not self._app_version:
- if os.path.isfile(self.version_file):
- fh = open(self.version_file)
- appname, _, version = fh.read().rstrip().partition('-')
- fh.close()
- self._app_version = ApplicationVersion.make(appname, version)
- else:
- self._app_version = self.log[-1].version
+ if os.path.isdir(os.path.join(self.location, ".git")):
+ try:
+ with util.ChangeDirectory(self.location):
+ appname, _, version = git.describe().partition('-')
+ self._app_version = ApplicationVersion.make(appname, version)
+ except shell.CallError:
+ pass
+ if not self._app_version:
+ self._app_version = self.old_log[-1].version
return self._app_version
@staticmethod
def parse(line):
- """Parses a line from the versions directory.
+ """
+ Parses a line from the :term:`versions store`.
- Note: Use this method only when speed is of the utmost
- importance. You should prefer to directly create a deployment
- using Deployment(location) when accuracy is desired."""
+ .. note::
+
+ Use this method only when speed is of the utmost
+ importance. You should prefer to directly create a deployment
+ with only a ``location`` when possible.
+ """
line = line.rstrip()
try:
location, deploydir = line.split(":")
raise e
class Application(object):
- """Represents the generic notion of an application, i.e.
- mediawiki or phpbb."""
+ """Represents an application, i.e. mediawiki or phpbb."""
+ #: String name of the application
+ name = None
+ #: Dictionary of version strings to :class:`ApplicationVersion`.
+ #: See also :meth:`makeVersion`.
+ versions = None
+ #: List of files that need to be modified when parametrizing.
+ #: This is a class-wide constant, and should not normally be modified.
parametrized_files = []
def __init__(self, name):
self.name = name
self.versions = {}
# cache variables
self._extractors = {}
- self._parametrizers = {}
- @property
- def repository(self):
- """Returns the Git repository that would contain this application."""
- repo = os.path.join("/afs/athena.mit.edu/contrib/scripts/git/autoinstalls", self.name + ".git")
+ self._substitutions = {}
+ def repository(self, srv_path):
+ """
+ Returns the Git repository that would contain this application.
+ ``srv_path`` corresponds to ``options.srv_path`` from the global baton.
+ """
+ repo = os.path.join(srv_path, self.name + ".git")
if not os.path.isdir(repo):
- raise NoRepositoryError(app)
+ repo = os.path.join(srv_path, self.name, ".git")
+ if not os.path.isdir(repo):
+ raise NoRepositoryError(self.name)
return repo
def makeVersion(self, version):
+ """
+ Creates or retrieves the :class:`ApplicationVersion` singleton for the
+ specified version.
+ """
if version not in self.versions:
self.versions[version] = ApplicationVersion(distutils.version.LooseVersion(version), self)
return self.versions[version]
result[k] = extractor(deployment)
return result
def parametrize(self, deployment, dir):
- """Takes a generic source checkout at dir and parametrizes
- it according to the values of deployment."""
+ """
+ Takes a generic source checkout at dir and parametrizes
+ it according to the values of deployment.
+ """
variables = deployment.extract()
for file in self.parametrized_files:
fullpath = os.path.join(dir, file)
- f = open(fullpath, "r")
- contents = f.read()
- f.close()
+ try:
+ contents = open(fullpath, "r").read()
+ except IOError:
+ continue
for key, value in variables.items():
if value is None: continue
contents = contents.replace(key, value)
- tmp = tempfile.NamedTemporaryFile(delete=False)
- tmp.write(contents)
- tmp.close()
- os.rename(tmp.name, fullpath)
+ f = open(fullpath, "w")
+ f.write(contents)
+ def resolveConflicts(self, dir):
+ """
+ Takes a directory with conflicted files and attempts to
+ resolve them. Returns whether or not all conflicted
+ files were resolved or not. Fully resolved files are
+ added to the index, but no commit is made.
+ """
+ return False
+ def prepareMerge(self, dir):
+ """
+ Takes a directory and performs various edits to files in
+ order to make a merge go more smoothly. This is usually
+ used to fix botched line-endings. If you add new files,
+ you have to 'git add' them; this is not necessary for edits.
+ """
+ pass
+ def prepareConfig(self, deployment):
+ """
+ Takes a deployment and replaces any explicit instances
+ of a configuration variable with generic WIZARD_* constants.
+ There is a sane default implementation built on substitutions;
+ you can override this method to provide arbitrary extra
+ behavior.
+ """
+ for key, subst in self.substitutions.items():
+ subs = subst(deployment)
+ if not subs and key not in self.deprecated_keys:
+ logging.warning("No substitutions for %s" % key)
+ def install(self, version, options):
+ """
+ Run for 'wizard configure' (and, by proxy, 'wizard install')
+ to configure an application. This assumes that the current
+ working directory is a deployment.
+ """
+ raise NotImplemented
+ def upgrade(self, deployment, version, options):
+ """
+ Run for 'wizard upgrade' to upgrade database schemas and other
+ non-versioned data in an application. This assumes that
+ the current working directory is the deployment.
+ """
+ raise NotImplemented
+ def backup(self, deployment, options):
+ """
+ Run for 'wizard backup' and upgrades to backup database schemas
+ and other non-versioned data in an application. This assumes
+ that the current working directory is the deployment.
+ """
+ raise NotImplemented
+ def restore(self, deployment, backup, options):
+ """
+ Run for 'wizard restore' and failed upgrades to restore database
+ and other non-versioned data to a backed up version. This assumes
+ that the current working directory is the deployment.
+ """
+ raise NotImplemented
+ def detectVersion(self, deployment):
+ """
+ Checks source files to determine the version manually.
+ """
+ return None
+ def checkWeb(self, deployment, output=None):
+ """
+ Checks if the autoinstall is viewable from the web. Output
+ should be an empty list that will get mutated by this function.
+ """
+ raise NotImplemented
@property
def extractors(self):
+ """
+ Dictionary of variable names to extractor functions. These functions
+ take a :class:`Deployment` as an argument and return the value of
+ the variable, or ``None`` if it could not be found.
+ See also :func:`wizard.app.filename_regex_extractor`.
+ """
+ return {}
+ @property
+ def substitutions(self):
+ """
+ Dictionary of variable names to substitution functions. These functions
+ take a :class:`Deployment` as an argument and modify the deployment such
+ that an explicit instance of the variable is released with the generic
+ WIZARD_* constant. See also :func:`wizard.app.filename_regex_substitution`.
+ """
return {}
@staticmethod
def make(name):
return Application(name)
class ApplicationVersion(object):
- """Represents an abstract notion of a version for an application"""
+ """Represents an abstract notion of a version for an application, where
+ ``version`` is a :class:`distutils.version.LooseVersion` and
+ ``application`` is a :class:`Application`."""
+ #: The :class:`distutils.version.LooseVersion` of this instance.
+ version = None
+ #: The :class:`Application` of this instance.
+ application = None
def __init__(self, version, application):
- """ `version` Instance of distutils.LooseVersion
- `application` Instance of Application
- WARNING: Please don't call this directly; instead, use getVersion()
- on the application you want, so that this version gets registered."""
self.version = version
self.application = application
@property
+ def tag(self):
+ """
+ Returns the name of the git describe tag for the commit the user is
+ presently on, something like mediawiki-1.2.3-scripts-4-g123abcd
+ """
+ return "%s-%s" % (self.application, self.version)
+ @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. Unfortunately, finding
- # the "true" latest version is computationally expensive
- return "v%s-scripts" % self.version
+ """
+ Returns the name of the Git tag for this version.
+ """
+ end = str(self.version).partition('-scripts')[2].partition('-')[0]
+ return "%s-scripts%s" % (self.pristine_tag, end)
+ @property
+ def pristine_tag(self):
+ """
+ Returns the name of the Git tag for the pristine version corresponding
+ to this version.
+ """
+ return "%s-%s" % (self.application.name, str(self.version).partition('-scripts')[0])
def __cmp__(x, y):
return cmp(x.version, y.version)
@staticmethod
def parse(value):
- """Parses a line from the versions directory and return ApplicationVersion.
+ """
+ Parses a line from the :term:`versions store` and return
+ :class:`ApplicationVersion`.
Use this only for cases when speed is of primary importance;
the data in version is unreliable and when possible, you should
prefer directly instantiating a Deployment and having it query
the autoinstall itself for information.
- value : The value to parse, will look like:
- /afs/athena.mit.edu/contrib/scripts/deploy/APP-x.y.z for old style installs
- APP-x.y.z-scripts for wizard style installs
+ The `value` to parse will vary. For old style installs, it
+ will look like::
+
+ /afs/athena.mit.edu/contrib/scripts/deploy/APP-x.y.z
+
+ For new style installs, it will look like::
+
+ APP-x.y.z-scripts
"""
name = value.split("/")[-1]
try:
return ApplicationVersion.make(app, version)
@staticmethod
def make(app, version):
+ """
+ Makes/retrieves a singleton :class:`ApplicationVersion` from
+ a``app`` and ``version`` string.
+ """
try:
# defer to the application for version creation to enforce
# singletons
pass
class NoSuchApplication(Error):
+ """
+ You attempted to reference a :class:`Application` named
+ ``app``, which is not recognized by Wizard.
+ """
+ #: The name of the application that does not exist.
+ app = None
+ #: The location of the autoinstall that threw this variable.
+ #: This should be set by error handling code when it is availble.
+ location = None
def __init__(self, app):
- """app : Application that doesn't exist"""
self.app = app
- self.location = None # filled in when available
class DeploymentParseError(Error):
+ """
+ Could not parse ``value`` from :term:`versions store`.
+ """
+ #: The value that failed to parse.
+ value = None
+ #: The location of the autoinstall that threw this variable.
+ #: This should be set by error handling code when it is available.
+ location = None
def __init__(self, value):
- """value : Value from 'versions' that could not be parsed"""
self.value = value
- self.location = None # filled in when available
class NoRepositoryError(Error):
+ """
+ :class:`Application` does not appear to have a Git repository
+ in the normal location.
+ """
+ #: The name of the application that does not have a Git repository.
+ app = None
def __init__(self, app):
- """app : The application that doesn't have a Git repository"""
self.app = app
+ def __str__(self):
+ return """Could not find Git repository for '%s'. If you would like to use a local version, try specifying --srv-path or WIZARD_SRV_PATH.""" % self.app
+
+class NotMigratedError(Error):
+ """
+ The deployment contains a .scripts-version file, but no .git
+ or .scripts directory.
+ """
+ #: Directory of deployment
+ dir = None
+ def __init__(self, dir):
+ self.dir = dir
+ def __str__(self):
+ return """This installation was not migrated"""
+
+class AlreadyVersionedError(Error):
+ """The deployment contained a .git directory but no .scripts directory."""
+ #: Directory of deployment
+ dir = None
+ def __init__(self, dir):
+ self.dir = dir
+ def __str__(self):
+ return """
+
+ERROR: Directory contains a .git directory, but not
+a .scripts directory. If this is not a corrupt
+migration, this means that the user was versioning their
+install using Git."""
+
+class NotConfiguredError(Error):
+ """The install was missing essential configuration."""
+ #: Directory of unconfigured install
+ dir = None
+ def __init__(self, dir):
+ self.dir = dir
+ def __str__(self):
+ return """
+
+ERROR: The install was well-formed, but not configured
+(essential configuration files were not found.)"""
+
+class CorruptedAutoinstallError(Error):
+ """The install was missing a .git directory, but had a .scripts directory."""
+ #: Directory of the corrupted install
+ dir = None
+ def __init__(self, dir):
+ self.dir = dir
+ def __str__(self):
+ return """
+
+ERROR: Directory contains a .scripts directory,
+but not a .git directory."""
+
+class NotAutoinstallError(Error):
+ """The directory was not an autoinstall, due to missing .scripts-version file."""
+ #: Directory in question
+ dir = None
+ def __init__(self, dir):
+ self.dir = dir
+ def __str__(self):
+ return """
+
+ERROR: Could not find .scripts-version file. Are you sure
+this is an autoinstalled application?
+"""
+
+class NoTagError(Error):
+ """Deployment has a tag that does not have an equivalent in upstream repository."""
+ #: Missing tag
+ tag = None
+ def __init__(self, tag):
+ self.tag = tag
+ def __str__(self):
+ return """
+
+ERROR: Could not find tag %s in repository.""" % self.tag
+
+class NoLocalTagError(Error):
+ """Could not find tag in local repository."""
+ #: Missing tag
+ tag = None
+ def __init__(self, tag):
+ self.tag = tag
+ def __str__(self):
+ return """
+
+ERROR: Could not find tag %s in local repository.""" % self.tag
+
+class InconsistentPristineTagError(Error):
+ """Pristine tag commit ID does not match upstream pristine tag commit ID."""
+ #: Inconsistent tag
+ tag = None
+ def __init__(self, tag):
+ self.tag = tag
+ def __str__(self):
+ return """
+
+ERROR: Local pristine tag %s did not match repository's. This
+probably means an upstream rebase occured.""" % self.tag
+
+class InconsistentScriptsTagError(Error):
+ """Scripts tag commit ID does not match upstream scripts tag commit ID."""
+ #: Inconsistent tag
+ tag = None
+ def __init__(self, tag):
+ self.tag = tag
+ def __str__(self):
+ return """
+
+ERROR: Local scripts tag %s did not match repository's. This
+probably means an upstream rebase occurred.""" % self.tag
+
+class HeadNotDescendantError(Error):
+ """HEAD is not connected to tag."""
+ #: Tag that HEAD should have been descendant of.
+ tag = None
+ def __init__(self, tag):
+ self.tag = tag
+ def __str__(self):
+ return """
+
+ERROR: HEAD is not a descendant of %s. This probably
+means that an upstream rebase occurred, and new tags were
+pulled, but local user commits were never rebased.""" % self.tag
+
+class VersionDetectionError(Error):
+ """Could not detect real version of application."""
+ def __str__(self):
+ return """
+
+ERROR: Could not detect the real version of the application."""
+
+class VersionMismatchError(Error):
+ """Git version of application does not match detected version."""
+ #: Detected version
+ real_version = None
+ #: Version from Git
+ git_version = None
+ def __init__(self, real_version, git_version):
+ self.real_version = real_version
+ self.git_version = git_version
+ def __str__(self):
+ return """
+
+ERROR: The detected version %s did not match the Git
+version %s.""" % (self.real_version, self.git_version)
+
+class WebVerificationError(Error):
+ """Could not access the application on the web"""
+ #: Contents of web page access
+ contents = None
+ def __init__(self, contents):
+ self.contents = contents
+ def __str__(self):
+ return """
+
+ERROR: We were not able to access the application on the
+web. This may indicate that the website is behind
+authentication on the htaccess level. The contents
+of the page were:
+
+%s""" % self.contents
+
+class UnknownWebPath(Error):
+ """Could not determine application's web path."""
+ def __str__(self):
+ return """
-# If you want, you can wrap this up into a registry and access things
-# through that, but it's not really necessary
+ERROR: We were not able to determine what the application's
+host and path were in order to perform a web request
+on the application. You can specify this manually using
+the WIZARD_WEB_HOST and WIZARD_WEB_PATH environment
+variables."""
-application_list = [
+_application_list = [
"mediawiki", "wordpress", "joomla", "e107", "gallery2",
"phpBB", "advancedbook", "phpical", "trac", "turbogears", "django",
# these are technically deprecated
"""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 ])
+ _applications = dict([(n,Application.make(n)) for n in _application_list ])
return _applications
scripts.mit.edu / wizard.git / blobdiff