翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# AWS Device Farm での Appium テスト
リモートアクセスセッション中に、マネージド Appium エンドポイントを使用してセッションのデバイスをターゲットにして、ローカル環境から Appium テストを実行できます。Appium エンドポイントを使用すると、迅速なフィードバックと迅速な反復により、Appium コードを開発、テスト、実行できます。この**クライアント側の**テストアプローチは、任意の Appium クライアント環境から Device Farm デバイスに接続するための柔軟性を提供します。
クライアント側のテストを補完するために、Device Farm は**、サーバー側の**実行と呼ばれるサービスによって管理されるインフラストラクチャでのテストの実行もサポートしています。この方法では、アプリケーションとテストをサービスにアップロードし、サービスマネージドテスト[ホスト](custom-test-environments-hosts.md)を使用して複数のデバイスでテストを並行して実行できます。このアプローチは、多くのデバイスで個別にテストしたり、CI/CD パイプラインのコンテキストからテストしたりするのに適しています。
サーバー側の実行の詳細については、「」を参照してください[AWS Device Farm のテストフレームワークと組み込みテスト](test-types.md)。
**Topics**
+ [Appium エンドポイントとは](#appium-endpoint-what-is)
+ [Appium テストの開始方法](appium-endpoint-getting-started.md)
+ [Appium を使用してデバイスを操作する](appium-endpoint-interaction.md)
+ [Appium サーバーログの確認](appium-endpoint-server-logs.md)
+ [サポートされている Appium 機能とコマンド](appium-endpoint-supported-caps-and-commands.md)
## Appium エンドポイントとは
[Appium](https://appium.io/) は、iOS と Android の両方で、携帯電話やタブレットなど、さまざまなデバイスでネイティブ、ハイブリッド、モバイルウェブアプリケーションをテストするための一般的なオープンソースソフトウェアテストフレームワークです。これにより、デベロッパーと QA (品質保証) エンジニアは、デバイスをリモートで制御し、ユーザーとのやり取りをシミュレートし、テスト対象のアプリケーションが期待どおりに動作していることを検証できるスクリプトを作成できます。Appium はエンドユーザーの観点からアプリとやり取りするため、テスターは実際のユーザーがテストにアプリをどのように使用するかをシミュレートするテストを開発できます。
Appium はクライアント/サーバーモデルに基づいて構築されており、ローカルクライアントは (ローカルまたはリモート) Appium サーバーにユーザーに代わってデバイスをコマンドするようリクエストします。Appium サーバーは、Android 用 [UIAutomator2 ドライバーや iOS](https://github.com/appium/appium-uiautomator2-driver/) 用 [XCUITest ドライバーなど、デバイスと通信](https://appium.github.io/appium-xcuitest-driver/9.10/)するためのドライバーを管理します。すべてのコマンドは、デバイスの制御方法に関する [W3C WebDriver](https://www.w3.org/TR/webdriver2/) 標準に従います。
Device Farm の Appium エンドポイントは、リモートアクセスセッションでデバイスの Appium サーバー URL を公開します。Appium エンドポイント URL は、そのセッション内のデバイスに固有であり、セッション中は有効であり、追加のセットアップ時間なしで同じデバイスで反復処理できます。リモートアクセスの詳細については、「」を参照してください[AWS Device Farm でのリモートアクセス](remote-access.md)。
# Appium テストの開始方法
ほとんどの Appium ユーザーの場合、Device Farm for Appium テストを使用するために必要なのは、既存のテスト設定のわずかな変更のみです。
大まかに言うと、クライアント側の Appium テストに Device Farm を使用するための 3 つのステップがあります。
1. まず、Device Farm デバイスをテストするための[リモートアクセスセッションを作成](how-to-create-session.md)する必要があります。リモートアクセスリクエストの一部としてアプリを含めることも、セッションの開始後にアプリをインストールすることもできます。
1. セッションが実行されたら、[Appium エンドポイント URL をコピー](appium-endpoint-interaction.md)し、スタンドアロンツール ([Appium Inspector](https://github.com/appium/appium-inspector) など) または IDE の Appium テストコードから使用できます。URL は、リモートアクセスセッションの期間中有効です。
1. 最後に、Appium テストが開始されたら、テスト実行中にデバイスのビデオストリームとともに [Appium サーバーログをライブで確認できます](appium-endpoint-server-logs.md)。
# Appium を使用してデバイスを操作する
[リモートアクセスセッションを作成する](how-to-create-session.md)と、デバイスは Appium テストに使用できます。リモートアクセスセッションの全期間中、デバイス上で必要な数の Appium セッションを実行できます。使用するクライアントに制限はありません。例えば、まず IDE からローカル Appium コードを使用してテストを実行し、Appium Inspector を使用して発生した問題のトラブルシューティングに切り替えることができます。セッションは最大 [150 分](limits.md#service-limits)かかることがありますが、5 分以上アクティビティがない場合 (インタラクティブコンソールまたは Appium エンドポイント経由）、セッションはタイムアウトします。
## Appium セッションでのテストに Apps を使用する
Device Farm では、リモートアクセスセッションの作成リクエストの一部としてアプリを使用することも、リモートアクセスセッション自体中にアプリをインストールすることもできます (複数可）。これらのアプリはテスト対象のデバイスに自動的にインストールされ、Appium セッションリクエストのデフォルト機能として挿入されます。リモートアクセスセッションを作成するときは、アプリ ARN を渡すオプションがあります。これは、後続のすべての Appium セッションの `appium:app`機能としてデフォルトで使用され、補助アプリ ARNs は `appium:otherApps`機能として使用されます。
例えば、アプリをアプリ`com.aws.devicefarm.sample`として使用し、補助アプリの 1 つ`com.aws.devicefarm.other.sample`としてリモートアクセスセッションを作成する場合、Appium セッションを作成するときに次のような機能があります。
```
{
"value":
{
"sessionId": "abcdef123456-1234-5678-abcd-abcdef123456",
"capabilities":
{
"app": "/tmp/com.aws.devicefarm.sample.apk",
"otherApps": "[\"/tmp/com.aws.devicefarm.other.sample.apk\"]",
...
}
}
}
```
セッション中に、追加のアプリをインストールできます (コンソール内または [https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_InstallToRemoteAccessSession.html](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_InstallToRemoteAccessSession.html) API を使用）。これらは、`appium:app`以前に機能として使用された既存のアプリを上書きします。以前に使用したアプリケーションに個別のパッケージ名がある場合は、デバイス上に残り、 `appium:otherApps`機能の一部として使用されます。
たとえば、最初にリモートアクセスセッションの作成`com.aws.devicefarm.sample`時にアプリを使用し、セッション`com.aws.devicefarm.other.sample`中に という名前の新しいアプリをインストールした場合、Appium セッションには次のような機能があります。
```
{
"value":
{
"sessionId": "abcdef123456-1234-5678-abcd-abcdef123456",
"capabilities":
{
"app": "/tmp/com.aws.devicefarm.other.sample.apk",
"otherApps": "[\"/tmp/com.aws.devicefarm.sample.apk\"]",
...
}
}
}
```
必要に応じて、アプリ名を使用してアプリの機能を明示的に指定できます (Android および iOS の `appium:appPackage`または `appium:bundleId`機能をそれぞれ使用）。
ウェブアプリケーションをテストする場合は、Appium セッション作成リクエスト`browserName`の機能を指定します。`Chrome` ブラウザはすべての Android デバイスで使用でき、`Safari`ブラウザはすべての iOS デバイスで使用できます。
Device Farm は、リモートアクセスセッション`appium:app`中に にリモート URL またはローカルファイルシステムパスを渡すことをサポートしていません。Device Farm にアプリケーションをアップロードし、代わりにセッションに含めます。
**注記**
リモートアクセスセッションの一部としてアプリを自動的にアップロードする方法の詳細については、[「アプリのアップロードの自動化」を参照してください。](api-ref.md#upload-example)
## Appium エンドポイントの使用方法
コンソール、、 AWS CLIおよび AWS SDKs からセッションの Appium エンドポイントにアクセスする手順は次のとおりです。これらのステップには、さまざまな Appium クライアントテストフレームワークを使用してテストの実行を開始する方法が含まれます。
------
#### [ Console ]
1. ウェブブラウザでリモートアクセスセッションページを開きます。
![\[\]](http://docs.aws.amazon.com/ja_jp/devicefarm/latest/developerguide/images/aws-device-farm-appium-endpoint.png)
1. Appium Inspector を使用してセッションを実行するには、以下を実行します。
1. **Appium セッションの設定**ボタンをクリックする
1. Appium Inspector を使用してセッションを開始する方法については、ページの指示に従ってください。
1. ローカル IDE から Appium テストを実行するには、以下を実行します。
1. **Appium エンドポイント URL **のテキストの横にある「コピー」アイコンをクリックします。
1. リモートアドレスまたはコマンドエグゼキュターを現在指定しているローカル Appium コードにこの URL を貼り付けます。言語固有の例については、このサンプルウィンドウのいずれかのタブをクリックして任意の言語を選択してください。
------
#### [ AWS CLI ]
まず、[最新バージョンをダウンロードしてインストールして、AWS CLI のバージョンが](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)up-to-dateであることを確認します。
**重要**
Appium エンドポイントフィールドは、古いバージョンの AWS CLI では使用できません。
セッションが起動して実行されると、[https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_GetRemoteAccessSession.html](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_GetRemoteAccessSession.html)API への呼び出しに対するレスポンス`remoteDriverEndpoint`で という名前のフィールドを介して Appium エンドポイント URL が使用可能になります。
```
$ aws devicefarm get-remote-access-session \
--arn "arn:aws:devicefarm:us-west-2:123456789876:session:abcdef123456-1234-5678-abcd-abcdef123456/abcdef123456-1234-5678-abcd-abcdef123456/00000"
```
これにより、次のような出力が表示されます。
```
{
"remoteAccessSession": {
"arn": "arn:aws:devicefarm:us-west-2:111122223333:session:abcdef123456-1234-5678-abcd-abcdef123456/abcdef123456-1234-5678-abcd-abcdef123456/00000",
"name": "Google Pixel 8",
"status": "RUNNING",
"endpoints": {
"remoteDriverEndpoint": "https://devicefarm-interactive-global.us-west-2.api.aws/remote-endpoint/ABCD1234...",
...
}
```
この URL は、現在リモートアドレスまたはコマンドエグゼキュターを指定しているローカル Appium コードで使用できます。言語固有の例については、このサンプルウィンドウのいずれかのタブをクリックして任意の言語を選択してください。
コマンドラインから直接エンドポイントを操作する方法の例については、[コマンドラインツール curl ](https://curl.se/)を使用して WebDriver エンドポイントを直接呼び出すことができます。
```
$ curl "https://devicefarm-interactive-global.us-west-2.api.aws/remote-endpoint/ABCD1234.../status"
```
これにより、次のような出力が表示されます。
```
{
"value":
{
"ready": true,
"message": "The server is ready to accept new connections",
"build":
{
"version": "2.5.1"
}
}
}
```
------
#### [ Python ]
セッションが起動して実行されると、[https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_GetRemoteAccessSession.html](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_GetRemoteAccessSession.html)API への呼び出しに対するレスポンス`remoteDriverEndpoint`で という名前のフィールドを介して Appium エンドポイント URL が使用可能になります。
```
# To get the URL
import sys
import boto3
from botocore.exceptions import ClientError
def get_appium_endpoint() -> str:
session_arn = "arn:aws:devicefarm:us-west-2:111122223333:session:abcdef123456-1234-5678-abcd-abcdef123456/abcdef123456-1234-5678-abcd-abcdef123456/00000"
device_farm_client = boto3.client("devicefarm", region_name="us-west-2")
try:
resp = device_farm_client.get_remote_access_session(arn=session_arn)
except ClientError as exc:
sys.exit(f"Failed to call Device Farm: {exc}")
remote_access_session = resp.get("remoteAccessSession", {})
endpoints = remote_access_session.get("endpoints", {})
endpoint = endpoints.get("remoteDriverEndpoint")
if not endpoint:
sys.exit("Device Farm response did not include endpoints.remoteDriverEndpoint")
return endpoint
# To use the URL
from appium import webdriver
from appium.options.android import UiAutomator2Options
opts = UiAutomator2Options()
driver = webdriver.Remote(get_appium_endpoint(), options=opts)
# ...
driver.quit()
```
------
#### [ Java ]
*注: この例では AWS SDK for Java v2 を使用し、JDK バージョン 11 以降と互換性があります。*
セッションが起動して実行されると、[https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_GetRemoteAccessSession.html](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_GetRemoteAccessSession.html)API への呼び出しに対するレスポンス`remoteDriverEndpoint`で という名前のフィールドを介して Appium エンドポイント URL が使用可能になります。
```
// To get the URL
import software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider;
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.devicefarm.DeviceFarmClient;
import software.amazon.awssdk.services.devicefarm.model.GetRemoteAccessSessionRequest;
import software.amazon.awssdk.services.devicefarm.model.GetRemoteAccessSessionResponse;
public class AppiumEndpointBuilder {
public static String getAppiumEndpoint() throws Exception {
String session_arn = "arn:aws:devicefarm:us-west-2:111122223333:session:abcdef123456-1234-5678-abcd-abcdef123456/abcdef123456-1234-5678-abcd-abcdef123456/00000";
try (DeviceFarmClient client = DeviceFarmClient.builder()
.region(Region.US_WEST_2)
.credentialsProvider(DefaultCredentialsProvider.create())
.build()) {
GetRemoteAccessSessionResponse resp = client.getRemoteAccessSession(
GetRemoteAccessSessionRequest.builder().arn(session_arn).build()
);
String endpoint = resp.remoteAccessSession().endpoints().remoteDriverEndpoint();
if (endpoint == null || endpoint.isEmpty()) {
throw new IllegalStateException("remoteDriverEndpoint missing from response");
}
return endpoint;
}
}
}
// To use the URL
import io.appium.java_client.android.AndroidDriver;
import io.appium.java_client.android.options.UiAutomator2Options;
import java.net.URL;
public class ExampleTest {
public static void main(String[] args) throws Exception {
String endpoint = AppiumEndpointBuilder.getAppiumEndpoint();
UiAutomator2Options options = new UiAutomator2Options();
AndroidDriver driver = new AndroidDriver(new URL(endpoint), options);
try {
// ... your test ...
} finally {
driver.quit();
}
}
}
```
------
#### [ JavaScript ]
*注: この例では AWS 、SDK for JavaScript v3 と Node 18\$1 を使用する WebdriverIO v8\$1 を使用しています。*
セッションが起動して実行されると、[https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_GetRemoteAccessSession.html](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_GetRemoteAccessSession.html)API への呼び出しに対するレスポンス`remoteDriverEndpoint`で という名前のフィールドを介して Appium エンドポイント URL が使用可能になります。
```
// To get the URL
import { DeviceFarmClient, GetRemoteAccessSessionCommand } from "@aws-sdk/client-device-farm";
export async function getAppiumEndpoint() {
const sessionArn = "arn:aws:devicefarm:us-west-2:111122223333:session:abcdef123456-1234-5678-abcd-abcdef123456/abcdef123456-1234-5678-abcd-abcdef123456/00000";
const client = new DeviceFarmClient({ region: "us-west-2" });
const resp = await client.send(new GetRemoteAccessSessionCommand({ arn: sessionArn }));
const endpoint = resp?.remoteAccessSession?.endpoints?.remoteDriverEndpoint;
if (!endpoint) throw new Error("remoteDriverEndpoint missing from response");
return endpoint;
}
// To use the URL with WebdriverIO
import { remote } from "webdriverio";
(async () => {
const endpoint = await getAppiumEndpoint();
const u = new URL(endpoint);
const driver = await remote({
protocol: u.protocol.replace(":", ""),
hostname: u.hostname,
port: u.port ? Number(u.port) : (u.protocol === "https:" ? 443 : 80),
path: u.pathname + u.search,
capabilities: {
platformName: "Android",
"appium:automationName": "UiAutomator2",
// ...other caps...
},
});
try {
// ... your test ...
} finally {
await driver.deleteSession();
}
})();
```
------
#### [ C\$1 ]
セッションが起動して実行されると、[https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_GetRemoteAccessSession.html](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_GetRemoteAccessSession.html)API への呼び出しに対するレスポンス`remoteDriverEndpoint`で という名前のフィールドを介して Appium エンドポイント URL が使用可能になります。
```
// To get the URL
using System;
using System.Threading.Tasks;
using Amazon;
using Amazon.DeviceFarm;
using Amazon.DeviceFarm.Model;
public static class AppiumEndpointBuilder
{
public static async Task GetAppiumEndpointAsync()
{
var sessionArn = "arn:aws:devicefarm:us-west-2:111122223333:session:abcdef123456-1234-5678-abcd-abcdef123456/abcdef123456-1234-5678-abcd-abcdef123456/00000";
var config = new AmazonDeviceFarmConfig
{
RegionEndpoint = RegionEndpoint.USWest2
};
using var client = new AmazonDeviceFarmClient(config);
var resp = await client.GetRemoteAccessSessionAsync(new GetRemoteAccessSessionRequest { Arn = sessionArn });
var endpoint = resp?.RemoteAccessSession?.Endpoints?.RemoteDriverEndpoint;
if (string.IsNullOrWhiteSpace(endpoint))
throw new InvalidOperationException("RemoteDriverEndpoint missing from response");
return endpoint;
}
}
// To use the URL
using OpenQA.Selenium.Appium;
using OpenQA.Selenium.Appium.Android;
class Example
{
static async Task Main()
{
var endpoint = await AppiumEndpointBuilder.GetAppiumEndpointAsync();
var options = new AppiumOptions();
options.PlatformName = "Android";
options.AutomationName = "UiAutomator2";
using var driver = new AndroidDriver(new Uri(endpoint), options);
try
{
// ... your test ...
}
finally
{
driver.Quit();
}
}
}
```
------
#### [ Ruby ]
セッションが起動して実行されると、[https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_GetRemoteAccessSession.html](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_GetRemoteAccessSession.html)API への呼び出しに対するレスポンス`remoteDriverEndpoint`で という名前のフィールドを介して Appium エンドポイント URL が使用可能になります。
```
# To get the URL
require 'aws-sdk-devicefarm'
def get_appium_endpoint
session_arn = "arn:aws:devicefarm:us-west-2:111122223333:session:abcdef123456-1234-5678-abcd-abcdef123456/abcdef123456-1234-5678-abcd-abcdef123456/00000"
client = Aws::DeviceFarm::Client.new(region: 'us-west-2')
resp = client.get_remote_access_session(arn: session_arn)
endpoint = resp.remote_access_session.endpoints.remote_driver_endpoint
raise "remote_driver_endpoint missing from response" if endpoint.nil? || endpoint.empty?
endpoint
end
# To use the URL
require 'appium_lib_core'
endpoint = get_appium_endpoint
opts = {
server_url: endpoint,
capabilities: {
'platformName' => 'Android',
'appium:automationName' => 'UiAutomator2'
}
}
driver = Appium::Core.for(opts).start_driver
begin
# ... your test ...
ensure
driver.quit
end
```
------
# Appium サーバーログの確認
[Appium セッションを開始すると](appium-endpoint-interaction.md)、Device Farm コンソールで Appium サーバーログをライブで表示したり、リモートアクセスセッションが終了した後にダウンロードしたりできます。これを行う手順は次のとおりです。
------
#### [ Console ]
1. Device Farm コンソールで、デバイスのリモートアクセスセッションを開きます。
1. ローカル IDE または Appium Inspector からデバイスで Appium エンドポイントセッションを開始する
1. 次に、Appium サーバーログがリモートアクセスセッションページにデバイスとともに表示され、デバイスの下のページの下部に「セッション情報」が表示されます。
![\[\]](http://docs.aws.amazon.com/ja_jp/devicefarm/latest/developerguide/images/aws-device-farm-appium-endpoint-logs.gif)
------
#### [ AWS CLI ]
*注: この例では、 [コマンドラインツールを使用して `curl`](https://curl.se/) Device Farm からログをプルします。*
セッション中またはセッション後に、Device Farm の [https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListArtifacts.html](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListArtifacts.html) API を使用して Appium サーバーログをダウンロードできます。
```
$ aws devicefarm list-artifacts \
--type FILE \
--arn arn:aws:devicefarm:us-west-2:111122223333:session:12345678-1111-2222-333-456789abcdef/12345678-1111-2222-333-456789abcdef/00000
```
これにより、セッション中に次のような出力が表示されます。
```
{
"artifacts": [
{
"arn": "arn:aws:devicefarm:us-west-2:111122223333:artifact:12345678-1111-2222-333-456789abcdef/12345678-1111-2222-333-456789abcdef/00000",
"name": "AppiumServerLogOutput",
"type": "APPIUM_SERVER_LOG_OUTPUT",
"extension": "",
"url": "https://prod-us-west-2-results.s3.dualstack.us-west-2.amazonaws.com/111122223333/12345678..."
}
]
}
```
セッションが完了したら、以下を実行します。
```
{
"artifacts": [
{
"arn": "arn:aws:devicefarm:us-west-2:111122223333:artifact:12345678-1111-2222-333-456789abcdef/12345678-1111-2222-333-456789abcdef/00000",
"name": "Appium Server Output",
"type": "APPIUM_SERVER_OUTPUT",
"extension": "log",
"url": "https://prod-us-west-2-results.s3.dualstack.us-west-2.amazonaws.com/111122223333/12345678..."
}
]
}
```
```
$ curl "https://prod-us-west-2-results.s3.dualstack.us-west-2.amazonaws.com/111122223333/12345678..."
```
これにより、次のような出力が表示されます。
```
info Appium Welcome to Appium v2.5.4
info Appium Non-default server args:
info Appium { address: '127.0.0.1',
info Appium allowInsecure:
info Appium [ 'execute_driver_script',
info Appium 'session_discovery',
info Appium 'perf_record',
info Appium 'adb_shell',
info Appium 'chromedriver_autodownload',
info Appium 'get_server_logs' ],
info Appium keepAliveTimeout: 0,
info Appium logNoColors: true,
info Appium logTimestamp: true,
info Appium longStacktrace: true,
info Appium sessionOverride: true,
info Appium strictCaps: true,
info Appium useDrivers: [ 'uiautomator' ] }
```
------
#### [ Python ]
*注: この例では、サードパーティー`requests`パッケージを使用してログと AWS SDK for Python をダウンロードします`boto3`。*
セッション中またはセッション後に、Device Farm の [https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListArtifacts.html](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListArtifacts.html) API を使用して Appium サーバーログ URL を取得し、ダウンロードすることができます。
```
import pathlib
import requests
import boto3
def download_appium_log():
session_arn = "arn:aws:devicefarm:us-west-2:111122223333:session:12345678-1111-2222-333-456789abcdef/12345678-1111-2222-333-456789abcdef/00000"
client = boto3.client("devicefarm", region_name="us-west-2")
# 1) List artifacts for the session (FILE artifacts), handling pagination
artifacts = []
token = None
while True:
kwargs = {"arn": session_arn, "type": "FILE"}
if token:
kwargs["nextToken"] = token
resp = client.list_artifacts(**kwargs)
artifacts.extend(resp.get("artifacts", []))
token = resp.get("nextToken")
if not token:
break
if not artifacts:
raise RuntimeError("No artifacts found in this session")
# Filter strictly to Appium server logs
allowed = {"APPIUM_SERVER_OUTPUT", "APPIUM_SERVER_LOG_OUTPUT"}
filtered = [a for a in artifacts if a.get("type") in allowed]
if not filtered:
raise RuntimeError("No Appium server log artifacts found (expected APPIUM_SERVER_OUTPUT or APPIUM_SERVER_LOG_OUTPUT)")
# Prefer the final 'OUTPUT' log, else the live 'LOG_OUTPUT'
chosen = (next((a for a in filtered if a.get("type") == "APPIUM_SERVER_OUTPUT"), None)
or next((a for a in filtered if a.get("type") == "APPIUM_SERVER_LOG_OUTPUT"), None))
url = chosen["url"]
ext = chosen.get("extension") or "log"
out = pathlib.Path(f"./appium_server_log.{ext}")
# 2) Download the artifact
with requests.get(url, stream=True) as r:
r.raise_for_status()
with open(out, "wb") as fh:
for chunk in r.iter_content(chunk_size=1024 * 1024):
if chunk:
fh.write(chunk)
print(f"Saved Appium server log to: {out.resolve()}")
download_appium_log()
```
これにより、次のような出力が表示されます。
```
info Appium Welcome to Appium v2.5.4
info Appium Non-default server args:
info Appium { address: '127.0.0.1', allowInsecure: [ 'execute_driver_script', ... ], useDrivers: [ 'uiautomator' ] }
```
------
#### [ Java ]
*注: この例では AWS SDK for Java v2 と を使用してログ`HttpClient`をダウンロードし、JDK バージョン 11 以降と互換性があります。*
セッション中またはセッション後に、Device Farm の [https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListArtifacts.html](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListArtifacts.html) API を使用して Appium サーバーログ URL を取得してからダウンロードできます。
```
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.file.Path;
import java.time.Duration;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.List;
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.devicefarm.DeviceFarmClient;
import software.amazon.awssdk.services.devicefarm.model.Artifact;
import software.amazon.awssdk.services.devicefarm.model.ArtifactCategory;
import software.amazon.awssdk.services.devicefarm.model.ListArtifactsRequest;
import software.amazon.awssdk.services.devicefarm.model.ListArtifactsResponse;
public class AppiumLogDownloader {
public static void main(String[] args) throws Exception {
String sessionArn = "arn:aws:devicefarm:us-west-2:111122223333:session:12345678-1111-2222-333-456789abcdef/12345678-1111-2222-333-456789abcdef/00000";
try (DeviceFarmClient client = DeviceFarmClient.builder()
.region(Region.US_WEST_2)
.build()) {
// 1) List artifacts for the session (FILE artifacts) with pagination
List all = new ArrayList<>();
String token = null;
do {
ListArtifactsRequest.Builder b = ListArtifactsRequest.builder()
.arn(sessionArn)
.type(ArtifactCategory.FILE);
if (token != null) b.nextToken(token);
ListArtifactsResponse page = client.listArtifacts(b.build());
all.addAll(page.artifacts());
token = page.nextToken();
} while (token != null && !token.isBlank());
// Filter strictly to Appium logs
List filtered = all.stream()
.filter(a -> {
String t = a.typeAsString();
return "APPIUM_SERVER_OUTPUT".equals(t) || "APPIUM_SERVER_LOG_OUTPUT".equals(t);
})
.toList();
if (filtered.isEmpty()) {
throw new RuntimeException("No Appium server log artifacts found (expected APPIUM_SERVER_OUTPUT or APPIUM_SERVER_LOG_OUTPUT).");
}
// Prefer OUTPUT; else LOG_OUTPUT
Artifact chosen = filtered.stream()
.filter(a -> "APPIUM_SERVER_OUTPUT".equals(a.typeAsString()))
.findFirst()
.orElseGet(() -> filtered.stream()
.filter(a -> "APPIUM_SERVER_LOG_OUTPUT".equals(a.typeAsString()))
.findFirst()
.get());
String url = chosen.url();
String ext = (chosen.extension() == null || chosen.extension().isBlank()) ? "log" : chosen.extension();
Path out = Path.of("appium_server_log." + ext);
// 2) Download the artifact with HttpClient
HttpClient http = HttpClient.newBuilder()
.connectTimeout(Duration.ofSeconds(10))
.build();
HttpRequest get = HttpRequest.newBuilder(URI.create(url))
.timeout(Duration.ofMinutes(5))
.GET()
.build();
HttpResponse resp = http.send(get, HttpResponse.BodyHandlers.ofFile(out));
if (resp.statusCode() / 100 != 2) {
throw new IOException("Failed to download log, HTTP " + resp.statusCode());
}
System.out.println("Saved Appium server log to: " + out.toAbsolutePath());
}
}
}
```
これにより、次のような出力が表示されます。
```
info Appium Welcome to Appium v2.5.4
info Appium Non-default server args:
info Appium { address: '127.0.0.1', ..., useDrivers: [ 'uiautomator' ] }
```
------
#### [ JavaScript ]
*注: この例では、 AWS SDK for JavaScript (v3) と Node 18\$1 を使用してログ`fetch`をダウンロードします。*
セッション中またはセッション後に、Device Farm の [https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListArtifacts.html](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListArtifacts.html) API を使用して Appium サーバーログ URL を取得してからダウンロードできます。
```
import { DeviceFarmClient, ListArtifactsCommand } from "@aws-sdk/client-device-farm";
import { createWriteStream } from "fs";
import { pipeline } from "stream";
import { promisify } from "util";
const pipe = promisify(pipeline);
const client = new DeviceFarmClient({ region: "us-west-2" });
const sessionArn = "arn:aws:devicefarm:us-west-2:111122223333:session:12345678-1111-2222-333-456789abcdef/12345678-1111-2222-333-456789abcdef/00000";
// 1) List artifacts for the session (FILE artifacts), handling pagination
const artifacts = [];
let nextToken;
do {
const page = await client.send(new ListArtifactsCommand({
arn: sessionArn,
type: "FILE",
nextToken
}));
artifacts.push(...(page.artifacts ?? []));
nextToken = page.nextToken;
} while (nextToken);
if (!artifacts.length) throw new Error("No artifacts found");
// Strict filter to Appium logs
const filtered = (artifacts ?? []).filter(a =>
a.type === "APPIUM_SERVER_OUTPUT" || a.type === "APPIUM_SERVER_LOG_OUTPUT"
);
if (!filtered.length) {
throw new Error("No Appium server log artifacts found (expected APPIUM_SERVER_OUTPUT or APPIUM_SERVER_LOG_OUTPUT).");
}
// Prefer OUTPUT; else LOG_OUTPUT
const chosen =
filtered.find(a => a.type === "APPIUM_SERVER_OUTPUT") ??
filtered.find(a => a.type === "APPIUM_SERVER_LOG_OUTPUT");
const url = chosen.url;
const ext = chosen.extension || "log";
const outPath = `./appium_server_log.${ext}`;
// 2) Download the artifact
const resp = await fetch(url);
if (!resp.ok) {
throw new Error(`Failed to download log: ${resp.status} ${await resp.text().catch(()=>"")}`);
}
await pipe(resp.body, createWriteStream(outPath));
console.log("Saved Appium server log to:", outPath);
```
これにより、次のような出力が表示されます。
```
info Appium Welcome to Appium v2.5.4
info Appium Non-default server args:
info Appium { address: '127.0.0.1', allowInsecure: [ 'execute_driver_script', ... ], useDrivers: [ 'uiautomator' ] }
```
------
#### [ C\$1 ]
*注: この例では AWS SDK for .NET と `HttpClient` を使用してログをダウンロードします。*
セッション中またはセッション後に、Device Farm の [https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListArtifacts.html](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListArtifacts.html) API を使用して Appium サーバーログ URL を取得してからダウンロードできます。
```
using System;
using System.Collections.Generic;
using System.IO;
using System.Net.Http;
using System.Threading.Tasks;
using System.Linq;
using Amazon;
using Amazon.DeviceFarm;
using Amazon.DeviceFarm.Model;
class AppiumLogDownloader
{
static async Task Main()
{
var sessionArn = "arn:aws:devicefarm:us-west-2:111122223333:session:12345678-1111-2222-333-456789abcdef/12345678-1111-2222-333-456789abcdef/00000";
using var client = new AmazonDeviceFarmClient(RegionEndpoint.USWest2);
// 1) List artifacts for the session (FILE artifacts), handling pagination
var all = new List();
string? token = null;
do
{
var page = await client.ListArtifactsAsync(new ListArtifactsRequest
{
Arn = sessionArn,
Type = ArtifactCategory.FILE,
NextToken = token
});
if (page.Artifacts != null) all.AddRange(page.Artifacts);
token = page.NextToken;
} while (!string.IsNullOrEmpty(token));
if (all.Count == 0)
throw new Exception("No artifacts found");
// Strict filter to Appium logs
var filtered = all.Where(a =>
a.Type == "APPIUM_SERVER_OUTPUT" || a.Type == "APPIUM_SERVER_LOG_OUTPUT").ToList();
if (filtered.Count == 0)
throw new Exception("No Appium server log artifacts found (expected APPIUM_SERVER_OUTPUT or APPIUM_SERVER_LOG_OUTPUT).");
// Prefer OUTPUT; else LOG_OUTPUT
var chosen = filtered.FirstOrDefault(a => a.Type == "APPIUM_SERVER_OUTPUT")
?? filtered.First(a => a.Type == "APPIUM_SERVER_LOG_OUTPUT");
var url = chosen.Url;
var ext = string.IsNullOrWhiteSpace(chosen.Extension) ? "log" : chosen.Extension;
var outPath = $"./appium_server_log.{ext}";
// 2) Download the artifact
using var http = new HttpClient();
using var resp = await http.GetAsync(url, HttpCompletionOption.ResponseHeadersRead);
resp.EnsureSuccessStatusCode();
await using (var fs = File.Create(outPath))
{
await resp.Content.CopyToAsync(fs);
}
Console.WriteLine($"Saved Appium server log to: {Path.GetFullPath(outPath)}");
}
}
```
これにより、次のような出力が表示されます。
```
info Appium Welcome to Appium v2.5.4
info Appium Non-default server args:
info Appium { address: '127.0.0.1', ..., useDrivers: [ 'uiautomator' ] }
```
------
#### [ Ruby ]
*注: この例では、 AWS SDK for Ruby と `Net::HTTP` を使用してログをダウンロードします。*
セッション中またはセッション後に、Device Farm の [https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListArtifacts.html](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListArtifacts.html) API を使用して Appium サーバーログ URL を取得し、ダウンロードすることができます。
```
require "aws-sdk-devicefarm"
require "net/http"
require "uri"
client = Aws::DeviceFarm::Client.new(region: "us-west-2")
session_arn = "arn:aws:devicefarm:us-west-2:111122223333:session:12345678-1111-2222-333-456789abcdef/12345678-1111-2222-333-456789abcdef/00000"
# 1) List artifacts for the session (FILE artifacts), handling pagination
artifacts = []
token = nil
loop do
page = client.list_artifacts(arn: session_arn, type: "FILE", next_token: token)
artifacts.concat(page.artifacts || [])
token = page.next_token
break if token.nil? || token.empty?
end
raise "No artifacts found" if artifacts.empty?
# Strict filter to Appium logs
filtered = (artifacts || []).select { |a| ["APPIUM_SERVER_OUTPUT", "APPIUM_SERVER_LOG_OUTPUT"].include?(a.type) }
raise "No Appium server log artifacts found (expected APPIUM_SERVER_OUTPUT or APPIUM_SERVER_LOG_OUTPUT)." if filtered.empty?
# Prefer OUTPUT; else LOG_OUTPUT
chosen = filtered.find { |a| a.type == "APPIUM_SERVER_OUTPUT" } ||
filtered.find { |a| a.type == "APPIUM_SERVER_LOG_OUTPUT" }
url = chosen.url
ext = (chosen.extension && !chosen.extension.empty?) ? chosen.extension : "log"
out_path = "./appium_server_log.#{ext}"
# 2) Download the artifact
uri = URI.parse(url)
Net::HTTP.start(uri.host, uri.port, use_ssl: (uri.scheme == "https")) do |http|
req = Net::HTTP::Get.new(uri)
http.request(req) do |resp|
raise "Failed GET: #{resp.code} #{resp.body}" unless resp.code.to_i / 100 == 2
File.open(out_path, "wb") { |f| resp.read_body { |chunk| f.write(chunk) } }
end
end
puts "Saved Appium server log to: #{File.expand_path(out_path)}"
```
これにより、次のような出力が表示されます。
```
info Appium Welcome to Appium v2.5.4
info Appium Non-default server args:
info Appium { address: '127.0.0.1', allowInsecure: [ 'execute_driver_script', ... ], useDrivers: [ 'uiautomator' ] }
```
------
# サポートされている Appium 機能とコマンド
Device Farm の Appium エンドポイントは、いくつかの例外を除いて、ローカルデバイスで使用するのと同じコマンドと必要な機能のほとんどをサポートします。次のリストは、現在サポートされていない機能とコマンドを示しています。機能が制限されているためにテストを期待どおりに実行できない場合は、サポートケースを開いて追加のガイダンスを確認してください。
## サポートされる機能
Device Farm で Appium セッションを作成するときは、ローカルデバイスに固有の機能を除外する個別の機能セットを用意することをお勧めします。Device Farm では、サポートされていない機能が設定されている場合、セッションの作成が失敗することがあります。これには、 `udid`や などのデバイス固有の機能が含まれます`platformVersion`。さらに、Android の ChromeDriver および iOS の WebDriverAgent に関連する特定の機能はサポートされていません。また、エミュレータとシミュレーターでのみサポートされる機能もサポートされています。
## サポートされているコマンド
実際の Android および iOS デバイスで正しく実行されるほとんどの Appium コマンドは、Device Farm で想定どおりに実行されますが、以下の例外があります。
### Appium デバイスコマンド (`/appium/device`)
+ `install_app`
+ `finger_print`
+ `send_sms`
+ `gsm_call`
+ `gsm_signal`
+ `gsm_voice`
+ `power_ac`
+ `power_capacity`
+ `network_speed`
+ `shake`
### Appium 実行メソッドとスクリプト (`/execute`)
+ `installApp`
+ `execEmuConsoleCommand`
+ `fingerprint`
+ `gsmCall`
+ `gsmSignal`
+ `sendSms`
+ `gsmVoice`
+ `powerAC`
+ `powerCapacity`
+ `networkSpeed`
+ `sensorSet`
+ `injectEmulatorCameraImage`
+ `isGpsEnabled`
+ `shake`
+ `clearApp`
+ `clearKeychains`
+ `configureLocalization`
+ `enrollBiometric`
+ `getPasteboard`
+ `installXCTestBundle`
+ `listXCTestBundles`
+ `listXCTestsInTestBundle`
+ `runXCTest`
+ `sendBiometricMatch`
+ `setPasteboard`
+ `setPermission`
+ `startAudioRecording`
+ `startLogsBroadcast`
+ `startRecordingScreen`
+ `startScreenStreaming`
+ `startXCTestScreenRecording`
+ `stopAudioRecording`
+ `stopLogsBroadcast`
+ `stopRecordingScreen`
+ `stopScreenStreaming`
+ `stopXCTestScreenRecording`
+ `updateSafariPreferences`