在Bamboo上怎么使用iOS的单元测试 | 京东云技术团队

京东云开发者
• 阅读 210

作者:京东零售 吴滔

本教程将使用北汽登录模块为例,一步一步和大家一起搭建单元测试用例,并在Bamboo上跑起来,最终测试结果和代码覆盖率会Bamboo上汇总。

模块名称:BQLoginModule,是通过iBiu创建的一个模块工程

在Bamboo上怎么使用iOS的单元测试 | 京东云技术团队

一 建立单元测试Bundle

ProductName: BQLoginTests

在Bamboo上怎么使用iOS的单元测试 | 京东云技术团队

二 测试代码编写

1 配置文件同步

如果我们要在测试代码使用我们在Pod里的类,需要同步 Targets Support Files/Pods-BQLoginTests/Pods-BQLoginTests.debug.xcconfig 文件的内容到 Targets Support Files/Pods-BQLoginUITests/Pods-BQLoginUITests.debug.xcconfig,直接内容copy就成了,只是每次用iBiu安装过后都要做这个操作,后续使用脚本实现同步:

在Bamboo上怎么使用iOS的单元测试 | 京东云技术团队

2 测试代码编写

具体的编写我这里就过多介绍了,网上教程一大篇,这里就不多说了,如果没有做性能测试,这里可以把自动生成的 testPerformanceExample 屏蔽掉。

在Bamboo上怎么使用iOS的单元测试 | 京东云技术团队

三 运行单元测试

用 command+u,或者菜单(product->test)执行,就能获得结果

在Bamboo上怎么使用iOS的单元测试 | 京东云技术团队

结果在这里看:

在Bamboo上怎么使用iOS的单元测试 | 京东云技术团队

完成以上操作,基本的单元测试就OK了

下面我们用命令行来跑下单元测试,首先进入工程目录:

cd BQLoginModule/Example

执行如下命令:

xcodebuild test -UseModernBuildSystem=NO -configuration=Debug -workspace './BQLoginModule.xcworkspace' -scheme "BQLoginModule_Example" -destination 'platform=iOS Simulator,name=iPhone 8,OS=13.2.2' 

请大家注意将 workspace/scheme /模拟器信息 修改为自己工程对应信息,就可以看到结果

四 代码覆盖率

1 单元覆盖率

在XCode打开覆盖率统计,我们只打开我们的库做代码覆盖就成了,Xcode 12.4在如下地方:

在Bamboo上怎么使用iOS的单元测试 | 京东云技术团队

在Pod里面BQLoginModule设置 BuildSettings 查找 "cov" ,把 以下2项都设置为YES;

在Bamboo上怎么使用iOS的单元测试 | 京东云技术团队

然后我们跑下单元测试,就可以看到覆盖率结果了:

在Bamboo上怎么使用iOS的单元测试 | 京东云技术团队

2 Bamboo报告

因为我们需要在Bamboo上汇总覆盖率报告,这里我们使用iBiu的一个高级特性:用 Podfile.custom 文件加载通用cocoapods的外网库来使用,具体见图:

在Bamboo上怎么使用iOS的单元测试 | 京东云技术团队

这里我们引入2个库: OCMock(单元测试必备的Mock库) XcodeCoverage(覆盖率统计的库)

加入这个文件后,需要使用 iBou重新安装下组件

做如下设置:

在Bamboo上怎么使用iOS的单元测试 | 京东云技术团队

在Bamboo上怎么使用iOS的单元测试 | 京东云技术团队

这个命令主要是生成XcodeCoverage的环境依赖 env.sh 我们打开文件看下,文件路径如下

在Bamboo上怎么使用iOS的单元测试 | 京东云技术团队

env.sh内容如下:

在Bamboo上怎么使用iOS的单元测试 | 京东云技术团队

这里 OBJECT_FILE_DIR_normal 和 SRCROOT指向的是我们Example工程,我们是需要对Pods里的BQLoginModule里的代码做单元覆盖,这2个环境变量修改如下:

export OBJECT_FILE_DIR_normal ="/Users/cdwutao3/Library/Developer/Xcode/DerivedData/BQLoginModule-fvrzeicgcswucwfgjqweugauzxia/Build/Intermediates.noindex/Pods.build/Debug-iphonesimulator/BQLoginModule.build/Objects-normal"

export SRCROOT="/Users/cdwutao3/Desktop/ut/BQLoginModule/BQLoginModule/Classes"

然后在Pods/XcodeCoverage目录新建 xmlout目录,并运行命令:

./getcov -x -s -o xmlout 

可以得到如下结果:

在Bamboo上怎么使用iOS的单元测试 | 京东云技术团队

还可以查看哪些代码没被覆盖,和Bamboo结果对齐:

在Bamboo上怎么使用iOS的单元测试 | 京东云技术团队

完成以上步骤,就完成了本地用命令号完成单元测试的所有步骤,下面我们接着来看要在Bamboo上输出报告需要怎么做。

五 Bamboo操作

1 创建应用

这里要确保对应库和依赖的库 ,给 xn_testdev_ci账号开权限

在Bamboo上怎么使用iOS的单元测试 | 京东云技术团队

2 新建流水线

选择 “从零开始创建”

在Bamboo上怎么使用iOS的单元测试 | 京东云技术团队

3 配置流水线

基础信息里面的选择如下

在Bamboo上怎么使用iOS的单元测试 | 京东云技术团队

在Bamboo上怎么使用iOS的单元测试 | 京东云技术团队

需要用到以下四个原子:

“下载代码”--大家可先配置使用“下载代码-iBiu”这个原子,我用这个一直使用不成功,所以直接用“下载代码”来手动配置:

在Bamboo上怎么使用iOS的单元测试 | 京东云技术团队

在Bamboo上怎么使用iOS的单元测试 | 京东云技术团队

“自定义脚本”--因为现在iOS的单元测试还没有对应的原子操作,所有我们通过自己写脚本来完成:

在Bamboo上怎么使用iOS的单元测试 | 京东云技术团队

“单元测试”--你没看错,就是用java的单元测试原子,我们输出的结果和这个原子匹配,所以选他就成了

在Bamboo上怎么使用iOS的单元测试 | 京东云技术团队

在Bamboo上怎么使用iOS的单元测试 | 京东云技术团队

“GCC代码覆盖率”

在Bamboo上怎么使用iOS的单元测试 | 京东云技术团队

在Bamboo上怎么使用iOS的单元测试 | 京东云技术团队

其中“单元测试”和“代码覆盖率”的路径是可以修改的,这个可以根据自己的实际路径修改

4 自定义脚本

说明:

1 下载代码和配置iBiu都是自己的命令行来做的,但是需要开始配置下git用户信息

2 开始我用命令行写全部命令,但是Bamboo的命令行规则会导致一些的shell指令的失效,所以我采用把 shell命令 写到文件上传到git仓库,然后执行的方式来完成

3 结果转换会还会用到 ocunit2junit 和 xcpretty 这2个命令,如果这2个命令出错,请联系Bamboo同事协助安装下

4 大家在写shell命令时,不知道文件是否生成,可以多用 ls 来看目录下的文件

5 重点:

  • 为了手动安装iBiu配置,请将本机 ~/Library/Application Support/iBiu/BQLoginModule/下的2个文件 spec_sources 和 pod_setup 上传到git,我是copy到 Example/BQLoginModule/Resource目录下然后上传到git仓库,这个目录可以修改,然后修改对应shell 命令的目录就成了
  • iBiu建的git仓库默认会过滤一些内容,修改 BQLoginModule 工程目录下的 .gitignore 文件,需要上传xcworkspacedata内容

在Bamboo上怎么使用iOS的单元测试 | 京东云技术团队

  • 代码覆盖率设置,XcodeCoverage的说明强调了不要用于AppStore的工程,为了避免线上事故,我们通过命令来设置,不直接在工程里设置:

在Bamboo上怎么使用iOS的单元测试 | 京东云技术团队

所以修改xcode的构建命令新加 GCC_INSTRUMENT_PROGRAM_FLOW_ARCS=YES GCC_GENERATE_TEST_COVERAGE_FILES=YES,命令如下:

xcodebuild -UseModernBuildSystem=NO -enableCodeCoverage=YES -configuration=Debug GCC_INSTRUMENT_PROGRAM_FLOW_ARCS=YES GCC_GENERATE_TEST_COVERAGE_FILES=YES -workspace "./${moduleName}.xcworkspace" -scheme "${moduleName}_Example" -destination 'platform=iOS Simulator,name=iPhone 8,OS=13.2.2' test

5 Bamboo结果

在Bamboo上怎么使用iOS的单元测试 | 京东云技术团队

覆盖率下载地址:

在Bamboo上怎么使用iOS的单元测试 | 京东云技术团队

六 脚本汇集

1 本地脚本

以BQLoginModule为例,最终本地脚本命令如下,大家可以重新找到本地目录执行查看效果:

git clone --depth=1 https://git.jd.com/BQMobileshop/BQLoginModule.git
cd BQLoginModule/Example
pod update


pwd
moduleName="BQLoginModule"
testName="BQLoginTests"


biu -pod install ./
ls
ls ./Pods
rm -f "./Pods/Target Support Files/Pods-${testName}/Pods-${testName}.debug.xcconfig"
cp -f "./Pods/Target Support Files/Pods-${moduleName}_Example/Pods-${moduleName}_Example.debug.xcconfig"  "./Pods/Target Support Files/Pods-${testName}/Pods-${testName}.debug.xcconfig"
cat "./Pods/Target Support Files/Pods-${testName}/Pods-${testName}.debug.xcconfig"


xcodebuild clean -workspace "./${moduleName}.xcworkspace" -scheme "${moduleName}_Example"


xcodebuild  -UseModernBuildSystem=NO -enableCodeCoverage=YES -configuration=Debug GCC_INSTRUMENT_PROGRAM_FLOW_ARCS=YES GCC_GENERATE_TEST_COVERAGE_FILES=YES -workspace "./${moduleName}.xcworkspace" -scheme "${moduleName}_Example" -destination 'platform=iOS Simulator,name=iPhone 8,OS=13.2.2'  test  > utlogfile.txt
cat utlogfile.txt |grep ".xcresult" > utlogpath.txt
logStr=$(cat ./utlogpath.txt)
logPath=${logStr:1}
if [ -z "$logPath" ]; then
    exit 1
fi


sed "s/${moduleName}.build\/Debug-iphonesimulator\/${moduleName}_Example.build/Pods.build\/Debug-iphonesimulator\/${moduleName}.build/g" ./Pods/XcodeCoverage/env.sh> cov_env1.txt
sed "s/${moduleName}\/Example/${moduleName}\/${moduleName}\/Classes/g" ./cov_env1.txt > cov_env2.txt
cp -f ./Pods/XcodeCoverage/env.sh ./Pods/XcodeCoverage/env_bak.sh
rm -f ./Pods/XcodeCoverage/env.sh
cp ./cov_env2.txt ./Pods/XcodeCoverage/env.sh


cat "./utlogfile.txt"|ocunit2junit
ls test-reports


cp ./cov_env2.txt ./Pods/XcodeCoverage/env.sh
mkdir xmlout
./Pods/XcodeCoverage/getcov -x -o xmlout
ls ./xmlout/lcov


cat "./utlogfile.txt"|xcpretty -t -r html --output testresult/testresult.html
ls te

2 Bamboo脚本

Bamboo脚本分成2部分,一个是在Bamboo上执行的脚本

rm -fr "/Users/admin/Library/Application Support/iBiu/BQLoginModule"
mkdir "/Users/admin/Library/Application Support/iBiu/BQLoginModule"
rm -fr ./BQLoginModule
git clone --depth=1 https://git.jd.com/BQMobileshop/BQLoginModule.git
cd BQLoginModule/Example
cp "./BQLoginModule/Resource/spec_sources" "/Users/admin/Library/Application Support/iBiu/BQLoginModule"
cp "./BQLoginModule/Resource/pod_setup" "/Users/admin/Library/Application Support/iBiu/BQLoginModule"
ls "/Users/admin/Library/Application Support/iBiu/BQLoginModule"
biu -pod install ./


sh UT.sh

脚本剩下部分写入 UT.sh,放在BQLoginModule/Example目录下, 然后上传到git仓库来执行,大家做的时候注意修改变量名称:

pwd
moduleName="BQLoginModule"
testName="BQLoginTests"


ls ./Pods
rm -f "./Pods/Target Support Files/Pods-${testName}/Pods-${testName}.debug.xcconfig"
cp -f "./Pods/Target Support Files/Pods-${moduleName}_Example/Pods-${moduleName}_Example.debug.xcconfig"  "./Pods/Target Support Files/Pods-${testName}/Pods-${testName}.debug.xcconfig"
cat "./Pods/Target Support Files/Pods-${testName}/Pods-${testName}.debug.xcconfig"


xcodebuild clean -workspace "./${moduleName}.xcworkspace" -scheme "${moduleName}_Example"


xcodebuild  -UseModernBuildSystem=NO -enableCodeCoverage=YES -configuration=Debug GCC_INSTRUMENT_PROGRAM_FLOW_ARCS=YES GCC_GENERATE_TEST_COVERAGE_FILES=YES -workspace "./${moduleName}.xcworkspace" -scheme "${moduleName}_Example" -destination 'platform=iOS Simulator,name=iPhone 8,OS=13.2.2'  test  > utlogfile.txt
cat utlogfile.txt |grep ".xcresult" > utlogpath.txt
logStr=$(cat ./utlogpath.txt)
logPath=${logStr:1}
if [ -z "$logPath" ]; then
    exit 1
fi


sed "s/${moduleName}.build\/Debug-iphonesimulator\/${moduleName}_Example.build/Pods.build\/Debug-iphonesimulator\/${moduleName}.build/g" ./Pods/XcodeCoverage/env.sh> cov_env1.txt
sed "s/${moduleName}\/Example/${moduleName}\/${moduleName}\/Classes/g" ./cov_env1.txt > cov_env2.txt
cp -f ./Pods/XcodeCoverage/env.sh ./Pods/XcodeCoverage/env_bak.sh
rm -f ./Pods/XcodeCoverage/env.sh
cp ./cov_env2.txt ./Pods/XcodeCoverage/env.sh


cat "./utlogfile.txt"|ocunit2junit
ls test-reports


cp ./cov_env2.txt ./Pods/XcodeCoverage/env.sh
mkdir xmlout
./Pods/XcodeCoverage/getcov -x -o xmlout
ls ./xmlout/lcov


cat "./utlogfile.txt"|xcpretty -t -r html --output testresult/testresult.html
ls test

七 错误速查

这里汇集了在写脚本时的一些错误,方便大家查看

1 不能在测试工程引用自己的代码

请参看 二--1 ”配置文件同步“ 解决

2 在Bamboo上的Pods文件夹,没有拉到iBiu的其他配置信息

请参看 五--4 ”自定义脚本“的重点 1 来解决

3 “No coverage data in result bundle”

请参看 五--4 ”自定义脚本”的重点 2 来解决

4 使用命令行跑单元测试时,一直提示不能找到模拟器

-destination 'platform=iOS Simulator,name=iPhone 8,OS=13.2.2' 改为 -destination 'id=xxxxxxxxxx' 这种格式,id为屏幕提示

5 Bamboo Shell里提示 “未设置原子执行条件”

因为Bamboo的Shell对字符拼接,变量的处理有限制,所以一部分shell命令最好放在文件执行

6 在本地测试时,Pods/XXXXModule的设置项在每次iBiu安装后都会重置

请注意手动修改,或者直接使用脚本运行

7 在本地测试时,代码覆盖率只包含了一部分源码文件,不是全部

请清空 ~/Library/Developer/Xcode/DerivedData 目录再测试一次

8 在Bamboo上发现有些库拉不下来

请确保 对应 库给xn_testdev_ci开了权限

9 覆盖率文件生成不了

请确保XXXTests的版本信息和主工程的XXXXModule_Example的版本信息一致

点赞
收藏
评论区
推荐文章
Wesley13 Wesley13
2年前
PPDB:今晚老齐直播
【今晚老齐直播】今晚(本周三晚)20:0021:00小白开始“用”飞桨(https://www.oschina.net/action/visit/ad?id1185)由PPDE(飞桨(https://www.oschina.net/action/visit/ad?id1185)开发者专家计划)成员老齐,为深度学习小白指点迷津。
云原生引擎单元测试实践
快速迭代的开发工作中如何提高代码质量一直是团队痛点,特别是没有测试支持的开发团队。合理的使用单元测试,并关注单元测试通过率、代码覆盖率可以有效提高代码质量。今天就来讲讲云原生引擎单元测试实践。
Wesley13 Wesley13
2年前
VBox 启动虚拟机失败
在Vbox(5.0.8版本)启动Ubuntu的虚拟机时,遇到错误信息:NtCreateFile(\\Device\\VBoxDrvStub)failed:0xc000000034STATUS\_OBJECT\_NAME\_NOT\_FOUND(0retries) (rc101)Makesurethekern
Wesley13 Wesley13
2年前
FLV文件格式
1.        FLV文件对齐方式FLV文件以大端对齐方式存放多字节整型。如存放数字无符号16位的数字300(0x012C),那么在FLV文件中存放的顺序是:|0x01|0x2C|。如果是无符号32位数字300(0x0000012C),那么在FLV文件中的存放顺序是:|0x00|0x00|0x00|0x01|0x2C。2.  
Wesley13 Wesley13
2年前
mysql设置时区
mysql设置时区mysql\_query("SETtime\_zone'8:00'")ordie('时区设置失败,请联系管理员!');中国在东8区所以加8方法二:selectcount(user\_id)asdevice,CONVERT\_TZ(FROM\_UNIXTIME(reg\_time),'08:00','0
Stella981 Stella981
2年前
Jmeter+Ant+Jenkins接口自动化测试框架搭建for Windows
前言软件开发的V模型大家都不陌生,其中测试阶段分为单元测试→功能测试→系统测试→验收测试。其中单元测试一般由开发同学们自己完成,大部分测试具体实施(这里不包括用例设计)是从单体功能测试开始着手的。!(https://usergoldcdn.xitu.io/2018/11/12/16706895ac09c25d?imageView2/0/
Wesley13 Wesley13
2年前
PHP创建多级树型结构
<!lang:php<?php$areaarray(array('id'1,'pid'0,'name''中国'),array('id'5,'pid'0,'name''美国'),array('id'2,'pid'1,'name''吉林'),array('id'4,'pid'2,'n
Stella981 Stella981
2年前
SpringBoot(20)
  我们在写单元测试的时候,除了接口直接抛异常而导致该单元测试失败外,还有种是业务上的错误也代表着该单元测试失败。好比我们在测试接口的时候,  该接口返回是1代表成功,如果是0那就代表是失败的,这个时候可以考虑使用断言。  一、原理我们知道,我们可以通过断言来校验测试用例的返回值和实际期望值进行比较,以此来判断测试是否通过。那我们先来看下如果失败的情
Wesley13 Wesley13
2年前
MySQL部分从库上面因为大量的临时表tmp_table造成慢查询
背景描述Time:20190124T00:08:14.70572408:00User@Host:@Id:Schema:sentrymetaLast_errno:0Killed:0Query_time:0.315758Lock_
Python进阶者 Python进阶者
4个月前
Excel中这日期老是出来00:00:00,怎么用Pandas把这个去除
大家好,我是皮皮。一、前言前几天在Python白银交流群【上海新年人】问了一个Pandas数据筛选的问题。问题如下:这日期老是出来00:00:00,怎么把这个去除。二、实现过程后来【论草莓如何成为冻干莓】给了一个思路和代码如下:pd.toexcel之前把这