Google Home テストスイート

Cloud-to-cloud    Local Home SDK

Google Home Test Suite は、スマートホーム アクションのセルフテストを行うためのウェブ アプリケーションです。Test Suite は、アカウントに関連付けられているデバイスとトレイトに基づいて、テストケースを自動的に生成して実行します。テストが完了したら、テスト結果を表示するか、送信フォームに入力してテスト結果を Google に送信できます。

Test Suite によって実行されるテストには次のものがありますが、これらに限定されません。

  • デバイスとトレイトに Report StateRequest Sync が実装されていることを確認します。

  • デバイスに QUERY インテントが実装されていること、その結果が Report State の結果と一致することを検証します。

下のボタンをクリックすると、Test Suite ツールを起動できます。

Test Suite を起動

アクションのセルフテスト

次のセクションでは、デバイスとスマートホーム アクション プロジェクトで Test Suite を実行する方法について説明します。Test Suite では、Google Home Graph 内のデバイスを検査して Google Assistant に直接コマンドを送信するために、ログインが必要です。

アクションをセルフテストする手順は次のとおりです。

  1. ウェブブラウザで Test Suite を開きます。
  2. 右上のボタンから Google にログインします。

  3. [Project Details](プロジェクトの詳細)を設定します。

    1. [プロジェクト ID] フィールドに、スマートホーム アクションのプロジェクト ID を入力します。
    2. [次へ] をクリックします。
  4. [Test Settings](テスト設定)を構成します。

    1. スマートホーム アクションを認定する場合は、デフォルトの Report State / Request Sync Timeout 値をそのまま使用します。ただし、エージェントがホームグラフに状態を報告するのに時間がかかる場合は、テスト目的でタイムアウト値を変更できます。
    2. スマートホーム アクションを認定する場合は、[Test Request Sync](Request Sync のテスト)オプションが有効になっていることを確認します。テスト中は、デバイスを追加、更新、削除して、ホームグラフでデバイスリストが変更されたかどうかを確認するよう求めるメッセージが表示されます。変更アクションは、テスト対象の統合を介して行われます。テスト対象の統合では、エージェント ユーザーに常に 1 つ以上のデバイスが接続されている必要があります。

    3. Scene トレイトを使用している場合は、[Test Scene trait] を選択します。

    4. ローカルホーム デバイスのテストスイートを実行する場合は、[Supports Local Home SDK] を選択します。

      1. [ローカル フルフィルメント] または [シームレス連携のセットアップ] を選択します。
      2. デバイスが QUERY インテントをローカルで処理できる場合は、[Supports Local Query] をクリックします。
  5. [Test Run](テスト実行)を実行して結果を表示します。

    1. [Next] をクリックして、テストの実行を開始します。インターフェースにテスト対象のデバイスとトレイトが表示されます。
  6. [Results & Submission](結果と送信)ページを表示します。

    1. テストが完了したら、[Next] をクリックして結果を表示します。

テスト結果には、成功したテストと失敗したテストの件数、および成功率(%)を示す最終スコアが表示されます。

アカウントのリンクの検証テスト

アカウントのリンクは、Google スマートホーム エコシステムで重要な役割を果たします。Test Suite のアカウント リンク検証テストでは、OAuth サービスに問題がないかどうかチェックされます。

アカウント リンクの検証テストには、アクセス トークン更新トークンを検証するテストが含まれます。

アクセス トークンの検証テスト

トークン交換エンドポイントから返されたアクセス トークンがテストされ、有効な形式であること、有効な更新トークンとともに返されることが確認されます。

テスト項目 解説
アクセス トークンが JWT 形式かどうかを確認する Google アカウントのリンクでは、JWT 形式のアクセス トークンは推奨されません。JWT 形式が見つかった場合は、The access token seems to be JWT, this is not good. Because it unnecessarily exposes information about partner implementation and we recommend opaque symmetric encrypted access token. という警告が表示されます。
有効期限のあるアクセス トークンに更新トークンが含まれていることを確認します。 アクセス トークンの有効期限が切れた場合は、更新トークンを指定する必要があります。更新トークンが見つからない場合、このテストは失敗します。

更新トークン検証テスト

更新トークンをテストし、トークン交換エンドポイントがトークンを新しいアクセス トークンと適切に交換していることを確認します。

テスト項目 解説
無効な更新トークンでトークンを更新しており、パートナー レスポンスを確認しています。 サーバーは、無効な更新トークン リクエストに対して、HTTP 400 Bad Request エラー({"error": "invalid_grant"})を返す必要があります。 レスポンスが「エラーコードまたはメッセージ」と一致しない場合、このテストケースは失敗します。詳しくは、 更新トークンをアクセス トークンと交換するをご覧ください。
トークンの更新後にアクセス トークンが更新されたかどうかをテストします。 更新トークンのリクエストに応じて、新しいアクセス トークンを返す必要があります。サーバーが同じアクセス トークンを提供すると、テストケースは失敗します。
有効期限内のアクセス トークンが引き続き有効かどうかを確認します。 アクセス トークンの有効期限が表示されます。
更新中に更新トークンがローテーションされたかどうかを確認します。 更新トークンのリクエスト後に更新トークンが変更されたかどうかを確認します。更新トークンが変更された場合、ユーザーのアカウントのリンクが中断する可能性のある競合状態を防ぐため、サーバーは、新しい更新トークンが使用された後にのみ古い更新トークンを無効にするようにします。新しい更新トークンを使用する前に古い更新トークンを無効化すると、テストは失敗します。

エラー メッセージ

次の表は、一般的なエラー メッセージと、推奨される解決方法を示します。

エラー メッセージ 解決方法
HomeGraph API has not been used in project <_id_> before or it is disabled(HomeGraph API がこれまでプロジェクト <_id_> で使用されたことがないか、または無効になっています) HomeGraph API が有効になっていることを確認します。
Requested Entity not found(要求されたエンティティが見つかりません) agentUserId が有効であり、サービスにリンクされていることを確認してください。

プロジェクト ${your project id} に対する resourcemanager.projects.get 権限と、同意画面ですべての権限を付与していることを確認します。

モジュール データの取得中にエラーが発生しました: getModuleData error: HTTP 失敗レスポンス for https://hometestsuiteproxy-pa.googleapis.com/v1/module:get: 403 OK 403

  1. IAM 権限のトラブルシューティングの手順に沿って、アカウントにプロジェクトの resourcemanager.projects.get 権限があることを確認します。
  2. [アカウントにアクセスできるアプリ] ページに移動して、[スマートホーム用のテストスイート] に関する次の権限を確認します。
    • アカウントの基本情報
      1. Google アカウントのメインのメールアドレスを表示する
      2. ユーザーの個人情報(一般公開した個人情報を含む)の参照
    • 追加のアクセス権
      1. Assistant の使用: Google アカウントへの幅広いアクセス
      2. ホームグラフでのスマートホーム デバイスの確認と操作
    権限エラーが発生した場合は、まずアクセス権を削除し、再度ログインする際に同意画面ですべての権限を付与します。

テスト結果の送信

認定フォームを送信する前に、Test Suite の結果が 100% のテストに合格する必要があります。手動テストが必要なトレイトがある場合、100% で合格していなくても、Test Suite ツールを実行して結果をアタッチする必要があります。

テスト結果を送信し、スマートホーム アクションを認定する手順は次のとおりです。

  1. テスト結果を受け取り、スマートホーム アクションを認定する準備が整ったら、Test Suite ツールで [Submit] をクリックします。
  2. [DOWNLOAD TEST RESULTS](テスト結果のダウンロード)ボタンをクリックして、テスト結果を取得します。
  3. テスト結果を Google に送信するには、[GO TO SUBMISSION FORM](送信フォームに移動)をクリックします。
  4. すべての必須フィールドに入力してから、[Submit] をクリックします。