Method: projects.locations.integrations.versions.testCases.executeTest

Executes functional test

HTTP request

POST https://integrations.googleapis.com/v1/{testCaseName=projects/*/locations/*/integrations/*/versions/*/testCases/*}:executeTest

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
testCaseName

string

Required. Test case resource name

Request body

The request body contains data with the following structure:

JSON representation
{
  "inputParameters": {
    string: {
      object (ValueType)
    },
    ...
  }
}
Fields
inputParameters

map (key: string, value: object (ValueType))

Optional. Input parameters used by test case execution.

Response body

The response for executing a functional test.

If successful, the response body contains data with the following structure:

JSON representation
{
  "executionId": string,
  "outputParameters": {
    object
  },
  "assertionResults": [
    {
      object (AssertionResult)
    }
  ],
  "testExecutionState": enum (State)
}
Fields
executionId

string

The id of the execution corresponding to this run of integration.

outputParameters

object (Struct format)

OUTPUT parameters in format of Map<Key,Value>. Where Key is the name of the parameter. Note: name of the system generated parameters are wrapped by backtick(`) to distinguish them from the user defined parameters.

assertionResults[]

object (AssertionResult)

Results of each assertions ran during execution of test case.

testExecutionState

enum (State)

State of the test case execution

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the testCaseName resource:

  • integrations.testCases.invoke

For more information, see the IAM documentation.

AssertionResult

The result of an assertion.

JSON representation
{
  "assertion": {
    object (Assertion)
  },
  "taskNumber": string,
  "taskName": string,
  "status": enum (AssertionStatus),
  "failureMessage": string
}
Fields
assertion

object (Assertion)

Assertion that was run.

taskNumber

string

Task number of task where the assertion was run.

taskName

string

Task name of task where the assertion was run.

status

enum (AssertionStatus)

Status of assertion to signify if the assertion succeeded or failed

failureMessage

string

Details of the assertion failure

AssertionStatus

Possible values for AssertionStatus

Enums
ASSERTION_STATUS_UNSPECIFIED Unspecified assertion status
SUCCEEDED Assertion succeeded
FAILED Assertion failed

State

Status of the test case

Enums
STATE_UNSPECIFIED Unspecified state
PASSED Test case execution passed
FAILED Test case execution failed