(三) git pre-push hook 实践一二

逃离我推掉我的手 2022-03-16 06:54 268阅读 0赞

在 [(一) 初探 iOS 单元测试][_ iOS] 一文中，我们简单提到了执行xcodebuild test可以启动工程的单元测试并输出测试结果，但手动执行此类命令意义是不大的。我们需要的是，把一些测试和lint等命令写在脚本文件里，在代码提交、合并及打包等行为实际发生前，自动执行脚本，以执行的结果决定是否打断上述操作，一定程度上达到控制代码质量的目的。   在多人协作开发中，我们可以在所有成员进行某些git操作(commit push merge rebase等)前进行代码的验证(Test、Lint等)，防止逻辑错误或不合规范的代码更新到远端仓库中。当然，如果团队搭建了自己的git服务器，有Mac服务器，在server端进行git hooks是最好的解决方案，本地仓库也不用进行额外配置。此外，我们也可以做一些Client Hooks，来达到同样的效果。以下内容是笔者对git pre-push hook的一些实践。

#### 手动添加pre-push文件 ####

前往本地仓库，按下command+shift+.查看隐藏文件，目录如下。我们可以看到.git/hooks路径下有一些.sample的文件。

删除pre-push.sample文件的后缀名，用编辑器打开，写入：

exit 1
    复制代码

保存退出，仓库根目录下，执行：

git push
    复制代码

可以看到push失败。下面我们在pre-push写入单元测试的命令，如果测试通过，pre-push程序正常退出，push成功；测试失败，出错并退出，push失败。写入：

workspace_name() {
      workspace_file=`find . -maxdepth 2 -name *.xcworkspace -exec basename {} \;`
      echo ${workspace_file%.xcworkspace}
    }
    
    check_result() {
    if [ $? != 0 ]; then
    echo "$1 failed!!"
    echo "push will not execute"
    echo "$?"
    exit 1
    else
    echo "$1 passed."
    echo "push will execute"
    echo "$?"
    fi
    }
    
    workspace=$(workspace_name)
    
    xcodebuild -workspace Example/$workspace.xcworkspace -scheme $workspace-Example -destination 'platform=iOS Simulator,OS=11.0,name=iPhone 7' test
    check_result "test"
    复制代码

例子是以`pod lib create ...`创建的标准工作空间，从仓库根目录起以最大深度为2寻找以.xcworkspace结尾的文件名，赋给workspace变量，最后test名为worksapce.xcworkspace scheme为worksapce-Example的工程，测试失败，打印`"push will not execute"`，`exit 1`；反之打印`push will execute`，`exit 0`。 仓库根目录下执行：

git push
    复制代码

最后输出：

现在我们已经实现了一些我们想要的效果，但如何让团队里的每个开发成员都收到pre-push hook的规范呢？

#### 自动添加pre-push文件 ####

我们知道，.git文件夹并不会被push到远程仓库，每个成员clone仓库，.git文件夹是会初始化的。也就是说，正常情况下，pre-push hook只对个人有效。但我们可以耍一些小手段，让每个成员仓库.git/hooks路径下都存在我们写好的pre-push文件，这样其他成员的仓库也具备了git pre-push hook功能。

if [ ! -d "$../.git/hooks/pre-push" ]; then
    cp ../pre-push ../.git/hooks/pre-push
    exit 0
    fi
    复制代码

首先，我们写好一个脚本，功能为如果.git/hooks路径下没有pre-push文件，就复制一个进去。如图中add-pre-push-hook.sh文件：

那这个脚本在什么时候被执行呢？答案是放在我们Target的Run Script下：  注意Run Script 和 add-pre-push-hook.sh 是在.xcodeproj的路径下开始执行的。这样，每当build，就会执行add-pre-push-hook.sh检查.git/hooks文件夹下是否存在pre-push文件并尝试复制进去。下次当开发成员尝试push代码时，便无形中受到了hook！！！这一切对很多工程的基础库的维护做代码检查还是有一定实用价值的。

### 谢谢观看！欢迎指出文中错误！ ###

#### 参考文档 ####

[git-scm.com/book/en/v2/…][git-scm.com_book_en_v2] [blog.ittybittyapps.com/blog/2013/0…][blog.ittybittyapps.com_blog_2013_0] [blog.ricardofilipe.com/post/git-ho…][blog.ricardofilipe.com_post_git-ho]

[_ iOS]: https://link.juejin.im?target=http%3A%2F%2Fwww.jianshu.com%2Fp%2F750a44f52a18
[git-scm.com_book_en_v2]: https://link.juejin.im?target=https%3A%2F%2Fgit-scm.com%2Fbook%2Fen%2Fv2%2FCustomizing-Git-Git-Hooks
[blog.ittybittyapps.com_blog_2013_0]: https://link.juejin.im?target=http%3A%2F%2Fblog.ittybittyapps.com%2Fblog%2F2013%2F09%2F03%2Fgit-pre-push%2F
[blog.ricardofilipe.com_post_git-ho]: https://link.juejin.im?target=http%3A%2F%2Fblog.ricardofilipe.com%2Fpost%2Fgit-hook-push-master