使用 Appium 與裝置互動

建立遠端存取工作階段後，裝置將可用於 Appium 測試。在遠端存取工作階段的整個期間，您可以視需要在裝置上執行任意數量的 Appium 工作階段，而不會限制您使用的用戶端。例如，您可以從 IDE 使用本機 Appium 程式碼執行測試，然後切換到使用 Appium Inspector 來疑難排解您遇到的任何問題。工作階段最多可持續 150 分鐘，不過，如果超過 5 分鐘沒有活動（透過互動式主控台或透過 Appium 端點），工作階段將會逾時。

使用應用程式搭配 Appium 工作階段進行測試

Device Farm 可讓您使用應用程式作為遠端存取工作階段建立請求的一部分，或在遠端存取工作階段本身期間安裝應用程式。這些應用程式會自動安裝在待測裝置上，並插入為任何 Appium 工作階段請求的預設功能。當您建立遠端存取工作階段時，您可以選擇傳入應用程式 ARN，該應用程式 ARN 預設會用作所有後續 Appium 工作階段appium:app的功能，以及輔助應用程式 ARNs，其將用作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.sample.apk",
            "otherApps": "[\"/tmp/com.aws.devicefarm.other.sample.apk\"]",
            ...
        }
    }
}

在工作階段期間，您可以安裝其他應用程式（在主控台內或使用 InstallToRemoteAccessSession 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功能）。

如果您要測試 Web 應用程式，請指定 Appium 工作階段建立請求browserName的功能。Chrome 瀏覽器適用於所有 Android 裝置，瀏覽器Safari適用於所有 iOS 裝置。

Device Farm 不支援在遠端存取工作階段appium:app期間在中傳遞遠端 URL 或本機檔案系統路徑。將應用程式上傳至 Device Farm，並改為將其包含在工作階段中。

注意

如需在遠端存取工作階段中自動上傳應用程式的詳細資訊，請參閱自動上傳應用程式。

如何使用 Appium 端點

以下是從主控台 AWS CLI、和 AWS SDKs 存取工作階段 Appium 端點的步驟。這些步驟包括如何使用各種 Appium 用戶端測試架構開始執行測試：

Console

在 Web 瀏覽器中開啟遠端存取工作階段頁面：
若要使用 Appium Inspector 執行工作階段，請執行下列動作：
1. 按一下按鈕設定 Appium 工作階段
2. 遵循頁面上的指示，了解如何使用 Appium Inspector 啟動工作階段。
若要從本機 IDE 執行 Appium 測試，請執行下列動作：
1. 按一下文字 Appium 端點 URL 旁的「複製」圖示
2. 將此 URL 貼到您的本機 Appium 程式碼，只要您目前指定遠端地址或命令執行器。如需特定語言的範例，請按一下此範例視窗中您所選語言的其中一個標籤。

AWS CLI

重要

Appium 端點欄位不適用於舊版的 AWS CLI。

一旦您的工作階段啟動並執行，Appium 端點 URL 將透過 GetRemoteAccessSession API 呼叫回應remoteDriverEndpoint中名為的欄位提供：


$ 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...",
        ...
}

無論您目前在何處指定遠端地址或命令執行器，都可以在本機 Appium 程式碼中使用此 URL。如需特定語言的範例，請按一下此範例視窗中您所選語言的其中一個標籤。

如需如何直接從命令列與端點互動的範例，您可以使用命令列工具 curl 直接呼叫 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

一旦您的工作階段啟動並執行，Appium 端點 URL 將透過 GetRemoteAccessSession API 呼叫回應remoteDriverEndpoint中名為的欄位提供：


# 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

注意：此範例使用適用於 Java v2 的 AWS 開發套件，並與 JDK 第 11 版及更新版本相容。

一旦您的工作階段啟動並執行，Appium 端點 URL 將透過 GetRemoteAccessSession API 呼叫回應remoteDriverEndpoint中名為的欄位提供：


// 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

注意：此範例使用適用於 JavaScript v3 的 AWS SDK，以及使用 Node 18+ 的 WebdriverIO v8+。

一旦您的工作階段啟動並執行，Appium 端點 URL 將透過 GetRemoteAccessSession API 呼叫回應remoteDriverEndpoint中名為的欄位提供：


// 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#

一旦您的工作階段啟動並執行，Appium 端點 URL 將透過 GetRemoteAccessSession API 呼叫回應remoteDriverEndpoint中名為的欄位提供：


// 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<string> 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

一旦您的工作階段啟動並執行，Appium 端點 URL 將透過 GetRemoteAccessSession API 呼叫回應remoteDriverEndpoint中名為的欄位提供：


# 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

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

Appium 測試入門

檢閱您的 Appium 伺服器日誌