仅当测试通过时才在 git 中提交

Question

我最近开始使用 git，也开始了单元测试（使用 Python 的 unittest 模块）。我想在每次提交时运行我的测试，并且只有在它们通过时才提交。

我猜我需要在/hooks 中使用pre-commit，并且我已经设法让它运行测试，但是如果测试失败，我似乎无法找到停止提交的方法。我正在使用make test 运行测试，而后者又运行python3.1 foo.py --test。无论测试通过还是失败，我似乎都没有得到不同的退出条件，但我可能看错了地方。

编辑：这是我想在这里做的不寻常的事情吗？我原以为这是一个常见的要求......

Edit2：以防万一人们懒得阅读 cmets，问题是 unittest.TextTestRunner 不会以非零状态退出，无论测试套件是成功还是不是。为了抓住它，我做了：

result = runner.run(allTests)
if not result.wasSuccessful():
    sys.exit(1)

Answer 1

另一个选项，如果您不想手动处理预提交： 有一个很好的工具可以运行 Python、Ruby 等的测试和语法检查：github/overcommit

Answer 2

我会检查以确保在每一步中，您的脚本都会在失败时返回非零退出代码。如果测试失败，请检查您的 python3.1 foo.py --test 是否返回非零退出代码。检查以确保您的 make test 命令返回非零退出代码。最后，检查您的 pre-commit 钩子本身是否在失败时返回非零退出代码。

您可以通过在命令末尾添加|| echo $? 来检查非零退出代码；如果命令失败，它将打印出退出代码。

以下示例适用于我（我将 stderr 重定向到 /dev/null 以避免在此处包含过多的无关输出）：

$ python3.1 test.py 2>/dev/null || echo $?
1
$ make test 2>/dev/null || echo $?
python3.1 test.py
2
$ .git/hooks/pre-commit 2>/dev/null || echo $?
python3.1 test.py
1

test.py：

import unittest

class TestFailure(unittest.TestCase):
    def testFail(self):
        assert(False)

if __name__ == '__main__':
    unittest.main()

Makefile：

test:
    python3.1 test.py

.git/hooks/pre-commit：

#!/bin/sh
make test || exit 1

注意|| exit 1。如果make test 是钩子中的最后一个命令，则不需要这样做，因为最后一个命令的退出状态将是脚本的退出状态。但是如果您稍后检查了您的pre-commit 钩子，那么您需要确保您退出时出现错误；否则，钩子末尾的成功命令将导致您的脚本以0 的状态退出。

Answer 3

您能否解析 python 测试会话的结果并确保以非零状态退出预提交挂钩？

在发出适当的消息后，钩子应该以非零状态退出，如果 它想停止提交。

因此，如果您的 python 脚本由于任何原因没有返回适当的状态，您需要直接从 pre-commit 挂钩脚本中确定该状态。
如果测试失败，这将确保提交不会继续进行。
（或者你可以从钩子中调用一个 python 包装器来调用测试，并根据测试结果确保sys.exit(exit_status)）。