チュートリアル: 信頼度テストスイートからの信頼度テストを使用する - AWS IoT Greengrass

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

チュートリアル: 信頼度テストスイートからの信頼度テストを使用する

AWS IoT Greengrass テストフレームワーク (GTF) と Greengrass Development Kit (GDK) は、開発者がend-to-endのテストを実行する方法を提供します。このチュートリアルでは、コンポーネントで GDK プロジェクトを初期化し、エンドツーエンドのテストモジュールで GDK プロジェクトを初期化し、信頼度テストスイートの信頼度テストを使用します。カスタムテストケースの作成後、テストを実行できます。

信頼度テストは、Greengrass が提供する一般的なテストで、基本的なコンポーネントの動作を検証します。これらのテストは、より具体的なコンポーネントニーズに合わせて変更または拡張できます。

このチュートリアルでは、HelloWorld コンポーネントを使用します。別のコンポーネントを使用する場合は、HelloWorld コンポーネントを自分のコンポーネントに置き換えます。

このチュートリアルでは、以下の作業を行います。

  1. GDK プロジェクトをコンポーネントで初期化します。

  2. エンドツーエンドのテストモジュールで GDK プロジェクトを初期化します。

  3. 信頼度テストスイートからのテストを使用します。

  4. 新しいテストケースにタグを追加します。

  5. テスト JAR をビルドします。

  6. テストを実行します。

前提条件

このチュートリアルを完了するには、以下が必要です。

  • GDK バージョン 1.6.0 以降

  • Java

  • Maven

  • Git

ステップ 1: GDK プロジェクトをコンポーネントで初期化する

  • 空のフォルダーを GDK プロジェクトで初期化します。以下のコマンドを実行して Python で実装された HelloWorld コンポーネントをダウンロードします。

    gdk component init -t HelloWorld -l python -n HelloWorld

    このコマンドで、現在のディレクトリに HelloWorld という名前の新しいディレクトリが作成されます。

ステップ 2: エンドツーエンドのテストモジュールで GDK プロジェクトを初期化する

  • GDK を使用して、テストモジュールテンプレートをダウンロードできます。このテンプレートには、特定の機能とステップの実装が含まれています。以下のコマンドを実行して HelloWorld ディレクトリを開き、テストモジュールを使用して既存の GDK プロジェクトを初期化します。

    cd HelloWorld gdk test-e2e init

    このコマンドで、HelloWorld ディレクトリに gg-e2e-tests という名前の新しいディレクトリが作成されます。このテストディレクトリは Greengrass のテスト用スタンドアロン JAR に依存する Maven プロジェクトです。

ステップ 3: 信頼度テストスイートからのテストを使用する

提供された機能ファイルを使用する信頼度テストケースを書き、必要に応じてシナリオを変更します。信頼度テストの使用例については、「例: カスタムテストケースを構築する」を参照してください。信頼度テストを使用するには、次のステップを使用します。

  • 提供された機能ファイルを使用します。

    現在のディレクトリの gg-e2e-tests/src/main/resources/greengrass/features フォルダーに移動します。サンプル confidenceTest.feature ファイルを開き、信頼度テストを使用します。

ステップ 4 : 新しいテストケースにタグを追加する

  • 機能やシナリオにタグを割り当てて、テストプロセスを整理できます。タグを使用してシナリオのサブセットを分類したり、実行するフックを条件付きで選択したりできます。機能とシナリオには、スペースで区切ることで複数のタグを付けることができます。

    この例では、HelloWorld コンポーネントを使用します。

    各シナリオには @ConfidenceTest がタグ付けされています。テストスイートのサブセットのみを実行する場合は、タグを変更または追加します。各テストシナリオは、各信頼度テストの上部に記載されています。このシナリオは、各テストケースのインタラクションと期待される結果を理解するのに役立つ一連のステップです。これらのテストは、独自のステップを追加するか、既存のステップを変更することで拡張できます。

    @ConfidenceTest Scenario: As a Developer, I can deploy GDK_COMPONENT_NAME to my device and see it is working as expected ....

ステップ 5: テスト JAR を構築する

  1. コンポーネントを構築します。テストモジュールを構築する前に、コンポーネントを構築する必要があります。

    gdk component build
  2. 次のコマンドを使用してテストモジュールを構築します。このコマンドは、greengrass-build フォルダーにテスト用 JAR を構築します。

    gdk test-e2e build

ステップ 6 : テストを実行する

信頼度テストを実行すると、GTF はテスト中に作成されたリソースを管理するとともに、テストのライフサイクルを自動化します。まず、テスト対象デバイス (DUT) を AWS IoT モノとしてプロビジョニングし、Greengrass コアソフトウェアをインストールします。次に、そのパスで指定されたレシピを使用して HelloWorld という名前の新しいコンポーネントを作成します。その後、HelloWorld コンポーネントは Greengrass デバイスデプロイメントを通じてコアデバイスにデプロイされます。その後、デプロイが成功したかどうかが検証されます。デプロイが成功すると 3 分以内にデプロイステータスが COMPLETED に変わります。

  1. プロジェクトディレクトリ内の gdk-config.json ファイルに移動し、ConfidenceTest タグまたはステップ 4 で指定したタグをもつテストをターゲットにします。次のコマンドを使用して、test-e2e キーをアップデートします。

    "test-e2e":{ "gtf_options" : { "tags":"ConfidenceTest" } }
  2. テストを実行する前に、ホストデバイスに AWS 認証情報を指定する必要があります。GTF は、テストプロセス中にこれらの認証情報を使用して AWS リソースを管理します。指定したロールに、テストに含まれる必要な操作を自動化する権限があることを確認してください。

    認証情報を指定するには、次のコマンドを実行します AWS 。

    1. Linux or Unix
      export AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE export AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
      Windows Command Prompt (CMD)
      set AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE set AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
      PowerShell
      $env:AWS_ACCESS_KEY_ID="AKIAIOSFODNN7EXAMPLE" $env:AWS_SECRET_ACCESS_KEY="wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
  3. 次のコマンドを使用してテストを実行します。

    gdk test-e2e run

    このコマンドは、greengrass-build フォルダーにある Greengrass nucleus の最新バージョンをダウンロードし、それを使用してテストを実行します。また、このコマンドは、ConfidenceTest タグを持つシナリオのみをターゲットにし、それらのシナリオのレポートを生成します。このテスト中に作成された AWS リソースは、テストの終了時に破棄されます。

例: 信頼度テストを使用する

GDK プロジェクトにダウンロードされたテストモジュールは、サンプル機能ファイルで構成されています。

以下の例では、Greengrass ソフトウェアのデバイスデプロイ機能をテストするための機能ファイルを使用します。Greengrass  AWS クラウド を介してコンポーネントをデプロイするシナリオを使用して、この機能の機能を部分的にテストします。これは、このユースケースの相互作用と期待される結果を理解するのに役立つ一連のステップです。

  • 提供された機能ファイルを使用します。

    現在のディレクトリの gg-e2e-tests/src/main/resources/greengrass/features フォルダーに移動します。次の例のような confidenceTest.feature サンプルがあります。

    Feature: Confidence Test Suite Background: Given my device is registered as a Thing And my device is running Greengrass @ConfidenceTest Scenario: As a Developer, I can deploy GDK_COMPONENT_NAME to my device and see it is working as expected When I create a Greengrass deployment with components | GDK_COMPONENT_NAME | GDK_COMPONENT_RECIPE_FILE | | aws.greengrass.Cli | LATEST | And I deploy the Greengrass deployment configuration Then the Greengrass deployment is COMPLETED on the device after 180 seconds # Update component state accordingly. Possible states: {RUNNING, FINISHED, BROKEN, STOPPING} And I verify the GDK_COMPONENT_NAME component is RUNNING using the greengrass-cli

    各テストシナリオは、各信頼度テストの上部に記載されています。このシナリオは、各テストケースのインタラクションと期待される結果を理解するのに役立つ一連のステップです。これらのテストは、独自のステップを追加するか、既存のステップを変更することで拡張できます。各シナリオには、これらの調整に役立つコメントが含まれています。