API

FrontTesterが提供するAPI一覧です。
APIはSDK Portalでproxyされており、https://portal-{your_env_id}.sdk-lab.qmonus.net/apis/e2eに下記のpathでリクエストすることで、外部からの試験実行、状態確認が可能です。
なお、実行にはSDK Portalで認証を取る必要があります。

POST /

GET /scenarios

GET /status

GET /status/:id

GET /statuslist

GET /history

GET /tools

GET /evidences/:id

DELETE /status/:id

---

POST /

試験の実行が可能です。
requestbodyにはindex.jsonで記述する内容を記載してください。
scenarioで指定する値は、実行環境に試験ディレクトリとして存在する必要があります。
試験ディレクトリに関してはディレクトリ構成を確認ください。
requestbody例：

{
    "scenario": "001sample",     #required
    "description": "",
    "params": {                  #required
        # ...
    },
    "options": {                 #required
        # ...
    }
}

responsebody例：

{
    "id": 1665124385435,
    "lastAccess": 1665124385435,
    "scenario": "001sample",
    "description": "",
    "modulePath": "",
    "start": null,
    "end": null,
    "current": -1,
    "steps": 0,
    "params": {
        # ...
    },
    "options": {
        # ...
    },
    "snapshots": [],
    "results": {},
    "logging": "",
    "error": null,
    "status": "waiting",
    "currentScenario": ""
}

GET /scenarios

試験ディレクトリとしてマウントされているディレクトリのindex.jsonを返却します。
responsebody例：

[
    {
        "description": "",
        "paramSchema": {
            "type": "object",
            "properties": {}
        },
        "params": {
            # ...
        },
        "defaultOptions": {
            # ...
        },
        "id": "001sample"
    },
    ....
]

GET /status

実行された試験のstatusの取得が可能です。
700件以上の取得はできません。必要に応じてstartで取得数を変更してください。
query startsを指定することで、指定時間以降で変化があった試験のみのデータを取得可能です。
query例：
1665124919427以降に更新されたデータを取得する場合

?start=1665124919427

responsebody例：

[
    {
        "error": null,
        "logging": "",
        "id": "1665124385435",
        "params": {
            # ...
        },
        "scenario": "001sample",
        "lastAccess": "1665124394451",
        "snapshots": [],
        "pid": "1064",
        "status": "processing",
        "description": "",
        "start": "Fri Oct 07 2022 06:33:14 GMT+0000 (協定世界時)",
        "results": {},
        "end": null,
        "modulePath": "/var/plugins/...",
        "options": {
            # ...
        },
        "currentScenario": "00_login.js",
        "current": -1,
        "steps": 5
    }
]

GET /status/:id

idで指定した試験のstatusの取得が可能です。
responsebody例：

[
    {
        "error": null,
        "logging": "",
        "id": "1665124385435",
        "params": {
            # ...
        },
        "scenario": "001sample",
        "lastAccess": "1665124394451",
        "snapshots": [],
        "pid": "1064",
        "status": "processing",
        "description": "",
        "start": "Fri Oct 07 2022 06:33:14 GMT+0000 (協定世界時)",
        "results": {},
        "end": null,
        "modulePath": "/var/plugins/...",
        "options": {
            # ...
        },
        "currentScenario": "00_login.js",
        "current": -1,
        "steps": 5
    }
]

GET /statuslist

実行した試験のid一覧が取得可能です。
responsebody例：

["1665124385435","1665124390000"]

GET /history

実行された試験のstatusの取得が可能です。
クエリ：

	クエリ名	型	説明
1	limit	Number	結果取得数。
2	offset	Number	データ取得offset(最新を0)
3	from	Number	取得開始位置 (UNIX時間)
3	to	Number	取得終了位置 (UNIX時間)

responsebody例：

[
    {
        "error": null,
        "logging": "",
        "id": "1665124385435",
        "params": {
            # ...
        },
        "scenario": "001sample",
        "lastAccess": "1665124394451",
        "snapshots": [],
        "pid": "1064",
        "status": "processing",
        "description": "",
        "start": "Fri Oct 07 2022 06:33:14 GMT+0000 (協定世界時)",
        "results": {},
        "end": null,
        "modulePath": "/var/plugins/...",
        "options": {
            # ...
        },
        "currentScenario": "00_login.js",
        "current": -1,
        "steps": 5
    }
]

GET /tools

ローカル試験ランナーをzipでダウンロードできます。

GET /evidences/:id

指定したidの試験結果をzipでダウンロードできます。

DELETE /status/:id

idを指定して試験をkillすることができます。