Testkube Agent /test-suite-with-executions operations

• getGet all test suite with executions
• getGet test suite by ID with execution

API docs by Redocly

Testkube API (1.0.0)

Download OpenAPI specification:Download

E-mail: testkube@kubeshop.io License: MIT

Testkube provides a Kubernetes-native framework for test definition, execution and results

Get all test suite with executions

Returns array of test suite with executions

query Parameters

selector	string Labels to filter by
textSearch	string Default: "" text to search in name and test name
status	string (TestSuiteExecutionStatus) Enum: "queued" "running" "passed" "failed" "aborting" "aborted" "timeout" optional status filter containing multiple values separated by comma
pageSize	integer Default: 100 the number of executions to get, setting to 0 will return only totals
page	integer Default: 0 the page index to start at

Responses

https://raw.githubusercontent.com/test-suite-with-executions

Response samples

• 200
• 400
• 500
• 502

Content type

application/jsontext/yamlapplication/json

[

• {

  • "testSuite": {

    • "name": "test-suite1",
    • "namespace": "testkube",
    • "description": "collection of tests",
    • "before": [

      • {

        • "stopOnFailure": true,
        • "execute": [

          • {

            • "test": "example-test"

            }

          ]

        }

      ],
    • "steps": [

      • {

        • "stopOnFailure": true,
        • "execute": [

          • {

            • "test": "example-test"

            }

          ]

        }

      ],
    • "after": [

      • {

        • "stopOnFailure": true,
        • "execute": [

          • {

            • "test": "example-test"

            }

          ]

        }

      ],
    • "labels": {

      • "env": "prod",
      • "app": "backend"

      },
    • "schedule": "* * * * *",
    • "repeats": 1,
    • "created": "2019-08-24T14:15:22Z",
    • "executionRequest": {

      • "name": "testing with 1000 users",
      • "number": 1,
      • "namespace": "testkube",
      • "variables": {

        • "var1": {

          • "name": "var1",
          • "type": "basic",
          • "value": "value1"

          },
        • "secret1": {

          • "name": "secret1",
          • "type": "secret",
          • "value": "secretvalue1"

          }

        },
      • "secretUUID": "7934600f-b367-48dd-b981-4353304362fb",
      • "labels": {

        • "users": "3",
        • "prefix": "some-"

        },
      • "executionLabels": {

        • "users": "3",
        • "prefix": "some-"

        },
      • "sync": true,
      • "httpProxy": "user:pass@my.proxy.server:8080",
      • "httpsProxy": "user:pass@my.proxy.server:8081",
      • "timeout": 1,
      • "contentRequest": {

        • "repository": {

          • "branch": "main",
          • "commit": "b928cbb7186944ab9275937ec1ac3d3738ca2e1d",
          • "path": "test/perf",
          • "workingDir": "/"

          }

        },
      • "runningContext": {

        • "type": "userCLI",
        • "context": "string"

        },
      • "jobTemplate": "string",
      • "jobTemplateReference": "string",
      • "cronJobTemplate": "string",
      • "cronJobTemplateReference": "string",
      • "scraperTemplate": "string",
      • "scraperTemplateReference": "string",
      • "pvcTemplate": "string",
      • "pvcTemplateReference": "string",
      • "concurrencyLevel": 10,
      • "testSuiteExecutionName": "string",
      • "disableWebhooks": [

        • true,
        • false

        ]

      },
    • "status": {

      • "latestExecution": {

        • "id": "62f395e004109209b50edfc4",
        • "startTime": "2019-08-24T14:15:22Z",
        • "endTime": "2019-08-24T14:15:22Z",
        • "status": "queued"

        }

      },
    • "readOnly": true

    },
  • "latestExecution": {

    • "id": "62f395e004109209b50edfc1",
    • "name": "test-suite1.needlessly-sweet-imp",
    • "testSuiteName": "test-suite1",
    • "status": "queued",
    • "startTime": "2019-08-24T14:15:22Z",
    • "endTime": "2019-08-24T14:15:22Z",
    • "duration": "00:00:09",
    • "durationMs": 9009,
    • "execution": [

      • {

        • "execute": [

          • {

            • "id": "62f395e004109209b50edfc4",
            • "name": "run:testkube/test1",
            • "testName": "test1",
            • "status": "queued",
            • "type": "executeTest"

            }

          ]

        }

      ],
    • "labels": {

      • "env": "prod",
      • "app": "backend"

      }

    }

  }

]

Get test suite by ID with execution

Returns test suite with given name with execution

path Parameters

id required

string unique id of the object

Responses

https://raw.githubusercontent.com/test-suite-with-executions/{id}

Response samples

• 200
• 500

Content type

application/jsontext/yamlapplication/json

{

• "testSuite": {

  • "name": "test-suite1",
  • "namespace": "testkube",
  • "description": "collection of tests",
  • "before": [

    • {

      • "stopOnFailure": true,
      • "execute": [

        • {

          • "test": "example-test"

          }

        ]

      }

    ],
  • "steps": [

    • {

      • "stopOnFailure": true,
      • "execute": [

        • {

          • "test": "example-test"

          }

        ]

      }

    ],
  • "after": [

    • {

      • "stopOnFailure": true,
      • "execute": [

        • {

          • "test": "example-test"

          }

        ]

      }

    ],
  • "labels": {

    • "env": "prod",
    • "app": "backend"

    },
  • "schedule": "* * * * *",
  • "repeats": 1,
  • "created": "2019-08-24T14:15:22Z",
  • "executionRequest": {

    • "name": "testing with 1000 users",
    • "number": 1,
    • "namespace": "testkube",
    • "variables": {

      • "var1": {

        • "name": "var1",
        • "type": "basic",
        • "value": "value1"

        },
      • "secret1": {

        • "name": "secret1",
        • "type": "secret",
        • "value": "secretvalue1"

        }

      },
    • "secretUUID": "7934600f-b367-48dd-b981-4353304362fb",
    • "labels": {

      • "users": "3",
      • "prefix": "some-"

      },
    • "executionLabels": {

      • "users": "3",
      • "prefix": "some-"

      },
    • "sync": true,
    • "httpProxy": "user:pass@my.proxy.server:8080",
    • "httpsProxy": "user:pass@my.proxy.server:8081",
    • "timeout": 1,
    • "contentRequest": {

      • "repository": {

        • "branch": "main",
        • "commit": "b928cbb7186944ab9275937ec1ac3d3738ca2e1d",
        • "path": "test/perf",
        • "workingDir": "/"

        }

      },
    • "runningContext": {

      • "type": "userCLI",
      • "context": "string"

      },
    • "jobTemplate": "string",
    • "jobTemplateReference": "string",
    • "cronJobTemplate": "string",
    • "cronJobTemplateReference": "string",
    • "scraperTemplate": "string",
    • "scraperTemplateReference": "string",
    • "pvcTemplate": "string",
    • "pvcTemplateReference": "string",
    • "concurrencyLevel": 10,
    • "testSuiteExecutionName": "string",
    • "disableWebhooks": [

      • true,
      • false

      ]

    },
  • "status": {

    • "latestExecution": {

      • "id": "62f395e004109209b50edfc4",
      • "startTime": "2019-08-24T14:15:22Z",
      • "endTime": "2019-08-24T14:15:22Z",
      • "status": "queued"

      }

    },
  • "readOnly": true

  },
• "latestExecution": {

  • "id": "62f395e004109209b50edfc1",
  • "name": "test-suite1.needlessly-sweet-imp",
  • "testSuite": {

    • "namespace": "testkube",
    • "name": "name"

    },
  • "status": "queued",
  • "envs": {

    • "record": "true",
    • "prefix": "some-"

    },
  • "variables": {

    • "var1": {

      • "name": "var1",
      • "type": "basic",
      • "value": "value1"

      },
    • "secret1": {

      • "name": "secret1",
      • "type": "secret",
      • "value": "secretvalue1"

      }

    },
  • "secretUUID": "7934600f-b367-48dd-b981-4353304362fb",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "duration": "2m",
  • "durationMs": 6000,
  • "stepResults": [

    • {

      • "step": {

        • "stopTestOnFailure": true,
        • "execute": {

          • "namespace": "testkube",
          • "name": "name"

          },
        • "delay": {

          • "duration": 0

          }

        },
      • "test": {

        • "namespace": "testkube",
        • "name": "name"

        },
      • "execution": {

        • "id": "62f395e004109209b50edfc4",
        • "testName": "example-test",
        • "testSuiteName": "test-suite1",
        • "testNamespace": "testkube",
        • "testType": "postman/collection",
        • "name": "test-suite1-example-test-1",
        • "number": 1,
        • "envs": {

          • "record": "true",
          • "prefix": "some-"

          },
        • "command": [

          • "curl"

          ],
        • "args": [

          • "--concurrency",
          • "2",
          • "--remote",
          • "--some",
          • "blabla"

          ],
        • "args_mode": "append",
        • "variables": {

          • "var1": {

            • "name": "var1",
            • "type": "basic",
            • "value": "value1"

            },
          • "secret1": {

            • "name": "secret1",
            • "type": "secret",
            • "value": "secretvalue1"

            }

          },
        • "isVariablesFileUploaded": false,
        • "variablesFile": "string",
        • "testSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
        • "testSuiteSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
        • "content": {

          • "type": "string",
          • "repository": {

            • "type": "git",
            • "uri": "https://github.com/kubeshop/testkube",
            • "branch": "main",
            • "commit": "b928cbb7186944ab9275937ec1ac3d3738ca2e1d",
            • "path": "test/perf",
            • "username": "string",
            • "token": "string",
            • "usernameSecret": {

              • "namespace": "string",
              • "name": "string",
              • "key": "string"

              },
            • "tokenSecret": {

              • "namespace": "string",
              • "name": "string",
              • "key": "string"

              },
            • "certificateSecret": "string",
            • "workingDir": "/",
            • "authType": "basic"

            },
          • "data": "string",
          • "uri": "https://github.com/kubeshop/testkube"

          },
        • "startTime": "2019-08-24T14:15:22Z",
        • "endTime": "2019-08-24T14:15:22Z",
        • "duration": "88s",
        • "durationMs": 10000,
        • "executionResult": {

          • "status": "queued",
          • "output": "string",
          • "outputType": "text/plain",
          • "errorMessage": "string",
          • "steps": [

            • {

              • "name": "step1",
              • "duration": "10m0s",
              • "status": "passed",
              • "assertionResults": [

                • {

                  • "name": null,
                  • "status": null,
                  • "errorMessage": null

                  }

                ]

              }

            ],
          • "reports": {

            • "junit": "string"

            }

          },
        • "labels": {

          • "env": "prod",
          • "app": "backend"

          },
        • "uploads": [

          • "settings/config.txt"

          ],
        • "bucketName": "execution-c01d7cf6-ec3f-47f0-9556-a5d6e9009a43",
        • "artifactRequest": {

          • "storageClassName": "artifact-volume-local",
          • "volumeMountPath": "string",
          • "dirs": [

            • "string"

            ],
          • "masks": [

            • "string"

            ],
          • "storageBucket": "test1-artifacts",
          • "omitFolderPerExecution": true,
          • "sharedBetweenPods": true,
          • "useDefaultStorageClassName": true,
          • "sidecarScraper": true

          },
        • "preRunScript": "echo -n '$SECRET_ENV' > ./secret_file",
        • "postRunScript": "sleep 30",
        • "executePostRunScriptBeforeScraping": true,
        • "sourceScripts": true,
        • "runningContext": {

          • "type": "userCLI",
          • "context": "string"

          },
        • "containerShell": "/bin/sh",
        • "testExecutionName": "string",
        • "downloadArtifactExecutionIDs": [

          • "string"

          ],
        • "downloadArtifactTestNames": [

          • "string"

          ],
        • "slavePodRequest": {

          • "resources": {

            • "requests": {

              • "cpu": "250m",
              • "memory": "64Mi"

              },
            • "limits": {

              • "cpu": "250m",
              • "memory": "64Mi"

              }

            },
          • "podTemplate": "string",
          • "podTemplateReference": "string"

          },
        • "executionNamespace": "string",
        • "disableWebhooks": [

          • true,
          • false

          ]

        }

      }

    ],
  • "executeStepResults": [

    • {

      • "step": {

        • "stopOnFailure": true,
        • "downloadArtifacts": {

          • "allPreviousSteps": false,
          • "previousStepNumbers": [

            • 0

            ],
          • "previousTestNames": [

            • "string"

            ]

          },
        • "execute": [

          • {

            • "test": "name",
            • "delay": "1s",
            • "executionRequest": {

              • "executionLabels": {

                • "users": "3",
                • "prefix": "some-"

                },
              • "variables": {

                • "var1": {

                  • "name": "var1",
                  • "type": "basic",
                  • "value": "value1"

                  },
                • "secret1": {

                  • "name": "secret1",
                  • "type": "secret",
                  • "value": "secretvalue1"

                  }

                },
              • "command": [

                • "curl"

                ],
              • "args": [

                • "--repeats",
                • "5",
                • "--insecure"

                ],
              • "args_mode": "append",
              • "sync": true,
              • "httpProxy": "user:pass@my.proxy.server:8080",
              • "httpsProxy": "user:pass@my.proxy.server:8081",
              • "negativeTest": false,
              • "jobTemplate": "string",
              • "jobTemplateReference": "string",
              • "cronJobTemplate": "string",
              • "cronJobTemplateReference": "string",
              • "scraperTemplate": "string",
              • "scraperTemplateReference": "string",
              • "pvcTemplate": "string",
              • "pvcTemplateReference": "string",
              • "runningContext": {

                • "type": "userCLI",
                • "context": "string"

                },
              • "disableWebhooks": [

                • true,
                • false

                ]

              }

            }

          ]

        },
      • "execute": [

        • {

          • "step": {

            • "test": "name",
            • "delay": "1s",
            • "executionRequest": {

              • "executionLabels": {

                • "users": "3",
                • "prefix": "some-"

                },
              • "variables": {

                • "var1": {

                  • "name": "var1",
                  • "type": "basic",
                  • "value": "value1"

                  },
                • "secret1": {

                  • "name": "secret1",
                  • "type": "secret",
                  • "value": "secretvalue1"

                  }

                },
              • "command": [

                • "curl"

                ],
              • "args": [

                • "--repeats",
                • "5",
                • "--insecure"

                ],
              • "args_mode": "append",
              • "sync": true,
              • "httpProxy": "user:pass@my.proxy.server:8080",
              • "httpsProxy": "user:pass@my.proxy.server:8081",
              • "negativeTest": false,
              • "jobTemplate": "string",
              • "jobTemplateReference": "string",
              • "cronJobTemplate": "string",
              • "cronJobTemplateReference": "string",
              • "scraperTemplate": "string",
              • "scraperTemplateReference": "string",
              • "pvcTemplate": "string",
              • "pvcTemplateReference": "string",
              • "runningContext": {

                • "type": "userCLI",
                • "context": "string"

                },
              • "disableWebhooks": [

                • true,
                • false

                ]

              }

            },
          • "test": {

            • "namespace": "testkube",
            • "name": "name"

            },
          • "execution": {

            • "id": "62f395e004109209b50edfc4",
            • "testName": "example-test",
            • "testSuiteName": "test-suite1",
            • "testNamespace": "testkube",
            • "testType": "postman/collection",
            • "name": "test-suite1-example-test-1",
            • "number": 1,
            • "envs": {

              • "record": "true",
              • "prefix": "some-"

              },
            • "command": [

              • "curl"

              ],
            • "args": [

              • "--concurrency",
              • "2",
              • "--remote",
              • "--some",
              • "blabla"

              ],
            • "args_mode": "append",
            • "variables": {

              • "var1": {

                • "name": "var1",
                • "type": "basic",
                • "value": "value1"

                },
              • "secret1": {

                • "name": "secret1",
                • "type": "secret",
                • "value": "secretvalue1"

                }

              },
            • "isVariablesFileUploaded": false,
            • "variablesFile": "string",
            • "testSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
            • "testSuiteSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
            • "content": {

              • "type": "string",
              • "repository": {

                • "type": "git",
                • "uri": "https://github.com/kubeshop/testkube",
                • "branch": "main",
                • "commit": "b928cbb7186944ab9275937ec1ac3d3738ca2e1d",
                • "path": "test/perf",
                • "username": "string",
                • "token": "string",
                • "usernameSecret": {

                  • "namespace": null,
                  • "name": null,
                  • "key": null

                  },
                • "tokenSecret": {

                  • "namespace": null,
                  • "name": null,
                  • "key": null

                  },
                • "certificateSecret": "string",
                • "workingDir": "/",
                • "authType": "basic"

                },
              • "data": "string",
              • "uri": "https://github.com/kubeshop/testkube"

              },
            • "startTime": "2019-08-24T14:15:22Z",
            • "endTime": "2019-08-24T14:15:22Z",
            • "duration": "88s",
            • "durationMs": 10000,
            • "executionResult": {

              • "status": "queued",
              • "output": "string",
              • "outputType": "text/plain",
              • "errorMessage": "string",
              • "steps": [

                • {

                  • "name": null,
                  • "duration": null,
                  • "status": null,
                  • "assertionResults": [ ]

                  }

                ],
              • "reports": {

                • "junit": "string"

                }

              },
            • "labels": {

              • "env": "prod",
              • "app": "backend"

              },
            • "uploads": [

              • "settings/config.txt"

              ],
            • "bucketName": "execution-c01d7cf6-ec3f-47f0-9556-a5d6e9009a43",
            • "artifactRequest": {

              • "storageClassName": "artifact-volume-local",
              • "volumeMountPath": "string",
              • "dirs": [

                • "string"

                ],
              • "masks": [

                • "string"

                ],
              • "storageBucket": "test1-artifacts",
              • "omitFolderPerExecution": true,
              • "sharedBetweenPods": true,
              • "useDefaultStorageClassName": true,
              • "sidecarScraper": true

              },
            • "preRunScript": "echo -n '$SECRET_ENV' > ./secret_file",
            • "postRunScript": "sleep 30",
            • "executePostRunScriptBeforeScraping": true,
            • "sourceScripts": true,
            • "runningContext": {

              • "type": "userCLI",
              • "context": "string"

              },
            • "containerShell": "/bin/sh",
            • "testExecutionName": "string",
            • "downloadArtifactExecutionIDs": [

              • "string"

              ],
            • "downloadArtifactTestNames": [

              • "string"

              ],
            • "slavePodRequest": {

              • "resources": {

                • "requests": {

                  • "cpu": null,
                  • "memory": null

                  },
                • "limits": {

                  • "cpu": null,
                  • "memory": null

                  }

                },
              • "podTemplate": "string",
              • "podTemplateReference": "string"

              },
            • "executionNamespace": "string",
            • "disableWebhooks": [

              • true,
              • false

              ]

            }

          }

        ],
      • "startTime": "2019-08-24T14:15:22Z",
      • "endTime": "2019-08-24T14:15:22Z",
      • "duration": "2m"

      }

    ],
  • "labels": {

    • "env": "prod",
    • "app": "backend"

    },
  • "runningContext": {

    • "type": "userCLI",
    • "context": "string"

    },
  • "testSuiteExecutionName": "string",
  • "disableWebhooks": [

    • true,
    • false

    ]

  }

}