Appium 客户端类库

Appium 支持以下语言的客户端类库:

语言
Ruby
Python
Java
JavaScript
PHP
C#
Objective-C

锁定注意,一些方法类似 endTestCoverage() 目前并不能完全支持。当这个问题被解决后,覆盖率支持才会被添加。如果你仍然想使用这些方法,请参考 GitHub 上关于 bindings 的文档。

锁定屏幕。

# ruby
lock 5
# python
driver.lock(5)
// java
driver.lockScreen(3);
// javascript
driver.lock(3)
// php
$this->lock(3);
// c#
driver.LockDevice(3);
// objective c
[driver lockDeviceScreen:3];

将应用切换至后台

将当前的应用切换到后台,然后可以让其在指定时间内回到前台,或者让它一直留在后台。

传递给这个方法的参数有两种类型:

  1. 一个整型(秒):表示后台状态维持多久。-1 表示持续置于后台。这种风格的参数已经被废弃。
  2. 一个看起来像 {"timeout": secs} 的对象。里面的 secs 是含义和第一个类型一样的整型数字(即表示置于后台多少秒),或者为 null (表示持续置于后台)。
# ruby
background_app 5  # 置于后台,持续5秒
background_app -1  # 持续置于后台
# python
driver.background_app(5)  # 置于后台,持续5秒
driver.background_app(-1) # 持续置于后台
driver.background_app({‘timeout‘: None}) # 持续置于后台
// java
driver.runAppInBackground(5);  // 置于后台,持续5秒
driver.runAppInBackground(-1);  // 持续置于后台
// javascript
driver.backgroundApp(5);  // 置于后台,持续5秒
driver.backgroundApp(-1); // 持续置于后台
driver.backgroundApp({timeout: null}); // 持续置于后台
// php
$this->backgroundApp(5);
$this->backgroundApp(-1);
// c#
driver.BackgroundApp(5);
driver.BackgroundApp(-1);
// objective c
[driver runAppInBackground:3];
[driver runAppInBackground:-1];

收起键盘

收起键盘。 注意: 在 iOS,这辅助功能并不能保证一定有效。因为没有用于隐藏键盘的自动化钩子方法(译者注:可以理解为 iOS 没有提供隐藏键盘的 API),而且应用是允许用户去使用各种策略去收起键盘的,无论是点击键盘以外的区域,还是向下滑动诸如此类...相比于使用该方法,我们更加鼓励你去思考 用户 在应用中是如何收起键盘(如滑动,点击一个固定的坐标,等等...),并让 Appium 去执行这些方法,而不是调用这个 API 。话虽如此,但这里默认的行为还是可能帮助到你的。

# ruby
hide_keyboard
# python
driver.hide_keyboard()
// java
driver.hideKeyboard();
// javascript
driver.hideKeyboard()
// php
$this->hideKeyboard();
$this->hideKeyboard(array(‘strategy‘ => ‘pressKey‘, ‘key‘ => ‘Done‘));
// c#
driver.HideKeyboard("Done");
// objective c
[driver hideKeyboard];

启动 Activity

在当前 app 打开一个 activity,或者新打开一个应用并启动一个 acticity, 仅支持 Android

// java
driver.startActivity("appPackage","com.example.android.apis", null, null);
// javascript
driver.startActivity({appPackage: ‘com.example.android.apis‘, appActivity: ‘.Foo‘}, cb);
# python
driver.start_activity(‘com.example.android.apis‘, ‘.Foo‘)
# ruby
start_activity app_package: ‘io.appium.android.apis‘, app_activity: ‘.accessibility.AccessibilityNodeProviderActivity‘
// c#
driver.StartActivity("com.example.android.apis", ".Foo");
// php
$this->startActivity(array("appPackage" => "com.example.android.apis",
                            "appActivity" => ".Foo"));
// objective c
[driver startActivity:@"com.example.android.apis" package:@".Foo"];

打开通知栏

打开通知栏,仅支持 Android

// java
driver.openNotifications();
// javascript
driver.openNotifications(cb);
# python
driver.open_notifications()
# ruby
open_notifications
// c#
driver.OpenNotifications();
// php
$this->openNotifications();
// objective c
[driver openNotifications];

应用是否已安装

检测应用是否已被安装。

# ruby
is_installed? "com.example.android.apis"
# python
driver.is_app_installed(‘com.example.android.apis‘)
// java
driver.isAppInstalled("com.example.android.apis")
// javascript
driver.isAppInstalled("com.example.android.apis")
  .then(function (isAppInstalled) { /*...*/ })
// php
$this->isAppInstalled(‘com.example.android.apis‘);
// c#
driver.IsAppInstalled("com.example.android.apis-");
// objective c
[driver isAppInstalled:@"com.example.android.apis-"];

安装应用

在设备上安装应用。

# ruby
install ‘path/to/my.apk‘
# python
driver.install_app(‘path/to/my.apk‘)
// java
driver.installApp("path/to/my.apk")
// javascript
driver.installApp("path/to/my.apk")
// php
$this->installApp(‘path/to/my.apk‘);
// c#
driver.InstallApp("path/to/my.apk");
// objective c
[driver installAppAtPath:@"path/to/my.apk"];

卸载应用

卸载设备上的应用。

# ruby
remove ‘com.example.android.apis‘
# python
driver.remove_app(‘com.example.android.apis‘)
// java
driver.removeApp("com.example.android.apis")
// javascript
driver.removeApp("com.example.android.apis")
// php
$this->removeApp(‘com.example.android.apis‘);
// c#
driver.RemoveApp("com.example.android.apis");
// objective c
[driver removeApp:@"com.example.android.apis"];

摇一摇

模拟摇晃设备的操作。

# ruby
shake
# python
driver.shake()
// java
driver.shake()
// javascript
driver.shake()
// php
$this->shake();
// c#
driver.ShakeDevice();
// objective c
[driver shakeDevice];

关闭应用

关闭应用。

# ruby
close_app
# python
driver.close_app();
// java
driver.closeApp()
// javascript
driver.closeApp()
// php
$this->closeApp();
// c#
driver.CloseApp();
// objective c
[driver closeApp];

启动(Launch)

为 desired capabilities 启动一个 session。请注意只有设置了 autoLaunch=false 关键字时才会生效。这不是为了随意启动一个应用或 activities ——如果你想这么做,请使用 start_activity 这个 desired capability 的参数。这个方法的使用场景是在你设置了 autoLaunch=false 后,用来继续执行初始化("launch")流程的。(译者注:举个例子,国产系统经常会在应用安装时弹出提示窗阻碍安装,此时可以通过 autoLaunch=false 来让应用安装后先执行你的脚本来关掉弹窗,然后再用这个函数来继续启动应用。)

# ruby
launch_app
# python
driver.launch_app()
// java
driver.launchApp()
// javascript
driver.launchApp()
// php
$this->launchApp();
// c#
driver.LaunchApp();
// objective c
[driver launchApp];

重置

重置应用。(译者注:类似于清除缓存)

# ruby
driver.reset
# python
driver.reset()
// java
driver.resetApp()
// javascript
driver.resetApp()
// php
$this->reset();
// c#
driver.ResetApp();
// objective c
[driver resetApp];

可用的上下文(Contexts)

列出所有可用的上下文(contexts)。

# ruby
context_array = available_contexts
# python
driver.contexts
// java
driver.getContextHandles()
// javascript
driver.contexts().then(function (contexts) { /*...*/ })
// php
$this->contexts();
// c#
driver.GetContexts()
// objective c
NSArray *contexts = driver.allContexts;

当前上下文(context)

列出当前的上下文(context)。

# ruby
context = current_context
# python
driver.current_context
// java
driver.getContext()
// javascript
driver.currentContext().then(function (context) { /*...*/ })
// php
$this->context();
// c#
driver.GetContext()
// objective c
NSString *context = driver.context;

切换至默认的上下文(context)

切换回默认的上下文(context)。(译者注:一般就是原生上下文 “NATIVE_APP”)

# ruby
switch_to_default_context
# python
driver.switch_to.context(None)
// java
driver.context();
// javascript
driver.context()
// php
$this->context(NULL);
// c#
driver.SetContext();
// objective c
[driver setContext:nil];

应用的字符串

获得应用的字符串。(译者注:这里实际指的是返回应用的多语言文本,即每个 string 变量及在指定语言上的显示内容。例如 {"action_forgot_password":"Forgot your password?"} 。在 android 上对应的是项目中的 strings.xml 多语言配置文件)

# ruby
app_strings
# python
driver.app_strings
// java
driver.getAppStrings();
// javascript
driver.getAppStrings().then(function (appStrings) { /*...*/ })
// php
$this->appStrings();
$this->appStrings(‘ru‘);
// c#
driver.GetAppStrings();
// objective c
[driver appStrings];
[driver appStringsForLanguage:"@ru"];

按键事件

给设备发送按键事件。

# ruby
key_event 176
# python
driver.keyevent(176)
// java
driver.sendKeyEvent(AndroidKeyCode.HOME);
// javascript
driver.deviceKeyEvent(wd.SPECIAL_KEYS.Home)
// php
$this->keyEvent(‘176‘);
// c#
driver.KeyEvent("176");
// objective c
NSError *err;
[driver triggerKeyEvent:176 metastate:0 error:&err];

当前 Activity

获取当前的 Acticity。仅支持 Android。

# ruby
current_activity
# python
driver.current_activity
// java
driver.currentActivity();
// javascript
driver.getCurrentActivity().then(function (activity) { /*...*/ })
// php
$this->currentActivity();
// c#
driver.GetCurrentActivity();
// objective c
NSError *err;
[driver currentActivity];

当前包名(package)

获取当前包名(package)。仅支持 Android 。

# ruby
current_package
# python
driver.current_package
// java
driver.getCurrentPackage();
// javascript
driver.getCurrentPackage().then(function (package) { /*...*/ })
// php
$this->currentPackage();
// c#
driver.GetCurrentPackage();

点击操作 / 多点触控操作

用于生成点击操作的 API。这部分文档的内容将会很快被补充进来。

# ruby
touch_action = Appium::TouchAction.new
element  = find_element :accessibility_id, ‘Buttons, Various uses of UIButton‘
touch_action.press(element: element, x: 10, y: 10).perform
# python
action = TouchAction(driver)
action.press(element=el, x=10, y=10).release().perform()
// java
TouchAction action = new TouchAction(driver)
.press(mapview, 10, 10)
.release().
perform();
// javascript
var action = new wd.TouchAction(driver);
action
  .tap({el: el, x: 10, y: 10})
  .release();
return action.perform(); // returns a promise
// php
$action = $this->initiateTouchAction();
               ->press(array(‘element‘ => $el))
               ->release()
               ->perform();

$action1 = $this->initiateTouchAction();
$action1->press(array(‘element‘ => $els[0]))
        ->moveTo(array(‘x‘ => 10, ‘y‘ => 0))
        ->moveTo(array(‘x‘ => 10, ‘y‘ => -75))
        ->moveTo(array(‘x‘ => 10, ‘y‘ => -600))
        ->release();

$action2 = $this->initiateTouchAction();
$action2->press(array(‘element‘ => $els[1]))
        ->moveTo(array(‘x‘ => 10, ‘y‘ => 10))
        ->moveTo(array(‘x‘ => 10, ‘y‘ => -300))
        ->moveTo(array(‘x‘ => 10, ‘y‘ => -600))
        ->release();

$multiAction = $this->initiateMultiAction();
$multiAction->add($action1);
$multiAction->add($action2);
$multiAction->perform();
// c#
ITouchAction action = new TouchAction(driver);
action.Press(el, 10, 10).Release();
action.Perform ();

滑动屏幕

模拟用户滑动屏幕的操作。

# ruby
swipe start_x: 75, start_y: 500, end_x: 75, end_y: 0, duration: 0.8
# python
driver.swipe(start_x=75, start_y=500, end_x=75, end_y=0, duration=800)
// java
driver.swipe(75, 500, 75, 0, 0.8)
// javascript
function swipe(opts) {
  var action = new wd.TouchAction(this);
  action
    .press({x: opts.startX, y: opts.startY})
    .wait(opts.duration)
    .moveTo({x: opts.endX, y: opts.endY})
    .release();
  return action.perform();
}
wd.addPromiseChainMethod(‘swipe‘, swipe);
// ...
return driver.swipe({ startX: 75, startY: 500,
  endX: 75,  endY: 0, duration: 800 });
// php
$this->swipe(75, 500, 75, 0, 800);
// c#
todo: c#

捏(Pinch)手势

在屏幕上使用捏(Pinch)手势。

# ruby
pinch 75
# python
driver.pinch(element=el)
// java
driver.pinch(element);
// javascript
function pinch(el) {
  return Q.all([
    el.getSize(),
    el.getLocation(),
  ]).then(function(res) {
    var size = res[0];
    var loc = res[1];
    var center = {
      x: loc.x + size.width / 2,
      y: loc.y + size.height / 2
    };
    var a1 = new wd.TouchAction(this);
    a1.press({el: el, x: center.x, y:center.y - 100}).moveTo({el: el}).release();
    var a2 = new wd.TouchAction(this);
    a2.press({el: el, x: center.x, y: center.y + 100}).moveTo({el: el}).release();
    var m = new wd.MultiAction(this);
    m.add(a1, a2);
    return m.perform();
  }.bind(this));
};
wd.addPromiseChainMethod(‘pinch‘, pinch);
wd.addElementPromiseChainMethod(‘pinch‘, function() {
  return this.browser.pinch(this);
});
// ...
return driver.pinch(el);
// ...
return el.pinch();
$this->pinch($el);
// c#
driver.Pinch(25, 25)

放大屏幕(Zoom)

在屏幕上使用放大手势。

# ruby
zoom 200
# python
driver.zoom(element=el)
// java
driver.zoom(element);
// javascript
function zoom(el) {
  return Q.all([
    this.getWindowSize(),
    this.getLocation(el),
  ]).then(function(res) {
    var size = res[0];
    var loc = res[1];
    var center = {
      x: loc.x + size.width / 2,
      y: loc.y + size.height / 2
    };
    var a1 = new wd.TouchAction(this);
    a1.press({el: el}).moveTo({el: el, x: center.x, y: center.y - 100}).release();
    var a2 = new wd.TouchAction(this);
    a2.press({el: el}).moveTo({el: el, x: center.x, y: center.y + 100}).release();
    var m = new wd.MultiAction(this);
    m.add(a1, a2);
    return m.perform();
  }.bind(this));
};
wd.addPromiseChainMethod(‘zoom‘, zoom);
wd.addElementPromiseChainMethod(‘zoom‘, function() {
  return this.browser.zoom(this);
});
// ...
return driver.zoom(el);
// ...
return el.zoom();
// php
$this->zoom($el);
// c#
driver.Zoom(100, 200);

滚动到

滚动到指定的元素。

# ruby
element = find_element :accessibility_id, "Element ID"
execute_script "mobile: scroll", direction: "down", element: element.ref
# python
driver.execute_script("mobile: scroll", {"direction": "down", "element": element.id})
// java
JavascriptExecutor js = (JavascriptExecutor) driver;
HashMap<String, String> scrollObject = new HashMap<String, String>();
scrollObject.put("direction", "down");
scrollObject.put("element", ((RemoteWebElement) element).getId());
js.executeScript("mobile: scroll", scrollObject);
// javascript
return driver.elementByAccessibilityId().then(function (el) {
  driver.execute("mobile: scroll", [{direction: "down", element: el.value}]);
});
// php
$els = $this->elements($this->using(‘class name‘)->value(‘android.widget.TextView‘));
$this->scroll($els[count($els) - 1], $els[0]);
// c#
Dictionary<string, string> scrollObject = new Dictionary<string, string>();
scrollObject.Add("direction", "down");
scrollObject.Add("element", <element_id>);
((IJavaScriptExecutor)driver).ExecuteScript("mobile: scroll", scrollObject));

拉取(pull)文件

从设备上拉取文件。

# ruby
pull_file ‘Library/AddressBook/AddressBook.sqlitedb‘
# python
driver.pull_file(‘Library/AddressBook/AddressBook.sqlitedb‘)
// java
driver.pullFile("Library/AddressBook/AddressBook.sqlitedb");
// javascript
driver.pullFile("Library/AddressBook/AddressBook.sqlitedb")
  .then(function (base64File) { /*...*/ })
// php
$this->pullFile(‘Library/AddressBook/AddressBook.sqlitedb‘);
// c#
driver.PullFile("Library/AddressBook/AddressBook.sqlitedb");

推送(push)文件

推送文件到设备。

# ruby
data = "some data for the file"
path = "/data/local/tmp/file.txt"
push_file path, data
# python
data = "some data for the file"
path = "/data/local/tmp/file.txt"
driver.push_file(path, data.encode(‘base64‘))
// java
byte[] data = Base64.encodeBase64("some data for the file".getBytes());
String path = "/data/local/tmp/file.txt";
driver.pushFile(path, data)
// javascript
driver.pushFile(path, data)
// php
$path = ‘data/local/tmp/test_push_file.txt‘;
$data = ‘This is the contents of the file to push to the device.‘;
$this->pushFile($path, base64_encode($data));
// c#
driver.PushFile("/data/local/tmp/file.txt", "some data for the file");

设置

在这你会找到关于获取或设置 appium 服务器设置的示例代码。如果想了解工作原理,以及支持哪些设置,请查看设置文档

# ruby
current_settings = get_settings
update_settings someSetting: true
# python
current_settings = driver.get_settings()
driver.update_settings({"someSetting": true})
// java
JsonObject settings = driver.getSettings()
// java 客户端不支持设置任意的设置项,只能设置 appium 当前支持的部分。
// 所以对于 `ignoreUnimportantViews`(译者注:忽略不重要的视图,即 android uiautomator 上的压缩后 xml )这个设置项,对应存在下面这个设置方法:
driver.ignoreUnimportantViews(true);
// javascript
var settings = driver.settings();
browser.updateSettings({‘someSetting‘: true});
// php
$settings = $this->getSettings();
$this->updateSettings(array(‘cyberdelia‘ => "open"));
// c#
Dictionary<String, Object>settings = driver.GetSettings();
// .net 客户端不支持设置任意的设置项,只能设置 appium 当前支持的部分。
// 所以对于 `ignoreUnimportantViews`(译者注:忽略不重要的视图,即 android uiautomator 上的压缩后 xml )这个设置项,对应存在下面这个设置方法:
driver.IgnoreUnimportantViews(true);

Appium 桌面应用

Appium 的桌面应用支持 OS X, Windows 及 Linux.

原文地址:https://www.cnblogs.com/xxsl/p/9732989.html

时间: 2024-10-08 04:53:26

Appium 客户端类库的相关文章

中文Appium API 文档

该文档是Testerhome官方翻译的源地址:https://github.com/appium/appium/tree/master/docs/cn官方网站上的:http://appium.io/slate/cn/master/?ruby#about-appium 中文Appium API 文档 第一章:关于appium1.1 appium客户端客户端类库列表及Appium服务端支持 这些类库封装了标准Selenium客户端类库,为用户提供所有常见的JSON 格式selenium命令以及额外的

Appium(1)简介

appium介绍 官方网站 1.特点 appium 是一个自动化测试开源工具,支持 iOS 平台和 Android 平台上的原生应用,web应用和混合应用. "移动原生应用"是指那些用iOS或者 Android SDK 写的应用(Application简称app). "移动web应用"是指使用移动浏览器访问的应用(appium支持iOS上的Safari和Android上的 Chrome). "混合应用"是指原生代码封装网页视图--原生代码和 we

移动端自动化测试(一)之 Appium+Pyhton环境准备篇

由于工作的需要进行Andriod手机app自动化测试,公司现有支持的app的手机平台(Andriod和IOS), 所以选择了Appium工具.因为Andriod和IOS,Appium都支持.百度和谷歌上的各种Appium教程可谓是琳琅满目,但大抵都是浅尝辄止.因此笔者想要总结一套较全面的Appium的实战经验,以此记录我遇到的坑和填过的坑. web自动化测试的路线是这样的:编程语言基础--->测试框架--->webdriver API(selenium2)--->开发自动化测试项目. 移

一、appium工具使用

一.appium简介 1.appium是开源的支持移动测试的自动化测试框架,官网是appium.io 2.appium支持的平台:Android.iOS.某些windows应用 3.测试时支持的移动APP的类型 原生(native):实现技术(Android:java,iOS:objective-c) web(html5) 混合(hybrid):既包含原生,也包含web 4.特点 开源 不限制客户端测试脚本的编程语言,支持Python.java.javascript.c/c++.ruby 主要采

Mac下搭建appium自动化测试环境

一起需要装的有: 1.  JDK http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html 2.  SDK(测试安装app需要,链接为SDK24.4.1版本) http://down.tech.sina.com.cn/download/d_load.php?d_id=45703&down_id=2&ip=183.11.129.46 3.  Appium客户端 http://pan.

appium 遇到的坑

上周开始试着来用appium,首先开始去官网看,然后下载appium客户端,下载安装后,然后笔者开始安装android sdk   ,进官网下载后,笔者下载安装后,在更新下载SDK Manager的时候一直出错,下载不下来,FQ也不行,来到虫师博客 ,看到方式后,就试着去做,可是按照虫师的方式还是不行,后来,我试着在360软件管家去搜,很庆幸在360软件管家搜了出来,下载了,然后安装,点进去可以正常更新,笔者也不知道为啥,可能是360在软件里面注入其他东西,这点不得而知,  不管怎样,我们的目的

Appium原理及版本变化细节

Appium原理小结 Api接口调用selenium的接口,Android底层用android的instrumentation(API2.3+ 通过绑定另外一个独立的selendroid项目来实现的).uiautomator接口(API4.2+),iOS底层用ios的uiautomation接口. Client/ServerArchitecture Appium server是用Node.js写的,安装node.js可以直接用npm命令或dmg,server端功能:监听一个端口,接收client

第一章 Appium简介

随着移动终端的普及,手机应用越来越多,也越来越重要.而作为测试的我们也要与时俱进,努力学习手机App的相关测试,前一段时间我们介绍了Robotium手机自动化测试框架,从本章开始,我们介绍另一个手机自动化测试框架Appium.那究竟什么是Appium呢?我们引用Appium官网的介绍如下: 英文官网:http://appium.io/introduction.html?lang=zh 1.1 Appium 简介 Appium是一个开源的自动化测试工具,其支持iOS和安卓平台上的原生的,基于移动浏

appium远程调用appium server

如何通过本地的代码,调用远程的server呢? 例如:我有两台电脑A(192.168.112.10)和B(192.168.112.11),那我怎么能在A执行本地脚本,但是使用B上的server呢? 查看appium连接appium服务并开启一个session的例子如下: desired_caps = {} desired_caps['platformName'] = 'Android' desired_caps['platformVersion'] = '4.4' desired_caps['d