Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Buildkite
  3. API Docs
  4. TestSuite
  5. TestSuite
Buildkite v3.1.6 published on Wednesday, Apr 3, 2024 by Pulumiverse
pulumiverse/pulumi-buildkite

buildkite.TestSuite.TestSuite

Explore with Pulumi AI

buildkite logo
Buildkite v3.1.6 published on Wednesday, Apr 3, 2024 by Pulumiverse
pulumiverse/pulumi-buildkite

    A test suite is a collection of tests. A run is to a suite what a build is to a Pipeline.Use this resource to manage Test Suites on Buildkite.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as buildkite from "@pulumiverse/buildkite";

// create a test suite for the main repository
const main = new buildkite.testsuite.TestSuite("main", {
    defaultBranch: "main",
    teamOwnerId: "VGVhbvDf4eRef20tMzIxMGEfYTctNzEF5g00M8f5s6E2YjYtODNlOGNlZgD6HcBi",
});

    import pulumi
import pulumiverse_buildkite as buildkite

# create a test suite for the main repository
main = buildkite.test_suite.TestSuite("main",
    default_branch="main",
    team_owner_id="VGVhbvDf4eRef20tMzIxMGEfYTctNzEF5g00M8f5s6E2YjYtODNlOGNlZgD6HcBi")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-buildkite/sdk/v3/go/buildkite/TestSuite"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// create a test suite for the main repository
		_, err := TestSuite.NewTestSuite(ctx, "main", &TestSuite.TestSuiteArgs{
			DefaultBranch: pulumi.String("main"),
			TeamOwnerId:   pulumi.String("VGVhbvDf4eRef20tMzIxMGEfYTctNzEF5g00M8f5s6E2YjYtODNlOGNlZgD6HcBi"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Buildkite = Pulumiverse.Buildkite;

return await Deployment.RunAsync(() => 
{
    // create a test suite for the main repository
    var main = new Buildkite.TestSuite.TestSuite("main", new()
    {
        DefaultBranch = "main",
        TeamOwnerId = "VGVhbvDf4eRef20tMzIxMGEfYTctNzEF5g00M8f5s6E2YjYtODNlOGNlZgD6HcBi",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.buildkite.TestSuite.TestSuite;
import com.pulumi.buildkite.TestSuite.TestSuiteArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var main = new TestSuite("main", TestSuiteArgs.builder()        
            .defaultBranch("main")
            .teamOwnerId("VGVhbvDf4eRef20tMzIxMGEfYTctNzEF5g00M8f5s6E2YjYtODNlOGNlZgD6HcBi")
            .build());

    }
}

    resources:
  # create a test suite for the main repository
  main:
    type: buildkite:TestSuite:TestSuite
    properties:
      defaultBranch: main
      teamOwnerId: VGVhbvDf4eRef20tMzIxMGEfYTctNzEF5g00M8f5s6E2YjYtODNlOGNlZgD6HcBi

    Create TestSuite Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new TestSuite(name: string, args: TestSuiteArgs, opts?: CustomResourceOptions);
    @overload
def TestSuite(resource_name: str,
              args: TestSuiteArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def TestSuite(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              default_branch: Optional[str] = None,
              team_owner_id: Optional[str] = None,
              name: Optional[str] = None)
    func NewTestSuite(ctx *Context, name string, args TestSuiteArgs, opts ...ResourceOption) (*TestSuite, error)
    public TestSuite(string name, TestSuiteArgs args, CustomResourceOptions? opts = null)
    public TestSuite(String name, TestSuiteArgs args)
public TestSuite(String name, TestSuiteArgs args, CustomResourceOptions options)

    type: buildkite:TestSuite:TestSuite
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args TestSuiteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args TestSuiteArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args TestSuiteArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TestSuiteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TestSuiteArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var testSuiteResource = new Buildkite.TestSuite.TestSuite("testSuiteResource", new()
{
    DefaultBranch = "string",
    TeamOwnerId = "string",
    Name = "string",
});

    example, err := TestSuite.NewTestSuite(ctx, "testSuiteResource", &TestSuite.TestSuiteArgs{
	DefaultBranch: pulumi.String("string"),
	TeamOwnerId:   pulumi.String("string"),
	Name:          pulumi.String("string"),
})

    var testSuiteResource = new TestSuite("testSuiteResource", TestSuiteArgs.builder()
    .defaultBranch("string")
    .teamOwnerId("string")
    .name("string")
    .build());

    test_suite_resource = buildkite.test_suite.TestSuite("testSuiteResource",
    default_branch="string",
    team_owner_id="string",
    name="string")

    const testSuiteResource = new buildkite.testsuite.TestSuite("testSuiteResource", {
    defaultBranch: "string",
    teamOwnerId: "string",
    name: "string",
});

    type: buildkite:TestSuite:TestSuite
properties:
    defaultBranch: string
    name: string
    teamOwnerId: string

    TestSuite Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The TestSuite resource accepts the following input properties:

    DefaultBranch string
    The default branch for the repository this test suite is for.
    TeamOwnerId string
    The GraphQL ID of the team to mark as the owner/admin of the test suite.
    Name string
    The name to give the test suite.
    DefaultBranch string
    The default branch for the repository this test suite is for.
    TeamOwnerId string
    The GraphQL ID of the team to mark as the owner/admin of the test suite.
    Name string
    The name to give the test suite.
    defaultBranch String
    The default branch for the repository this test suite is for.
    teamOwnerId String
    The GraphQL ID of the team to mark as the owner/admin of the test suite.
    name String
    The name to give the test suite.
    defaultBranch string
    The default branch for the repository this test suite is for.
    teamOwnerId string
    The GraphQL ID of the team to mark as the owner/admin of the test suite.
    name string
    The name to give the test suite.
    default_branch str
    The default branch for the repository this test suite is for.
    team_owner_id str
    The GraphQL ID of the team to mark as the owner/admin of the test suite.
    name str
    The name to give the test suite.
    defaultBranch String
    The default branch for the repository this test suite is for.
    teamOwnerId String
    The GraphQL ID of the team to mark as the owner/admin of the test suite.
    name String
    The name to give the test suite.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the TestSuite resource produces the following output properties:

    ApiToken string
    The API token to use to send test run data to the API.
    Id string
    The provider-assigned unique ID for this managed resource.
    Slug string
    The generated slug of the test suite.
    Uuid string
    The UUID of the test suite.
    ApiToken string
    The API token to use to send test run data to the API.
    Id string
    The provider-assigned unique ID for this managed resource.
    Slug string
    The generated slug of the test suite.
    Uuid string
    The UUID of the test suite.
    apiToken String
    The API token to use to send test run data to the API.
    id String
    The provider-assigned unique ID for this managed resource.
    slug String
    The generated slug of the test suite.
    uuid String
    The UUID of the test suite.
    apiToken string
    The API token to use to send test run data to the API.
    id string
    The provider-assigned unique ID for this managed resource.
    slug string
    The generated slug of the test suite.
    uuid string
    The UUID of the test suite.
    api_token str
    The API token to use to send test run data to the API.
    id str
    The provider-assigned unique ID for this managed resource.
    slug str
    The generated slug of the test suite.
    uuid str
    The UUID of the test suite.
    apiToken String
    The API token to use to send test run data to the API.
    id String
    The provider-assigned unique ID for this managed resource.
    slug String
    The generated slug of the test suite.
    uuid String
    The UUID of the test suite.

    Look up Existing TestSuite Resource

    Get an existing TestSuite resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: TestSuiteState, opts?: CustomResourceOptions): TestSuite
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_token: Optional[str] = None,
        default_branch: Optional[str] = None,
        name: Optional[str] = None,
        slug: Optional[str] = None,
        team_owner_id: Optional[str] = None,
        uuid: Optional[str] = None) -> TestSuite
    func GetTestSuite(ctx *Context, name string, id IDInput, state *TestSuiteState, opts ...ResourceOption) (*TestSuite, error)
    public static TestSuite Get(string name, Input<string> id, TestSuiteState? state, CustomResourceOptions? opts = null)
    public static TestSuite get(String name, Output<String> id, TestSuiteState state, CustomResourceOptions options)
    resources:  _:    type: buildkite:TestSuite:TestSuite    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApiToken string
    The API token to use to send test run data to the API.
    DefaultBranch string
    The default branch for the repository this test suite is for.
    Name string
    The name to give the test suite.
    Slug string
    The generated slug of the test suite.
    TeamOwnerId string
    The GraphQL ID of the team to mark as the owner/admin of the test suite.
    Uuid string
    The UUID of the test suite.
    ApiToken string
    The API token to use to send test run data to the API.
    DefaultBranch string
    The default branch for the repository this test suite is for.
    Name string
    The name to give the test suite.
    Slug string
    The generated slug of the test suite.
    TeamOwnerId string
    The GraphQL ID of the team to mark as the owner/admin of the test suite.
    Uuid string
    The UUID of the test suite.
    apiToken String
    The API token to use to send test run data to the API.
    defaultBranch String
    The default branch for the repository this test suite is for.
    name String
    The name to give the test suite.
    slug String
    The generated slug of the test suite.
    teamOwnerId String
    The GraphQL ID of the team to mark as the owner/admin of the test suite.
    uuid String
    The UUID of the test suite.
    apiToken string
    The API token to use to send test run data to the API.
    defaultBranch string
    The default branch for the repository this test suite is for.
    name string
    The name to give the test suite.
    slug string
    The generated slug of the test suite.
    teamOwnerId string
    The GraphQL ID of the team to mark as the owner/admin of the test suite.
    uuid string
    The UUID of the test suite.
    api_token str
    The API token to use to send test run data to the API.
    default_branch str
    The default branch for the repository this test suite is for.
    name str
    The name to give the test suite.
    slug str
    The generated slug of the test suite.
    team_owner_id str
    The GraphQL ID of the team to mark as the owner/admin of the test suite.
    uuid str
    The UUID of the test suite.
    apiToken String
    The API token to use to send test run data to the API.
    defaultBranch String
    The default branch for the repository this test suite is for.
    name String
    The name to give the test suite.
    slug String
    The generated slug of the test suite.
    teamOwnerId String
    The GraphQL ID of the team to mark as the owner/admin of the test suite.
    uuid String
    The UUID of the test suite.

    Package Details

    Repository
    buildkite pulumiverse/pulumi-buildkite
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the buildkite Terraform Provider.
    buildkite logo
    Buildkite v3.1.6 published on Wednesday, Apr 3, 2024 by Pulumiverse
    pulumiverse/pulumi-buildkite