mirror of
https://gerrit.googlesource.com/git-repo
synced 2024-12-21 07:16:21 +00:00
37282b4b9c
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):
<repo-hooks in-project="hooks" enabled-list="pre-upload" />
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
85 lines
2.2 KiB
Python
85 lines
2.2 KiB
Python
#
|
|
# Copyright (C) 2008 The Android Open Source Project
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
class ManifestParseError(Exception):
|
|
"""Failed to parse the manifest file.
|
|
"""
|
|
|
|
class ManifestInvalidRevisionError(Exception):
|
|
"""The revision value in a project is incorrect.
|
|
"""
|
|
|
|
class EditorError(Exception):
|
|
"""Unspecified error from the user's text editor.
|
|
"""
|
|
def __init__(self, reason):
|
|
self.reason = reason
|
|
|
|
def __str__(self):
|
|
return self.reason
|
|
|
|
class GitError(Exception):
|
|
"""Unspecified internal error from git.
|
|
"""
|
|
def __init__(self, command):
|
|
self.command = command
|
|
|
|
def __str__(self):
|
|
return self.command
|
|
|
|
class ImportError(Exception):
|
|
"""An import from a non-Git format cannot be performed.
|
|
"""
|
|
def __init__(self, reason):
|
|
self.reason = reason
|
|
|
|
def __str__(self):
|
|
return self.reason
|
|
|
|
class UploadError(Exception):
|
|
"""A bundle upload to Gerrit did not succeed.
|
|
"""
|
|
def __init__(self, reason):
|
|
self.reason = reason
|
|
|
|
def __str__(self):
|
|
return self.reason
|
|
|
|
class NoSuchProjectError(Exception):
|
|
"""A specified project does not exist in the work tree.
|
|
"""
|
|
def __init__(self, name=None):
|
|
self.name = name
|
|
|
|
def __str__(self):
|
|
if self.Name is None:
|
|
return 'in current directory'
|
|
return self.name
|
|
|
|
class RepoChangedException(Exception):
|
|
"""Thrown if 'repo sync' results in repo updating its internal
|
|
repo or manifest repositories. In this special case we must
|
|
use exec to re-execute repo with the new code and manifest.
|
|
"""
|
|
def __init__(self, extra_args=[]):
|
|
self.extra_args = extra_args
|
|
|
|
class HookError(Exception):
|
|
"""Thrown if a 'repo-hook' could not be run.
|
|
|
|
The common case is that the file wasn't present when we tried to run it.
|
|
"""
|
|
pass
|