Appium — その概要、動作原理とクロスプラットフォームテスト

Appiumとは

Appiumは、クライアント-サーバーアーキテクチャ上に構築されたモバイルアプリケーションテスト自動化のためのオープンソースフレームワークです。AppiumサーバーはWebDriverプロトコルを介してクライアントからコマンドを受信し、それらをネイティブドライバーに委任します：iOS用のXCUITest、Android用のUiAutomator2、Windows用のWinAppDriver。

歴史とコミュニティ

Appiumは2013年に作成され、以来クロスプラットフォームテストの業界標準となっています。プロジェクトはAppium Foundationによって管理され、Sauce Labs、HeadSpin、Microsoftなどの大企業によってサポートされています。世界中で毎月50万人以上のテスターがAppiumを使用しています。

サポートされるアプリケーションタイプ

Appiumは3種類のアプリケーションをサポートしています：ネイティブ（iOS、Android、Windows）、モバイルウェブブラウザ（Safari、Chrome）、およびハイブリッドアプリケーション（ネイティブシェル内のWebView）。各タイプは独自のコンテキストを使用します：NATIVE_APP、WEBVIEW、またはCHROMIUM。

AppiumとWebDriverのアーキテクチャ

Appiumのアーキテクチャは4つの層で構成されています：クライアントコード → Appium Client Library → Appium Server → ネイティブドライバー。クライアントライブラリはWebDriverプロトコルを実装し、HTTPリクエストをサーバーに送信します。サーバーはそれらをプラットフォームのネイティブドライバーコマンドに変換します。

WebDriverプロトコル

WebDriverはブラウザ自動化のためのW3C標準であり、Appiumによってモバイルデバイス向けに適応されています。各アクション（要素検索、タップ、テキスト入力）はHTTPリクエストとしてサーバーに送信されます。例えば、POST /session/{id}/elementは新しいテストセッションを作成します。

セッションとDesired Capabilities

各テストはDesired Capabilitiesオブジェクトを介してセッションを作成することから始まります。これにはplatformName、deviceName、appPath、automationName、および追加パラメータが指定されます。Appiumはこのデータを使用して適切なネイティブドライバーとデバイス設定を選択します。

# Android用Desired Capabilitiesの例
desired_caps = {
    'platformName': 'Android',
    'deviceName': 'Pixel_4',
    'app': '/path/to/app.apk',
    'automationName': 'UiAutomator2',
    'appPackage': 'com.example.app',
    'appActivity': '.MainActivity'
}
driver = webdriver.Remote('http://localhost:4723/wd/hub', desired_caps)

Appiumのインストールと設定

Appiumはnpmを使用してインストールされます：npm install -g appium。インストール後、各プラットフォーム用のネイティブドライバーを設定する必要があります：appium driver install xcuitestおよびappium driver install uiautomator2。iOSにはXcode、AndroidにはAndroid SDKが必要です。

Appium Inspector

Appium InspectorはUI要素を検査するためのグラフィカルツールです。実行中のAppiumサーバーに接続し、UIコンポーネントの階層、その属性、ロケーターを表示します。Inspectorを使用すると、テストを作成する前にセレクターを検証できます。

サーバーの起動

Appiumサーバーは、ポート、アドレス、ロギングなどのオプションパラメータを指定してappiumコマンドで起動します。デフォルトでは、サーバーはポート4723で待機します。複数のデバイスで並列実行するには、異なるポートまたはAppiumクラスターを使用します。

# ロギング付きAppiumサーバーの起動
appium \
  --port 4723 \
  --log-level debug \
  --use-plugins images \
  --base-path /wd/hub

Appiumテストの作成

Appiumテストはコード整理にPage Objectパターンを使用します。各アプリ画面は、要素ロケーターとインタラクションメソッドを持つ個別のクラスで記述されます。Page Object Modelはインターフェース変更時のテスト保守を簡素化し、テストシナリオ間でセレクターを再利用します。

要素ロケーター

Appiumは多くの要素検索戦略をサポートしています：id、xpath、accessibilityId、className、androidUIAutomator、iOSClassChain。最も推奨されるのはaccessibilityIdとidです。これらはレイアウト変更に対しても安定しています。XPathは他のロケーターが利用できない場合にのみ使用する必要があります。

// ログイン画面用のPage Object
public class LoginPage {
    private AppiumDriver driver;

    private MobileElement emailField =
        (MobileElement) driver.findElement(MobileBy.AccessibilityId("emailInput"));
    private MobileElement passwordField =
        (MobileElement) driver.findElement(MobileBy.AccessibilityId("passwordInput"));
    private MobileElement loginButton =
        (MobileElement) driver.findElement(MobileBy.AccessibilityId("loginButton"));

    public void login(String email, String password) {
        emailField.sendKeys(email);
        passwordField.sendKeys(password);
        loginButton.click();
    }
}

ジェスチャーとアクションの操作

AppiumはTouchActionクラスまたはW3C Actions APIを介して複雑なジェスチャーをサポートしています：スワイプ、マルチタッチ、長押し、要素へのスクロール。新しいW3C Actions APIは標準化されており、異なるプラットフォームバージョン間でより安定して動作するため、新しいプロジェクトに推奨されます。

Appiumと代替ツールの比較

AppiumはDetox、XCUITest、Espressoとよく比較されます。Appiumの主な利点はクロスプラットフォーム機能です：1つのテストを変更なしでiOSとAndroidで実行できます。ただし、DetoxはReact Native向けのより優れた同期を提供し、XCUITest/Espressoはネイティブテスト向けのより高速な実行を提供します。

Appiumを選ぶべき場合

AppiumはiOS、Android、ウェブ向けの単一フレームワークが必要なプロジェクトに適しています。JavaまたはPythonでテストを記述するテスターがいるチームには不可欠です。多くのE2Eテストを含むReact Nativeプロジェクトの場合は、自動同期機能があるDetoxを検討してください。

Appium Gridとクラウドテスト

Appium Gridは、複数のデバイスで同時にテストを並列実行するための拡張機能です。Appium GridはSelenium Grid上に構築されており、複数のAppiumサーバー間でテストを分散できます。各サーバーは独自のデバイスまたはエミュレーターセットを管理します。これは、単一デバイスでのリグレッションテストに数時間かかる大規模プロジェクトにとって重要です。Gridはノード数に比例して時間を数分に短縮します。

Gridの設定

Gridの設定には、デバイスを含むノードを記述したJSON設定ファイルを使用します。各ノードは、サーバーポート、プラットフォームとOSバージョンを含むデバイスリスト、最大セッション数を指定します。Hubは空いているノードにテストを分散し、インフラストラクチャの最大活用を確保します。

{
  "capabilities": [
    {
      "browserName": "android",
      "platformName": "Android",
      "deviceName": "Pixel_4",
      "platformVersion": "14.0",
      "maxInstances": 2
    }
  ],
  "configuration": {
    "port": 4724,
    "registerCycle": 5000
  }
}

クラウドサービス

独自のデバイスインフラが利用できない場合は、クラウドサービスがあります：Sauce Labs、BrowserStack、LambdaTest。これらはクラウド内の数百の実デバイスとエミュレーターを提供します。Appiumとの統合は最小限です：localhostの代わりにDesired CapabilitiesでクラウドハブのURLと認証情報を指定するだけです。

並列実行

AppiumはTestNG（Java）またはpytest-xdist（Python）を使用した並列テスト実行をサポートしています。並列化には、各セッションに固有のポートと分離されたテストデータが必要です。各スレッドは個別のデバイスまたはエミュレーターで独自のAppiumセッションを開始します。クラウドサービスを使用する場合、並列化は自動です。プラットフォームが利用可能なデバイスにテストを分散し、完了後に解放します。

Appiumの診断とデバッグ

Appiumで問題が発生した場合、最初のステップはサーバーログの確認です（appium --log-level debug）。一般的なエラー：ポートが使用中（別の--portを指定）、ドライバーバージョンの非互換、Android SDKまたはXcodeの欠落。iOSの場合は、WebKitAgentが実行中でシミュレーターにアクセスできることを確認してください。

要素検索の問題

Appiumが要素を見つけられない場合は、以下を確認してください：コンテキストが正しいか（NATIVE_APP vs WEBVIEW）、要素が画面に表示されているか、スクロールが必要か、ロケーターが正しいか。Appium Inspectorを使用して、テストに挿入する前にインタラクティブに検索しXPath式を確認してください。WebDriverWaitによる要素の可視性の待機を有効にすることも役立ちます。これにより、UI読み込みが遅い場合の同期問題が解決されます。

セッション管理

不適切なセッション終了はAppiumテストの不安定性の一般的な原因です。常にfinallyブロックまたはAutoCloseableを介してドライバーを閉じてください。障害が発生した場合は、強制的にdriver.quit()を使用してください。iOSの場合は、セッション間にWebKitAgent（WDA）が再起動することを確認してください。そうしないと、session not createdエラーが発生する可能性があります。CIでのセッション状態監視には、Appium Dashboardプラグインを接続すると便利です。これにより、実行中のすべてのテストの状態がリアルタイムで可視化されます。

安定性フラグ

テストの安定性を向上させるには、shouldTerminateApp（テスト間でアプリを終了）、noReset（セッション間でデータを保持）、autoGrantPermissions（システムダイアログを自動許可）を使用します。また、デベロッパーオプションでデバイスのアニメーションを無効にすることをお勧めします。