The Git Pre-Commit Hook to Avoid Pushing Only Unit Tests In Node
- 时间:2020-09-20 13:49:13
- 分类:网络文摘
- 阅读:99 次
In NodeJS unit testing frameworks such as mocha/chai, you could add .only after describe or it, so that the specific set of tests are run, which excludes/disables all other tests. For example,
1 2 3 4 5 | describe.only("I just want to run these tests", function() { it("should work", function() { expect(1).to.equal(1); }); }); |
describe.only("I just want to run these tests", function() { it("should work", function() { expect(1).to.equal(1); }); });
Chances are, you might forget to remove the .only before you commit and push. And even worse, the code review may miss this – which in fact will disable all other tests in the Continous Integration process.
So, you can easily add a pre-commit hook check that will give you a nice warning if you try to commit some code that has .only.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | # Redirect output to stderr. exec 1>&2 # prevent it.only or describe.only commited if [ "$allowonlytests" != "true" ] && test $(git diff --cached | grep -E "\b(it|describe).only\(" | wc -l) != 0 then cat <<\EOF Error: Attempt to add it.only or describe.only - which may disable all other tests If you know what you are doing you can disable this check using: git config hooks.allowonlytests true EOF exit 1 fi exit 0 |
# Redirect output to stderr. exec 1>&2 # prevent it.only or describe.only commited if [ "$allowonlytests" != "true" ] && test $(git diff --cached | grep -E "\b(it|describe).only\(" | wc -l) != 0 then cat <<\EOF Error: Attempt to add it.only or describe.only - which may disable all other tests If you know what you are doing you can disable this check using: git config hooks.allowonlytests true EOF exit 1 fi exit 0
Save above as filename “pre-commit” (without the quotes) in the folder .git/hooks at your project repository. The script will exit non-zero ONE which indicates a No if there is it.only or describe.only in the diff changes. However, the command/script is smart enough (to use grep with regular expression) that will not trigger the warning if it is followed by // line comment.
You can also disable the warning by using the following:
1 | git config hooks.allowonlytests true |
git config hooks.allowonlytests true

git-pre-commit-hook
Here’s an eslint plugin that has the same effect.
https://www.npmjs.com/package/eslint-plugin-no-only-tests
Here is another post on the pre-push hooks to the master branch: How to Prevent Commiting to master/develop branch by Accidents using Pre-push Hooks in Git?
–EOF (The Ultimate Computing & Technology Blog) —
推荐阅读:秋之韵|小学作文 新年的颜色|小学作文 我也是偶然成为你的姐姐|小学作文 生命是什么?|小学作文 伟大的创造——迪卡尔的故事 迪卡尔受教会迫害致死 一个直角三角形里画一个最大的正方形 非凡的天才——伽罗华 承受磨炼——伽罗华 难以遮掩的光芒——伽罗华
- 评论列表
-
- 添加评论