From 37282b4b9c5b1d9a1ff07f7f0686a81b65a0a5c6 Mon Sep 17 00:00:00 2001 From: Doug Anderson Date: Fri, 4 Mar 2011 11:54:18 -0800 Subject: Support repo-level pre-upload hook and prep for future hooks. All repo-level hooks are expected to live in a single project at the top level of that project. The name of the hooks project is provided in the manifest.xml. The manifest also lists which hooks are enabled to make it obvious if a file somehow failed to sync down (or got deleted). Before running any hook, we will prompt the user to make sure that it is OK. A user can deny running the hook, allow once, or allow "forever" (until hooks change). This tries to keep with the git spirit of not automatically running anything on the user's computer that got synced down. Note that individual repo commands can add always options to avoid these prompts as they see fit (see below for the 'upload' options). When hooks are run, they are loaded into the current interpreter (the one running repo) and their main() function is run. This mechanism is used (instead of using subprocess) to make it easier to expand to a richer hook interface in the future. During loading, the interpreter's sys.path is updated to contain the directory containing the hooks so that hooks can be split into multiple files. The upload command has two options that control hook behavior: - no-verify=False, verify=False (DEFAULT): If stdout is a tty, can prompt about running upload hooks if needed. If user denies running hooks, the upload is cancelled. If stdout is not a tty and we would need to prompt about upload hooks, upload is cancelled. - no-verify=False, verify=True: Always run upload hooks with no prompt. - no-verify=True, verify=False: Never run upload hooks, but upload anyway (AKA bypass hooks). - no-verify=True, verify=True: Invalid Sample bit of manifest.xml code for enabling hooks (assumes you have a project named 'hooks' where hooks are stored): Sample main() function in pre-upload.py in hooks directory: def main(project_list, **kwargs): print ('These projects will be uploaded: %s' % ', '.join(project_list)) print ('I am being a good boy and ignoring anything in kwargs\n' 'that I don\'t understand.') print 'I fail 50% of the time. How flaky.' if random.random() <= .5: raise Exception('Pre-upload hook failed. Have a nice day.') Change-Id: I5cefa2cd5865c72589263cf8e2f152a43c122f70 --- manifest_xml.py | 90 ++++++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 66 insertions(+), 24 deletions(-) (limited to 'manifest_xml.py') diff --git a/manifest_xml.py b/manifest_xml.py index 0103cf55..0e6421f1 100644 --- a/manifest_xml.py +++ b/manifest_xml.py @@ -171,6 +171,14 @@ class XmlManifest(object): ce.setAttribute('dest', c.dest) e.appendChild(ce) + if self._repo_hooks_project: + root.appendChild(doc.createTextNode('')) + e = doc.createElement('repo-hooks') + e.setAttribute('in-project', self._repo_hooks_project.name) + e.setAttribute('enabled-list', + ' '.join(self._repo_hooks_project.enabled_repo_hooks)) + root.appendChild(e) + doc.writexml(fd, '', ' ', '\n', 'UTF-8') @property @@ -188,6 +196,11 @@ class XmlManifest(object): self._Load() return self._default + @property + def repo_hooks_project(self): + self._Load() + return self._repo_hooks_project + @property def notice(self): self._Load() @@ -207,6 +220,7 @@ class XmlManifest(object): self._projects = {} self._remotes = {} self._default = None + self._repo_hooks_project = None self._notice = None self.branch = None self._manifest_server = None @@ -239,15 +253,15 @@ class XmlManifest(object): def _ParseManifest(self, is_root_file): root = xml.dom.minidom.parse(self.manifestFile) if not root or not root.childNodes: - raise ManifestParseError, \ - "no root node in %s" % \ - self.manifestFile + raise ManifestParseError( + "no root node in %s" % + self.manifestFile) config = root.childNodes[0] if config.nodeName != 'manifest': - raise ManifestParseError, \ - "no in %s" % \ - self.manifestFile + raise ManifestParseError( + "no in %s" % + self.manifestFile) for node in config.childNodes: if node.nodeName == 'remove-project': @@ -255,25 +269,30 @@ class XmlManifest(object): try: del self._projects[name] except KeyError: - raise ManifestParseError, \ - 'project %s not found' % \ - (name) + raise ManifestParseError( + 'project %s not found' % + (name)) + + # If the manifest removes the hooks project, treat it as if it deleted + # the repo-hooks element too. + if self._repo_hooks_project and (self._repo_hooks_project.name == name): + self._repo_hooks_project = None for node in config.childNodes: if node.nodeName == 'remote': remote = self._ParseRemote(node) if self._remotes.get(remote.name): - raise ManifestParseError, \ - 'duplicate remote %s in %s' % \ - (remote.name, self.manifestFile) + raise ManifestParseError( + 'duplicate remote %s in %s' % + (remote.name, self.manifestFile)) self._remotes[remote.name] = remote for node in config.childNodes: if node.nodeName == 'default': if self._default is not None: - raise ManifestParseError, \ - 'duplicate default in %s' % \ - (self.manifestFile) + raise ManifestParseError( + 'duplicate default in %s' % + (self.manifestFile)) self._default = self._ParseDefault(node) if self._default is None: self._default = _Default() @@ -281,29 +300,52 @@ class XmlManifest(object): for node in config.childNodes: if node.nodeName == 'notice': if self._notice is not None: - raise ManifestParseError, \ - 'duplicate notice in %s' % \ - (self.manifestFile) + raise ManifestParseError( + 'duplicate notice in %s' % + (self.manifestFile)) self._notice = self._ParseNotice(node) for node in config.childNodes: if node.nodeName == 'manifest-server': url = self._reqatt(node, 'url') if self._manifest_server is not None: - raise ManifestParseError, \ - 'duplicate manifest-server in %s' % \ - (self.manifestFile) + raise ManifestParseError( + 'duplicate manifest-server in %s' % + (self.manifestFile)) self._manifest_server = url for node in config.childNodes: if node.nodeName == 'project': project = self._ParseProject(node) if self._projects.get(project.name): - raise ManifestParseError, \ - 'duplicate project %s in %s' % \ - (project.name, self.manifestFile) + raise ManifestParseError( + 'duplicate project %s in %s' % + (project.name, self.manifestFile)) self._projects[project.name] = project + for node in config.childNodes: + if node.nodeName == 'repo-hooks': + # Get the name of the project and the (space-separated) list of enabled. + repo_hooks_project = self._reqatt(node, 'in-project') + enabled_repo_hooks = self._reqatt(node, 'enabled-list').split() + + # Only one project can be the hooks project + if self._repo_hooks_project is not None: + raise ManifestParseError( + 'duplicate repo-hooks in %s' % + (self.manifestFile)) + + # Store a reference to the Project. + try: + self._repo_hooks_project = self._projects[repo_hooks_project] + except KeyError: + raise ManifestParseError( + 'project %s not found for repo-hooks' % + (repo_hooks_project)) + + # Store the enabled hooks in the Project object. + self._repo_hooks_project.enabled_repo_hooks = enabled_repo_hooks + def _AddMetaProjectMirror(self, m): name = None m_url = m.GetRemote(m.remote.name).url -- cgit v1.2.3-54-g00ecf