Appium UiAutomator2驱动：Settings A

一、什么是Settings API

Appium的UiAutomator2驱动支持各种能力参数，在创建客户端和服务端会话的时候，以键值对的方式进行协商。当会话建立之后，如何对这些能力参数进行调整呢？

针对上述场景的需要，Appium引入了一系列的扩展API接口，允许在会话建立后，在执行过程中对参数（能力）进行调整。这些API接口统称为Settings API，被改动的参数称为Settings。

Settings有三个重点的概念：

• Settings是可变的，会话期间可以通过Settings API接口进行更改；

• Settings只跟会话期间设置的内容相关，通常新的会话需要重新设置，但是借助某些驱动，一些设置可以在会话之间保持；

• Settings只是调整测试期间Appium服务端的行为，而不涉及被测设备和被测应用（APP）。

二、Python客户端如何使用Settings API

有2种方式来使用Settings：1）建立会话时通过能力参数传入；2）会话执行过程中通过专门的接口进行修改。备注：本文所有测试代码的前提是已经安装Appium和相关环境（例如JDK、Android SDK、AVD模拟器），可以参考Appium环境搭建。

2.1 建立会话时通过能力参数传入

键值对的方式为"appium:settings[<name>]":"<value>"，其中<name>是Settings的名称，<value>是待设置的值。以actionAcknowledgmentTimeout参数为例，它表示等待一个动作执行确认的超时时间，例如模拟按钮的点击操作，操作完成后结果通知到客户端的超时时间。该参数的默认值是3秒，示例如下：

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_api(custom_opts = None, appium_host = APPIUM_HOST, appium_port = APPIUM_PORT):
 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_set_settings_in_capabilities(start_appium_service):
 custom_opts = {
 "appium:settings[actionAcknowledgmentTimeout]": 4321,
 "appium:avd": "testPhone",
 }

 driver = create_appium_session_by_api(custom_opts)
 settings = driver.get_settings()

 assert settings["actionAcknowledgmentTimeout"] == 4321

2.2 会话执行过程中通过接口更改

执行过程中更改需要使用客户端webdriver提供的接口，本文使用的是Python，具体的修改接口是update_settings，获取所有参数的接口是get_settings，示例如下：

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_api(custom_opts = None, appium_host = APPIUM_HOST, appium_port = APPIUM_PORT):
 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_set_settings(start_appium_service):
 custom_opts = {
 "appium:avd": "testPhone",
 }

 driver = create_appium_session_by_api(custom_opts)

 settings = driver.get_settings()
 assert settings["actionAcknowledgmentTimeout"] == 3000

 modify_args = {
 "actionAcknowledgmentTimeout": 4321,
 }
 driver.update_settings(modify_args)

 settings = driver.get_settings()
 assert settings["actionAcknowledgmentTimeout"] == 4321

三、Settings参数详解

目前UiAutomator2支持的Settings参数具体描述如下，可以参考官方文档。

附录

1. 官方文档参考
2. 本文原始路径