Java接口自动化测试项目构建规范.doc

java接口自动化测试项目构建规范概要：本文档旨在指导说明如何基于eclipse+maven构建Java接口自动化测试项目，并遵循相关规范说明，各Java接口自动化测试项目需按此规范执行基本要求1） JDK：JDK1.8svn:///软件共享/SOFT/jdk-8u25-windows-x64.exe2)git客户端svn:///软件共享/SOFT/Git-2.5.3-64-bit.exe3)Eclipse：相关插件testNG、maven等已安装配置好svn:///软件共享/SOFT/eclipse-jee-mars-R-win32-x86_64.zip4)构建Java项目编码要求：统一使用UTF-8编码5)所有项目源码使用teamcode管理Teamcode操作及最佳实践git clone ssh:/yourUserN:29418/fangdd/engineering/teamcode & scp -p -P 29418 yourUserN:hooks/commit-msg teamcode/.git/hooks/clone后可参考specs目录下teamcode-workflow.md与teamcode-best-practice.md说明Maven基本配置testNG测试框架介绍及使用 构建步骤说明1） 新建Java maven项目，如下图所示，点击新建2、弹窗中选择新建Java maven项目，如下图所示，下一步3、修改workspace路径为Eclipse workspace路径，如下如所示，下一步4、选择类别，如下图所示，下一步5、输入相关信息，完成groupId 统一为com.fangdd.qaartifactId为java项目名，自定义，如agent-service-testversion默认package统一为com.fangdd6、 Java项目建好后修改项目编码选中项目右键，选择如下箭头所指修改项目编码为UTF-87、选中项目右键，新建package，选择如下箭头所指8、输入如下图所示，完成9、更改项目buildpath，选中项目右键，选择如下图所示10、弹框中切换至source11、点击Add Folder，弹框中勾选resources，如下图所示，OK 项目建好后基本结构如下，将默认的App.java 与AppTest.java删除后续相关配置文件均存放至resources目录下12、 从代码库clone出agent-service-test项目(确保本机已安装及配置好git相关配置)(作为后续新建项目demo参考)git clone ssh:/yourUserN:29418/fangdd/testcode/agent-service-test & scp -p -P 29418 yourUserN:hooks/commit-msg agent-service-test/.git/hooks/13、 配置新建项目1）重命名新建项目pom.xml文件为pom-back.xml，重命名操作如下图所示2) 复制agent-service-test中pom.xml及.gitignore文件至新建项目根目录3)修改pom.xml中artifactId与name配置，与pom-back.xml对应配置保持一致，如下红框所示内容4)修改后变为如下图所示5)覆盖完成后即可删除pom-back.xml文件6)拷贝agent-service-test下src/main/resources目录下资源文件至新建项目src/main/resources目录(可根据自身项目需要增加、修改或删除配置)，如下图红框所示Sperties：主要配置工具类的基础配置，也可将自身项目测试的相关配置也配置在该文件中，如被测系统ip、port等配置信息Dperties：主要配置数据库连接信息，测试项目有需要操作数据库的，可将相关配置信息配置在此文件中perties：主要配置日志相关配置信息，基本不用修7)同时需要将相关properties配置文件编码做修改，选中某配置文件，右键菜单选择如下图所示8)弹窗中修改编码为UTF-8，点击OK即可（OK后如有提示弹窗，选择yes）14、 在src/main/java目录及src/test/java新建相关package，我们目前测试代码的结构主要包括两部分，处理逻辑的action与action对应的testcase(可根据项目情况自定义)，故此，需要新建两个package，testcase的package需建在src/test/java下Package命名规范:Action package(被测试类package)：com.fangdd.项目名.actionTestcase package(测试类package，与被测试类package保持一致)：com.fangdd.项目名.action以agent项目为例：Action package(被测试类package)：com.fangdd. agent.actionTestcase package(测试类package，与被测试类package保持一致)：com.fangdd. agent.action如需其他package，根据自身项目需要自定义15、最终项目完成后目录结构如下：附录：规范要求及说明1、所有配置文件，除pom.xml、.gitignore外，均放在src/main/resources目录2、package命名：字母全部小写，例com.fangdd.agent.action，testcase的package需建在src/test/java下Package命名规范:Action package(被测试类package)：com.fangdd.项目名.actionTestcase package(测试类package，与被测试类package保持一致)：com.fangdd.项目名.action以agent项目为例：Action package(被测试类package)：com.fangdd. agent.actionTestcase package(测试类package，与被测试类package保持一致)：com.fangdd. agent.action如需其他package，根据自身项目需要自定义3、被测试类命名：首字母大写，例MyStoreAction4、测试类命名：首字母大写，与对应被测试类名对应，并加上Test后缀，例MyStoreActionTest(采用驼峰命名方式)5、被测试方法命名，首字母小写，例insertStoreProject6、测试方法命名，首字母小写，与对应被测试方法名对应，并加上test前缀，例testInsertStoreProject(采用小驼峰命名方式)7、 TestCase中测试方法均需有Assert断言，且在断言失败时需返回失败说明,例：8、 有异常捕获的代码，需抛出自定义BusinessException异常，便于testNG测试框架捕获异常信息并在测试报告中反馈出来例如：创建thrift client，可能有异常，需抛出例如：thrift接口调用逻辑代码，可能有异常，需抛出例如：HTTP调用接口逻辑代码，后台返回HTTP status code非200，抛出异常9、项目pom中添加如下dependency依赖11、pom中关键配置说明1)properties属性定义2)profiles配置,通过此配置可以实现不同环境动态加载对应环境配置文件，如6与04测试环境切换执行，在maven命令行增加-P参数即可例：clean test -Ptest104 -U3）resources配置，配合profiles配置，实现不同环境动态加载对应环境配置文件4)pluginRepositories配置，指定要使用的maven