import distutils.version
import tempfile
import logging
+import shutil
import wizard
-from wizard import git, old_log, shell, util
+from wizard import git, old_log, scripts, shell, util
## -- Global Functions --
-def get_install_lines(versions_store):
+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):
+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. Make sure that ``show`` is a list and not a string.
+ log output.
"""
- if not show: show = applications()
- show = frozenset(show)
- for line in get_install_lines(versions_store):
+ 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)
as such dir will generally not equal :attr:`location`.
"""
return self.application.parametrize(self, dir)
+ 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
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."""
for key, value in variables.items():
if value is None: continue
contents = contents.replace(key, value)
- tmp = tempfile.NamedTemporaryFile(delete=False)
- tmp.write(contents)
- 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
subs = subst(deployment)
if not subs and key not in self.deprecated_keys:
logging.warning("No substitutions for %s" % key)
- def install(self, options):
+ def install(self, version, options):
"""
Run for 'wizard configure' (and, by proxy, 'wizard install')
- to configure an application.
+ to configure an application. This assumes that the current
+ working directory is a deployment.
"""
raise NotImplemented
- def upgrade(self, options):
+ def upgrade(self, deployment, version, options):
"""
Run for 'wizard upgrade' to upgrade database schemas and other
- non-versioned data in an application.
+ 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
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):
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):
(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):
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):
"""
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):
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):
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):
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):
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):
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 """
+
+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 = [
"mediawiki", "wordpress", "joomla", "e107", "gallery2",
"phpBB", "advancedbook", "phpical", "trac", "turbogears", "django",
scripts.mit.edu / wizard.git / blobdiff