calabash-android Windows 安装部署与测试

安装配置

1. 安装 JDK

https://www.oracle.com/java/technologies/javase-downloads.html

配置环境变量：JAVA_HOME

2. 安装 AndroidSDK

配置环境变量：ANDROID_HOME

3. 安装 ant

https://ant.apache.org/bindownload.cgi，配置环境变量：ANT_HOME

4. 安装 ruby+Devkit

https://rubyinstaller.org/downloads/

5. 安装 calabash-android

a) 更换源(可选，官网源被墙，目前淘宝源已不可用)

# 移除原有源，并添加 ruby-china 源
gem sources --add https://gems.ruby-china.com/ --remove https://rubygems.org/
# 查看当前源
gem sources -l

b) 安装 calabash-android

gem install calabash-android
# 或者安装指定版本
gem install calabash-android -v 0.9.5
# 如需要卸载历史版本
gem uninstall calabash-android -v 0.9.5
# 查看当前安装版本
calabash-android version

运行测试

1. demo 测试

a) 下载一个测试 demo

(https://github.com/calabash/calabash-android-demoapp 已不可用，可以下载 https://github.com/bootstraponline/calabash_android_example)

git clone https://github.com/bootstraponline/calabash_android_example.git

calabash-android setup
依次输入文件路径，密钥，别名

c) 生成 test-server 基座 apk 文件

calabash-android build com.github.mobile_1.6.1.apk

d) 重签名

calabash-android resign com.github.mobile_1.6.1.apk

e) 运行测试

先安装基座
adb install test_servers xxx.apk
再运行测试 apk
calabash-android run com.github.mobile_1.6.1.apk

2. 正式测试

calabash-android gen

b) 编写测试脚本

修改工程下 feature 目录下面 .feature 文件, 增加测试用例

c) 准备测试 apk ，放置测试工程目录
d) 生成基座、重签名、运行测试(同上)

问题排错与解决方案

in fingerprint_from_apk': No signature files found in META-INF. Cannot proceed. (RuntimeError)

获取签名失败，排查是新版本 Windows 兼容性问题，网上有的说需要降版本，但实际操作可能有各种坑，这里推荐一种修改源码的办法：
报错显示helpers.rb中的 fingerprint_from_apk 方法获取签名失败，一个原因时解压 apk 时解压失败或者丢失了签名文件
找到 calabash-android 的 helpers.rb所在目录(命令行错误信息有打印全路径)，如 Ruby25-x64\lib\ruby\gems\2.5.0\gems\calabash-android-0.9.12\lib\calabash-android\helpers.rb
原解压代码片段：

Calabash::Utils.with_silent_zip do
  Zip::File.foreach("app.apk") do |z|
    $logger.debug("foreach #{z.name}")
    z.extract if /^META-INF\/\w+\.(rsa|dsa)$/i =~ z.name
  end
end

修改为:

Zip::File.open("app.apk") do |z|
  z.each do |f|
    if f.name.downcase.include? ".rsa"
      ppath = f.name[0, f.name.rindex("/")]
      FileUtils.mkdir_p(ppath)
      newfname = File.join(tmp_dir, f.name)
      z.extract(f, newfname) unless File.exist?(newfname)
    end
  end
end

重签名时获取的 keytool 路径可能缺失盘符导致签名失败，如我的 JDK 安装在 D:\Program\Java\jdk1.8.0_221, 获取的路径为: \Program\Java\jdk1.8.0_221\bin/keytool.exe

错误原因，获取 JDK 环境变量路径时对 Path 环境变量的分割去掉了盘符，详见:\Ruby25-x64\lib\ruby\gems\2.5.0\gems\calabash-android-0.9.12\lib\calabash-android\dependencies.rb中的 path_elements 初始化代码片段:

def self.path_elements
  return [] unless ENV['PATH']
  ENV['PATH'].split (/[:;]/)
end

修改为:

def self.path_elements
    return [] unless ENV['PATH']
    # ENV['PATH'].split (/[:;]/)
    if is_windows?
        ENV['PATH'].split (/[;]/)
    else
        ENV['PATH'].split (/[:;]/)
    end
end

另如果系统 Path 环境变量中有多个路径包含 java.exe 的情况，请确保实际配置的 JDK 环境变量最靠前。如有些机器上可能多出一个C:\Program Files (x86)\Common Files\Oracle\Java\javapath路径，这里面是不包含keytool.exe, 也会导致签名失败的问题

cannot load such file -- retriable

# 安装缺失文件
gem install retriable

android.util.AndroidException: INSTRUMENTATION_FAILED

测试基座与测试应用不匹配或者签名不对，参考：https://stackoverflow.com/questions/14269687/android-util-androidexception-instrumentation-failed

以刚刚的 demo 为例：

# 查询安装的应用
adb shell
pm list packages | grep com.github

# 查询结果需要包含以下两条记录
package:com.github.mobile.test
package:com.github.mobile

adb shell
pm list instrumentation
# 查询所有测试包
instrumentation:com.github.mobile.test/sh.calaba.instrumentationbackend.GetPreferences (target=com.github.mobile)
instrumentation:com.github.mobile.test/sh.calaba.instrumentationbackend.ClearPreferences (target=com.github.mobile)
instrumentation:com.github.mobile.test/sh.calaba.instrumentationbackend.CalabashInstrumentationTestRunner (target=com.github.mobile)
instrumentation:com.github.mobile.test/sh.calaba.instrumentationbackend.ClearAppData (target=com.github.mobile)
instrumentation:com.github.mobile.test/sh.calaba.instrumentationbackend.SetPreferences (target=com.github.mobile)
instrumentation:com.github.mobile.test/sh.calaba.instrumentationbackend.ClearAppData2 (target=com.github.mobile)