Documentation ¶
Index ¶
- type Team
- type TeamArgs
- type TeamArray
- type TeamArrayInput
- type TeamArrayOutput
- type TeamInput
- type TeamMap
- type TeamMapInput
- type TeamMapOutput
- type TeamOutput
- func (o TeamOutput) AccessLevel() pulumi.StringOutput
- func (TeamOutput) ElementType() reflect.Type
- func (o TeamOutput) TeamId() pulumi.StringOutput
- func (o TeamOutput) TestSuiteId() pulumi.StringOutput
- func (o TeamOutput) ToTeamOutput() TeamOutput
- func (o TeamOutput) ToTeamOutputWithContext(ctx context.Context) TeamOutput
- func (o TeamOutput) Uuid() pulumi.StringOutput
- type TeamState
- type TestSuite
- type TestSuiteArgs
- type TestSuiteArray
- type TestSuiteArrayInput
- type TestSuiteArrayOutput
- func (TestSuiteArrayOutput) ElementType() reflect.Type
- func (o TestSuiteArrayOutput) Index(i pulumi.IntInput) TestSuiteOutput
- func (o TestSuiteArrayOutput) ToTestSuiteArrayOutput() TestSuiteArrayOutput
- func (o TestSuiteArrayOutput) ToTestSuiteArrayOutputWithContext(ctx context.Context) TestSuiteArrayOutput
- type TestSuiteInput
- type TestSuiteMap
- type TestSuiteMapInput
- type TestSuiteMapOutput
- type TestSuiteOutput
- func (o TestSuiteOutput) ApiToken() pulumi.StringOutput
- func (o TestSuiteOutput) DefaultBranch() pulumi.StringOutput
- func (TestSuiteOutput) ElementType() reflect.Type
- func (o TestSuiteOutput) Name() pulumi.StringOutput
- func (o TestSuiteOutput) Slug() pulumi.StringOutput
- func (o TestSuiteOutput) TeamOwnerId() pulumi.StringOutput
- func (o TestSuiteOutput) ToTestSuiteOutput() TestSuiteOutput
- func (o TestSuiteOutput) ToTestSuiteOutputWithContext(ctx context.Context) TestSuiteOutput
- func (o TestSuiteOutput) Uuid() pulumi.StringOutput
- type TestSuiteState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Team ¶
type Team struct { pulumi.CustomResourceState // The access level the team has on the test suite. Either READ_ONLY or MANAGE_AND_READ. AccessLevel pulumi.StringOutput `pulumi:"accessLevel"` // The GraphQL ID of the team. TeamId pulumi.StringOutput `pulumi:"teamId"` // The GraphQL ID of the test suite. TestSuiteId pulumi.StringOutput `pulumi:"testSuiteId"` // This is the UUID of the test suite team. Uuid pulumi.StringOutput `pulumi:"uuid"` }
## # Resource: testSuiteTeam
This resources allows you to create, manage and import team access to Test Suites.
Buildkite documentation: https://buildkite.com/docs/test-analytics
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi" "github.com/pulumiverse/pulumi-buildkite/sdk/v2/go/buildkite/Team" "github.com/pulumiverse/pulumi-buildkite/sdk/v2/go/buildkite/TestSuite"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { owners, err := Team.NewTeam(ctx, "owners", &Team.TeamArgs{ DefaultTeam: pulumi.Bool(false), Privacy: pulumi.String("VISIBLE"), DefaultMemberRole: pulumi.String("MAINTAINER"), }) if err != nil { return err } viewers, err := Team.NewTeam(ctx, "viewers", &Team.TeamArgs{ DefaultTeam: pulumi.Bool(false), Privacy: pulumi.String("VISIBLE"), DefaultMemberRole: pulumi.String("MAINTAINER"), }) if err != nil { return err } rspecSuite, err := TestSuite.NewTestSuite(ctx, "rspecSuite", &TestSuite.TestSuiteArgs{ DefaultBranch: pulumi.String("main"), TeamOwnerId: owners.ID(), }) if err != nil { return err } _, err = TestSuite.NewTeam(ctx, "viewersRspec", &TestSuite.TeamArgs{ TestSuiteId: rspecSuite.ID(), TeamId: viewers.ID(), AccessLevel: pulumi.String("READ_ONLY"), }) if err != nil { return err } return nil }) }
```
## Import
Test suite teams can be imported using the `GraphQL ID` (not UUID), e.g.
```sh
$ pulumi import buildkite:TestSuite/team:Team viewers VGVhbvDf4eRef20tMzIxMGEfYTctNzEF5g00M8f5s6E2YjYtODNlOGNlZgD6HcBi
```
To find the ID to use, you can use the GraphQL query below. Alternatively, you could use this [pre-saved query](https://buildkite.com/user/graphql/console/e8480014-37a8-4150-a011-6d35f33b4dfd), where you will need fo fill in the organization slug and suite search term (SUITE_SEARCH_TERM) for the particular test suite required. graphql query getTeamSuiteIds { organization(slug"ORGANIZATION_SLUG") { suites(first1, search:"SUITE_SEARCH_TERM") { edges { node { id name teams(first10){ edges { node { id accessLevel team{ name } } } } } } } } }
func GetTeam ¶
func GetTeam(ctx *pulumi.Context, name string, id pulumi.IDInput, state *TeamState, opts ...pulumi.ResourceOption) (*Team, error)
GetTeam gets an existing Team resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewTeam ¶
func NewTeam(ctx *pulumi.Context, name string, args *TeamArgs, opts ...pulumi.ResourceOption) (*Team, error)
NewTeam registers a new resource with the given unique name, arguments, and options.
func (*Team) ElementType ¶
func (*Team) ToTeamOutput ¶
func (i *Team) ToTeamOutput() TeamOutput
func (*Team) ToTeamOutputWithContext ¶
func (i *Team) ToTeamOutputWithContext(ctx context.Context) TeamOutput
type TeamArgs ¶
type TeamArgs struct { // The access level the team has on the test suite. Either READ_ONLY or MANAGE_AND_READ. AccessLevel pulumi.StringInput // The GraphQL ID of the team. TeamId pulumi.StringInput // The GraphQL ID of the test suite. TestSuiteId pulumi.StringInput }
The set of arguments for constructing a Team resource.
func (TeamArgs) ElementType ¶
type TeamArray ¶
type TeamArray []TeamInput
func (TeamArray) ElementType ¶
func (TeamArray) ToTeamArrayOutput ¶
func (i TeamArray) ToTeamArrayOutput() TeamArrayOutput
func (TeamArray) ToTeamArrayOutputWithContext ¶
func (i TeamArray) ToTeamArrayOutputWithContext(ctx context.Context) TeamArrayOutput
type TeamArrayInput ¶
type TeamArrayInput interface { pulumi.Input ToTeamArrayOutput() TeamArrayOutput ToTeamArrayOutputWithContext(context.Context) TeamArrayOutput }
TeamArrayInput is an input type that accepts TeamArray and TeamArrayOutput values. You can construct a concrete instance of `TeamArrayInput` via:
TeamArray{ TeamArgs{...} }
type TeamArrayOutput ¶
type TeamArrayOutput struct{ *pulumi.OutputState }
func (TeamArrayOutput) ElementType ¶
func (TeamArrayOutput) ElementType() reflect.Type
func (TeamArrayOutput) Index ¶
func (o TeamArrayOutput) Index(i pulumi.IntInput) TeamOutput
func (TeamArrayOutput) ToTeamArrayOutput ¶
func (o TeamArrayOutput) ToTeamArrayOutput() TeamArrayOutput
func (TeamArrayOutput) ToTeamArrayOutputWithContext ¶
func (o TeamArrayOutput) ToTeamArrayOutputWithContext(ctx context.Context) TeamArrayOutput
type TeamInput ¶
type TeamInput interface { pulumi.Input ToTeamOutput() TeamOutput ToTeamOutputWithContext(ctx context.Context) TeamOutput }
type TeamMap ¶
func (TeamMap) ElementType ¶
func (TeamMap) ToTeamMapOutput ¶
func (i TeamMap) ToTeamMapOutput() TeamMapOutput
func (TeamMap) ToTeamMapOutputWithContext ¶
func (i TeamMap) ToTeamMapOutputWithContext(ctx context.Context) TeamMapOutput
type TeamMapInput ¶
type TeamMapInput interface { pulumi.Input ToTeamMapOutput() TeamMapOutput ToTeamMapOutputWithContext(context.Context) TeamMapOutput }
TeamMapInput is an input type that accepts TeamMap and TeamMapOutput values. You can construct a concrete instance of `TeamMapInput` via:
TeamMap{ "key": TeamArgs{...} }
type TeamMapOutput ¶
type TeamMapOutput struct{ *pulumi.OutputState }
func (TeamMapOutput) ElementType ¶
func (TeamMapOutput) ElementType() reflect.Type
func (TeamMapOutput) MapIndex ¶
func (o TeamMapOutput) MapIndex(k pulumi.StringInput) TeamOutput
func (TeamMapOutput) ToTeamMapOutput ¶
func (o TeamMapOutput) ToTeamMapOutput() TeamMapOutput
func (TeamMapOutput) ToTeamMapOutputWithContext ¶
func (o TeamMapOutput) ToTeamMapOutputWithContext(ctx context.Context) TeamMapOutput
type TeamOutput ¶
type TeamOutput struct{ *pulumi.OutputState }
func (TeamOutput) AccessLevel ¶
func (o TeamOutput) AccessLevel() pulumi.StringOutput
The access level the team has on the test suite. Either READ_ONLY or MANAGE_AND_READ.
func (TeamOutput) ElementType ¶
func (TeamOutput) ElementType() reflect.Type
func (TeamOutput) TeamId ¶
func (o TeamOutput) TeamId() pulumi.StringOutput
The GraphQL ID of the team.
func (TeamOutput) TestSuiteId ¶
func (o TeamOutput) TestSuiteId() pulumi.StringOutput
The GraphQL ID of the test suite.
func (TeamOutput) ToTeamOutput ¶
func (o TeamOutput) ToTeamOutput() TeamOutput
func (TeamOutput) ToTeamOutputWithContext ¶
func (o TeamOutput) ToTeamOutputWithContext(ctx context.Context) TeamOutput
func (TeamOutput) Uuid ¶
func (o TeamOutput) Uuid() pulumi.StringOutput
This is the UUID of the test suite team.
type TeamState ¶
type TeamState struct { // The access level the team has on the test suite. Either READ_ONLY or MANAGE_AND_READ. AccessLevel pulumi.StringPtrInput // The GraphQL ID of the team. TeamId pulumi.StringPtrInput // The GraphQL ID of the test suite. TestSuiteId pulumi.StringPtrInput // This is the UUID of the test suite team. Uuid pulumi.StringPtrInput }
func (TeamState) ElementType ¶
type TestSuite ¶
type TestSuite struct { pulumi.CustomResourceState // This is the unique API token used when send test results. ApiToken pulumi.StringOutput `pulumi:"apiToken"` // This is the default branch used to compare tests against. DefaultBranch pulumi.StringOutput `pulumi:"defaultBranch"` // This is the name of the test suite. Name pulumi.StringOutput `pulumi:"name"` // This is the unique slug generated from the name upon creation. Slug pulumi.StringOutput `pulumi:"slug"` // This is a single team linked to the test suite upon creation. TeamOwnerId pulumi.StringOutput `pulumi:"teamOwnerId"` // This is the UUID of the suite. Uuid pulumi.StringOutput `pulumi:"uuid"` }
## # Resource: testSuite
This resources allows you to create and manage a Test Suite.
Buildkite documentation: https://buildkite.com/docs/test-analytics
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi" "github.com/pulumiverse/pulumi-buildkite/sdk/v2/go/buildkite/Team" "github.com/pulumiverse/pulumi-buildkite/sdk/v2/go/buildkite/TestSuite"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { test, err := Team.NewTeam(ctx, "test", &Team.TeamArgs{ Privacy: pulumi.String("VISIBLE"), DefaultTeam: pulumi.Bool(false), DefaultMemberRole: pulumi.String("MEMBER"), }) if err != nil { return err } _, err = TestSuite.NewTestSuite(ctx, "unitTests", &TestSuite.TestSuiteArgs{ DefaultBranch: pulumi.String("main"), TeamOwnerId: test.ID(), }) if err != nil { return err } return nil }) }
```
func GetTestSuite ¶
func GetTestSuite(ctx *pulumi.Context, name string, id pulumi.IDInput, state *TestSuiteState, opts ...pulumi.ResourceOption) (*TestSuite, error)
GetTestSuite gets an existing TestSuite resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewTestSuite ¶
func NewTestSuite(ctx *pulumi.Context, name string, args *TestSuiteArgs, opts ...pulumi.ResourceOption) (*TestSuite, error)
NewTestSuite registers a new resource with the given unique name, arguments, and options.
func (*TestSuite) ElementType ¶
func (*TestSuite) ToTestSuiteOutput ¶
func (i *TestSuite) ToTestSuiteOutput() TestSuiteOutput
func (*TestSuite) ToTestSuiteOutputWithContext ¶
func (i *TestSuite) ToTestSuiteOutputWithContext(ctx context.Context) TestSuiteOutput
type TestSuiteArgs ¶
type TestSuiteArgs struct { // This is the default branch used to compare tests against. DefaultBranch pulumi.StringInput // This is the name of the test suite. Name pulumi.StringPtrInput // This is a single team linked to the test suite upon creation. TeamOwnerId pulumi.StringInput }
The set of arguments for constructing a TestSuite resource.
func (TestSuiteArgs) ElementType ¶
func (TestSuiteArgs) ElementType() reflect.Type
type TestSuiteArray ¶
type TestSuiteArray []TestSuiteInput
func (TestSuiteArray) ElementType ¶
func (TestSuiteArray) ElementType() reflect.Type
func (TestSuiteArray) ToTestSuiteArrayOutput ¶
func (i TestSuiteArray) ToTestSuiteArrayOutput() TestSuiteArrayOutput
func (TestSuiteArray) ToTestSuiteArrayOutputWithContext ¶
func (i TestSuiteArray) ToTestSuiteArrayOutputWithContext(ctx context.Context) TestSuiteArrayOutput
type TestSuiteArrayInput ¶
type TestSuiteArrayInput interface { pulumi.Input ToTestSuiteArrayOutput() TestSuiteArrayOutput ToTestSuiteArrayOutputWithContext(context.Context) TestSuiteArrayOutput }
TestSuiteArrayInput is an input type that accepts TestSuiteArray and TestSuiteArrayOutput values. You can construct a concrete instance of `TestSuiteArrayInput` via:
TestSuiteArray{ TestSuiteArgs{...} }
type TestSuiteArrayOutput ¶
type TestSuiteArrayOutput struct{ *pulumi.OutputState }
func (TestSuiteArrayOutput) ElementType ¶
func (TestSuiteArrayOutput) ElementType() reflect.Type
func (TestSuiteArrayOutput) Index ¶
func (o TestSuiteArrayOutput) Index(i pulumi.IntInput) TestSuiteOutput
func (TestSuiteArrayOutput) ToTestSuiteArrayOutput ¶
func (o TestSuiteArrayOutput) ToTestSuiteArrayOutput() TestSuiteArrayOutput
func (TestSuiteArrayOutput) ToTestSuiteArrayOutputWithContext ¶
func (o TestSuiteArrayOutput) ToTestSuiteArrayOutputWithContext(ctx context.Context) TestSuiteArrayOutput
type TestSuiteInput ¶
type TestSuiteInput interface { pulumi.Input ToTestSuiteOutput() TestSuiteOutput ToTestSuiteOutputWithContext(ctx context.Context) TestSuiteOutput }
type TestSuiteMap ¶
type TestSuiteMap map[string]TestSuiteInput
func (TestSuiteMap) ElementType ¶
func (TestSuiteMap) ElementType() reflect.Type
func (TestSuiteMap) ToTestSuiteMapOutput ¶
func (i TestSuiteMap) ToTestSuiteMapOutput() TestSuiteMapOutput
func (TestSuiteMap) ToTestSuiteMapOutputWithContext ¶
func (i TestSuiteMap) ToTestSuiteMapOutputWithContext(ctx context.Context) TestSuiteMapOutput
type TestSuiteMapInput ¶
type TestSuiteMapInput interface { pulumi.Input ToTestSuiteMapOutput() TestSuiteMapOutput ToTestSuiteMapOutputWithContext(context.Context) TestSuiteMapOutput }
TestSuiteMapInput is an input type that accepts TestSuiteMap and TestSuiteMapOutput values. You can construct a concrete instance of `TestSuiteMapInput` via:
TestSuiteMap{ "key": TestSuiteArgs{...} }
type TestSuiteMapOutput ¶
type TestSuiteMapOutput struct{ *pulumi.OutputState }
func (TestSuiteMapOutput) ElementType ¶
func (TestSuiteMapOutput) ElementType() reflect.Type
func (TestSuiteMapOutput) MapIndex ¶
func (o TestSuiteMapOutput) MapIndex(k pulumi.StringInput) TestSuiteOutput
func (TestSuiteMapOutput) ToTestSuiteMapOutput ¶
func (o TestSuiteMapOutput) ToTestSuiteMapOutput() TestSuiteMapOutput
func (TestSuiteMapOutput) ToTestSuiteMapOutputWithContext ¶
func (o TestSuiteMapOutput) ToTestSuiteMapOutputWithContext(ctx context.Context) TestSuiteMapOutput
type TestSuiteOutput ¶
type TestSuiteOutput struct{ *pulumi.OutputState }
func (TestSuiteOutput) ApiToken ¶
func (o TestSuiteOutput) ApiToken() pulumi.StringOutput
This is the unique API token used when send test results.
func (TestSuiteOutput) DefaultBranch ¶
func (o TestSuiteOutput) DefaultBranch() pulumi.StringOutput
This is the default branch used to compare tests against.
func (TestSuiteOutput) ElementType ¶
func (TestSuiteOutput) ElementType() reflect.Type
func (TestSuiteOutput) Name ¶
func (o TestSuiteOutput) Name() pulumi.StringOutput
This is the name of the test suite.
func (TestSuiteOutput) Slug ¶
func (o TestSuiteOutput) Slug() pulumi.StringOutput
This is the unique slug generated from the name upon creation.
func (TestSuiteOutput) TeamOwnerId ¶
func (o TestSuiteOutput) TeamOwnerId() pulumi.StringOutput
This is a single team linked to the test suite upon creation.
func (TestSuiteOutput) ToTestSuiteOutput ¶
func (o TestSuiteOutput) ToTestSuiteOutput() TestSuiteOutput
func (TestSuiteOutput) ToTestSuiteOutputWithContext ¶
func (o TestSuiteOutput) ToTestSuiteOutputWithContext(ctx context.Context) TestSuiteOutput
func (TestSuiteOutput) Uuid ¶
func (o TestSuiteOutput) Uuid() pulumi.StringOutput
This is the UUID of the suite.
type TestSuiteState ¶
type TestSuiteState struct { // This is the unique API token used when send test results. ApiToken pulumi.StringPtrInput // This is the default branch used to compare tests against. DefaultBranch pulumi.StringPtrInput // This is the name of the test suite. Name pulumi.StringPtrInput // This is the unique slug generated from the name upon creation. Slug pulumi.StringPtrInput // This is a single team linked to the test suite upon creation. TeamOwnerId pulumi.StringPtrInput // This is the UUID of the suite. Uuid pulumi.StringPtrInput }
func (TestSuiteState) ElementType ¶
func (TestSuiteState) ElementType() reflect.Type