> ## Documentation Index
> Fetch the complete documentation index at: https://e2e.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# TestMu AI

> @e2e-dev/testmu を使い、TestMu AI（旧 LambdaTest）のエミュレーター、シミュレーター、実機でモバイルターゲットを、ホスト型の Chrome と Edge で Web ターゲットを実行します。

`@e2e-dev/testmu` は [TestMu AI](https://www.lambdatest.com)（旧 LambdaTest）でターゲットを実行します。
`testmu()` は、Android エミュレーター、iOS シミュレーター、実機向けの[デバイスプロバイダー](https://e2e.com/docs/ja/mobile#hosted-devices)です。
`@e2e-dev/testmu/web` の `testmuBrowsers()` は、ホスト型の Chrome と Edge 向けの
[ブラウザプロバイダー](https://e2e.com/docs/ja/browser#hosted-browsers)です。テストを書き換える必要はありません。

## 認証

CI のシークレットなどを使い、`e2e run` を起動する環境に `LT_USERNAME` と `LT_ACCESS_KEY` を設定します。
値は **Account Settings → Password & Security → Username and Access Key**
（[accounts.lambdatest.com/security/username-accesskey](https://accounts.lambdatest.com/security/username-accesskey)）からコピーします。
どちらか一方でも欠けていると、テスト開始前にリースの取得が失敗します。
`testmuBrowsers()` はこれらを各セッションの CDP URL にのみ含め、ログには出力しません。

## デバイスでモバイルターゲットを実行する

各ワーカースロットは実行開始時に 1 台のデバイスを借り受け、実行終了時に解放します。

<Tip>
ホスト型デバイスで e2e を実行する場合、Mac、Xcode、Android SDK は不要です。
</Tip>

モバイルエンジンとともに連携パッケージをインストールします。

<CodeGroup>
```bash npm
npm install --save-dev e2e @e2e-dev/mobile @e2e-dev/testmu
```

```bash pnpm
pnpm add -D e2e @e2e-dev/mobile @e2e-dev/testmu
```

```bash bun
bun add -d e2e @e2e-dev/mobile @e2e-dev/testmu
```
</CodeGroup>

```ts title="e2e.config.ts"

const apk = 'https://prod-mobile-artefacts.lambdatest.com/assets/docs/proverbial_android.apk';
const ipa = 'https://prod-mobile-artefacts.lambdatest.com/assets/docs/proverbial_ios.ipa';

export default {
  targets: [
    {
      name: 'android-emulator',
      engine: mobile({
        platform: 'android',
        device: testmu({ device: 'Galaxy S22 Ultra 5G', osVersion: '14', app: apk }),
      }),
      app: { bundleId: 'com.lambdatest.proverbial' },
    },
    {
      name: 'ios-real',
      engine: mobile({
        platform: 'ios',
        device: testmu({ device: 'iPhone 16', osVersion: '18', app: ipa, deviceType: 'real' }),
      }),
      app: { bundleId: 'proverbial' },
    },
    {
      name: 'android-real',
      engine: mobile({
        platform: 'android',
        device: testmu({ device: 'Pixel 6', osVersion: '14', app: apk, deviceType: 'real' }),
      }),
      app: { bundleId: 'com.lambdatest.proverbial' },
    },
  ],
  workers: 1,
} satisfies E2EConfig;
```

`device` と `osVersion` は、TestMu AI のカタログの値と正確に一致させてください。
[capabilities generator](https://www.lambdatest.com/capabilities-generator) の表記に従い、
iOS 仮想デバイスは `18.0`、iOS 実機は `18`、Android は `14` などと指定します。
実機と仮想デバイスではカタログが異なります。

`app` は、TestMu AI が各セッションにインストールするビルドです。
`lt://` アプリ ID、`https` URL、またはローカルパスを指定します。
ローカルパスは `e2e.config.ts` のあるディレクトリを基準に解決され、アップロードされます。
Android では `.apk` または `.aab`、iOS シミュレーターでは zip 圧縮した `.app`、iOS 実機では署名済みの `.ipa` を使います。
ターゲットの `app.appPath` は指定せず、`app.open()` 用の `app.bundleId` は残してください。

<Accordion title="テストの例">

```ts title="tests/home.e2e.ts"

test('Proverbial home screen', async ({ app, screen }) => {
  await app.open();
  await expect(screen.getByText('Proverbial')).toBeVisible();
  // Android labels the button GEOLOCATION, iOS GeoLocation.
  await expect(screen.getByRole('button', /^geolocation$/i)).toBeVisible();
});
```
</Accordion>

## ブラウザで Web ターゲットを実行する

各ワーカースロットには、実行中専用の Chrome または Edge セッションが割り当てられます。
ローカル実行と同様に、各試行はそのセッション内の新しいブラウザコンテキストを使うため、
他のテストの Cookie、ストレージ、権限を参照することはありません。

Web エンジンとともに連携パッケージをインストールします。

<CodeGroup>
```bash npm
npm install --save-dev e2e @e2e-dev/web @e2e-dev/testmu
```

```bash pnpm
pnpm add -D e2e @e2e-dev/web @e2e-dev/testmu
```

```bash bun
bun add -d e2e @e2e-dev/web @e2e-dev/testmu
```
</CodeGroup>

ターゲットの `browser` に `testmuBrowsers()` を設定します。

```ts title="e2e.config.ts"

export default {
  targets: [
    {
      name: 'testmu-web',
      engine: web({ browser: testmuBrowsers(), viewport: null }),
      app: { url: 'https://staging.example.com' },
    },
  ],
} satisfies E2EConfig;
```

## デバイスのオプション

| オプション | デフォルト | 意味 |
| ------------- | --------------- | ------- |
| `device` | 必須 | TestMu AI のカタログに記載されたデバイス名（`'Galaxy S22 Ultra 5G'`、`'iPhone 16'`）。 |
| `osVersion` | 必須 | そのデバイスについてカタログに記載された OS バージョン。 |
| `app` | 必須 | TestMu AI がインストールするビルド。`lt://` アプリ ID、`https` URL、ローカルパスのいずれか。 |
| `deviceType` | `'virtual'` | エミュレーターやシミュレーターには `'virtual'`、実機には `'real'`。 |
| `project` | `'e2e'` | ダッシュボードでセッションをまとめるプロジェクト。 |
| `build` | 実行 ID | ダッシュボードでセッションをまとめるビルド。 |
| `sessionName` | `e2e-<run id>-<target>-<slot>` | ダッシュボード上のセッション名。ワーカースロットが複数ある場合は `-<slot>` が付加されます。 |
| `orientation` | デバイスの設定 | `'portrait'` または `'landscape'`。 |
| `geoLocation` | TestMu AI の設定 | デバイスの IP アドレスの位置情報に使う国コード（`'US'`）。 |
| `timezone` | デバイスの設定 | タイムゾーン（`'UTC+05:30'`）。 |
| `language` | デバイスの設定 | 言語コード（`'fr'`）。 |
| `locale` | デバイスの設定 | ロケール（`'fr_FR'`）。 |
| `appiumVersion` | TestMu AI の設定 | セッションの Appium バージョン（`'2.16.2'`）。 |

デバイスの機能はセッション開始時に設定され、そのセッション全体に適用されます。
不明なオプションや不正な値は、設定読み込み時に `INVALID_CONFIG` で失敗します。

## ブラウザのオプション

| オプション | デフォルト | 意味 |
| ------ | ------- | ------- |
| `browserName` | `'Chrome'` | `'Chrome'` または `'MicrosoftEdge'`。Web エンジンは CDP 経由で接続するため、他のブラウザを指定すると設定が失敗します。 |
| `capabilities` | なし | `browserName` と並べて送信される `browserVersion`、および TestMu AI の `LT:Options` フィールド。たとえば `platform`、`geoLocation`、`timezone`、`video`、`network`、または [TestMu AI Tunnel](https://www.lambdatest.com/support/docs/testing-locally-hosted-pages/) 用の `tunnel` と `tunnelName` です。 |

`capabilities` で指定しない限り、プロバイダーは `platform`（未指定では TestMu AI がセッションを拒否するため `Windows 11`）、
`build`（実行 ID）、`project`（`e2e`）、`idleTimeout`（600 秒）を送信します。
Edge セッションには、`capabilities` で指定しない限り、`browserOptions` に `--user-data-dir=remote-debug-profile-edge` が設定されます。
`user`、`accessKey`、`name` はプロバイダー自身が設定するため、`capabilities` にこれらを指定すると設定が `INVALID_CONFIG` で失敗します。
入れ子の `LT:Options`、`browserName`（専用のオプションを使ってください）、JSON で表現できない値、
スペルを誤った `testmuBrowsers()` オプションも同様です。
それ以外の `capabilities` キーは検証せずに TestMu AI に送信されます。

```ts
testmuBrowsers({
  browserName: 'MicrosoftEdge',
  capabilities: { browserVersion: '140', platform: 'Windows 10', build: `checkout ${process.env.GITHUB_SHA}`, video: true },
})
```

## セッションと動画を探す

デフォルトでは、ダッシュボードの各セッション名は `e2e-<run id>-<target>-<slot>` です。

[動画](https://e2e.com/docs/ja/reference/config#video)を記録する試行では、次を取得できます。

- **デバイスの場合**: `build` と `sessionName` から見つけた TestMu AI のセッション録画へのリンク。
  録画はセッション全体を含むため、同じワーカースロットの各試行は同じ動画にリンクします。
  固定の `build` と `sessionName` を共有する実行が重なると、別の実行の動画にリンクすることがあります。
  デフォルト値ではこの問題は起こりません。
- **ブラウザの場合**: ローカル実行と同様に、Web エンジンが取得するページのスクリーンキャスト。
  `capabilities: { video: true }` を渡すと、TestMu AI もセッションの画面を録画します。
  TestMu AI ダッシュボードで視聴できます。

## 制限

- **並列セッション。** `workers` と TestMu AI ターゲット数の積が、プランの並列セッション数を超えないようにしてください。
  プランの上限を超えるブラウザセッションは、TestMu AI のキューで待機します。
- **デバイスセッションは借り受けている間、課金されます。** デバイスセッションはスロットのリース時に開始し、準備には約 30〜75 秒かかります。
  テストが一度も実行されなくても、実行がデバイスを解放するまで課金されます。
- **デバイス使用中のランナー停止。** デバイスを解放する前にランナーが強制終了すると、セッションにコマンドを送るものがなくなります。
  TestMu AI の[アイドルタイムアウト](https://www.lambdatest.com/support/docs/desired-capabilities-in-appium/)
  （デフォルトは 120 秒）により、最後のコマンドから約 3 分後に終了します。
- **解放を確認できないと実行が失敗します。** agent-device がデバイスセッションの終了を確認できない場合、
  すべてのテストが成功していても、解放処理によって実行が失敗します。
  原因には、デーモンの強制停止、シャットダウンレポートの消失、実行中のデーモン終了があります。
  ダッシュボードでは `build` と `sessionName` でセッションを探してください。
- **デバイス設定とログ。** デバイス設定（権限、位置情報、ネットワーク、外観）、システムアラート、
  agent-device 経由の録画とデバイスログ、ポートリバースは利用できません。
  ログは TestMu AI ダッシュボードで確認し、ネットワーク内のサーバーへの接続には TestMu AI Tunnel を使ってください。
- **ブラウザ接続は最大 60 秒。** Web エンジンは、ブラウザセッションが CDP 接続を受け付けるまで最大 60 秒待ちます。
  `launchTimeout` が短ければ待機は早く終わりますが、長くしてもこの上限は延びません。
  それ以降もキュー待ちやプロビジョニング中のセッションは `LAUNCH_TIMEOUT` で失敗します。
  `launchTimeout` が 60 秒を超えている場合は `ENGINE_FAILURE` になります。
- **ブラウザ接続の切断。** ブラウザセッションは再開できないため、接続が切れると試行が失敗します。
- **ブラウザのダウンロード。** TestMu AI のブラウザは自身のマシンにダウンロードを保存するため、
  `browser.waitForDownload` は `ENGINE_FAILURE` で失敗します。代わりにダウンロードリンクやリクエストを検証してください。

## 次のステップ

<CardGroup cols={2}>
  <Card title="ホスト型デバイス" icon="mobile" href="/mobile#hosted-devices">
    デバイスプロバイダーのリースの仕組みを説明します。
  </Card>
  <Card title="ホスト型ブラウザ" icon="globe" href="/browser#hosted-browsers">
    ブラウザプロバイダーのリースの仕組みを説明します。
  </Card>
</CardGroup>
