import traceback
import shutil
import errno
+import pkg_resources
+import urlparse
import wizard
-from wizard import app, git, old_log, scripts, shell, sql, util
+from wizard import app, git, old_log, shell, sql, util
## -- Global Functions --
d = Deployment.parse(line)
name = d.application.name
except app.NoSuchApplication as e:
+ if not e.location:
+ try:
+ e.location = line.split(':')[0]
+ except IndexError:
+ e.location = line
if yield_errors:
yield e
continue
logging.warning("Error with '%s'" % line.rstrip())
continue
# filter
- if name + "-" + str(d.version) in show or name in show:
+ if name + "-" + util.truncate(str(d.version)) in show or name in show:
pass
else:
continue
# yield
yield d
+def web(dir, url=None):
+ """
+ Attempts to determine the URL a directory would be web-accessible at.
+ If ``url`` is specified, automatically use it. Returns a generator which
+ produces a list of candidate urls.
+
+ This function implements a plugin interface named :ref:`wizard.deploy.web`.
+ """
+ if url:
+ if isinstance(url, str):
+ url = urlparse.urlparse(url)
+ logging.info("wizard.deploy.web: Using default URL %s", url)
+ yield url
+ return
+
+ for entry in pkg_resources.iter_entry_points("wizard.deploy.web"):
+ logging.debug("wizard.deploy.web: Processing %s", entry)
+ f = entry.load()
+ for r in f(dir):
+ if isinstance(r, str):
+ r = urlparse.urlparse(r)
+ logging.info("wizard.deploy.web: Using plugin-supplied URL %s", r)
+ yield r
+
+ # try the environment
+ host = os.getenv("WIZARD_WEB_HOST")
+ path = os.getenv("WIZARD_WEB_PATH")
+ if host is not None and path is not None:
+ r = urlparse.ParseResult(
+ "http",
+ host,
+ path.rstrip('/'),
+ "", "", "")
+ logging.info("wizard.deploy.web: Using environment URL %s", r)
+ yield r
+
+ logging.info("wizard.deploy.web: Exhausted URLs")
+
## -- Model Objects --
@decorator.decorator
class Deployment(object):
"""
- Represents a deployment of an autoinstall, e.g. directory
- 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).
+ Represents a deployment of an autoinstall, e.g. directory that has a
+ ``.wizard`` directory 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).
The Deployment interface is somewhat neutered, so you may
want to use :class:`WorkingCopy` or :class:`ProductionCopy` for
more powerful operations.
+
+ .. note::
+
+ For legacy purposes, deployments can also be marked by a
+ ``.scripts`` directory or a ``.scripts-version`` file.
"""
#: Absolute path to the deployment
location = None
self._old_log = None
self._dsn = None
self._url = None
+ self._urlGen = None
+ self._wizard_dir = None
def invalidateCache(self):
"""
Invalidates all cached variables. This currently applies to
self._app_version = None
self._read_cache = {}
self._old_log = None
+ def setAppVersion(self, app_version):
+ """
+ Manually resets the application version; useful if the working
+ copy is off in space (i.e. not anchored to something we can
+ git describe off of) or there is no metadata to be heard of.
+ """
+ self._app_version = app_version
def read(self, file, force = False):
"""
Reads a file's contents, possibly from cache unless ``force``
"""
return self.application.extract(self)
- def verify(self):
+ def verify(self, no_touch=False):
"""
Checks if this is an autoinstall, throws an exception if there
- are problems.
+ are problems. If ``no_touch`` is ``True``, it will not attempt
+ edit the installation.
"""
with util.ChangeDirectory(self.location):
has_git = os.path.isdir(".git")
- has_scripts = os.path.isdir(".scripts")
- if not has_git and has_scripts:
+ has_wizard = os.path.isdir(".wizard")
+ if not has_wizard and os.path.isdir(".scripts"):
+ # LEGACY
+ os.symlink(".scripts", ".wizard")
+ has_wizard = True
+ if not has_git and has_wizard:
raise CorruptedAutoinstallError(self.location)
- elif has_git and not has_scripts:
+ elif has_git and not has_wizard:
raise AlreadyVersionedError(self.location)
- elif not has_git and not has_scripts:
+ # LEGACY
+ elif not has_git and not has_wizard:
if os.path.isfile(".scripts-version"):
raise NotMigratedError(self.location)
+ else:
+ raise NotAutoinstallError(self.location)
def verifyTag(self, srv_path):
"""
"""
repo = self.application.repository(srv_path)
try:
- shell.eval("git", "--git-dir", repo, "rev-parse", self.app_version.scripts_tag, '--')
+ shell.eval("git", "--git-dir", repo, "rev-parse", self.app_version.wizard_tag, '--')
except shell.CallError:
- raise NoTagError(self.app_version.scripts_tag)
+ raise NoTagError(self.app_version.wizard_tag)
def verifyGit(self, srv_path):
"""
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)
+ if not compare_tags(self.app_version.wizard_tag):
+ # Causes remastering
+ raise InconsistentWizardTagError(self.app_version.wizard_tag)
+ parent = repo_rev_parse(self.app_version.wizard_tag)
merge_base = shell.safeCall("git", "merge-base", parent, "HEAD", strip=True)
if merge_base != parent:
- raise HeadNotDescendantError(self.app_version.scripts_tag)
+ # Causes remastering
+ raise HeadNotDescendantError(self.app_version.wizard_tag)
def verifyConfigured(self):
"""
if not str(real) == self.app_version.pristine_tag.partition('-')[2]:
raise VersionMismatchError(real, self.version)
- @property
@chdir_to_location
def detectVersion(self):
"""
@property
def migrated(self):
"""Whether or not the autoinstalls has been migrated."""
- return os.path.isdir(self.scripts_dir)
+ return os.path.isdir(self.wizard_dir)
+ @property
+ def wizard_dir(self):
+ """The absolute path of the Wizard directory."""
+ return os.path.join(self.location, ".wizard")
@property
- def scripts_dir(self):
- """The absolute path of the ``.scripts`` directory."""
- return os.path.join(self.location, '.scripts')
+ def backup_dir(self):
+ """The absolute path to ``.wizard/backups``."""
+ return os.path.join(self.wizard_dir, "backups")
+ # LEGACY
@property
def old_version_file(self):
"""
- The absolute path of either ``.scripts-version`` (for unmigrated
- installs) or ``.scripts/version``.
-
- .. note::
-
- Use of this is discouraged for migrated installs.
+ The absolute path of either ``.scripts-version``.
"""
return os.path.join(self.location, '.scripts-version')
@property
+ def blacklisted_file(self):
+ """The absolute path of the ``.wizard/blacklisted`` file."""
+ return os.path.join(self.wizard_dir, 'blacklisted')
+ @property
+ def pending_file(self):
+ """The absolute path of the ``.wizard/pending`` file."""
+ return os.path.join(self.wizard_dir, 'pending')
+ @property
def version_file(self):
- """The absolute path of the ``.scripts/version`` file."""
- return os.path.join(self.scripts_dir, 'version')
+ """The absolute path of the ``.wizard/version`` file."""
+ return os.path.join(self.wizard_dir, 'version')
@property
def dsn_file(self):
- """The absolute path of the :file:`.scripts/dsn` override file."""
- return os.path.join(self.scripts_dir, 'dsn')
+ """The absolute path of the :file:`.wizard/dsn` override file."""
+ return os.path.join(self.wizard_dir, 'dsn')
@property
def url_file(self):
- """The absolute path of the :file:`.scripts/url` override file."""
- return os.path.join(self.scripts_dir, 'url')
+ """The absolute path of the :file:`.wizard/url` override file."""
+ return os.path.join(self.wizard_dir, 'url')
@property
def application(self):
"""The :class:`app.Application` of this deployment."""
except shell.CallError:
pass
if not self._app_version:
+ # LEGACY
try:
self._app_version = self.old_log[-1].version
except old_log.ScriptsVersionNoSuchFile:
def dsn(self):
"""The :class:`sqlalchemy.engine.url.URL` for this deployment."""
if not self._dsn:
- self._dsn = sql.fill_url(self.application.dsn(self))
+ self._dsn = sql.auth(self.application.dsn(self))
return self._dsn
@property
def url(self):
"""The :class:`urlparse.ParseResult` for this deployment."""
if not self._url:
- self._url = scripts.fill_url(self.location, self.application.url(self))
- if not self._url:
- raise UnknownWebPath
+ self.nextUrl()
return self._url
+ def nextUrl(self):
+ """
+ Initializes :attr:`url` with a possible URL the web application may
+ be located at. It may be called again to switch to another possible
+ URL, usually in the event of a web access failure.
+ """
+ if not self._urlGen:
+ self._urlGen = web(self.location, self.application.url(self))
+ try:
+ self._url = self._urlGen.next() # pylint: disable-msg=E1101
+ return self._url
+ except StopIteration:
+ raise UnknownWebPath
@staticmethod
def parse(line):
"""
# There are retarded amounts of race-safety in this function,
# because we do NOT want to claim to have made a backup, when
# actually something weird happened to it.
- backupdir = os.path.join(self.scripts_dir, "backups")
- if not os.path.exists(backupdir):
+ if not os.path.exists(self.backup_dir):
try:
- os.mkdir(backupdir)
+ os.mkdir(self.backup_dir)
except OSError as e:
if e.errno == errno.EEXIST:
pass
shutil.rmtree(tmpdir)
raise
backup = None
- with util.LockDirectory(os.path.join(backupdir, "lock")):
+ with util.LockDirectory(os.path.join(self.backup_dir, "lock")):
while 1:
backup = str(self.version) + "-" + datetime.datetime.today().strftime("%Y-%m-%dT%H%M%S")
- outdir = os.path.join(backupdir, backup)
+ outdir = os.path.join(self.backup_dir, backup)
if os.path.exists(outdir):
logging.warning("Backup: A backup occurred in the last second. Trying again in a second...")
time.sleep(1)
does, so you probably do NOT want to call this elsewhere unless
you know what you're doing (call 'wizard restore' instead).
"""
- backup_dir = os.path.join(".scripts", "backups", backup)
- return self.application.restore(self, backup_dir, options)
+ return self.application.restore(self, os.path.join(self.backup_dir, backup), options)
@chdir_to_location
def remove(self, options):
"""
this application uses.
"""
self.application.remove(self, options)
+ def verifyDatabase(self):
+ """
+ Checks if the autoinstall has a properly configured database.
+ """
+ if not self.application.checkDatabase(self):
+ raise DatabaseVerificationError
def verifyWeb(self):
"""
- Checks if the autoinstall is viewable from the web.
+ Checks if the autoinstall is viewable from the web. If you do not run
+ this, there is no guarantee that the url returned by this application
+ is the correct one.
"""
- if not self.application.checkWeb(self):
- raise WebVerificationError
+ while True:
+ if not self.application.checkWeb(self):
+ try:
+ self.nextUrl()
+ except UnknownWebPath:
+ raise WebVerificationError
+ else:
+ break
def fetch(self, path, post=None):
"""
Performs a HTTP request on the website.
"""Base error class for this module"""
pass
+# LEGACY
class NotMigratedError(Error):
"""
The deployment contains a .scripts-version file, but no .git
- or .scripts directory.
+ or .wizard directory.
"""
#: Directory of deployment
dir = None
return """This installation was not migrated"""
class AlreadyVersionedError(Error):
- """The deployment contained a .git directory but no .scripts directory."""
+ """The deployment contained a .git directory but no .wizard directory."""
#: Directory of deployment
dir = None
def __init__(self, dir):
return """
ERROR: Directory contains a .git directory, but not
-a .scripts directory. If this is not a corrupt
+a .wizard directory. If this is not a corrupt
migration, this means that the user was versioning their
install using Git."""
(essential configuration files were not found.)"""
class CorruptedAutoinstallError(Error):
- """The install was missing a .git directory, but had a .scripts directory."""
+ """The install was missing a .git directory, but had a .wizard directory."""
#: Directory of the corrupted install
dir = None
def __init__(self, dir):
def __str__(self):
return """
-ERROR: Directory contains a .scripts directory,
+ERROR: Directory contains a .wizard directory,
but not a .git directory."""
class NotAutoinstallError(Error):
- """The directory was not an autoinstall, due to missing .scripts-version file."""
- #: Directory in question
+ """Application is not an autoinstall."""
+ #: Directory of the not autoinstall
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?
-"""
+ERROR: The directory
+
+ %s
+
+does not appear to be an autoinstall. If you are in a
+subdirectory of an autoinstall, you need to use the root
+directory for the autoinstall.""" % self.dir
class NoTagError(Error):
"""Deployment has a tag that does not have an equivalent in upstream repository."""
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."""
+class InconsistentWizardTagError(Error):
+ """Wizard tag commit ID does not match upstream wizard tag commit ID."""
#: Inconsistent tag
tag = None
def __init__(self, tag):
def __str__(self):
return """
-ERROR: Local scripts tag %s did not match repository's. This
-probably means an upstream rebase occurred.""" % self.tag
+ERROR: Local wizard tag %s did not match repository's. This
+probably means an upstream rebase occurred. Try
+'git fetch --tags && wizard remaster'.""" % self.tag
class HeadNotDescendantError(Error):
"""HEAD is not connected to tag."""
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
+pulled, but local user commits were never rebased. Try
+running 'wizard remaster'.""" % self.tag
class VersionDetectionError(Error):
"""Could not detect real version of application."""
authentication on the htaccess level. You can find
the contents of the page from the debug backtraces."""
+class DatabaseVerificationError(Error):
+ """Could not access the database"""
+ def __str__(self):
+ return """
+
+ERROR: We were not able to access the database for
+this application; this probably means that your database
+configuration is misconfigured."""
+
class UnknownWebPath(Error):
"""Could not determine application's web path."""
def __str__(self):
on the application. You can specify this manually using
the WIZARD_WEB_HOST and WIZARD_WEB_PATH environment
variables."""
-
scripts.mit.edu / wizard.git / blobdiff