カスタムアプリケーションのテストとデバッグ test-debug-custom-worker

カスタムアプリケーションのユニットテストの実行 test-custom-worker

Docker Desktop をコンピューターにインストールします。カスタムワーカーをテストするには、アプリケーションのルートで次のコマンドを実行します。

$ aio app test

これにより、以下で説明するように、プロジェクト内の Asset Compute アプリケーションアクションに対するカスタムユニットテストフレームワークが実行されます。これは package.json ファイル内の設定を通じて接続されます。また、Jest などの JavaScript ユニットテストをおこなうこともできます。aio app test では両方を実行します。

aio-cli-plugin-asset-compute プラグインは、カスタムアプリケーションに開発依存コンポーネントとして組み込まれているので、ビルド／テストシステムにインストールする必要はありません。

アプリケーションユニットテストフレームワーク unit-test-framework

Asset Compute アプリケーションのユニットテストフレームワークを使用すると、コードを書かずにアプリケーションをテストできます。アプリケーションのソースからレンディションへのファイル原則を利用します。テストソースファイル、オプションパラメーター、期待されるレンディション、カスタム検証スクリプトを含んだテストケースを定義するには、特定のファイルおよびフォルダー構造を設定する必要があります。デフォルトでは、レンディションのバイト等価性が比較されます。さらに、単純な JSON ファイルを使用して外部 HTTP サービスのモックを容易に作成できます。

テストの追加 add-tests

テストは、Adobe I/O プロジェクトのルートレベルにある test フォルダーに含まれている必要があります。各アプリケーションのテストケースは、パス test/asset-compute/<worker-name> 内にテストケースごとに 1 つのフォルダーとして配置する必要があります。

action/
manifest.yml
package.json
...
test/
  asset-compute/
    <worker-name>/
        <testcase1>/
            file.jpg
            params.json
            rendition.png
        <testcase2>/
            file.jpg
            params.json
            rendition.gif
            validate
        <testcase3>/
            file.jpg
            params.json
            rendition.png
            mock-adobe.com.json
            mock-console.adobe.io.json

いくつかの例については、カスタムアプリケーションの例を参照してください。以下に詳細を説明します。

テスト出力 test-output

カスタムアプリケーションのログを含めた詳細なテスト出力は、aio app test の出力で示されているように、Adobe Developer App Builder アプリのルートの build フォルダーで使用できます。

モック用外部サービス mock-external-services

テストケースで mock-<HOST_NAME>.json ファイルを定義すると、アクション内で外部サービス呼び出しのモックを作成できます。ここで、HOST_NAME はモックを作成するホストです。ユースケースの例としては、S3 を個別に呼び出すアプリケーションがあります。新しいテスト構造は次のようになります。

test/
  asset-compute/
    <worker-name>/
      <testcase3>/
        file.jpg
        params.json
        rendition.png
        mock-<HOST_NAME1>.json
        mock-<HOST_NAME2>.json

モックファイルは、JSON 形式の http 応答です。詳しくは、こちらのドキュメントを参照してください。モック作成対象のホスト名が複数ある場合は、複数の mock-<mocked-host>.json ファイルを定義します。以下は、mock-google.com.json という名前の、google.com のサンプルモックファイルです。

[{
    "httpRequest": {
        "path": "/images/hello.txt"
        "method": "GET"
    },
    "httpResponse": {
        "statusCode": 200,
        "body": {
          "message": "hello world!"
        }
    }
}]

worker-animal-pictures サンプルには、やり取りするウィキメディアサービスのモックファイルが含まれています。

テストケース間でのファイルの共有 share-files-across-test-cases

複数のテスト間で file.*、params.json、validate のいずれかのスクリプトを共有する場合は、相対的なシンボリックリンクを使用することをお勧めします。これらは Git でサポートされます。共有ファイルには異なる名前をつけることもあるので、必ず一意の名前を付けてください。以下の例では、いくつかの共有ファイルとテスト自体のファイルを組み合わせています。

tests/
    file-one.jpg
    params-resize.json
    params-crop.json
    validate-image-compare

    jpg-png-resize/
        file.jpg    - symlink: ../file-one.jpg
        params.json - symlink: ../params-resize.json
        rendition.png
        validate    - symlink: ../validate-image-compare

    jpg2-png-crop/
        file.jpg
        params.json - symlink: ../params-crop.json
        rendition.gif
        validate    - symlink: ../validate-image-compare

    jpg-gif-crop/
        file.jpg    - symlink: ../file-one.jpg
        params.json - symlink: ../params-crop.json
        rendition.gif
        validate

予期されるエラーのテスト test-unexpected-errors

エラーテストケースには、予期される rendition.* ファイルを含めず、予期される errorReason を params.json ファイル内で定義してください。

エラーテストケースの構造：

<error_test_case>/
    file.jpg
    params.json

エラー理由を含んだパラメーターファイル：

{
    "errorReason": "SourceUnsupported",
    // ... other params
}

エラー理由の一覧と説明については、Asset Compute のエラー理由を参照してください。

カスタムアプリケーションのデバッグ debug-custom-worker

次の手順は、Visual Studio Code を使用したカスタムアプリケーションのデバッグ方法を示しています。ライブログの確認、ブレークポイントのヒット、コードのステップスルー、ローカルコード変更のライブ再読み込みをアクティベーションのたびにおこなうことができます。

これらの手順の多くは通常、初期設定では aio で自動的に実行されます。詳しくは、Adobe Developer App Builder ドキュメントのアプリケーションのデバッグの節を参照してください。現時点では、以下の手順には回避策が含まれています。

コードの変更内容はすべてリアルタイムで読み込まれ、次回アクティベーションがおこなわれるとすぐに有効になります。