Appium UiAutomator2驱动:通用能力集介绍

Appium服务端会提供的一系列能力集合,Appium客户端通过构造键值对集合并发送给Appium服务端,以此来告诉服务器需要提供什么样的能力(例如建立与何种设备的通信,是Android还是ios设备、建链的超时时间等),也可以在运行过程中对服务端的行为进行修改。

Appium提供的能力跟Driver相关,不同的Driver对应不同的测试对象,提供的能力以及所需要传入的参数都不一样,本文描述的是UiAutomator2 Driver提供的能力集合,它提供对Android设备的自动化测试支持。按照官方文档的定义,分为通用能力、Driver/Server能力等方面,本文介绍UiAutomator2提供的通用能力集。

本文所有测试代码的前提是已经安装Appium和相关环境(例如JDKAndroid SKD),可以参考Appium环境搭建

本文所使用的相关软件及版本如下:

软件名称 软件版本
Linux操作系统 Ubuntu 22.04
JDK 20.0.1
Android SDK 33
node.js 18.17
npm 9.6.7
Appium Server 2.0.1
Appium Client 2.11.1
AVD(模拟器) /
Python 3.10.6

通用能力

1、通用能力描述
能力名称 具体描述
platformName 必选,表明被测设备的平台,其值必须为"android",Appium服务端不会区分大小写。
appium:automationName 必选,表明使用的Driver名称。其值必须为"uiautomator2",Appium服务端不会区分大小写。
appium:deviceName 非必选,表明被测设备的名称。实际上该值不会作为选择被测设备的依据。建议:如果是真实设备,该参数填"udid";如果是模拟设备,该参数填"avd"。
appium:platformVersion 非必选,表明被测设备的平台版本。如果udid参数没有提供的话,该参数会自动检测。
appium:udid 非必选,表明被测设备的UDID,可以通过adb devices -l命令获取。如果未提供该参数,那么Appium服务端会默认选择第一个连上的设备。因此如果需要在一台机器上测试多个设备,该参数需要按照实际被测设备填写。
appium:noReset 非必选,该值如果设置为"true",建立会前不重置测设备(被测应用不会被结束,被测应用的数据也不会被清除),实际上,。该值默认是"false"。
appium:fullReset 非必选,用于卸载被测应用。该值如果设置为"true",在启动新的会话之前,会强制卸载被测应用。该值默认是"false"。
appium:printPageSourceOnFindFailure 非必选,设置为"true"时,当发生错误会强制记录实际的XML页面源码到日志中。该值默认是"false"
2 、通用能力解读

运行测试脚本前,请打开模拟器或者连接真机器

  • 建立会话连接

    从前面分析可以知道,要建立客户端与服务端的会话,至少需要提供两个参数:platformNameappium:automationName 。其中任何一个未提供,建立会话时都会返回错误,有两种方法可以指定所需要的能力集,一种是使用将能力使用字典键值对的方式传入,另外一种是使用UiAutomator2Options类来创建并指定添加能力。第一种方式目前已经不推荐,后续也会被废弃,建议采用第二种方式。

方法1:

# -*- coding: utf-8 -*-

import pytest

from appium import webdriver
from appium.options.android import UiAutomator2Options
from appium.webdriver.appium_service import AppiumService

# 开启服务端
APPIUM_HOST = '127.0.0.1'
APPIUM_PORT = 4723
@pytest.fixture(scope="session")
def start_appium_service():
    server = AppiumService()
    server.start(args=['--address', APPIUM_HOST, '-p', str(APPIUM_PORT)], timeout_ms=60000)
    yield server
    server.stop()

# !使用原始的字典键值对创建能力---该方法会被废弃
def create_appium_session_by_dict(custom_opts:dict):
    return webdriver.Remote(f'http://{APPIUM_HOST}:{APPIUM_PORT}', custom_opts)

# 客户端创建会话连接所需要的最少参数
def test_general_capability_of_min_args(start_appium_service):
    min_opts = {
        "appium:automationName":"uiautomator2",
        "platformName": "android"
    }
    driver = create_appium_session_by_dict(min_opts)
    driver.quit()

方法2(推荐):UiAutomator2Options会默认创建platformName 和appium:automationName两个参数,因此无需传入其他参数也可以建立会话

# -*- coding: utf-8 -*-

import pytest

from appium import webdriver
from appium.options.android import UiAutomator2Options
from appium.webdriver.appium_service import AppiumService

# 开启服务端
APPIUM_HOST = '127.0.0.1'
APPIUM_PORT = 4723
@pytest.fixture(scope="session")
def start_appium_service():
    server = AppiumService()
    server.start(args=['--address', APPIUM_HOST, '-p', str(APPIUM_PORT)], timeout_ms=60000)
    yield server
    server.stop()

# 创建客户端到服务端的会话
# !使用API接口UiAutomator2Options创建能力---推荐
def create_appium_session_by_api(custom_opts = None):
    # !UiAutomator2Options默认就已经初始化automationName和platformName两个参数
    options = UiAutomator2Options()
    if custom_opts is not None:
        options.load_capabilities(custom_opts)
    return webdriver.Remote(f'http://{APPIUM_HOST}:{APPIUM_PORT}', options=options)

# 客户端创建会话连接所需要的最少参数
def test_general_capability_of_min_args(start_appium_service):
    driver = create_appium_session_by_api()
    driver.quit()
  • appium:noReset :保持被测应用和数据不被恢复

    该参数可以保持会话过程中打开的应用和数据不被恢复,下面的例子首先使用"appium:noReset": True 建立会话连接,并打开联系人应用。随后关闭该会话,新建一个会话(不打开任何应用),进入之后页面仍保留在联系人应用上。

# -*- coding: utf-8 -*-

import pytest

from appium import webdriver
from appium.options.android import UiAutomator2Options
from appium.webdriver.appium_service import AppiumService

# 开启服务端
APPIUM_HOST = '127.0.0.1'
APPIUM_PORT = 4723
@pytest.fixture(scope="session")
def start_appium_service():
    server = AppiumService()
    server.start(args=['--address', APPIUM_HOST, '-p', str(APPIUM_PORT)], timeout_ms=60000)
    yield server
    server.stop()

def test_open_contact(start_appium_service):
    # 创建一个会话连接,打开联系人应用
    # noReset设置为True,会话退出后不会清零应用
    custom_opts_noreset = {
        "appium:noReset" : True,
        "appPackage": "com.google.android.dialer",
        "appActivity": ".extensions.GoogleDialtactsActivity"
    }
    driver = create_appium_session_by_api(custom_opts_noreset)
    driver.quit() # 模拟会话终止

    # 创建一个新的会话连接,不做具体动作
    driver = create_appium_session_by_api()
    # 由于前一个会话未清理应用,因此该会话连接之后,被测设备仍停留在联系人应用界面
    assert driver.current_activity == ".extensions.GoogleDialtactsActivity"
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,163评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,301评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,089评论 0 352
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,093评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,110评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,079评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,005评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,840评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,278评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,497评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,667评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,394评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,980评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,628评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,796评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,649评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,548评论 2 352

推荐阅读更多精彩内容