只有在测试通过时才在git中提交

Question

我最近开始使用git,并开始进行单元测试(使用Python的unittest模块).我想在每次提交时运行我的测试,并且只有在它们通过时才提交.

我猜我需要用pre-commit的/hooks,我已经成功地使它运行测试,但我似乎无法找到一种方法来阻止,如果他们失败测试的承诺.我正在运行测试make test,而后者正在运行python3.1 foo.py --test.似乎我没有得到不同的退出条件,无论测试通过还是失败,但我可能在错误的地方寻找.

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

编辑2:万一人们无法阅读评论,问题是unittest.TextTestRunner不会以非零状态退出,测试套件是否成功.要抓住它,我做了:

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

Answer 1

我会检查以确保每个步骤,您的脚本在失败时返回非零退出代码.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 2

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

如果要挂起提交,挂钩应在发出适当的消息后以非零状态退出.

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