规范--自动化代码规范

  自动化其实有很多种方式实现,有的用pyhon,有的用Java,也有的用c语言,规范可能也不尽相同,今天着重分享下用Java+git 写自动化的一些规范。

第一,代码规范

1、命名规范
  • 包名:小写:例如service.impl;

  • 类名:大写开头的驼峰命名规则(可读性);

  • 接口名: 大写开头的驼峰命名规则(可读性);

    例如:
    image.png
  • VO: 大写开头的驼峰命名规则(可读性)RequestVO, ResponseRes;

  • Entity: 大写开头的驼峰命名规则(可读性,和表名一致)如:FinLoanTaskEntity;

  • Mapper:大写开头的驼峰命名规则(可读性,和表名一致)如:FinLoanTaskMapper;

  • 用例类名:以大写开头的驼峰命名规则,且以TestXXX开头:如: TestQueryFinLoanTask;

  • 测试用例方法名: 以小写开头的驼峰命名规则,且以testXX开头,如:testQueryFinLoanTask;

2、注意事项
  • 用例之间不能相互依赖,如果需要调用相关业务场景,需要业务方提供基础方法;
  • 自动化测试数据需要与用例隔离,数据配置需要单独存放特定文件(利于业务方数据维护);
  • check模块需要独立实现,暂时在common模块中进行公用分装,但是不要在用例里面写过多的Assert.xxx();
  • 各个业务方需要提供各种数据构造场景的实现,方便其它业务线进行直接调用;
  • 请求vo和返回vo等共用的在common模块进行对象封装,业务相关的需要各个业务线在自己所属模块封装;
  • 测试用例中,需要对步骤进行详细注解;
  • 接口日志需要打印:入参,出参,数据查询结果相关详情信息;
  • entity 和mapper需要和相关的表对应(命名);
  • 入参的bean 同一以VO结尾,返回的bean封装命名同一以Res结尾;
  • mybatis和mybatis plush 都支持;
  • 不要在用例中直接调用mapper注解,需要单独抽一个dbservice,统一注入mapper;
  • 通过配置实现多环境的切换;

第二、公共模块实例

  • common包下的base.BaseTest 是所有子模块的测试入口;
  • common包下的common.base 是http请求和mapper的入口;
  • common包下的cofing 将外部文件动态注入到bean;
  • common包下的database 主要实现数据源的动态切换;
  • common包下的enums 通过枚举封装常量;
  • common包下的util 主要封装一些常用共有方法;
  • ext 包下主要提供一些共有的service(例如:登录);
  • loan 包下主要提供常用的共有vo,entity,mapper;
  • applicationContext 只在common包存在,各个业务线需要在Common包中添加;


    image.png

第三、分支合并master规范

image.png

说明:

  • 1、从Remote Master 分支拉取代码至本地 (本地会生成一个Local-Master Branch);
  • 2、在本地建立自己项目的分支(Local-owner Branch);
  • 3、切换(check out)成自己的项目分支(Local-owner Branch),并在该分支上进行自动化代码的编写;
  • 4、提交commit并review;
  • 5、Review通过后,则将自己本地分支的代码(Local-owner Branch)提交至远程服务器所对应的远程分支仓库(Remote-owner Branch); 如果review不通过,则重新在本地分支(Local-owner Branch)上做修改,修改完成后重新提交commit,进行review,直至本次修改Review通过;
  • 6、在本地切换(check out)成Local-Master Branch分支,并拉取(pull)一下最新的Remote Master分支的代码(这一步确保你本地的代码是最新的,和Remote repository上的代码一致);
  • 7、在Local-Master Branch分支上Merge下自己提交的代码;
  • 8、将Local-Master Branch分支的代码Push至Remote Master Branch分支;
  • 9、在本地切换成本地分支,重新开发,如此循环;
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,047评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,807评论 3 386
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,501评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,839评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,951评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,117评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,188评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,929评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,372评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,679评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,837评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,536评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,168评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,886评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,129评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,665评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,739评论 2 351

推荐阅读更多精彩内容

  • 本文针对初级用户,从最简单的讲起,但是需要读者对Git的基本用法有所了解。 Git是开源的分布式版本控制系统,...
    Sachie阅读 1,144评论 0 2
  • 本文通过以下四个部分讲解git的使用 Git配置 Git使用场景 Git分支管理方法 常用git命令 在讲解...
    z小牛阅读 1,649评论 0 3
  • 1. GIT命令 git init在本地新建一个repo,进入一个项目目录,执行git init,会初始化一个re...
    江边一蓑烟阅读 793评论 0 0
  • 查看、添加、提交、删除、找回,重置修改文件 git help # 显示command的help git sho...
    Swiftor阅读 2,103评论 0 2
  • github创建本地仓库并同步到远程仓库 …or create a new repository on the c...
    BenjaminCool阅读 320评论 0 0