テストAutomation
次のエンドポイントを使用すると、テスト自動化機能をプログラムで使用できます。
レート制限
テスト自動化リソースには、次のレート制限があります:
| タイプ | リソース | 制限 |
|---|---|---|
| すべて | すべてのテスト自動化エンドポイント | 1分あたり60リクエスト |
クイックリファレンス
| タイプ | リソース | 説明 |
|---|---|---|
| POST | /api/test_cases/run_requests | テストケースを実行します。 |
| GET | /api/test_cases/run_requests/{id} | テストケース実行リクエストの現在の状態を取得します。 |
| GET | /api/recipes/{recipe_id}/test_cases | テストケースを取得します。 |
テストケースの実行
このエンドポイントを使用してテストケースを実行します。 実行するテストケースは、次の方法で指定できます:
- マニフェスト内のすべてのレシピのすべてのテストケース
- プロジェクト内のすべてのレシピのすべてのテストケース
- フォルダ内のすべてのレシピのすべてのテストケース
- 特定のレシピに属するすべてのテストケース
- 指定したテストケース
このエンドポイントは非同期です。 実行リクエストのidを使用して、/api/test_cases/run_requests/{id}エンドポイントでリクエストの現在の状態をポーリングできます。
POST /api/test_cases/run_requestsリクエスト本文
| 名前 | 型 | 説明 |
|---|---|---|
| manifest_id | 整数 任意 | 指定したエクスポートマニフェスト内のすべてのレシピのテストケースを実行します。 |
| project_id | 整数 任意 | 指定したプロジェクト内のすべてのレシピのテストケースを実行します。 ワークスペース内のすべてのプロジェクトのIDを取得するには、プロジェクトの一覧表示エンドポイントを使用します。 |
| folder_id | 整数 任意 | 指定したフォルダ内のすべてのレシピのテストケースを実行します。 |
| recipe_id | 整数 任意 | 指定したレシピのすべてのテストケースを実行します。 |
| test_case_ids | 文字列の配列 任意 | 特定のテストケースをIDで実行します。 |
サンプルリクエスト
shell
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"
}'サンプルレスポンス
json
{
"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 | 文字列 必須 | 実行リクエストのID。 |
サンプルリクエスト
shell
curl -X GET https://www.workato.com/api/test_cases/run_requests/{id} \
-H 'Authorization: Bearer <api_token>'サンプルレスポンス
json
{
"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_casesURLパラメーター
| 名前 | 型 | 説明 |
|---|---|---|
| recipe_id | 整数 必須 | テストケースの詳細を取得するレシピのID。 |
サンプルリクエスト
shell
curl -X GET https://www.workato.com/api/recipes/{recipe_id}/test_cases \
-H 'Authorization: Bearer <api_token>'サンプルレスポンス
json
{
"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"
}
]
}Last updated: