git - 如何测试我的预接收 Hook ？

Question

我需要创建一个预接收钩子(Hook)来拒绝来自任何非主分支的任何客户端的推送，所以我写了这个脚本:

     #!/bin/bash

    refname="$0"
    oldrev="$1"
    newrev="$2"

    alowed_branch='master'
    current_branch=$(git symbolic-ref HEAD | sed -e 's,.*/\(.*\),\1,')

    if [ $alowed_branch = $current_branch ]
    then
      echo "you are pushing to master branch"
      exit 0
    else
      echo Branch $current_branch is Locked.
     exit 1
    fi

现在我不知道如何测试它...

在本地 git 仓库的“预提交” Hook 上进行测试时，我得到了我想要的:

但是当尝试按照建议将其作为预推送或预接收 Hook 进行测试时，它没有任何效果，我可以在不受干扰的情况下提交和推送。

有没有办法在 GitHub 上测试它？

Answer 1

测试钩子(Hook)，尤其是预接收钩子(Hook)，是很困难的:它们在不寻常的环境中运行。测试它们的好方法很少(主要的好方法是牺牲一两个存储库)。

这里有很多相互交织的问题:

refname="$0"

无论如何这是错误的，因为在 shell 脚本中，$0 指的是脚本本身的名称。

current_branch=$(refname) 

您在编辑中删除的这个也是错误的:它尝试运行命令 refname。所以你更换它很好，但是:

current_branch=$(git symbolic-ref HEAD | sed -e 's,.*/\(.*\),\1,')

这是一个微妙的错误:如果您当前的分支名为 fixes/bug-123，它会将 current_branch 设置为 bug-123，而不是修复/bug-123。

要获取当前分支名称作为减去refs/heads/部分的符号引用，使用:

current_branch=$(git symbolic-ref --short HEAD) || exit 1

--short 指示 git symbolic-ref 省略 refs/heads/ 部分，而 || exit 1 指示 shell 在 git symbolic-ref 本身失败时退出(失败状态)，它可能是:如果你有一个“分离的 HEAD” , HEAD 不是一个符号引用，Git 会对此报错并且 current_branch 将被设置为空字符串。

现在，除了这些，你提到:

... trying to test it as a pre-push or pre-receive hook ...

作为预推送 Hook ，$1 和 $2(您存储在 oldrev 和 newrev 中)实际上将设置为 Remote 的名称和 URL!旧的和新的修订版 ID 以及旧的和新的引用名称作为其标准输入 传递给该 Hook 。这一切都发生在客户端，在连接到另一个 Git(远程)之后但在发送任何内容之前。 (See the section on pre-push hooks in the githooks documentation.)

作为预接收 Hook ，$1 和 $2 将根本不设置任何值(这没关系，因为您从不使用无论如何变量)。 当前分支 将是 远程上另一个 Git 中的当前分支。预接收 Hook ，如预推 Hook ，必须读取其标准输入，一次一行，检查该行提供的每组参数。如果 Hook 以非零返回值退出，则整个推送将被拒绝(从服务器端)。

在预推或预接收 Hook 中检查引用名称时，请务必检查整个引用:传入引用(在任一 Hook 中)或传出引用(在预推hook) 可以引用一个标签，例如，在 refs/tags/v1.2 中，或者一个名称包含斜线的分支，如在 refs/heads/feature/tall。除了名称的最后一部分，不要只砍掉名称的最后一部分，也不要在不看的情况下砍掉前两个部分。而且，在任一 Hook 中，当前分支名称通常完全不相关:运行 git push 的人在命令行上指定要推送的引用:

git push origin \
  refs/heads/master:refs/for/master \
  refs/tags/v1.2:refs/tags/v1.2 \
  refs/notes/commits:refs/notes/commits \
  refs/peculiar-ref:refs/even-stranger/master

例如。这些都不会进入目标的分支；只有一个是来自源上的一个分支。

(请注意， Hook 可以用任何可以在安装了特定 Git 的机器上运行的语言编写。它们不必是 bash/sh 脚本——尽管如果你有Git 你必须有一个 shell，因为 Git 的一部分是用 shell 编写的。始终注意硬编码路径:例如，bash 可能位于 /usr/local/bin/bash 而不是 /bin/bash 在某些系统上。)