标签 博客 下的文章

使用svn pre-commit hook

一直以来我们对项目代码的提交管理都是粗放型的,即对大家提交代码的时间、频率和提交日志的形式都没有严格的要求,可谓比较随意。主要发现的问题包括:
- 某些提交没有规划,甚至随意增加一些并无太大意义的注释都作一次提交。
- 提交的代码甚至没有经过REVIEW和UT,这样的代码即使内部发布,也会带来后续工作量的严重浪费(测试、发现问题、定位问题、重新fix、重新验证等);
- 提交日志无实际意义,如commit log为空、commit log没能真实反映出这次提交的真实目的和意义、多次提交却采用同一条提交日志等等;
… …

以上,有些问题是需要通过过程要求改善的,有些问题则可以通过技术手段引导大家去完成,比如对commit log的校验。从Tim的博客中了解到twiiter内部对每次commit的log都做严格要求,至少必须填写此次代码变动的代码评审人。这个idea很好!这样开发人员每次尝试提交代码时都要想着填写reviewed by xxx。xxx是要对这次提交代码的质量负责任的;绝对禁止提交代码者随意填写上一个并未真实review其代码的人的名字。

使用SVN来进行代码版本控制工具的项目可采用svn pre-commit hook来实现对commit log的检查。在SVN服务器侧你的项目repos下有一个hook目录,该目录下存放着一些hook的模板(以.tmpl为后缀名)。各个hook模板中都有对该类型hook的说明,甚至还包括一段代码样例。如果你想使该hook启用,需要将xxx.tmpl改名为xxx,这样你再提交代码时,hook就会被svn server端自动调用。svn的hook其实就可以理解为一个可执行的文件,你可用各种语言(如shell脚本、C、Java、Python、Ruby等)实现hook。svn server端在调用hook时,会按照规定次序给hook传入N个确定含义的命令行参数供hook的实现使用。以pre-commit hook为例,svn server会依次传入REPOS和TXN;其中REPOS存储的是项目repository的路径信息;TXN则是此次提交的一个事务号名称。hook实现的返回值将作为svn server判断是否继续此次提交事务的依据:如果返回0,则svn server继续此次提交事务,否则svn server停止此次提交,并将hook实现中输出到标准错误的信息回送到客户端以作为错误提示。

下面是一个用C语言实现的pre-commit hook的简单例子:
/* pre-commit.c */
/* gcc -o pre-commit pre-commit.c */
int main(int argc, char *argv[]) {
    char     repos[PATH_MAX];
    char     txn[64];

    memset(repos, 0, sizeof(repos));
    memset(txn, 0, sizeof(txn));

    strcpy(repos, argv[1]);
    strcpy(txn, argv[2]);

    /* 只对repos下的特定路径下的文件ci进行log检查 */
    if (!filter_repos_subdir(txn, repos)) {
        return check_log(txn, repos);
    }

    return 0;
}

对于一个repos,其下面有些folder中的文件可能并不一定是代码,可能不需要严格执行ci log格式的要求,filter_repos_subdir这个函数就旨在过滤此次提交的各个文件的路径信息:若判断出此次提交的文件路径均是不需要严格执行ci log格式要求的,则后续不作log check。

通过repos和txn两个参数我们如何获取此次提交的文件路径信息呢?svn提供了svnlook工具,我们利用svnlook changed -t txn repos可以获取文件路径信息。

#define SVNLOOK "/usr/local/bin/svnlook"
int filter_repos_subdir(const char *txn, const char *repos) {
    FILE        *fp;
    char        buf[PATH_MAX];
    char        cmd[PATH_MAX];

    memset(cmd, 0, sizeof(cmd));
    memset(buf, 0, sizeof(buf));
    sprintf(cmd, "%s changed -t %s %s", SVNLOOK, txn, repos);

    fp = popen(cmd, "r");
    if (fp == NULL) {
        fprintf(stderr, "%s\n", "popen failed");
        return 1;
    }

    while (fgets(buf, PATH_MAX, fp) != NULL) {
        if ((strstr(buf, "dog/") != NULL)
            || (strstr(buf, "cat/") != NULL)
            || (strstr(buf, "tiger/") != NULL) {
            memset(buf, 0, sizeof(buf));
            continue;
        } else {
            pclose(fp);
            return 1;
        }
    }

    pclose(fp);
    return 0;
}
filter_repos_subdir利用popen与shell交互获取svnlook执行后输出的信息,如:
U   dog/test1.c
U   cat/test2.c
A   tiger/test3.c
并对多行信息逐一进行过滤。

check_log与filter_repos_subdir类似,它通过svnlook log -t TXN REPOS获取此次提交的日志信息,并根据日志格式要求对日志进行校验,如发现不合格则返回失败;svn server将停止本次commit事务。

int check_log(const char *txn, const char *repos) {
    FILE        *fp;
    char        buf[PATH_MAX];
    char        cmd[PATH_MAX];

    memset(cmd, 0, sizeof(cmd));
    memset(buf, 0, sizeof(buf));
    sprintf(cmd, "%s log -t %s %s", SVNLOOK, txn, repos);

    fp = popen(cmd, "r");
    if (fp == NULL) {
        fprintf(stderr, "%s\n", "popen failed");
        return 1;
    }

    while (fgets(buf, PATH_MAX, fp) != NULL) {
        if (strstr(buf, "reviewed by")) {
            pclose(fp);
            return 0;
        }
        memset(buf, 0, sizeof(buf));
    }
    fprintf(stderr, "%s\n", "请填写此次提交代码的reviewer, log格式:… reviewed by xxx …");
    pclose(fp);
    return 1;
}

以上这个pre-commit hook demo只是为了说明hook的实现思路,如果你要打造自己的pre-commit hook可能还需要更严谨一些,另外还可加上更多有创意性的idea在里面!其他类型hook的实现思路大致一样,详细内容请参考svn manual

使用astyle美化代码

昨天一位同事发了一篇小文档,文档中介绍了一种开源格式化代码的工具,名为Artistic Style(astyle),功能看起来还是很不错的。之前我写代码时比较注意代码的风格,一直按照自己的思路来美化自己的代码,用的最多的辅助工具就是Vim自带的indent功能,对这之外的格式化工具少有涉猎。记得几年前部门曾推广一款名为checkstyle的Java代码格式规范检查工具,由于当时基本不接触Java,也没有用过。

今天被问及该工具是否可以在组内推广,遂又花心思想了一下。看了同事的介绍文档,感觉astyle还是很实用的,特别是对现存遗留的格式不规范的代码文件,可批量做转换(之前我都是修改哪个源文件时顺便对格式进行美化,浪费了我不少精力) 但是如何能被大家接受和使用起来,这还是一个问题。最开始想到的是让astyle与svn结合在一起,对开发人员保持透明。通过svn hooks来自动完成对代码的格式化。不过细致研究后发现,这样是有问题的。如果在svn server端增加svn pre-commit hook来调用astyle对提交的代码进行格式化,那么这势必可能导致开发人员提交后的server端代码与其Local copy不一致;如果开发人员不知情,后续就会导致进一步的代码不一致问题。另外在svn官方manual中似乎也不推荐在svn pre-commit hook中修改提交的文件内容,好像是会破坏svn commit事务(导致本地和服务器端的一些对文件的统计不一致)。又考虑在客户端svn hook,可查来查去才发现目前只有TortoiseSVN的实现支持客户端hook,遂放弃。

让大家直接执行astyle,显然是高估了大家的执行力了。遂想到还是将astyle与Vim集成在一起吧。

步骤如下:
1、编译artistic style源码,将astyle的可执行程序放到某个目录X下,并将目录X放到path中(ubuntu上可用sudo apt-get install astyle安装)
2、编辑.vimrc,添加一行map :%! astyle  (Shift+F 注:在当前缓冲区用astyle美化缓冲区中的内容,并输出结果到当前缓冲区中)
3、定义模板option文件,位置:$HOME/.astylerc

以下是一个.astylerc的例子:
# my astyle options file

–indent=spaces=8
–brackets=attach
–indent-switches
–indent-cases
–indent-labels
–indent-preprocessor
–indent-col1-comments
–pad-oper
–pad-header
–unpad-paren
–add-brackets
–keep-one-line-statements
–align-pointer=name
–mode=c
–min-conditional-indent=0

按照以上方式集成astyle到vim中有一个缺点:就是每次美化都是针对当前缓冲区(一般就是一个文件)。无法做到对某几行或一块区域进行代码美化。

后在stackoverflow上发现有一人提出这样的方案:在.vimrc中增加一行:autocmd BufNewFile,BufRead *.c set formatprg=astyle\ -T4pb。最初以为这样设置是使用astyle替换vim内置的c indent格式化工具,遂照猫画虎配置后用"="命令进行测试,发现无法格式化;遂花时间研读Vim手册,终于发现是我的理解错了。formatprg这个option是与gq命令联系在一起的,而非关联"="命令。以前的确不怎么使用gq命令,而是一直用c indent("=")来做所谓的格式化操作。利用对formatprg这个option的设置可以做到利用外部工具对vim当前文本buffer做格式化的目的。因为之前已经配置了$HOME/.astylerc,所以在.vimrc中增加一行:autocmd BufNewFile,BufRead *.c set formatprg=astyle,去掉了-T4pb这几个参数。

生效.vimrc后使用gq命令对.c文件进行测试,果然有效。gq命令不仅支持对Whole Buffer进行filter,而且可以对单行、多行以及对块文本进行格式化过滤,比如:
NORMAL模式下: gggqG 即对Whole Buffer进行格式化过滤;
 gqG  对从当前行到末尾行之间的文本进行格式化过滤;
 gq+1 对下一行文本进行格式化过滤;
 gqj  对当前行和下一行文本进行格式化过滤;

与Vim结合在一起最大的好处是:astyle被透明的引入到我们日常开发过程中了,你的工作量并未因astyle的引入而增加,反而astyle却提升了你的工作效率,不是吗?

如发现本站页面被黑,比如:挂载广告、挖矿等恶意代码,请朋友们及时联系我。十分感谢! Go语言第一课 Go语言精进之路1 Go语言精进之路2 Go语言编程指南
商务合作请联系bigwhite.cn AT aliyun.com

欢迎使用邮件订阅我的博客

输入邮箱订阅本站,只要有新文章发布,就会第一时间发送邮件通知你哦!

这里是 Tony Bai的个人Blog,欢迎访问、订阅和留言! 订阅Feed请点击上面图片

如果您觉得这里的文章对您有帮助,请扫描上方二维码进行捐赠 ,加油后的Tony Bai将会为您呈现更多精彩的文章,谢谢!

如果您希望通过微信捐赠,请用微信客户端扫描下方赞赏码:

如果您希望通过比特币或以太币捐赠,可以扫描下方二维码:

比特币:

以太币:

如果您喜欢通过微信浏览本站内容,可以扫描下方二维码,订阅本站官方微信订阅号“iamtonybai”;点击二维码,可直达本人官方微博主页^_^:
本站Powered by Digital Ocean VPS。
选择Digital Ocean VPS主机,即可获得10美元现金充值,可 免费使用两个月哟! 著名主机提供商Linode 10$优惠码:linode10,在 这里注册即可免费获 得。阿里云推荐码: 1WFZ0V立享9折!


View Tony Bai's profile on LinkedIn
DigitalOcean Referral Badge

文章

评论

  • 正在加载...

分类

标签

归档



View My Stats