Test

Test runs a function’s test suite in a sandboxed environment and returns the results.

POST /api/v1/functions/{function_id}/test

Test

Go

package main

import(
	"context"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := conductoronesdkgo.New(
        conductoronesdkgo.WithSecurity(shared.Security{
            BearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
            Oauth: "<YOUR_OAUTH_HERE>",
        }),
    )

    res, err := s.Functions.Test(ctx, operations.C1APIFunctionsV1FunctionsServiceTestRequest{
        FunctionID: "<id>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.FunctionsServiceTestResponse != nil {
        // handle response
    }
}

import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";

const conductoroneSDKTypescript = new ConductoroneSDKTypescript({
  security: {
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
    oauth: "<YOUR_OAUTH_HERE>",
  },
});

async function run() {
  const result = await conductoroneSDKTypescript.functions.test({
    functionId: "<id>",
  });

  console.log(result);
}

run();

curl --request POST \
  --url https://{tenantDomain}.conductor.one/api/v1/functions/{function_id}/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "commitId": "<string>"
}
'

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/functions/{function_id}/test"

payload = { "commitId": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({commitId: '<string>'})
};

fetch('https://{tenantDomain}.conductor.one/api/v1/functions/{function_id}/test', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}.conductor.one/api/v1/functions/{function_id}/test",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'commitId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://{tenantDomain}.conductor.one/api/v1/functions/{function_id}/test")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"commitId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}.conductor.one/api/v1/functions/{function_id}/test")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"commitId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "result": {
    "assertions": [
      {
        "actual": "<string>",
        "at": "<string>",
        "description": "<string>",
        "expected": "<string>",
        "operator": "<string>",
        "pass": true
      }
    ],
    "error": "<string>",
    "logs": [
      {
        "level": "<string>",
        "log": "<string>",
        "source": "<string>"
      }
    ],
    "name": "<string>"
  },
  "results": [
    {
      "assertions": [
        {
          "actual": "<string>",
          "at": "<string>",
          "description": "<string>",
          "expected": "<string>",
          "operator": "<string>",
          "pass": true
        }
      ],
      "error": "<string>",
      "logs": [
        {
          "level": "<string>",
          "log": "<string>",
          "source": "<string>"
        }
      ],
      "name": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization · string · header · required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Path Parameters

function_id · string · required

The function ID to test.

Body

application/json

FunctionsServiceTestRequest runs tests for a function at a specific commit.

commitId · string | null

The commit ID to test. If empty, the published commit is used.

Response

200 - application/json

FunctionsServiceTestResponse contains test execution results.

FunctionsServiceTestResponse contains test execution results.

result · Function Test Result · object | null

FunctionTestResult contains the result of a single test case execution.

Show child attributes

results · Function Test Result · object[] | null

All test results.

Show child attributes