CI/CD

API Thực Thi

RakAPIt cung cấp một API để thực hiện Test cases/Scenario. Thông tin cần thiết cho API thực thi như sau:

• Thực thi Test Cases

  REQUEST

  • Method: POST
  • Endpoint: https://rakapit-run-api.dockyard.biz
  • Header:
    • Content-Type: application/json
    • Authorization: [Access Token]
      ※Vui lòng kiểm tra "Access Token" trong phần "CI/CD Setting - Access Token" của "My profile".
      
  • Body:
    • projectId: string
      ※ ProjectId được lấy như thế này
      

      
      Lấy ProjectId

    • testObjectId: string
      ※ TestObjectId được lấy như thế này
      

      
      Lấy TestObjectId

    • runTestCase: object
      ※ Chỉ định các Test cases ở đây. Có bốn cách để chỉ định các trường hợp Test cases.
      
      • Chỉ định Test Suite Id:
        runTestCase.testSuiteIdList: integer array
        

        
        Lấy SuiteId

        Example:
        

        {
          "projectId": "xxxxxxxxxxxxxxx",
          "testObjectId": "xxxxxxxxxxxxx",
          "runTestCase": {
            "testSuiteIdList": [
              0,
              1
            ]
          }
        }

      • Chỉ định Test Case Id:
        runTestCase.testCaseIdList: integer array
        

        
        Lấy TestCaseId

        Example:
        

        {
          "projectId": "xxxxxxxxxxxxxxx",
          "testObjectId": "xxxxxxxxxxxxx",
          "runTestCase": {
            "testCaseIdList": [
              0,
              1
            ]
          }
        }

      • Chỉ định Response Code:
        runTestCase.responseCodeList: integer array
        

        
        Lấy Response Code

        Example:
        

        {
          "projectId": "xxxxxxxxxxxxxxx",
          "testObjectId": "xxxxxxxxxxxxx",
          "runTestCase": {
            "responseCodeList": [
              200,
              400
            ]
          }
        }

      • Chỉ định trong một phạm vi:
        runTestCase.from: integer
        runTestCase.to: integer
        
        Example:
        

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

  RESPONSE

  • Trường hợp Run Test cases được thực hiện bình thường
    Status: Success - Status Code: 200
    Example:
    

    {
      "status": "Success",
      "detail": "Start running Test case(s). Please wait a few minutes!",
      "requestId": [requestId]
    }

  • Trường hợp đang thực hiện test cases khác trong cùng một 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."
    }

  • Trường hợp không thể Run Test cases vì một lý do nào đó
    Status: Failed - Status Code: 400/500
    Example:
    

    {
      "status": "Failed",
      "detail": [error detail]
    }

API Nhận Kết Quả

Bạn có thể sử dụng API để nhận kết quả của Test cases/Scenario mà bạn đã Request. Để lấy được kết quả phải có requestId trả về khi gọi API thực thi.

• Kết quả của Test Cases

  REQUEST

  • Method: GET
  • Endpoint: https://rakapit-run-api.dockyard.biz?requestId={requestId}
  • Header:
    • Content-Type: application/json
    • Authorization: [Access Token]
      ※Bạn có thể lấy Access Token trong mục「CI/CD Setting - Access Token」ở「My profile」
      
  • URL param:
    • requestId: string
      ※Có thể tìm thấy requestId trong Response trả về khi gọi API thực hiện test cases.
      

  RESPONSE

  • Trường hợp chạy thành công
    Status: Success - Status Code: 200
    Example:
    

    {
      "status": "Finish",
      "detail": "Get data successfully!",
      "data": [data]
    }

  • Trường hợp đang thực thi test cases:
    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."
    }

  • Trường hợp TimeOut
    Thời gian thực hiện cho một yêu cầu tối đa là 45 phút. Nếu vượt quá thời gian thực trên, quá trình thực thi Test cases sẽ dừng lại và một số Test cases sẽ không được thực thi. Sau khi kiểm tra kết quả, hãy tiến hành thực thi bổ sung.
    Status: TimeOut - Status Code: 200
    Example:
    

    {
      "status": "TimeOut",
      "detail": "Some test cases are not executed.",
      "data": [data]
    }

  • Trường hợp thực thi test cases không thành công vì một số lý do
    Status: Failed - Status Code: 400/432
    Example:
    

    {
      "status": "Failed",
      "detail": [error detail]
    }

Tạo Access Token

Lấy Access Token bằng cách

• Nhấn My profile, "CI/CD Setting - Access Token" sẽ được hiển thị trong Profile drawer
• Nhấn nút "Generate Token" để sinh Token


Generate Access Token