教學課程:使用置信度測試套件中的可信度測試 - AWS IoT Greengrass

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

教學課程:使用置信度測試套件中的可信度測試

AWS IoT Greengrass測試框架(GTF)和 Greengrass 開發工具包(GDK)為開發人員提供了運行測試的方法。 end-to-end 您可以完成本教程來初始化 GDK 項目與組件,初始化 GDK 項目與 end-to-end 測試模塊,並使用從可信度測試套件的置信度測試。在構建自定義測試用例後,您可以運行測試。

置信度測試是 Greengrass 提供的通用測試,用於驗證基本組件行為。這些測試可以進行修改或擴展,以滿足更具體的組件需求。

在本教程中,我們將使用一個 HelloWorld 組件。如果您正在使用其他元件,請用您的 HelloWorld 元件取代該元件。

在此教學課程中,您將執行下列操作:

  1. 使用元件初始化 GDK 專案。

  2. 使用 end-to-end 測試模塊初始化 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 步:使用 end-to-end測試模塊初始化 GDK 項目

  • GDK 使您能夠下載由功能和步驟實現組成的測試模塊模板。運行以下命令來打開HelloWorld目錄,並使用測試模塊初始化現有的 GDK 項目。

    cd HelloWorld gdk test-e2e init

    這個命令會在目錄中建立一gg-e2e-tests個名為的新HelloWorld目錄。這個測試目錄是一個 Maven 項目,它對 Greengrass 測試獨立 JAR 的依賴關係。

步驟 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文件,以使用在步驟 4 中指定的ConfidenceTest標籤或任何標籤 yo8u 定位測試。使用以下命令更新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 核的最新版本,並使用它執行測試。此命令也只針對具有ConfidenceTest標籤的案例,並產生這些案例的報表。您將看到在此測試期間創建的AWS資源在測試結束時被丟棄。

範例:使用可信度測試

在 GDK 項目下載的測試模塊由提供的功能文件。

在下列範例中,我們使用功能檔案來測試 Greengrass 軟體的物件部署功能。我們使用透過 Greeng AWS 雲端 rass 執行元件部署的案例來部分測試此功能的功能。這是一系列步驟,可協助我們瞭解此使用案例的互動和預期結果。

  • 使用提供的功能文件。

    導覽至目前目錄中的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

    每個測試案例都在每個可信度測試的頂部進行描述。該方案是一系列的步驟,有助於理解每個測試用例的交互和預期結果。您可以通過添加自己的步驟或修改現有步驟來擴展這些測試。每個案例都包含可協助您進行這些調整的註解。