本文主要介绍对于 NoSmoke 遍历 Android App 使用过程中的一些记录,通过源码打断点的方式及查看截图效果简单确定一些 NoSmoke 的内部机制,其中若有理解错误或不当之处还请多多指教。本文未多介绍环境搭建,环境搭建有需要再补。
Macaca+NoSmoke+Android 手机 +Mac10.13.1
主要参考文档:
NoSmoke 其实是提供了一套遍历流程,Macaca 作为服务端,NoSmoke 作为客户端 去对手机进行一个遍历操作。
主要分以下步骤:
首先来简单介绍一下 NoSmoke 的遍历结果页面,在图上简单的进行了一下标注,对于标注相关说明会在下面详细介绍
NoSmoke 在遍历过程中核心步骤主要如下:
在上面的效果图中提到了 Digest,Digest 就相当于一个页面的唯一标识,即在自动化遍历页面时如何确定两个页面时相同的控件结构。
在 NoSmoke 的代码中NoSmoke/lib/crawler/models.js
函数NSAppCrawlingTreeNode.prototype.checkDigest
里提供了判断 Digest 的方法,核心代码如下:
this.digest = '' + (source.value.match(/node/g) || []).length +
(source.value.match(/Android/g) || []).length +
(source.value.match(/TextView/g) || []).length +
(source.value.match(/EditText/g) || []).length +
(source.value.match(/Layout/g) || []).length +
(source.value.match(/Button/g) || []).length;
从代码中可以看到每个页面根据 Macaca 返回的控件树的 value 值,匹配一定节点,拼接而成的 Digest。因此我们看到的 Digest 是一串数字。图片上的 View 值就是唯一 ID。
对于这个 Digest,从页面效果来看它的区分程度准确率并不是特别的好,上面的图和下面的图区分来看是一样的页面,但是它们的 Digest 是不一样的。图片没有截全,下面的 Digest 是520120411
,上面的图图像上标识是520120421
个人认为页面唯一 ID 的确定本身就是一个有无数种选择的问题,可以说未必能有一种唯一的算法可以确定出所有 APP 的页面 ID,因此 NoSmoke 也提供了 hook,用户可以自己编写自己所确定页面 ID 的代码。
当我们确定好这个页面的唯一 ID 时,页面中我们要去点击哪些控件呢?这就是 Action 集合所做的事情。
每一次请求页面 Source 时,都会返回页面的节点层级,在 NoSmoke 中通过不断的查询子节点,确定了每一个控件的执行路径。此处详细代码在NoSmoke/lib/crawler/crawler.js
文件中的NSCrawler.prototype.recursiveFilter
函数中 以下仅截取部分代码:主要是如果当前节点有子节点,进行递归循环,并生产Xpath
路径
/** 1. filter Current Node Information */
if (source.hasOwnProperty('children')) {
if (Array.isArray(source.children)) {
for (let i = 0; i < source.children.length; i++) {
this.eraseModelDifference(source.children);
this.insertXPath(source, source.children[i]);
let result = this.recursiveFilter(source.children[i], matches, exclusive);
sourceArray = sourceArray.concat(result);
}
} else {
this.eraseModelDifference(source.children);
this.insertXPath(source, source.children);
let result = this.recursiveFilter(source.children, matches, exclusive);
sourceArray = sourceArray.concat(result);
}
}
生产的路径如下:
此处重点概括一下就是:
上图是页面的控件层级图。我们如果转化成模块简单化路径按下图层级为:
a-b-d//这个结果是通过生产的Action和页面的层级路径相比对整理出来的,如有错误还请指出
a-b-e
a-f
a-g
上图里的 c 和 h 路径并没有被录入,用户可以匹配某种控件类型被过滤,如果父元素为被过滤的类型,那么子元素同样不会被选择。
页面元素点击在performAction
函数里,这里的逻辑就比较简单,主要是对于当前即将点击的元素进行类型判断clickTypes
,horizontalScrollTypes
,editTypes
这三种分别为点击、滑动、输入三种类型,那么我们怎么知道过来的一个元素应该点击滑动还是输入呢?
yml 文件配置
horizontalScrollTypes:
- 'android.widget.ImageView'
- 'android.widget.TextView'
- 'android.widget.Button'
clickTypes:
- 'android.widget.Button'
- 'android.widget.TextView'
editTypes:
- 'android.widget.EditText'
当前的元素是图片类型,它被设定为滑动类型,那么久会被滑动,当前图片是按钮,它既可以滑动也可以点击,按照下面代码中的 if else 逻辑会对其进行点击操作.
if (this.config.clickTypes.indexOf(action.source.type) >= 0) {
/** 1. handle click actions */
return new Promise((resolve, reject) => {
root.wdclient.send('/wd/hub/session/' + this.sessionId + '/element/' + action.data.value.ELEMENT + '/click', 'post', {}, () => {
this.refreshScreen();
resolve();
});
});
} else if (this.config.horizontalScrollTypes.indexOf(action.source.type) >= 0) {
/** 2. handle horizontal scroll actions */
return new Promise((resolve, reject) => {
root.wdclient.send('/wd/hub/session/' + this.sessionId + '/actions', 'post', {'actions': [{'type': 'drag', 'fromX': 600, 'fromY': 200, 'toX': 10, 'toY': 200, 'duration': 2}]},//这里滑动的坐标被我更改了
() => {
this.refreshScreen();
resolve();
});
});
} else if (this.config.editTypes.indexOf(action.source.type) >= 0) {
/** 3. handle edit actions */
return new Promise((resolve, reject) => {
root.wdclient
.send('/wd/hub/session/' + this.sessionId + '/element/' + action.data.value.ELEMENT + '/value', 'post', {
'value': [action.input]
}, () => {
this.refreshScreen();
resolve();
});
});
}
整个页面的遍历会在什么时候循环结束呢?
// Terminate under the following cases:
// 1. the previous node has been finished for continuously count of 8, assume crawling finish
// 2. the crawling process takes too long and hence expire
if (this.repeatingCrawlingCount >= maxRepeatCrawlingCount || this.crawlingExpires) {
this.terminate('terminate due to timeout');
return;
}
以上是我在通过打断点和页面效果观察过程中的一点记录,下面是官方公布的原理图,在上面做了小标志。官方高清大图请走链接
以上就是在 NoSmoke 调研过程中的一点个人记录,主要从四个方面结合源码和执行效果进行了简单分析,如有错误或者疏漏之处还请指出。
NoSmoke 本身提供了很强的 hook 配置,及用户可以自己定义一系列的 Action,最后的页面展示页特别赞,本次调研未调研 iOS 相关,因为 WDA 好像……又出问题了……