py_tasks_melange: comparison scripts/release/release.py

equal deleted inserted replaced

-:0589bf1395c5
+:3f30b7b14c57
 # release number.
 MELANGE_RELEASE_RE = re.compile(r'\d-\d-\d{8}p\d+')
 class Error(error.Error):
 pass
 class AbortedByUser(Error):
 """The operation was aborted by the user."""
 class ObstructionError(Error):
 """An operation was obstructed by existing data."""
 class ExpectationFailed(Error):
 """An unexpected state was encountered by an automated step."""
 class FileAccessError(Error):
 """An error occured while accessing a file."""
 def confirm(prompt, default=False):
 """Ask a yes/no question and return the answer.
 Will reprompt the user until one of "yes", "no", "y" or "n" is
 entered. The input is case insensitive.
 Args:
 prompt: The question to ask the user.
 default: The answer to return if the user just hits enter.
+Returns:
+True if the user answered affirmatively, False otherwise.
+"""
+if default:
+question = prompt + ' [Yn] '
+else:
+question = prompt + ' [yN] '
+while True:
+try:
+answer = raw_input(question).strip().lower()
+except EOFError:
+raise AbortedByUser('Aborted by ctrl+D')
+if not answer:
+return default
+elif answer in ('y', 'yes'):
+return True
+elif answer in ('n', 'no'):
+return False
+else:
+log.error('Please answer yes or no.')
+def getString(prompt):
+"""Prompt for and return a string."""
+try:
+return raw_input(prompt + ' ').strip()
+except EOFError:
+raise AbortedByUser('Aborted by ctrl+D')
+def getNumber(prompt):
+"""Prompt for and return a number.
+Will reprompt the user until a number is entered.
+"""
+while True:
+value_str = getString(prompt)
+try:
+return int(value_str)
+except ValueError:
+log.error('Please enter a number. You entered "%s".' % value_str)
+def getChoice(intro, prompt, choices, done=None, suggest=None):
+"""Prompt for and return a choice from a menu.
+Will reprompt the user until a valid menu entry is chosen.
+Args:
+intro: Text to print verbatim before the choice menu.
+prompt: The prompt to print right before accepting input.
+choices: The list of string choices to display.
+done: If not None, the list of indices of previously
+selected/completed choices.
+suggest: If not None, the index of the choice to highlight as
+the suggested choice.
+Returns:
+The index in the choices list of the selection the user made.
+"""
+done = set(done or [])
+while True:
+print intro
+print
+for i, entry in enumerate(choices):
+done_text = ' (done)' if i in done else ''
+indent = '--> ' if i == suggest else '    '
+print '%s%2d. %s%s' % (indent, i+1, entry, done_text)
+print
+choice = getNumber(prompt)
+if 0 < choice <= len(choices):
+return choice-1
+log.error('%d is not a valid choice between %d and %d' %
+(choice, 1, len(choices)))
+print
+def fileToLines(path):
+"""Read a file and return it as a list of lines."""
+try:
+with file(path) as f:
+return f.read().split('\n')
+except (IOError, OSError), e:
+raise FileAccessError(str(e))
+def linesToFile(path, lines):
+"""Write a list of lines to a file."""
+try:
+with file(path, 'w') as f:
+f.write('\n'.join(lines))
+except (IOError, OSError), e:
+raise FileAccessError(str(e))
+class Subversion(util.Paths):
+"""Wrapper for operations on a Subversion working copy.
+An instance of this class is bound to a specific working copy
+directory, and provides an API to perform various Subversion
+operations on this working copy.
+Some methods take a 'depth' argument. Depth in Subversion is a
+feature that allows the creation of arbitrarily shallow or deep
+working copies on a per-directory basis. Possible values are
+'none' (no files or directories), 'files' (only files in .),
+'immediates' (files and directories in ., directories checked out
+at depth 'none') or 'infinity' (a normal working copy with
+everything).
+This class also provides a few static functions that run the 'svn'
+tool against remote repositories to gather information or retrieve
+data.
+Note that this wrapper also doubles as a Paths object, offering an
+easy way to get or check the existence of paths in the working
+copy.
+"""
+def __init__(self, wc_dir):
+util.Paths.__init__(self, wc_dir)
+def _unknownAndMissing(self, path):
+"""Returns lists of unknown and missing files in the working copy.
+Args:
+path: The working copy path to scan.
 Returns:
-True if the user answered affirmatively, False otherwise.
-"""
+Two lists. The first is a list of all unknown paths
-if default:
+(subversion has no knowledge of them), the second is a list
-question = prompt + ' [Yn] '
+of missing paths (subversion knows about them, but can't
+find them). Paths in either list are relative to the input
+path.
+"""
+assert self.exists()
+unknown = []
+missing = []
+for line in self.status(path):
+if not line.strip():
+continue
+if line[0] == '?':
+unknown.append(line[7:])
+elif line[0] == '!':
+missing.append(line[7:])
+return unknown, missing
+def checkout(self, url, depth='infinity'):
+"""Check out a working copy from the given URL.
+Args:
+url: The Subversion repository URL to check out.
+depth: The depth of the working copy root.
+"""
+assert not self.exists()
+util.run(['svn', 'checkout', '--depth=' + depth, url, self.path()])
+def update(self, path='', depth=None):
+"""Update a working copy path, optionally changing depth.
+Args:
+path: The working copy path to update.
+depth: If set, change the depth of the path before updating.
+"""
+assert self.exists()
+if depth is None:
+util.run(['svn', 'update', self.path(path)])
 else:
-question = prompt + ' [yN] '
+util.run(['svn', 'update', '--set-depth=' + depth, self.path(path)])
-while True:
-try:
+def revert(self, path=''):
-answer = raw_input(question).strip().lower()
+"""Recursively revert a working copy path.
-except EOFError:
-raise AbortedByUser('Aborted by ctrl+D')
+Note that this command is more zealous than the 'svn revert'
-if not answer:
+command, as it will also delete any files which subversion
-return default
+does not know about.
-elif answer in ('y', 'yes'):
+"""
-return True
+util.run(['svn', 'revert', '-R', self.path(path)])
-elif answer in ('n', 'no'):
-return False
+unknown, missing = self._unknownAndMissing(path)
-else:
+unknown = [os.path.join(self.path(path), p) for p in unknown]
-log.error('Please answer yes or no.')
+if unknown:
+# rm -rf makes me uneasy. Verify that all paths to be deleted
-def getString(prompt):
+# are within the release working copy.
-"""Prompt for and return a string."""
+for p in unknown:
+assert p.startswith(self.path())
+util.run(['rm', '-rf', '--'] + unknown)
+def ls(self, dir=''):
+"""List the contents of a working copy directory.
+Note that this returns the contents of the directory as seen
+by the server, not constrained by the depth settings of the
+local path.
+"""
+assert self.exists()
+return util.run(['svn', 'ls', self.path(dir)], capture=True)
+def copy(self, src, dest):
+"""Copy a working copy path.
+The copy is only scheduled for commit, not committed.
+Args:
+src: The source working copy path.
+dst: The destination working copy path.
+"""
+assert self.exists()
+util.run(['svn', 'cp', self.path(src), self.path(dest)])
+def propget(self, prop_name, path):
+"""Get the value of a property on a working copy path.
+Args:
+prop_name: The property name, eg. 'svn:externals'.
+path: The working copy path on which the property is set.
+"""
+assert self.exists()
+return util.run(['svn', 'propget', prop_name, self.path(path)],
+capture=True)
+def propset(self, prop_name, prop_value, path):
+"""Set the value of a property on a working copy path.
+The property change is only scheduled for commit, not committed.
+Args:
+prop_name: The property name, eg. 'svn:externals'.
+prop_value: The value that should be set.
+path: The working copy path on which to set the property.
+"""
+assert self.exists()
+util.run(['svn', 'propset', prop_name, prop_value, self.path(path)])
+def add(self, paths):
+"""Schedule working copy paths for addition.
+The paths are only scheduled for addition, not committed.
+Args:
+paths: The list of working copy paths to add.
+"""
+assert self.exists()
+paths = [self.path(p) for p in paths]
+util.run(['svn', 'add'] + paths)
+def remove(self, paths):
+"""Schedule working copy paths for deletion.
+The paths are only scheduled for deletion, not committed.
+Args:
+paths: The list of working copy paths to delete.
+"""
+assert self.exists()
+paths = [self.path(p) for p in paths]
+util.run(['svn', 'rm'] + paths)
+def status(self, path=''):
+"""Return the status of a working copy path.
+The status returned is the verbatim output of 'svn status' on
+the path.
+Args:
+path: The path to examine.
+"""
+assert self.exists()
+return util.run(['svn', 'status', self.path(path)], capture=True)
+def addRemove(self, path=''):
+"""Perform an "addremove" operation a working copy path.
+An "addremove" runs 'svn status' and schedules all the unknown
+paths (listed as '?') for addition, and all the missing paths
+(listed as '!') for deletion. Its main use is to synchronize
+working copy state after applying a patch in unified diff
+format.
+Args:
+path: The path under which unknown/missing files should be
+added/removed.
+"""
+assert self.exists()
+unknown, missing = self._unknownAndMissing(path)
+if unknown:
+self.add(unknown)
+if missing:
+self.remove(missing)
+def commit(self, message, path=''):
+"""Commit scheduled changes to the source repository.
+Args:
+message: The commit message to use.
+path: The path to commit.
+"""
+assert self.exists()
+util.run(['svn', 'commit', '-m', message, self.path(path)])
+@staticmethod
+def export(url, revision, dest_path):
+"""Export the contents of a repository to a local path.
+Note that while the underlying 'svn export' only requires a
+URL, we require that both a URL and a revision be specified,
+to fully qualify the data to export.
+Args:
+url: The repository URL to export.
+revision: The revision to export.
+dest_path: The destination directory for the export. Note
+that this is an absolute path, NOT a working copy
+relative path.
+"""
+assert os.path.isabs(dest_path)
+if os.path.exists(dest_path):
+raise ObstructionError('Cannot export to obstructed path %s' %
+dest_path)
+util.run(['svn', 'export', '-r', str(revision), url, dest_path])
+@staticmethod
+def find_tag_rev(url):
+"""Return the revision at which a remote tag was created.
+Since tags are immutable by convention, usually the HEAD of a
+tag should be the tag creation revision. However, mistakes can
+happen, so this function will walk the history of the given
+tag URL, stopping on the first revision that was created by
+copy.
+This detection is not foolproof. For example: it will be
+fooled by a tag that was created, deleted, and recreated by
+copy at a different revision. It is not clear what the desired
+behavior in these edge cases are, and no attempt is made to
+handle them. You should request user confirmation before using
+the result of this function.
+Args:
+url: The repository URL of the tag to examine.
+"""
 try:
-return raw_input(prompt + ' ').strip()
+output = util.run(['svn', 'log', '-q', '--stop-on-copy', url],
-except EOFError:
+capture=True)
-raise AbortedByUser('Aborted by ctrl+D')
+except util.SubprocessFailed:
+raise ExpectationFailed('No tag at URL ' + url)
+first_rev_line = output[-2]
-def getNumber(prompt):
+first_rev = int(first_rev_line.split()[0][1:])
-"""Prompt for and return a number.
+return first_rev
-Will reprompt the user until a number is entered.
+@staticmethod
-"""
+def diff(url, revision):
-while True:
+"""Retrieve a revision from a remote repository as a unified diff.
-value_str = getString(prompt)
-try:
+Args:
-return int(value_str)
+url: The repository URL on which to perform the diff.
-except ValueError:
+revision: The revision to extract at the given url.
-log.error('Please enter a number. You entered "%s".' % value_str)
-def getChoice(intro, prompt, choices, done=None, suggest=None):
-"""Prompt for and return a choice from a menu.
-Will reprompt the user until a valid menu entry is chosen.
-Args:
-intro: Text to print verbatim before the choice menu.
-prompt: The prompt to print right before accepting input.
-choices: The list of string choices to display.
-done: If not None, the list of indices of previously
-selected/completed choices.
-suggest: If not None, the index of the choice to highlight as
-the suggested choice.
 Returns:
-The index in the choices list of the selection the user made.
+A string containing the changes extracted from the remote
-"""
+repository, in unified diff format suitable for application
-done = set(done or [])
+using 'patch'.
-while True:
+"""
-print intro
-print
-for i, entry in enumerate(choices):
-done_text = ' (done)' if i in done else ''
-indent = '--> ' if i == suggest else '    '
-print '%s%2d. %s%s' % (indent, i+1, entry, done_text)
-print
-choice = getNumber(prompt)
-if 0 < choice <= len(choices):
-return choice-1
-log.error('%d is not a valid choice between %d and %d' %
-(choice, 1, len(choices)))
-print
-def fileToLines(path):
-"""Read a file and return it as a list of lines."""
 try:
-with file(path) as f:
+return util.run(['svn', 'diff', '-c', str(revision), url],
-return f.read().split('\n')
+capture=True, split_capture=False)
-except (IOError, OSError), e:
+except util.SubprocessFailed:
-raise FileAccessError(str(e))
+raise ExpectationFailed('Could not get diff for r%d '
+'from remote repository' % revision)
-def linesToFile(path, lines):
-"""Write a list of lines to a file."""
-try:
-with file(path, 'w') as f:
-f.write('\n'.join(lines))
-except (IOError, OSError), e:
-raise FileAccessError(str(e))
-class Subversion(util.Paths):
-"""Wrapper for operations on a Subversion working copy.
-An instance of this class is bound to a specific working copy
-directory, and provides an API to perform various Subversion
-operations on this working copy.
-Some methods take a 'depth' argument. Depth in Subversion is a
-feature that allows the creation of arbitrarily shallow or deep
-working copies on a per-directory basis. Possible values are
-'none' (no files or directories), 'files' (only files in .),
-'immediates' (files and directories in ., directories checked out
-at depth 'none') or 'infinity' (a normal working copy with
-everything).
-This class also provides a few static functions that run the 'svn'
-tool against remote repositories to gather information or retrieve
-data.
-Note that this wrapper also doubles as a Paths object, offering an
-easy way to get or check the existence of paths in the working
-copy.
-"""
-def __init__(self, wc_dir):
-util.Paths.__init__(self, wc_dir)
-def _unknownAndMissing(self, path):
-"""Returns lists of unknown and missing files in the working copy.
-Args:
-path: The working copy path to scan.
-Returns:
-Two lists. The first is a list of all unknown paths
-(subversion has no knowledge of them), the second is a list
-of missing paths (subversion knows about them, but can't
-find them). Paths in either list are relative to the input
-path.
-"""
-assert self.exists()
-unknown = []
-missing = []
-for line in self.status(path):
-if not line.strip():
-continue
-if line[0] == '?':
-unknown.append(line[7:])
-elif line[0] == '!':
-missing.append(line[7:])
-return unknown, missing
-def checkout(self, url, depth='infinity'):
-"""Check out a working copy from the given URL.
-Args:
-url: The Subversion repository URL to check out.
-depth: The depth of the working copy root.
-"""
-assert not self.exists()
-util.run(['svn', 'checkout', '--depth=' + depth, url, self.path()])
-def update(self, path='', depth=None):
-"""Update a working copy path, optionally changing depth.
-Args:
-path: The working copy path to update.
-depth: If set, change the depth of the path before updating.
-"""
-assert self.exists()
-if depth is None:
-util.run(['svn', 'update', self.path(path)])
-else:
-util.run(['svn', 'update', '--set-depth=' + depth, self.path(path)])
-def revert(self, path=''):
-"""Recursively revert a working copy path.
-Note that this command is more zealous than the 'svn revert'
-command, as it will also delete any files which subversion
-does not know about.
-"""
-util.run(['svn', 'revert', '-R', self.path(path)])
-unknown, missing = self._unknownAndMissing(path)
-unknown = [os.path.join(self.path(path), p) for p in unknown]
-if unknown:
-# rm -rf makes me uneasy. Verify that all paths to be deleted
-# are within the release working copy.
-for p in unknown:
-assert p.startswith(self.path())
-util.run(['rm', '-rf', '--'] + unknown)
-def ls(self, dir=''):
-"""List the contents of a working copy directory.
-Note that this returns the contents of the directory as seen
-by the server, not constrained by the depth settings of the
-local path.
-"""
-assert self.exists()
-return util.run(['svn', 'ls', self.path(dir)], capture=True)
-def copy(self, src, dest):
-"""Copy a working copy path.
-The copy is only scheduled for commit, not committed.
-Args:
-src: The source working copy path.
-dst: The destination working copy path.
-"""
-assert self.exists()
-util.run(['svn', 'cp', self.path(src), self.path(dest)])
-def propget(self, prop_name, path):
-"""Get the value of a property on a working copy path.
-Args:
-prop_name: The property name, eg. 'svn:externals'.
-path: The working copy path on which the property is set.
-"""
-assert self.exists()
-return util.run(['svn', 'propget', prop_name, self.path(path)],
-capture=True)
-def propset(self, prop_name, prop_value, path):
-"""Set the value of a property on a working copy path.
-The property change is only scheduled for commit, not committed.
-Args:
-prop_name: The property name, eg. 'svn:externals'.
-prop_value: The value that should be set.
-path: The working copy path on which to set the property.
-"""
-assert self.exists()
-util.run(['svn', 'propset', prop_name, prop_value, self.path(path)])
-def add(self, paths):
-"""Schedule working copy paths for addition.
-The paths are only scheduled for addition, not committed.
-Args:
-paths: The list of working copy paths to add.
-"""
-assert self.exists()
-paths = [self.path(p) for p in paths]
-util.run(['svn', 'add'] + paths)
-def remove(self, paths):
-"""Schedule working copy paths for deletion.
-The paths are only scheduled for deletion, not committed.
-Args:
-paths: The list of working copy paths to delete.
-"""
-assert self.exists()
-paths = [self.path(p) for p in paths]
-util.run(['svn', 'rm'] + paths)
-def status(self, path=''):
-"""Return the status of a working copy path.
-The status returned is the verbatim output of 'svn status' on
-the path.
-Args:
-path: The path to examine.
-"""
-assert self.exists()
-return util.run(['svn', 'status', self.path(path)], capture=True)
-def addRemove(self, path=''):
-"""Perform an "addremove" operation a working copy path.
-An "addremove" runs 'svn status' and schedules all the unknown
-paths (listed as '?') for addition, and all the missing paths
-(listed as '!') for deletion. Its main use is to synchronize
-working copy state after applying a patch in unified diff
-format.
-Args:
-path: The path under which unknown/missing files should be
-added/removed.
-"""
-assert self.exists()
-unknown, missing = self._unknownAndMissing(path)
-if unknown:
-self.add(unknown)
-if missing:
-self.remove(missing)
-def commit(self, message, path=''):
-"""Commit scheduled changes to the source repository.
-Args:
-message: The commit message to use.
-path: The path to commit.
-"""
-assert self.exists()
-util.run(['svn', 'commit', '-m', message, self.path(path)])
-@staticmethod
-def export(url, revision, dest_path):
-"""Export the contents of a repository to a local path.
-Note that while the underlying 'svn export' only requires a
-URL, we require that both a URL and a revision be specified,
-to fully qualify the data to export.
-Args:
-url: The repository URL to export.
-revision: The revision to export.
-dest_path: The destination directory for the export. Note
-that this is an absolute path, NOT a working copy
-relative path.
-"""
-assert os.path.isabs(dest_path)
-if os.path.exists(dest_path):
-raise ObstructionError('Cannot export to obstructed path %s' %
-dest_path)
-util.run(['svn', 'export', '-r', str(revision), url, dest_path])
-@staticmethod
-def find_tag_rev(url):
-"""Return the revision at which a remote tag was created.
-Since tags are immutable by convention, usually the HEAD of a
-tag should be the tag creation revision. However, mistakes can
-happen, so this function will walk the history of the given
-tag URL, stopping on the first revision that was created by
-copy.
-This detection is not foolproof. For example: it will be
-fooled by a tag that was created, deleted, and recreated by
-copy at a different revision. It is not clear what the desired
-behavior in these edge cases are, and no attempt is made to
-handle them. You should request user confirmation before using
-the result of this function.
-Args:
-url: The repository URL of the tag to examine.
-"""
-try:
-output = util.run(['svn', 'log', '-q', '--stop-on-copy', url],
-capture=True)
-except util.SubprocessFailed:
-raise ExpectationFailed('No tag at URL ' + url)
-first_rev_line = output[-2]
-first_rev = int(first_rev_line.split()[0][1:])
-return first_rev
-@staticmethod
-def diff(url, revision):
-"""Retrieve a revision from a remote repository as a unified diff.
-Args:
-url: The repository URL on which to perform the diff.
-revision: The revision to extract at the given url.
-Returns:
-A string containing the changes extracted from the remote
-repository, in unified diff format suitable for application
-using 'patch'.
-"""
-try:
-return util.run(['svn', 'diff', '-c', str(revision), url],
-capture=True, split_capture=False)
-except util.SubprocessFailed:
-raise ExpectationFailed('Could not get diff for r%d '
-'from remote repository' % revision)
 #
 # Decorators for use in ReleaseEnvironment.
 #
 def pristine_wc(f):
 """A decorator that cleans up the release repository."""
 @functools.wraps(f)
 def revert_wc(self, *args, **kwargs):
 self.wc.revert()
 return f(self, *args, **kwargs)
 return revert_wc
 def requires_branch(f):
 """A decorator that checks that a release branch is active."""
 @functools.wraps(f)
 def check_branch(self, *args, **kwargs):
 if self.branch is None:
 raise ExpectationFailed(
 'This operation requires an active release branch')
 return f(self, *args, **kwargs)
 return check_branch
 class ReleaseEnvironment(util.Paths):
 """Encapsulates the state of a Melange release rolling environment.
 This class contains the actual releasing logic, and makes use of
 the previously defined utility classes to carry out user commands.
 Attributes:
+release_repos: The URL to the Google release repository root.
+upstream_repos: The URL to the Melange upstream repository root.
+wc: A Subversion object encapsulating a Google SoC working copy.
+"""
+BRANCH_FILE = 'BRANCH'
+def __init__(self, root, release_repos, upstream_repos):
+"""Initializer.
+Args:
+root: The root of the release environment.
 release_repos: The URL to the Google release repository root.
 upstream_repos: The URL to the Melange upstream repository root.
-wc: A Subversion object encapsulating a Google SoC working copy.
+"""
-"""
+util.Paths.__init__(self, root)
+self.wc = Subversion(self.path('google-soc'))
-BRANCH_FILE = 'BRANCH'
+self.release_repos = release_repos.strip('/')
+self.upstream_repos = upstream_repos.strip('/')
-def __init__(self, root, release_repos, upstream_repos):
-"""Initializer.
+if not self.wc.exists():
+self._InitializeWC()
-Args:
+else:
-root: The root of the release environment.
+self.wc.revert()
-release_repos: The URL to the Google release repository root.
-upstream_repos: The URL to the Melange upstream repository root.
+if self.exists(self.BRANCH_FILE):
-"""
+branch = fileToLines(self.path(self.BRANCH_FILE))[0]
-util.Paths.__init__(self, root)
+self._switchBranch(branch)
-self.wc = Subversion(self.path('google-soc'))
+else:
-self.release_repos = release_repos.strip('/')
+self._switchBranch(None)
-self.upstream_repos = upstream_repos.strip('/')
+def _InitializeWC(self):
-if not self.wc.exists():
+"""Check out the initial release repository.
-self._InitializeWC()
-else:
+Will also select the latest release branch, if any, so that
-self.wc.revert()
+the end state is a fully ready to function release
+environment.
-if self.exists(self.BRANCH_FILE):
+"""
-branch = fileToLines(self.path(self.BRANCH_FILE))[0]
+log.info('Checking out the release repository')
-self._switchBranch(branch)
-else:
+# Check out a sparse view of the relevant repository paths.
-self._switchBranch(None)
+self.wc.checkout(self.release_repos, depth='immediates')
+self.wc.update('vendor', depth='immediates')
-def _InitializeWC(self):
+self.wc.update('branches', depth='immediates')
-"""Check out the initial release repository.
+self.wc.update('tags', depth='immediates')
-Will also select the latest release branch, if any, so that
+# Locate the most recent release branch, if any, and switch
-the end state is a fully ready to function release
+# the release environment to it.
-environment.
+branches = self._listBranches()
-"""
+if not branches:
-log.info('Checking out the release repository')
+self._switchBranch(None)
+else:
-# Check out a sparse view of the relevant repository paths.
+self._switchBranch(branches[-1])
-self.wc.checkout(self.release_repos, depth='immediates')
-self.wc.update('vendor', depth='immediates')
+def _listBranches(self):
-self.wc.update('branches', depth='immediates')
+"""Return a list of available Melange release branches.
-self.wc.update('tags', depth='immediates')
+Branches are returned in sorted order, from least recent to
-# Locate the most recent release branch, if any, and switch
+most recent in release number ordering.
-# the release environment to it.
+"""
-branches = self._listBranches()
+assert self.wc.exists('branches')
-if not branches:
+branches = self.wc.ls('branches')
-self._switchBranch(None)
-else:
+# Some early release branches used a different naming scheme
-self._switchBranch(branches[-1])
+# that doesn't sort properly with new-style release names. We
+# filter those out here, along with empty lines.
-def _listBranches(self):
+branches = [b.strip('/') for b in branches
-"""Return a list of available Melange release branches.
+if MELANGE_RELEASE_RE.match(b.strip('/'))]
-Branches are returned in sorted order, from least recent to
+return sorted(branches)
-most recent in release number ordering.
-"""
+def _switchBranch(self, release):
-assert self.wc.exists('branches')
+"""Activate the branch matching the given release.
-branches = self.wc.ls('branches')
+Once activated, this branch is the target of future release
-# Some early release branches used a different naming scheme
+operations.
-# that doesn't sort properly with new-style release names. We
-# filter those out here, along with empty lines.
+None can be passed as the release. The result is that no
-branches = [b.strip('/') for b in branches
+branch is active, and all operations that require an active
-if MELANGE_RELEASE_RE.match(b.strip('/'))]
+branch will fail until a branch is activated again. This is
+used only at initialization, when it is detected that there
-return sorted(branches)
+are no available release branches to activate.
-def _switchBranch(self, release):
+Args:
-"""Activate the branch matching the given release.
+release: The version number of a Melange release already
+imported in the release repository, or None to
-Once activated, this branch is the target of future release
+activate no branch.
-operations.
+"""
-None can be passed as the release. The result is that no
+if release is None:
-branch is active, and all operations that require an active
+self.branch = None
-branch will fail until a branch is activated again. This is
+self.branch_dir = None
-used only at initialization, when it is detected that there
+log.info('No release branch available')
-are no available release branches to activate.
+else:
+self.wc.update()
-Args:
+assert self.wc.exists('branches/' + release)
-release: The version number of a Melange release already
+linesToFile(self.path(self.BRANCH_FILE), [release])
-imported in the release repository, or None to
+self.branch = release
-activate no branch.
+self.branch_dir = 'branches/' + release
+self.wc.update(self.branch_dir, depth='infinity')
-"""
+log.info('Working on branch ' + self.branch)
-if release is None:
-self.branch = None
+def _branchPath(self, path):
-self.branch_dir = None
+"""Return the given path with the release branch path prepended."""
-log.info('No release branch available')
+assert self.branch_dir is not None
-else:
+return os.path.join(self.branch_dir, path)
-self.wc.update()
-assert self.wc.exists('branches/' + release)
+#
-linesToFile(self.path(self.BRANCH_FILE), [release])
+# Release engineering commands. See further down for their
-self.branch = release
+# integration into a commandline interface.
-self.branch_dir = 'branches/' + release
+#
-self.wc.update(self.branch_dir, depth='infinity')
+@pristine_wc
-log.info('Working on branch ' + self.branch)
+def update(self):
+"""Update and clean the release repository"""
-def _branchPath(self, path):
+self.wc.update()
-"""Return the given path with the release branch path prepended."""
-assert self.branch_dir is not None
+@pristine_wc
-return os.path.join(self.branch_dir, path)
+def switchToBranch(self):
+"""Switch to another Melange release branch"""
-#
+branches = self._listBranches()
-# Release engineering commands. See further down for their
+if not branches:
-# integration into a commandline interface.
+raise ExpectationFailed(
-#
+'No branches available. Please import one.')
-@pristine_wc
-def update(self):
+choice = getChoice('Available release branches:',
-"""Update and clean the release repository"""
+'Your choice?',
-self.wc.update()
+branches,
+suggest=len(branches)-1)
-@pristine_wc
+self._switchBranch(branches[choice])
-def switchToBranch(self):
-"""Switch to another Melange release branch"""
+def _addAppYaml(self):
-branches = self._listBranches()
+"""Create a Google production app.yaml configuration.
-if not branches:
-raise ExpectationFailed(
+The file is copied and modified from the upstream
-'No branches available. Please import one.')
+app.yaml.template, configure for Google's Summer of Code App
+Engine instance, and committed.
-choice = getChoice('Available release branches:',
+"""
-'Your choice?',
+if self.wc.exists(self._branchPath('app/app.yaml')):
-branches,
+raise ObstructionError('app/app.yaml exists already')
-suggest=len(branches)-1)
-self._switchBranch(branches[choice])
+yaml_path = self._branchPath('app/app.yaml')
+self.wc.copy(yaml_path + '.template', yaml_path)
-def _addAppYaml(self):
-"""Create a Google production app.yaml configuration.
+yaml = fileToLines(self.wc.path(yaml_path))
+out = []
-The file is copied and modified from the upstream
+for i, line in enumerate(yaml):
-app.yaml.template, configure for Google's Summer of Code App
+stripped_line = line.strip()
-Engine instance, and committed.
+if 'TODO' in stripped_line:
-"""
+continue
-if self.wc.exists(self._branchPath('app/app.yaml')):
+elif stripped_line == '# application: FIXME':
-raise ObstructionError('app/app.yaml exists already')
+out.append('application: socghop')
+elif stripped_line.startswith('version:'):
-yaml_path = self._branchPath('app/app.yaml')
+out.append(line.lstrip() + 'g0')
-self.wc.copy(yaml_path + '.template', yaml_path)
+out.append('# * initial Google fork of Melange ' +
+self.branch)
-yaml = fileToLines(self.wc.path(yaml_path))
+else:
-out = []
+out.append(line)
-for i, line in enumerate(yaml):
+linesToFile(self.wc.path(yaml_path), out)
-stripped_line = line.strip()
-if 'TODO' in stripped_line:
+self.wc.commit('Create app.yaml with Google patch version g0 '
-continue
+'in branch ' + self.branch)
-elif stripped_line == '# application: FIXME':
-out.append('application: socghop')
+def _applyGooglePatches(self):
-elif stripped_line.startswith('version:'):
+"""Apply Google-specific patches to a vanilla Melange release.
-out.append(line.lstrip() + 'g0')
-out.append('# * initial Google fork of Melange ' +
+Each patch is applied and committed in turn.
-self.branch)
+"""
-else:
+# Edit the base template to point users to the Google fork
-out.append(line)
+# of the Melange codebase instead of the vanilla release.
-linesToFile(self.wc.path(yaml_path), out)
+tmpl_file = self.wc.path(
+self._branchPath('app/soc/templates/soc/base.html'))
-self.wc.commit('Create app.yaml with Google patch version g0 '
+tmpl = fileToLines(tmpl_file)
-'in branch ' + self.branch)
+for i, line in enumerate(tmpl):
+if 'http://code.google.com/p/soc/source/browse/tags/' in line:
-def _applyGooglePatches(self):
+tmpl[i] = line.replace('/p/soc/', '/p/soc-google/')
-"""Apply Google-specific patches to a vanilla Melange release.
+break
+else:
-Each patch is applied and committed in turn.
+raise ExpectationFailed(
-"""
+'No source code link found in base.html')
-# Edit the base template to point users to the Google fork
+linesToFile(tmpl_file, tmpl)
-# of the Melange codebase instead of the vanilla release.
-tmpl_file = self.wc.path(
+self.wc.commit(
-self._branchPath('app/soc/templates/soc/base.html'))
+'Customize the Melange release link in the sidebar menu')
-tmpl = fileToLines(tmpl_file)
-for i, line in enumerate(tmpl):
+@pristine_wc
-if 'http://code.google.com/p/soc/source/browse/tags/' in line:
+def importTag(self):
-tmpl[i] = line.replace('/p/soc/', '/p/soc-google/')
+"""Import a new Melange release"""
-break
+release = getString('Enter the Melange release to import:')
-else:
+if not release:
-raise ExpectationFailed(
+AbortedByUser('No release provided, import aborted')
-'No source code link found in base.html')
-linesToFile(tmpl_file, tmpl)
+branch_dir = 'branches/' + release
+if self.wc.exists(branch_dir):
-self.wc.commit(
+raise ObstructionError('Release %s already imported' % release)
-'Customize the Melange release link in the sidebar menu')
+tag_url = '%s/tags/%s' % (self.upstream_repos, release)
-@pristine_wc
+release_rev = Subversion.find_tag_rev(tag_url)
-def importTag(self):
-"""Import a new Melange release"""
+if confirm('Confirm import of release %s, tagged at r%d?' %
-release = getString('Enter the Melange release to import:')
+(release, release_rev)):
-if not release:
+# Add an entry to the vendor externals for the Melange
-AbortedByUser('No release provided, import aborted')
+# release.
+externals = self.wc.propget('svn:externals', 'vendor/soc')
-branch_dir = 'branches/' + release
+externals.append('%s -r %d %s' % (release, release_rev, tag_url))
-if self.wc.exists(branch_dir):
+self.wc.propset('svn:externals', '\n'.join(externals), 'vendor/soc')
-raise ObstructionError('Release %s already imported' % release)
+self.wc.commit('Add svn:externals entry to pull in Melange '
+'release %s at r%d.' % (release, release_rev))
-tag_url = '%s/tags/%s' % (self.upstream_repos, release)
-release_rev = Subversion.find_tag_rev(tag_url)
+# Export the tag into the release repository's branches
+Subversion.export(tag_url, release_rev, self.wc.path(branch_dir))
-if confirm('Confirm import of release %s, tagged at r%d?' %
-(release, release_rev)):
+# Add and commit the branch add (very long operation!)
-# Add an entry to the vendor externals for the Melange
+self.wc.add([branch_dir])
-# release.
+self.wc.commit('Branch of Melange release %s' % release,
-externals = self.wc.propget('svn:externals', 'vendor/soc')
+branch_dir)
-externals.append('%s -r %d %s' % (release, release_rev, tag_url))
+self._switchBranch(release)
-self.wc.propset('svn:externals', '\n'.join(externals), 'vendor/soc')
-self.wc.commit('Add svn:externals entry to pull in Melange '
+# Commit the production GSoC configuration and
-'release %s at r%d.' % (release, release_rev))
+# google-specific patches.
+self._addAppYaml()
-# Export the tag into the release repository's branches
+self._applyGooglePatches()
-Subversion.export(tag_url, release_rev, self.wc.path(branch_dir))
+# All done!
-# Add and commit the branch add (very long operation!)
+log.info('Melange release %s imported and googlified' % self.branch)
-self.wc.add([branch_dir])
-self.wc.commit('Branch of Melange release %s' % release,
+@requires_branch
-branch_dir)
+@pristine_wc
-self._switchBranch(release)
+def cherryPickChange(self):
+"""Cherry-pick a change from the Melange trunk"""
-# Commit the production GSoC configuration and
+rev = getNumber('Revision number to cherry-pick:')
-# google-specific patches.
+bug = getNumber('Issue fixed by this change:')
-self._addAppYaml()
-self._applyGooglePatches()
+diff = self.wc.diff(self.upstream_repos + '/trunk', rev)
+if not diff.strip():
-# All done!
+raise ExpectationFailed(
-log.info('Melange release %s imported and googlified' % self.branch)
+'Retrieved diff is empty. '
+'Did you accidentally cherry-pick a branch change?')
-@requires_branch
+util.run(['patch', '-p0'], cwd=self.wc.path(self.branch_dir),
-@pristine_wc
+stdin=diff)
-def cherryPickChange(self):
+self.wc.addRemove(self.branch_dir)
-"""Cherry-pick a change from the Melange trunk"""
-rev = getNumber('Revision number to cherry-pick:')
+yaml_path = self.wc.path(self._branchPath('app/app.yaml'))
-bug = getNumber('Issue fixed by this change:')
+out = []
+updated_patchlevel = False
-diff = self.wc.diff(self.upstream_repos + '/trunk', rev)
+for line in fileToLines(yaml_path):
-if not diff.strip():
+if line.strip().startswith('version: '):
-raise ExpectationFailed(
+version = line.strip().split()[-1]
-'Retrieved diff is empty. '
+base, patch = line.rsplit('g', 1)
-'Did you accidentally cherry-pick a branch change?')
+new_version = '%sg%d' % (base, int(patch) + 1)
-util.run(['patch', '-p0'], cwd=self.wc.path(self.branch_dir),
+message = ('Cherry-picked r%d from /p/soc/ to fix issue %d' %
-stdin=diff)
+(rev, bug))
-self.wc.addRemove(self.branch_dir)
+out.append('version: ' + new_version)
+out.append('# * ' + message)
-yaml_path = self.wc.path(self._branchPath('app/app.yaml'))
+updated_patchlevel = True
-out = []
+else:
-updated_patchlevel = False
+out.append(line)
-for line in fileToLines(yaml_path):
-if line.strip().startswith('version: '):
+if not updated_patchlevel:
-version = line.strip().split()[-1]
+log.error('Failed to update Google patch revision')
-base, patch = line.rsplit('g', 1)
+log.error('Cherry-picking failed')
-new_version = '%sg%d' % (base, int(patch) + 1)
-message = ('Cherry-picked r%d from /p/soc/ to fix issue %d' %
+linesToFile(yaml_path, out)
-(rev, bug))
-out.append('version: ' + new_version)
+log.info('Check the diff about to be committed with:')
-out.append('# * ' + message)
+log.info('svn diff ' + self.wc.path(self.branch_dir))
-updated_patchlevel = True
+if not confirm('Commit this change?'):
-else:
+raise AbortedByUser('Cherry-pick aborted')
-out.append(line)
+self.wc.commit(message)
+log.info('Cherry-picked r%d from the Melange trunk.' % rev)
-if not updated_patchlevel:
-log.error('Failed to update Google patch revision')
+MENU_ORDER = [
-log.error('Cherry-picking failed')
+update,
+switchToBranch,
-linesToFile(yaml_path, out)
+importTag,
+cherryPickChange,
-log.info('Check the diff about to be committed with:')
+]
-log.info('svn diff ' + self.wc.path(self.branch_dir))
-if not confirm('Commit this change?'):
+MENU_STRINGS = [d.__doc__ for d in MENU_ORDER]
-raise AbortedByUser('Cherry-pick aborted')
-self.wc.commit(message)
+MENU_SUGGESTIONS = {
-log.info('Cherry-picked r%d from the Melange trunk.' % rev)
+None: update,
+update: cherryPickChange,
-MENU_ORDER = [
+switchToBranch: cherryPickChange,
-update,
+importTag: cherryPickChange,
-switchToBranch,
+cherryPickChange: None,
-importTag,
+}
-cherryPickChange,
-]
+def interactiveMenu(self):
+done = []
-MENU_STRINGS = [d.__doc__ for d in MENU_ORDER]
+last_choice = None
+while True:
-MENU_SUGGESTIONS = {
+# Show the user their previously completed operations and
-None: update,
+# a suggested next op, to remind them where they are in
-update: cherryPickChange,
+# the release process (useful after long operations that
-switchToBranch: cherryPickChange,
+# may have caused lunch or an extended context switch).
-importTag: cherryPickChange,
+if last_choice is not None:
-cherryPickChange: None,
+last_command = self.MENU_ORDER[last_choice]
-}
+else:
+last_command = None
-def interactiveMenu(self):
+suggested_next = self.MENU_ORDER.index(
-done = []
+self.MENU_SUGGESTIONS[last_command])
-last_choice = None
-while True:
+try:
-# Show the user their previously completed operations and
+choice = getChoice('Main menu:', 'Your choice?',
-# a suggested next op, to remind them where they are in
+self.MENU_STRINGS, done=done,
-# the release process (useful after long operations that
+suggest=suggested_next)
-# may have caused lunch or an extended context switch).
+except (KeyboardInterrupt, AbortedByUser):
-if last_choice is not None:
+log.info('Exiting.')
-last_command = self.MENU_ORDER[last_choice]
+return
-else:
+try:
-last_command = None
+self.MENU_ORDER[choice](self)
-suggested_next = self.MENU_ORDER.index(
+except Error, e:
-self.MENU_SUGGESTIONS[last_command])
+log.error(str(e))
+else:
-try:
+done.append(choice)
-choice = getChoice('Main menu:', 'Your choice?',
+last_choice = choice
-self.MENU_STRINGS, done=done,
-suggest=suggested_next)
-except (KeyboardInterrupt, AbortedByUser):
-log.info('Exiting.')
-return
-try:
-self.MENU_ORDER[choice](self)
-except Error, e:
-log.error(str(e))
-else:
-done.append(choice)
-last_choice = choice
 def main(argv):
 if not (1 <= len(argv) <= 3):
 print ('Usage: gsoc-release.py [release repos root URL] '
 '[upstream repos root URL]')
 sys.exit(1)
 release_repos, upstream_repos = GOOGLE_SOC_REPOS, MELANGE_REPOS
 if len(argv) >= 2:
 release_repos = argv[1]
 if len(argv) == 3:
 upstream_repos = argv[2]
 log.init('release.log')
 log.info('Release repository: ' + release_repos)
 log.info('Upstream repository: ' + upstream_repos)
 r = ReleaseEnvironment(os.path.abspath('_release_'),
 release_repos,
 upstream_repos)
 r.interactiveMenu()
 if __name__ == '__main__':
 main(sys.argv)

changeset 1835	3f30b7b14c57
parent 1834	0589bf1395c5
child 1846	ac30e04bcbba