章节 ▾ 第二版

8.4 Git 自定义 - 一个示例 Git 强制策略

一个示例 Git 强制策略

在本节中，您将运用所学知识来建立一个 Git 工作流程，该工作流程会检查自定义的提交消息格式，并只允许某些用户修改项目中的特定子目录。您将构建客户端脚本来帮助开发人员了解他们的推送是否会被拒绝，以及服务器端脚本来实际执行这些策略。

我们将展示的脚本是用 Ruby 编写的；部分原因是我们的思维惯性，但也是因为 Ruby 易于阅读，即使您不一定能写出来。然而，任何语言都可以。Git 自带的所有示例钩子脚本都是用 Perl 或 Bash 编写的，因此您也可以通过查看示例来找到这些语言中大量的钩子示例。

服务器端钩子

所有服务器端工作都将放在 `hooks` 目录中的 `update` 文件中。`update` 钩子在每次推送的分支上运行一次，并接受三个参数：

  • 要推送的引用的名称

  • 该分支之前的修订版本

  • 要推送的新修订版本

如果推送是通过 SSH 运行的，您还可以访问执行推送的用户。如果您允许所有人通过公钥认证以单一用户（如“git”）连接，您可能需要给该用户一个 shell 包装器，该包装器根据公钥确定哪个用户正在连接，并相应地设置一个环境变量。在这里，我们将假设连接用户在 `$USER` 环境变量中，因此您的 update 脚本首先收集所有需要的信息：

#!/usr/bin/env ruby

$refname = ARGV[0]
$oldrev  = ARGV[1]
$newrev  = ARGV[2]
$user    = ENV['USER']

puts "Enforcing Policies..."
puts "(#{$refname}) (#{$oldrev[0,6]}) (#{$newrev[0,6]})"

是的，这些是全局变量。不要评判——这样演示更简单。

强制执行特定的提交消息格式

您的第一个挑战是强制每个提交消息都遵循特定的格式。为了有一个目标，假设每条消息都必须包含一个看起来像“ref: 1234”的字符串，因为您希望每次提交都链接到您的票证系统中的一个工作项。您必须查看正在推送的每个提交，查看该字符串是否在提交消息中，如果该字符串在任何提交中都不存在，则退出非零，以拒绝推送。

您可以通过获取 `$newrev` 和 `$oldrev` 值，并将它们传递给一个名为 `git rev-list` 的 Git 管道命令来获取正在推送的所有提交的 SHA-1 值列表。这基本上就是 `git log` 命令，但默认情况下它只打印 SHA-1 值而不打印其他信息。因此，要获取一个提交 SHA-1 和另一个提交 SHA-1 之间引入的所有提交 SHA-1 的列表，您可以运行类似这样的命令：

$ git rev-list 538c33..d14fc7
d14fc7c847ab946ec39590d87783c69b031bdfb7
9f585da4401b0a3999e84113824d15245c13f0be
234071a1be950e2a8d078e6141f5cd20c1e61ad3
dfa04c9ef3d5197182f13fb5b9b1fb7717d2222a
17716ec0f1ff5c77eff40b7fe912f9f6cfd0e475

您可以获取该输出，循环遍历每个提交 SHA-1，获取其消息，并使用一个查找模式的正则表达式来测试该消息。

您需要找出如何从每个提交中获取提交消息进行测试。要获取原始提交数据，您可以使用另一个名为 `git cat-file` 的管道命令。我们将在 Git Internals 中详细介绍所有这些管道命令；但现在，这里是该命令提供的内容：

$ git cat-file commit ca82a6
tree cfda3bf379e4f8dba8717dee55aab78aef7f4daf
parent 085bb3bcb608e1e8451d4b2432f8ecbe6306e7e7
author Scott Chacon <schacon@gmail.com> 1205815931 -0700
committer Scott Chacon <schacon@gmail.com> 1240030591 -0700

Change the version number

当您拥有 SHA-1 值时，从提交中获取提交消息的一种简单方法是找到第一个空行，并获取该行之后的所有内容。在 Unix 系统上，您可以使用 `sed` 命令来完成此操作：

$ git cat-file commit ca82a6 | sed '1,/^$/d'
Change the version number

您可以使用这个命令来获取正在推送的每个提交的消息，并在看到任何不匹配的内容时退出。要退出脚本并拒绝推送，请退出非零。整个方法如下：

$regex = /\[ref: (\d+)\]/

# enforced custom commit message format
def check_message_format
  missed_revs = `git rev-list #{$oldrev}..#{$newrev}`.split("\n")
  missed_revs.each do |rev|
    message = `git cat-file commit #{rev} | sed '1,/^$/d'`
    if !$regex.match(message)
      puts "[POLICY] Your message is not formatted correctly"
      exit 1
    end
  end
end
check_message_format

将此放入您的 `update` 脚本中，将拒绝包含不符合您规则的消息的提交的更新。

强制执行基于用户的 ACL 系统

假设您想添加一个机制，该机制使用一个访问控制列表 (ACL)，指定哪些用户可以推送更改到您项目的哪些部分。有些人拥有完全访问权限，而其他人只能将更改推送到特定的子目录或特定文件。为了强制执行此操作，您将这些规则写入一个名为 `acl` 的文件，该文件位于服务器上的裸 Git 仓库中。您将让 `update` 钩子查看这些规则，查看正在推送的所有提交引入了哪些文件，并确定执行推送的用户是否拥有更新所有这些文件的访问权限。

您首先要做的是编写您的 ACL。在这里，您将使用一种非常类似于 CVS ACL 机制的格式：它使用一系列行，其中第一个字段是 `avail` 或 `unavail`，下一个字段是要应用规则的用户的逗号分隔列表，最后一个字段是要应用的路径（留空表示开放访问）。所有这些字段都由管道（`|`）字符分隔。

在这种情况下，您有几位管理员，一些文档作者对 `doc` 目录有访问权限，还有一位开发人员只对 `lib` 和 `tests` 目录有访问权限，您的 ACL 文件如下所示：

avail|nickh,pjhyett,defunkt,tpw
avail|usinclair,cdickens,ebronte|doc
avail|schacon|lib
avail|schacon|tests

您首先将此数据读入一个可用的结构。在这种情况下，为了使示例保持简单，您将只强制执行 `avail` 指令。这是一个方法，它会为您提供一个关联数组，其中键是用户名，值是用户具有写入权限的路径数组：

def get_acl_access_data(acl_file)
  # read in ACL data
  acl_file = File.read(acl_file).split("\n").reject { |line| line == '' }
  access = {}
  acl_file.each do |line|
    avail, users, path = line.split('|')
    next unless avail == 'avail'
    users.split(',').each do |user|
      access[user] ||= []
      access[user] << path
    end
  end
  access
end

根据您之前查看的 ACL 文件，此 `get_acl_access_data` 方法返回的数据结构如下所示：

{"defunkt"=>[nil],
 "tpw"=>[nil],
 "nickh"=>[nil],
 "pjhyett"=>[nil],
 "schacon"=>["lib", "tests"],
 "cdickens"=>["doc"],
 "usinclair"=>["doc"],
 "ebronte"=>["doc"]}

既然您已经整理好了权限，您就需要确定被推送的提交修改了哪些路径，以便确保执行推送的用户能够访问所有这些路径。

使用 `git log` 命令的 `--name-only` 选项（在 Git Basics 中简要提及）可以很容易地看到单个提交中修改了哪些文件。

$ git log -1 --name-only --pretty=format:'' 9f585d

README
lib/test.rb

如果您使用 `get_acl_access_data` 方法返回的 ACL 结构，并将其与每个提交中列出的文件进行检查，您就可以确定用户是否有权限推送他们所有的提交。

# only allows certain users to modify certain subdirectories in a project
def check_directory_perms
  access = get_acl_access_data('acl')

  # see if anyone is trying to push something they can't
  new_commits = `git rev-list #{$oldrev}..#{$newrev}`.split("\n")
  new_commits.each do |rev|
    files_modified = `git log -1 --name-only --pretty=format:'' #{rev}`.split("\n")
    files_modified.each do |path|
      next if path.size == 0
      has_file_access = false
      access[$user].each do |access_path|
        if !access_path  # user has access to everything
           || (path.start_with? access_path) # access to this path
          has_file_access = true
        end
      end
      if !has_file_access
        puts "[POLICY] You do not have access to push to #{path}"
        exit 1
      end
    end
  end
end

check_directory_perms

您可以使用 `git rev-list` 获取推送到您服务器的新提交列表。然后，对于每个提交，找出修改了哪些文件，并确保执行推送的用户能够访问所有被修改的路径。

现在，您的用户无法推送任何格式错误的提交消息或修改了其指定路径之外文件的提交。

测试

如果您运行 `chmod u+x .git/hooks/update`（您应该将所有代码放入此文件中），然后尝试推送一条不符合要求的消息的提交，您将看到类似以下内容：

$ git push -f origin master
Counting objects: 5, done.
Compressing objects: 100% (3/3), done.
Writing objects: 100% (3/3), 323 bytes, done.
Total 3 (delta 1), reused 0 (delta 0)
Unpacking objects: 100% (3/3), done.
Enforcing Policies...
(refs/heads/master) (8338c5) (c5b616)
[POLICY] Your message is not formatted correctly
error: hooks/update exited with error code 1
error: hook declined to update refs/heads/master
To git@gitserver:project.git
 ! [remote rejected] master -> master (hook declined)
error: failed to push some refs to 'git@gitserver:project.git'

这里有几件有趣的事情。首先，您看到钩子开始运行的地方。

Enforcing Policies...
(refs/heads/master) (fb8c72) (c56860)

请记住，您在 update 脚本的开头就打印了这一点。您的脚本回显到 `stdout` 的任何内容都将传输到客户端。

接下来您会注意到的是错误消息。

[POLICY] Your message is not formatted correctly
error: hooks/update exited with error code 1
error: hook declined to update refs/heads/master

第一行是您打印的，另外两行是 Git 告诉您 update 脚本退出了非零，这正是拒绝您的推送的原因。最后，您有这个：

To git@gitserver:project.git
 ! [remote rejected] master -> master (hook declined)
error: failed to push some refs to 'git@gitserver:project.git'

您将看到每个被您的钩子拒绝的引用的远程拒绝消息，它告诉您拒绝的原因是钩子失败。

此外，如果有人尝试修改他们无权访问的文件并推送包含该文件的提交，他们会看到类似的内容。例如，如果一位文档作者尝试推送修改 `lib` 目录中内容的提交，他们会看到：

[POLICY] You do not have access to push to lib/test.rb

从现在开始，只要 `update` 脚本存在且可执行，您的存储库将永远不会有不包含您的模式的提交消息，您的用户也将被沙盒化。

客户端钩子

这种方法的缺点是，当用户的提交被拒绝时，不可避免地会产生抱怨。在最后关头拒绝他们精心制作的工作可能会非常令人沮丧和困惑；此外，他们将不得不编辑他们的历史来纠正它，这对于胆小的人来说并不总是容易的。

解决这个困境的方法是提供一些客户端钩子，用户可以运行这些钩子来通知他们何时在做服务器可能会拒绝的事情。这样，他们可以在提交之前、在这些问题变得更难修复之前纠正任何问题。由于钩子不会随项目的克隆一起传输，您必须以其他方式分发这些脚本，然后让您的用户将它们复制到他们的 `.git/hooks` 目录并使其可执行。您可以将这些钩子分发在项目内或单独的项目中，但 Git 不会自动设置它们。

首先，您应该在每次提交被记录之前检查您的提交消息，这样您就知道服务器不会因为格式错误的提交消息而拒绝您的更改。要做到这一点，您可以添加 `commit-msg` 钩子。如果您让它读取传递为第一个参数的文件中的消息，并将其与模式进行比较，您就可以强制 Git 在没有匹配项时中止提交：

#!/usr/bin/env ruby
message_file = ARGV[0]
message = File.read(message_file)

$regex = /\[ref: (\d+)\]/

if !$regex.match(message)
  puts "[POLICY] Your message is not formatted correctly"
  exit 1
end

如果该脚本已就位（在 `.git/hooks/commit-msg` 中）并且可执行，并且您使用格式不正确的消息进行提交，您会看到：

$ git commit -am 'Test'
[POLICY] Your message is not formatted correctly

在这种情况下，没有完成提交。但是，如果您的消息包含正确的模式，Git 会允许您提交：

$ git commit -am 'Test [ref: 132]'
[master e05c914] Test [ref: 132]
 1 file changed, 1 insertions(+), 0 deletions(-)

接下来，您希望确保您没有修改超出您 ACL 范围的文件。如果您的项目的 `.git` 目录包含您之前使用的 ACL 文件的副本，那么下面的 `pre-commit` 脚本将为您强制执行这些约束：

#!/usr/bin/env ruby

$user    = ENV['USER']

# [ insert acl_access_data method from above ]

# only allows certain users to modify certain subdirectories in a project
def check_directory_perms
  access = get_acl_access_data('.git/acl')

  files_modified = `git diff-index --cached --name-only HEAD`.split("\n")
  files_modified.each do |path|
    next if path.size == 0
    has_file_access = false
    access[$user].each do |access_path|
    if !access_path || (path.index(access_path) == 0)
      has_file_access = true
    end
    if !has_file_access
      puts "[POLICY] You do not have access to push to #{path}"
      exit 1
    end
  end
end

check_directory_perms

这大致与服务器端部分相同，但有两个重要区别。首先，ACL 文件在不同的位置，因为这个脚本从您的工作目录运行，而不是从您的 `.git` 目录运行。您需要将 ACL 文件的路径从这个

access = get_acl_access_data('acl')

更改为这个

access = get_acl_access_data('.git/acl')

另一个重要区别是您如何获取已更改文件的列表。因为服务器端方法查看提交日志，并且此时提交尚未记录，您必须从暂存区获取文件列表。而不是

files_modified = `git log -1 --name-only --pretty=format:'' #{ref}`

您必须使用

files_modified = `git diff-index --cached --name-only HEAD`

但那只是两个区别——否则，脚本工作方式相同。一个警告是，它期望您以与推送到远程机器相同的用户在本地运行。如果不同，则必须手动设置 `$user` 变量。

我们还可以做的另一件事是确保用户不推送非快进引用。要获取一个非快进的引用，您要么需要 rebase 已经推送过的提交，要么尝试将不同的本地分支推送到同一个远程分支。

可能，服务器已经配置了 `receive.denyDeletes` 和 `receive.denyNonFastForwards` 来强制执行此策略，因此您唯一可以尝试捕获的意外情况是 rebase 已经推送过的提交。

这是一个示例 pre-rebase 脚本，用于检查这一点。它获取您即将重写的提交列表，并检查它们是否存在于您的任何远程引用中。如果它看到一个可以从您的远程引用之一到达的提交，它会中止 rebase。

#!/usr/bin/env ruby

base_branch = ARGV[0]
if ARGV[1]
  topic_branch = ARGV[1]
else
  topic_branch = "HEAD"
end

target_shas = `git rev-list #{base_branch}..#{topic_branch}`.split("\n")
remote_refs = `git branch -r`.split("\n").map { |r| r.strip }

target_shas.each do |sha|
  remote_refs.each do |remote_ref|
    shas_pushed = `git rev-list ^#{sha}^@ refs/remotes/#{remote_ref}`
    if shas_pushed.split("\n").include?(sha)
      puts "[POLICY] Commit #{sha} has already been pushed to #{remote_ref}"
      exit 1
    end
  end
end

此脚本使用了 Revision Selection 中未涵盖的语法。您可以通过运行此命令获取已推送提交的列表：

`git rev-list ^#{sha}^@ refs/remotes/#{remote_ref}`

`SHA^@` 语法解析为该提交的所有父项。您正在寻找任何可以从远程的最后一个提交到达，但无法从您要推送的任何 SHA-1 的父项到达的提交——这意味着它是快进的。

这种方法的主要缺点是它可能非常慢而且通常不必要——如果您不使用 `-f` 强制推送，服务器会警告您并且不会接受推送。然而，这是一个有趣的练习，理论上可以帮助您避免以后可能需要修复的 rebase。