テスト自動化

以下のエンドポイントを使用すると、テスト自動化機能をプログラムで利用できます。

クイックリファレンス

タイプ	リソース	説明
POST	/api/test_cases/run_requests	テストケースを実行します。
GET	/api/test_cases/run_requests/{id}	テストケースの実行状態を取得します。
GET	/api/recipes/{recipe_id}/test_cases	テストケースを取得します。

テストケースを実行する

このエンドポイントを使用してテストケースを実行します。以下の方法で実行するテストケースを指定できます：

• エクスポートマニフェスト内のすべてのレシピのすべてのテストケース
• プロジェクト内のすべてのレシピのすべてのテストケース
• フォルダ内のすべてのレシピのすべてのテストケース
• 特定のレシピに属するすべてのテストケース
• 指定したテストケース

このエンドポイントは非同期です。/api/test_cases/run_requests/{id}エンドポイントを使用して、リクエストの現在の状態をポーリングするために実行リクエストのidを使用できます。

POST /api/test_cases/run_requests

リクエストボディ

名前	タイプ	説明
manifest_id	integer オプション	指定したエクスポートマニフェスト内のすべてのレシピのテストケースを実行します。
project_id	integer オプション	指定したプロジェクト内のすべてのレシピのテストケースを実行します。ワークスペース内のすべてのプロジェクトのIDを取得するには、プロジェクトの一覧エンドポイントを使用します。
folder_id	integer オプション	指定したフォルダ内のすべてのレシピのテストケースを実行します。
recipe_id	integer オプション	指定したレシピのすべてのテストケースを実行します。
test_case_ids	string オプション	IDで指定した特定のテストケースを実行します。

サンプルリクエスト

curl  -X POST https://www.workato.com/api/test_cases/run_requests \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "manifest_id": "0"
          }'

サンプルレスポンス

{
  "data": {
    "id": "cirr-AHNFkza6-dwMArc",
    "status": "running",
    "user": {
      "id": 0
    },
    "created_at": "2023-06-01T01:40:00.000-07:00",
    "updated_at": "2023-06-01T01:40:00.000-07:00",
    "results": [
      {
        "recipe": {
          "id": 0,
          "name": "string"
        },
        "test_case": {
          "id": "citc-AG48N4xo-g6ccgP",
          "name": "string"
        },
        "job": {
          "id": "j-AHNFpnRa-sMWLYJ"
        },
        "status": "pending"
      }
    ]
  }
}

テストケースの実行状態を取得する

テストケースの実行状態を取得します。完了したリクエストの場合、Workatoは結果とともにテストカバレッジデータも返します。

GET /api/test_cases/run_requests/{id}

URLパラメータ

名前	タイプ	説明
id	string 必須	実行リクエストのID。

サンプルリクエスト

curl  -X GET https://www.workato.com/api/test_cases/run_requests/{id} \
      -H 'Authorization: Bearer <api_token>' 

サンプルレスポンス

{
  "data": {
    "id": "cirr-AHNFkza6-dwMArc",
    "status": "completed",
    "user": {
      "id": 0
    },
    "created_at": "2023-06-01T01:40:00.000-07:00",
    "updated_at": "2023-06-01T01:40:00.000-07:00",
    "coverage": {
      "value": 87.5,
      "total_actions_count": 8,
      "total_visited_actions_count": 7,
      "recipes": [
        {
          "id": 0,
          "version_no": 0,
          "coverage": {
            "value": 87.5,
            "not_visited_actions": [
              {
                "step_number": 4
              }
            ]
          }
        }
      ]
    },
    "results": [
      {
        "recipe": {
          "id": 0,
          "name": "string"
        },
        "test_case": {
          "id": "citc-AG48N4xo-g6ccgP",
          "name": "string"
        },
        "job": {
          "id": "j-AHNFpnRa-sMWLYJ"
        },
        "status": "succeeded"
      }
    ]
  }
}

テストケースを取得する

指定したレシピに属するテストケースのコレクションを返します。

GET  /api/recipes/{recipe_id}/test_cases

URLパラメータ

名前	タイプ	説明
recipe_id	integer 必須	テストケースの詳細を取得するレシピのID。

サンプルリクエスト

curl  -X GET https://www.workato.com/api/recipes/{recipe_id}/test_cases \
      -H 'Authorization: Bearer <api_token>'

サンプルレスポンス

{
  "data": [
    {
      "id": "citc-AG48N4xo-g6ccgP",
      "created_at": "2023-06-01T01:40:00.000-07:00",
      "updated_at": "2023-06-01T01:40:00.000-07:00",
      "description": "string",
      "name": "string"
    }
  ]
}