icon
Start

CI/CD

実行API

RakAPItはテストケース・Scenario実行APIを提供しております。実行APIに必要な情報は下記の通りです。

  • テストケース実行

    REQUEST

    • Method: POST
    • Endpoint: https://rakapit-run-api.dockyard.biz
    • Header:
      • Content-Type: application/json
      • Authorization: [Access Token]
        ※ Access Tokenは「My profile」の「CI/CD Setting - Access Token」欄で確認してください。
    • Body:
      • projectId: string
        ※ ProjectIdはこのような取得する

        Get_ProjectId
        ProjectId取得

      • testObjectId: string
        ※ TestObjectIdはこのような取得する

        Get_TestObjectId
        TestObjectId取得

      • runTestCase: object
        ※ ここで実行したいテストケースを指定します。テストケースを指定するには、４つの方法があります。
        • Test Suite Idを指定する場合:
          runTestCase.testSuiteIdList: integer array

          Get_SuiteId
          SuiteId取得

          Example: 
          {
  "projectId": "xxxxxxxxxxxxxxx",
  "testObjectId": "xxxxxxxxxxxxx",
  "runTestCase": {
    "testSuiteIdList": [
      0,
      1
    ]
  }
}
        • Test Case Idを指定する場合:
          runTestCase.testCaseIdList: integer array

          Get_TestcaseId
          TestCaseId取得

          Example: 
          {
  "projectId": "xxxxxxxxxxxxxxx",
  "testObjectId": "xxxxxxxxxxxxx",
  "runTestCase": {
    "testCaseIdList": [
      0,
      1
    ]
  }
}
        • Response Codeを指定する場合:
          runTestCase.responseCodeList: integer array

          Get_ResponseCode
          Response Code取得

          Example: 
          {
  "projectId": "xxxxxxxxxxxxxxx",
  "testObjectId": "xxxxxxxxxxxxx",
  "runTestCase": {
    "responseCodeList": [
      200,
      400
    ]
  }
}
        • 範囲を指定する場合:
          runTestCase.from: integer
          runTestCase.to: integer

          Example: 
          {
  "projectId": "xxxxxxxxxxxxxxx",
  "testObjectId": "xxxxxxxxxxxxx",
  "runTestCase": {
    "from": 1,
    "to": 50
  }
}

    RESPONSE

    • テストケース実行が正常に開始された場合
      Status: Success - Status Code: 200
      Example: 
      {
  "status": "Success",
  "detail": "Start running Test case(s). Please wait a few minutes!",
  "requestId": [requestId]
}
    • 同Test Objectで他のテストケースが実行されている場合:
      Status: Failed - Status Code: 400
      Example: 
      {
  "status": "Failed",
  "detail": "There are some Test cases running in this Test Object. 
   Please wait for it to finish then get data again."
}
    • 何らかの原因によりテストケースが実行できない場合
      Status: Failed - Status Code: 400/500
      Example: 
      {
  "status": "Failed",
  "detail": [error detail]
}

結果取得API

RakAPIt結果取得APIを用いて、リクエストしたテストケース実行の結果を取得することができます。その際、RakAPIt実行APIで返却されたrequestIdが必要です。

  • テストケース結果

    REQUEST

    • Method: GET
    • Endpoint:https://rakapit-run-api.dockyard.biz?requestId={requestId}
    • Header:
      • Content-Type: application/json
      • Authorization: [Access Token]
        ※Access Tokenは「My profile」の「CI/CD Setting - Access Token」欄で確認してください。
    • URL param:
      • requestId: string
        requestIdはRakAPIt実行APIで返却されたレスポンスで確認することができます。

    RESPONSE

    • 実行が完了した場合
      Status: Success - Status Code: 200
      Example: 
      {
  "status": "Finish",
  "detail": "Get data successfully!",
  "data": [data]
}
    • テストケース実行が進行中の場合:
      Status: Running - Status Code: 419
      Example: 
      {
  "status": "Running",
  "detail": "There are some Test cases running in this Test Object. 
   Please wait for it to finish then get data again."
}
    • TimeOutの場合
      一回のリクエストの実行時間は45分までとなります。実行時間がオーバーした場合、テストケース実行が中断され、一部のテストケースが実行されません。結果を確認した上、追加実行を行ってください。
      Status: TimeOut - Status Code: 200
      Example: 
      {
  "status": "TimeOut",
  "detail": "Some test cases are not executed.",
  "data": [data]
}
    • 何らかの原因により、テストケース実行が正常に完了されない場合
      Status: Failed - Status Code: 400/432
      Example: 
      {
  "status": "Failed",
  "detail": [error detail]
}


CI/CD用AccessToken生成

  • My profileを押すと、Profile drawerにCI/CD Setting - Access Tokenが表示される
  • 「Generate Token」ボタンを押す、Tokenが生成される

    • generate_access_token
    Generate Access Token