Testkube Agent /test-with-executions operations

• getList test with executions
• getGet test 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

List test with executions

List available test with executions

query Parameters

selector	string Labels to filter by
textSearch	string Default: "" text to search in name and test name
status	string (ExecutionStatus) Enum: "queued" "running" "passed" "failed" "aborted" "timeout" "skipped" 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-with-executions

Response samples

• 200
• 400
• 500
• 502

Content type

application/jsontext/yamlapplication/json

[

• {

  • "test": {

    • "name": "test1",
    • "namespace": "testkube",
    • "description": "this test is used for that purpose",
    • "type": "postman/collection",
    • "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"

      },
    • "source": "my-private-repository-test",
    • "created": "2022-07-30T06:54:15Z",
    • "labels": {

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

      },
    • "schedule": "* * * * *",
    • "readOnly": true,
    • "uploads": [

      • "settings/config.txt"

      ],
    • "executionRequest": {

      • "id": "62f395e004109209b50edfc1",
      • "name": "testing with 1000 users",
      • "testSuiteName": "test-suite1",
      • "number": 0,
      • "executionLabels": {

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

        },
      • "namespace": "testkube",
      • "isVariablesFileUploaded": false,
      • "variablesFile": "string",
      • "variables": {

        • "var1": {

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

          },
        • "secret1": {

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

          }

        },
      • "testSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
      • "testSuiteSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
      • "command": [

        • "curl"

        ],
      • "args": [

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

        ],
      • "args_mode": "append",
      • "image": "kubeshop/testkube-executor-custom:1.10.11-dev-0a9c91",
      • "imagePullSecrets": [

        • {

          • "name": "string"

          }

        ],
      • "envs": {

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

        },
      • "secretEnvs": {

        • "secret_key_name1": "secret-name",
        • "secret_Key_name2": "secret-name"

        },
      • "sync": true,
      • "httpProxy": "user:pass@my.proxy.server:8080",
      • "httpsProxy": "user:pass@my.proxy.server:8081",
      • "negativeTest": false,
      • "isNegativeTestChangedOnRun": false,
      • "activeDeadlineSeconds": 1,
      • "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

        },
      • "jobTemplate": "string",
      • "jobTemplateReference": "string",
      • "cronJobTemplate": "string",
      • "cronJobTemplateReference": "string",
      • "contentRequest": {

        • "repository": {

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

          }

        },
      • "preRunScript": "echo -n '$SECRET_ENV' > ./secret_file",
      • "postRunScript": "sleep 30",
      • "executePostRunScriptBeforeScraping": true,
      • "sourceScripts": true,
      • "scraperTemplate": "string",
      • "scraperTemplateReference": "string",
      • "pvcTemplate": "string",
      • "pvcTemplateReference": "string",
      • "envConfigMaps": [

        • {

          • "reference": {

            • "name": "string"

            },
          • "mount": "/etc/data",
          • "mountPath": "string",
          • "mapToVariables": false

          }

        ],
      • "envSecrets": [

        • {

          • "reference": {

            • "name": "string"

            },
          • "mount": "/etc/data",
          • "mountPath": "string",
          • "mapToVariables": false

          }

        ],
      • "runningContext": {

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

        },
      • "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

        ]

      },
    • "status": {

      • "latestExecution": {

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

        }

      }

    },
  • "latestExecution": {

    • "id": "62f395e004109209b50edfc4",
    • "name": "test-suite1-test1",
    • "number": 1,
    • "testName": "test1",
    • "testNamespace": "testkube",
    • "testType": "postman/collection",
    • "status": "queued",
    • "startTime": "2019-08-24T14:15:22Z",
    • "endTime": "2019-08-24T14:15:22Z",
    • "duration": "00:00:13",
    • "durationMs": 10000,
    • "labels": {

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

      },
    • "runningContext": {

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

      }

    }

  }

]

Get test with execution

Gets the specified test with execution

path Parameters

id required

string unique id of the object

Responses

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

Response samples

• 200
• 400
• 404
• 500
• 502

Content type

application/jsontext/yamlapplication/json

{

• "test": {

  • "name": "test1",
  • "namespace": "testkube",
  • "description": "this test is used for that purpose",
  • "type": "postman/collection",
  • "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"

    },
  • "source": "my-private-repository-test",
  • "created": "2022-07-30T06:54:15Z",
  • "labels": {

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

    },
  • "schedule": "* * * * *",
  • "readOnly": true,
  • "uploads": [

    • "settings/config.txt"

    ],
  • "executionRequest": {

    • "id": "62f395e004109209b50edfc1",
    • "name": "testing with 1000 users",
    • "testSuiteName": "test-suite1",
    • "number": 0,
    • "executionLabels": {

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

      },
    • "namespace": "testkube",
    • "isVariablesFileUploaded": false,
    • "variablesFile": "string",
    • "variables": {

      • "var1": {

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

        },
      • "secret1": {

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

        }

      },
    • "testSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
    • "testSuiteSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
    • "command": [

      • "curl"

      ],
    • "args": [

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

      ],
    • "args_mode": "append",
    • "image": "kubeshop/testkube-executor-custom:1.10.11-dev-0a9c91",
    • "imagePullSecrets": [

      • {

        • "name": "string"

        }

      ],
    • "envs": {

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

      },
    • "secretEnvs": {

      • "secret_key_name1": "secret-name",
      • "secret_Key_name2": "secret-name"

      },
    • "sync": true,
    • "httpProxy": "user:pass@my.proxy.server:8080",
    • "httpsProxy": "user:pass@my.proxy.server:8081",
    • "negativeTest": false,
    • "isNegativeTestChangedOnRun": false,
    • "activeDeadlineSeconds": 1,
    • "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

      },
    • "jobTemplate": "string",
    • "jobTemplateReference": "string",
    • "cronJobTemplate": "string",
    • "cronJobTemplateReference": "string",
    • "contentRequest": {

      • "repository": {

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

        }

      },
    • "preRunScript": "echo -n '$SECRET_ENV' > ./secret_file",
    • "postRunScript": "sleep 30",
    • "executePostRunScriptBeforeScraping": true,
    • "sourceScripts": true,
    • "scraperTemplate": "string",
    • "scraperTemplateReference": "string",
    • "pvcTemplate": "string",
    • "pvcTemplateReference": "string",
    • "envConfigMaps": [

      • {

        • "reference": {

          • "name": "string"

          },
        • "mount": "/etc/data",
        • "mountPath": "string",
        • "mapToVariables": false

        }

      ],
    • "envSecrets": [

      • {

        • "reference": {

          • "name": "string"

          },
        • "mount": "/etc/data",
        • "mountPath": "string",
        • "mapToVariables": false

        }

      ],
    • "runningContext": {

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

      },
    • "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

      ]

    },
  • "status": {

    • "latestExecution": {

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

      }

    }

  },
• "latestExecution": {

  • "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": "assertion1",
            • "status": "passed",
            • "errorMessage": "string"

            }

          ]

        }

      ],
    • "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

    ]

  }

}