d633541ecc
Gerrit wants each commit message to include a unique identifier string in a special footer line, so provides a commit-msg hook to randomly generate and insert one. Traditionally, this file is served directly from each Gerrit server and users retrieve it via SCP or HTTPS to install a local copy in their clone of every repository. Retrieving this file over the network has historically presented a number of challenges: modern OpenSSH has deprecated the SCP protocol while the mina-sshd library Gerrit uses hasn't implemented compatible SFTP support, authentication failures can shadow some clearer error handling later in git-review's workflow leading to confusing error messages, and then there are the security concerns with needing to trust the Gerrit server to supply a script which will end up running locally on the developer's machine. In order to address these problems, making git-review more robust and secure, we embed a copy of the Gerrit upstream project's commit-msg hook in the client itself and write that to disk by default rather than pulling a remote copy. This approach does mean that the user will end up with a frozen version of the script contemporary with the git-review release they've installed (but its function is simple and the implementation has changed very infrequently). It may also break workflows for sites which rely on users retrieving a customized commit-msg hook. For those reasons, a command-line option is provided to restore the prior behavior. Change-Id: Ia26abc781a281817115cb1cafcd5e7b78b383e39
134 lines
4.0 KiB
Python
134 lines
4.0 KiB
Python
# Copyright (C) 2009 The Android Open Source Project
|
|
# Copyright OpenDev Contributors
|
|
#
|
|
# 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.
|
|
|
|
# Because wheels are unable to embed and install data files, we store
|
|
# our vendored copy of the Gerrit commit-msg hook script in a string and
|
|
# write it into place at runtime.
|
|
|
|
# Taken from https://gerrit.googlesource.com/gerrit/+/refs/heads/master
|
|
# /resources/com/google/gerrit/server/tools/root/hooks/commit-msg as of
|
|
# commit 05d6470 on 2024-02-21.
|
|
|
|
COMMIT_MSG = r"""#!/bin/sh
|
|
#
|
|
# Part of Gerrit Code Review (https://www.gerritcodereview.com/)
|
|
#
|
|
# Copyright (C) 2009 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.
|
|
|
|
set -u
|
|
|
|
# avoid [[ which is not POSIX sh.
|
|
if test "$#" != 1 ; then
|
|
echo "$0 requires an argument."
|
|
exit 1
|
|
fi
|
|
|
|
if test ! -f "$1" ; then
|
|
echo "file does not exist: $1"
|
|
exit 1
|
|
fi
|
|
|
|
# Do not create a change id if requested
|
|
case "$(git config --get gerrit.createChangeId)" in
|
|
false)
|
|
exit 0
|
|
;;
|
|
always)
|
|
;;
|
|
*)
|
|
# Do not create a change id for squash/fixup commits.
|
|
if head -n1 "$1" | LC_ALL=C grep -q '^[a-z][a-z]*! '; then
|
|
exit 0
|
|
fi
|
|
;;
|
|
esac
|
|
|
|
|
|
if git rev-parse --verify HEAD >/dev/null 2>&1; then
|
|
refhash="$(git rev-parse HEAD)"
|
|
else
|
|
refhash="$(git hash-object -t tree /dev/null)"
|
|
fi
|
|
|
|
random=$({ git var GIT_COMMITTER_IDENT ; echo "$refhash" ; cat "$1"; } | git hash-object --stdin)
|
|
dest="$1.tmp.${random}"
|
|
|
|
trap 'rm -f "$dest" "$dest-2"' EXIT
|
|
|
|
if ! cat "$1" | sed -e '/>8/q' | git stripspace --strip-comments > "${dest}" ; then
|
|
echo "cannot strip comments from $1"
|
|
exit 1
|
|
fi
|
|
|
|
if test ! -s "${dest}" ; then
|
|
echo "file is empty: $1"
|
|
exit 1
|
|
fi
|
|
|
|
reviewurl="$(git config --get gerrit.reviewUrl)"
|
|
if test -n "${reviewurl}" ; then
|
|
token="Link"
|
|
value="${reviewurl%/}/id/I$random"
|
|
pattern=".*/id/I[0-9a-f]\{40\}"
|
|
else
|
|
token="Change-Id"
|
|
value="I$random"
|
|
pattern=".*"
|
|
fi
|
|
|
|
if git interpret-trailers --parse < "$1" | grep -q "^$token: $pattern$" ; then
|
|
exit 0
|
|
fi
|
|
|
|
# There must be a Signed-off-by trailer for the code below to work. Insert a
|
|
# sentinel at the end to make sure there is one.
|
|
# Avoid the --in-place option which only appeared in Git 2.8
|
|
if ! git interpret-trailers \
|
|
--trailer "Signed-off-by: SENTINEL" < "$1" > "$dest-2" ; then
|
|
echo "cannot insert Signed-off-by sentinel line in $1"
|
|
exit 1
|
|
fi
|
|
|
|
# Make sure the trailer appears before any Signed-off-by trailers by inserting
|
|
# it as if it was a Signed-off-by trailer and then use sed to remove the
|
|
# Signed-off-by prefix and the Signed-off-by sentinel line.
|
|
# Avoid the --in-place option which only appeared in Git 2.8
|
|
# Avoid the --where option which only appeared in Git 2.15
|
|
if ! git -c trailer.where=before interpret-trailers \
|
|
--trailer "Signed-off-by: $token: $value" < "$dest-2" |
|
|
sed -e "s/^Signed-off-by: \($token: \)/\1/" \
|
|
-e "/^Signed-off-by: SENTINEL/d" > "$dest" ; then
|
|
echo "cannot insert $token line in $1"
|
|
exit 1
|
|
fi
|
|
|
|
if ! mv "${dest}" "$1" ; then
|
|
echo "cannot mv ${dest} to $1"
|
|
exit 1
|
|
fi
|
|
""" # noqa
|