testplan

package
v7.2.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 14, 2024 License: MIT Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var ExcludeFlagsValues = excludeFlagsValuesType{

	None: "none",

	PointAssignments: "pointAssignments",

	ExtraInformation: "extraInformation",
}
View Source
var FailureTypeValues = failureTypeValuesType{
	None:        "none",
	Regression:  "regression",
	New_Issue:   "new_Issue",
	Known_Issue: "known_Issue",
	Unknown:     "unknown",
	Null_Value:  "null_Value",
	MaxValue:    "maxValue",
}
View Source
var LastResolutionStateValues = lastResolutionStateValuesType{
	None:               "none",
	NeedsInvestigation: "needsInvestigation",
	TestIssue:          "testIssue",
	ProductIssue:       "productIssue",
	ConfigurationIssue: "configurationIssue",
	NullValue:          "nullValue",
	MaxValue:           "maxValue",
}
View Source
var LibraryTestCasesDataReturnCodeValues = libraryTestCasesDataReturnCodeValuesType{
	Success: "success",
	Error:   "error",
}
View Source
var OutcomeValues = outcomeValuesType{

	Unspecified: "unspecified",

	None: "none",

	Passed: "passed",

	Failed: "failed",

	Inconclusive: "inconclusive",

	Timeout: "timeout",

	Aborted: "aborted",

	Blocked: "blocked",

	NotExecuted: "notExecuted",

	Warning: "warning",

	Error: "error",

	NotApplicable: "notApplicable",

	Paused: "paused",

	InProgress: "inProgress",

	NotImpacted: "notImpacted",
	MaxValue:    "maxValue",
}
View Source
var PointStateValues = pointStateValuesType{

	None: "none",

	Ready: "ready",

	Completed: "completed",

	NotReady: "notReady",

	InProgress: "inProgress",
	MaxValue:   "maxValue",
}
View Source
var ResultStateValues = resultStateValuesType{

	Unspecified: "unspecified",

	Pending: "pending",

	Queued: "queued",

	InProgress: "inProgress",

	Paused: "paused",

	Completed: "completed",
	MaxValue:  "maxValue",
}
View Source
var SuiteEntryTypesValues = suiteEntryTypesValuesType{

	TestCase: "testCase",

	Suite: "suite",
}
View Source
var SuiteExpandValues = suiteExpandValuesType{

	None: "none",

	Children: "children",

	DefaultTesters: "defaultTesters",
}
View Source
var TestEntityTypesValues = testEntityTypesValuesType{
	TestCase:  "testCase",
	TestPoint: "testPoint",
}
View Source
var TestPlansLibraryQueryValues = testPlansLibraryQueryValuesType{
	None:                              "none",
	AllTestCases:                      "allTestCases",
	TestCasesWithActiveBugs:           "testCasesWithActiveBugs",
	TestCasesNotLinkedToRequirements:  "testCasesNotLinkedToRequirements",
	TestCasesLinkedToRequirements:     "testCasesLinkedToRequirements",
	AllSharedSteps:                    "allSharedSteps",
	SharedStepsNotLinkedToRequirement: "sharedStepsNotLinkedToRequirement",
}
View Source
var TestPlansLibraryWorkItemFilterModeValues = testPlansLibraryWorkItemFilterModeValuesType{

	Or: "or",

	And: "and",
}
View Source
var TestSuiteTypeValues = testSuiteTypeValuesType{

	None: "none",

	DynamicTestSuite: "dynamicTestSuite",

	StaticTestSuite: "staticTestSuite",

	RequirementTestSuite: "requirementTestSuite",
}
View Source
var UserFriendlyTestOutcomeValues = userFriendlyTestOutcomeValuesType{
	InProgress:    "inProgress",
	Blocked:       "blocked",
	Failed:        "failed",
	Passed:        "passed",
	Ready:         "ready",
	NotApplicable: "notApplicable",
	Paused:        "paused",
	Timeout:       "timeout",
	Warning:       "warning",
	Error:         "error",
	NotExecuted:   "notExecuted",
	Inconclusive:  "inconclusive",
	Aborted:       "aborted",
	None:          "none",
	NotImpacted:   "notImpacted",
	Unspecified:   "unspecified",
	MaxValue:      "maxValue",
}

Functions

This section is empty.

Types

type AddTestCasesToSuiteArgs

type AddTestCasesToSuiteArgs struct {
	// (required) SuiteTestCaseCreateUpdateParameters object.
	SuiteTestCaseCreateUpdateParameters *[]SuiteTestCaseCreateUpdateParameters
	// (required) Project ID or project name
	Project *string
	// (required) ID of the test plan to which test cases are to be added.
	PlanId *int
	// (required) ID of the test suite to which test cases are to be added.
	SuiteId *int
}

Arguments for the AddTestCasesToSuite function

type BuildDefinitionReference

type BuildDefinitionReference struct {
	// ID of the build definition
	Id *int `json:"id,omitempty"`
	// Name of the build definition
	Name *string `json:"name,omitempty"`
}

The build definition reference resource

type Client

type Client interface {
	// [Preview API] Add test cases to a suite with specified configurations
	AddTestCasesToSuite(context.Context, AddTestCasesToSuiteArgs) (*[]TestCase, error)
	// [Preview API]
	CloneTestCase(context.Context, CloneTestCaseArgs) (*CloneTestCaseOperationInformation, error)
	// [Preview API] Clone test plan
	CloneTestPlan(context.Context, CloneTestPlanArgs) (*CloneTestPlanOperationInformation, error)
	// [Preview API] Clone test suite
	CloneTestSuite(context.Context, CloneTestSuiteArgs) (*CloneTestSuiteOperationInformation, error)
	// [Preview API] Create a test configuration.
	CreateTestConfiguration(context.Context, CreateTestConfigurationArgs) (*TestConfiguration, error)
	// [Preview API] Create a test plan.
	CreateTestPlan(context.Context, CreateTestPlanArgs) (*TestPlan, error)
	// [Preview API] Create test suite.
	CreateTestSuite(context.Context, CreateTestSuiteArgs) (*TestSuite, error)
	// [Preview API] Create a test variable.
	CreateTestVariable(context.Context, CreateTestVariableArgs) (*TestVariable, error)
	// [Preview API] Delete a test case.
	DeleteTestCase(context.Context, DeleteTestCaseArgs) error
	// [Preview API] Delete a test configuration by its ID.
	DeleteTestConfguration(context.Context, DeleteTestConfgurationArgs) error
	// [Preview API] Delete a test plan.
	DeleteTestPlan(context.Context, DeleteTestPlanArgs) error
	// [Preview API] Delete test suite.
	DeleteTestSuite(context.Context, DeleteTestSuiteArgs) error
	// [Preview API] Delete a test variable by its ID.
	DeleteTestVariable(context.Context, DeleteTestVariableArgs) error
	// [Preview API] Get clone information.
	GetCloneInformation(context.Context, GetCloneInformationArgs) (*CloneTestPlanOperationInformation, error)
	// [Preview API] Get a particular Test Point from a suite.
	GetPoints(context.Context, GetPointsArgs) (*[]TestPoint, error)
	// [Preview API] Get all the points inside a suite based on some filters
	GetPointsList(context.Context, GetPointsListArgs) (*GetPointsListResponseValue, error)
	// [Preview API] Get clone information.
	GetSuiteCloneInformation(context.Context, GetSuiteCloneInformationArgs) (*CloneTestSuiteOperationInformation, error)
	// [Preview API] Get a list of test suite entries in the test suite.
	GetSuiteEntries(context.Context, GetSuiteEntriesArgs) (*[]SuiteEntry, error)
	// [Preview API] Find the list of all test suites in which a given test case is present. This is helpful if you need to find out which test suites are using a test case, when you need to make changes to a test case.
	GetSuitesByTestCaseId(context.Context, GetSuitesByTestCaseIdArgs) (*[]TestSuite, error)
	// [Preview API] Get a particular Test Case from a Suite.
	GetTestCase(context.Context, GetTestCaseArgs) (*[]TestCase, error)
	// [Preview API] Get clone information.
	GetTestCaseCloneInformation(context.Context, GetTestCaseCloneInformationArgs) (*CloneTestCaseOperationInformation, error)
	// [Preview API] Get Test Case List return those test cases which have all the configuration Ids as mentioned in the optional parameter. If configuration Ids is null, it return all the test cases
	GetTestCaseList(context.Context, GetTestCaseListArgs) (*GetTestCaseListResponseValue, error)
	// [Preview API] Get a test configuration
	GetTestConfigurationById(context.Context, GetTestConfigurationByIdArgs) (*TestConfiguration, error)
	// [Preview API] Get a list of test configurations.
	GetTestConfigurations(context.Context, GetTestConfigurationsArgs) (*GetTestConfigurationsResponseValue, error)
	// [Preview API] Get a test plan by Id.
	GetTestPlanById(context.Context, GetTestPlanByIdArgs) (*TestPlan, error)
	// [Preview API] Get a list of test plans
	GetTestPlans(context.Context, GetTestPlansArgs) (*GetTestPlansResponseValue, error)
	// [Preview API] Get test suite by suite id.
	GetTestSuiteById(context.Context, GetTestSuiteByIdArgs) (*TestSuite, error)
	// [Preview API] Get test suites for plan.
	GetTestSuitesForPlan(context.Context, GetTestSuitesForPlanArgs) (*GetTestSuitesForPlanResponseValue, error)
	// [Preview API] Get a test variable by its ID.
	GetTestVariableById(context.Context, GetTestVariableByIdArgs) (*TestVariable, error)
	// [Preview API] Get a list of test variables.
	GetTestVariables(context.Context, GetTestVariablesArgs) (*GetTestVariablesResponseValue, error)
	// [Preview API] Removes test cases from a suite based on the list of test case Ids provided.
	RemoveTestCasesFromSuite(context.Context, RemoveTestCasesFromSuiteArgs) error
	// [Preview API] Removes test cases from a suite based on the list of test case Ids provided. This API can be used to remove a larger number of test cases.
	RemoveTestCasesListFromSuite(context.Context, RemoveTestCasesListFromSuiteArgs) error
	// [Preview API] Reorder test suite entries in the test suite.
	ReorderSuiteEntries(context.Context, ReorderSuiteEntriesArgs) (*[]SuiteEntry, error)
	// [Preview API] Update the configurations for test cases
	UpdateSuiteTestCases(context.Context, UpdateSuiteTestCasesArgs) (*[]TestCase, error)
	// [Preview API] Update a test configuration by its ID.
	UpdateTestConfiguration(context.Context, UpdateTestConfigurationArgs) (*TestConfiguration, error)
	// [Preview API] Update a test plan.
	UpdateTestPlan(context.Context, UpdateTestPlanArgs) (*TestPlan, error)
	// [Preview API] Update Test Points. This is used to Reset test point to active, update the outcome of a test point or update the tester of a test point
	UpdateTestPoints(context.Context, UpdateTestPointsArgs) (*[]TestPoint, error)
	// [Preview API] Update test suite.
	UpdateTestSuite(context.Context, UpdateTestSuiteArgs) (*TestSuite, error)
	// [Preview API] Update a test variable by its ID.
	UpdateTestVariable(context.Context, UpdateTestVariableArgs) (*TestVariable, error)
}

func NewClient

func NewClient(ctx context.Context, connection *azuredevops.Connection) Client

type ClientImpl

type ClientImpl struct {
	Client azuredevops.Client
}

func (*ClientImpl) AddTestCasesToSuite

func (client *ClientImpl) AddTestCasesToSuite(ctx context.Context, args AddTestCasesToSuiteArgs) (*[]TestCase, error)

[Preview API] Add test cases to a suite with specified configurations

func (*ClientImpl) CloneTestCase

[Preview API]

func (*ClientImpl) CloneTestPlan

[Preview API] Clone test plan

func (*ClientImpl) CloneTestSuite

[Preview API] Clone test suite

func (*ClientImpl) CreateTestConfiguration

func (client *ClientImpl) CreateTestConfiguration(ctx context.Context, args CreateTestConfigurationArgs) (*TestConfiguration, error)

[Preview API] Create a test configuration.

func (*ClientImpl) CreateTestPlan

func (client *ClientImpl) CreateTestPlan(ctx context.Context, args CreateTestPlanArgs) (*TestPlan, error)

[Preview API] Create a test plan.

func (*ClientImpl) CreateTestSuite

func (client *ClientImpl) CreateTestSuite(ctx context.Context, args CreateTestSuiteArgs) (*TestSuite, error)

[Preview API] Create test suite.

func (*ClientImpl) CreateTestVariable

func (client *ClientImpl) CreateTestVariable(ctx context.Context, args CreateTestVariableArgs) (*TestVariable, error)

[Preview API] Create a test variable.

func (*ClientImpl) DeleteTestCase

func (client *ClientImpl) DeleteTestCase(ctx context.Context, args DeleteTestCaseArgs) error

[Preview API] Delete a test case.

func (*ClientImpl) DeleteTestConfguration

func (client *ClientImpl) DeleteTestConfguration(ctx context.Context, args DeleteTestConfgurationArgs) error

[Preview API] Delete a test configuration by its ID.

func (*ClientImpl) DeleteTestPlan

func (client *ClientImpl) DeleteTestPlan(ctx context.Context, args DeleteTestPlanArgs) error

[Preview API] Delete a test plan.

func (*ClientImpl) DeleteTestSuite

func (client *ClientImpl) DeleteTestSuite(ctx context.Context, args DeleteTestSuiteArgs) error

[Preview API] Delete test suite.

func (*ClientImpl) DeleteTestVariable

func (client *ClientImpl) DeleteTestVariable(ctx context.Context, args DeleteTestVariableArgs) error

[Preview API] Delete a test variable by its ID.

func (*ClientImpl) GetCloneInformation

func (client *ClientImpl) GetCloneInformation(ctx context.Context, args GetCloneInformationArgs) (*CloneTestPlanOperationInformation, error)

[Preview API] Get clone information.

func (*ClientImpl) GetPoints

func (client *ClientImpl) GetPoints(ctx context.Context, args GetPointsArgs) (*[]TestPoint, error)

[Preview API] Get a particular Test Point from a suite.

func (*ClientImpl) GetPointsList

func (client *ClientImpl) GetPointsList(ctx context.Context, args GetPointsListArgs) (*GetPointsListResponseValue, error)

[Preview API] Get all the points inside a suite based on some filters

func (*ClientImpl) GetSuiteCloneInformation

func (client *ClientImpl) GetSuiteCloneInformation(ctx context.Context, args GetSuiteCloneInformationArgs) (*CloneTestSuiteOperationInformation, error)

[Preview API] Get clone information.

func (*ClientImpl) GetSuiteEntries

func (client *ClientImpl) GetSuiteEntries(ctx context.Context, args GetSuiteEntriesArgs) (*[]SuiteEntry, error)

[Preview API] Get a list of test suite entries in the test suite.

func (*ClientImpl) GetSuitesByTestCaseId

func (client *ClientImpl) GetSuitesByTestCaseId(ctx context.Context, args GetSuitesByTestCaseIdArgs) (*[]TestSuite, error)

[Preview API] Find the list of all test suites in which a given test case is present. This is helpful if you need to find out which test suites are using a test case, when you need to make changes to a test case.

func (*ClientImpl) GetTestCase

func (client *ClientImpl) GetTestCase(ctx context.Context, args GetTestCaseArgs) (*[]TestCase, error)

[Preview API] Get a particular Test Case from a Suite.

func (*ClientImpl) GetTestCaseCloneInformation

func (client *ClientImpl) GetTestCaseCloneInformation(ctx context.Context, args GetTestCaseCloneInformationArgs) (*CloneTestCaseOperationInformation, error)

[Preview API] Get clone information.

func (*ClientImpl) GetTestCaseList

func (client *ClientImpl) GetTestCaseList(ctx context.Context, args GetTestCaseListArgs) (*GetTestCaseListResponseValue, error)

[Preview API] Get Test Case List return those test cases which have all the configuration Ids as mentioned in the optional parameter. If configuration Ids is null, it return all the test cases

func (*ClientImpl) GetTestConfigurationById

func (client *ClientImpl) GetTestConfigurationById(ctx context.Context, args GetTestConfigurationByIdArgs) (*TestConfiguration, error)

[Preview API] Get a test configuration

func (*ClientImpl) GetTestConfigurations

func (client *ClientImpl) GetTestConfigurations(ctx context.Context, args GetTestConfigurationsArgs) (*GetTestConfigurationsResponseValue, error)

[Preview API] Get a list of test configurations.

func (*ClientImpl) GetTestPlanById

func (client *ClientImpl) GetTestPlanById(ctx context.Context, args GetTestPlanByIdArgs) (*TestPlan, error)

[Preview API] Get a test plan by Id.

func (*ClientImpl) GetTestPlans

func (client *ClientImpl) GetTestPlans(ctx context.Context, args GetTestPlansArgs) (*GetTestPlansResponseValue, error)

[Preview API] Get a list of test plans

func (*ClientImpl) GetTestSuiteById

func (client *ClientImpl) GetTestSuiteById(ctx context.Context, args GetTestSuiteByIdArgs) (*TestSuite, error)

[Preview API] Get test suite by suite id.

func (*ClientImpl) GetTestSuitesForPlan

func (client *ClientImpl) GetTestSuitesForPlan(ctx context.Context, args GetTestSuitesForPlanArgs) (*GetTestSuitesForPlanResponseValue, error)

[Preview API] Get test suites for plan.

func (*ClientImpl) GetTestVariableById

func (client *ClientImpl) GetTestVariableById(ctx context.Context, args GetTestVariableByIdArgs) (*TestVariable, error)

[Preview API] Get a test variable by its ID.

func (*ClientImpl) GetTestVariables

func (client *ClientImpl) GetTestVariables(ctx context.Context, args GetTestVariablesArgs) (*GetTestVariablesResponseValue, error)

[Preview API] Get a list of test variables.

func (*ClientImpl) RemoveTestCasesFromSuite

func (client *ClientImpl) RemoveTestCasesFromSuite(ctx context.Context, args RemoveTestCasesFromSuiteArgs) error

[Preview API] Removes test cases from a suite based on the list of test case Ids provided.

func (*ClientImpl) RemoveTestCasesListFromSuite

func (client *ClientImpl) RemoveTestCasesListFromSuite(ctx context.Context, args RemoveTestCasesListFromSuiteArgs) error

[Preview API] Removes test cases from a suite based on the list of test case Ids provided. This API can be used to remove a larger number of test cases.

func (*ClientImpl) ReorderSuiteEntries

func (client *ClientImpl) ReorderSuiteEntries(ctx context.Context, args ReorderSuiteEntriesArgs) (*[]SuiteEntry, error)

[Preview API] Reorder test suite entries in the test suite.

func (*ClientImpl) UpdateSuiteTestCases

func (client *ClientImpl) UpdateSuiteTestCases(ctx context.Context, args UpdateSuiteTestCasesArgs) (*[]TestCase, error)

[Preview API] Update the configurations for test cases

func (*ClientImpl) UpdateTestConfiguration

func (client *ClientImpl) UpdateTestConfiguration(ctx context.Context, args UpdateTestConfigurationArgs) (*TestConfiguration, error)

[Preview API] Update a test configuration by its ID.

func (*ClientImpl) UpdateTestPlan

func (client *ClientImpl) UpdateTestPlan(ctx context.Context, args UpdateTestPlanArgs) (*TestPlan, error)

[Preview API] Update a test plan.

func (*ClientImpl) UpdateTestPoints

func (client *ClientImpl) UpdateTestPoints(ctx context.Context, args UpdateTestPointsArgs) (*[]TestPoint, error)

[Preview API] Update Test Points. This is used to Reset test point to active, update the outcome of a test point or update the tester of a test point

func (*ClientImpl) UpdateTestSuite

func (client *ClientImpl) UpdateTestSuite(ctx context.Context, args UpdateTestSuiteArgs) (*TestSuite, error)

[Preview API] Update test suite.

func (*ClientImpl) UpdateTestVariable

func (client *ClientImpl) UpdateTestVariable(ctx context.Context, args UpdateTestVariableArgs) (*TestVariable, error)

[Preview API] Update a test variable by its ID.

type CloneOperationCommonResponse

type CloneOperationCommonResponse struct {
	// Various statistics related to the clone operation
	CloneStatistics *test.CloneStatistics `json:"cloneStatistics,omitempty"`
	// Completion data of the operation
	CompletionDate *azuredevops.Time `json:"completionDate,omitempty"`
	// Creation data of the operation
	CreationDate *azuredevops.Time `json:"creationDate,omitempty"`
	// Reference links
	Links interface{} `json:"links,omitempty"`
	// Message related to the job
	Message *string `json:"message,omitempty"`
	// Clone operation Id
	OpId *int `json:"opId,omitempty"`
	// Clone operation state
	State *test.CloneOperationState `json:"state,omitempty"`
}

Common Response for clone operation

type CloneTestCaseArgs

type CloneTestCaseArgs struct {
	// (required)
	CloneRequestBody *CloneTestCaseParams
	// (required) Project ID or project name
	Project *string
}

Arguments for the CloneTestCase function

type CloneTestCaseOperationInformation

type CloneTestCaseOperationInformation struct {
	// Various information related to the clone
	CloneOperationResponse *CloneOperationCommonResponse `json:"cloneOperationResponse,omitempty"`
	// Test Plan Clone create parameters
	CloneOptions *test.CloneTestCaseOptions `json:"cloneOptions,omitempty"`
	// Information of destination Test Suite
	DestinationTestSuite *TestSuiteReferenceWithProject `json:"destinationTestSuite,omitempty"`
	// Information of source Test Suite
	SourceTestSuite *SourceTestSuiteResponse `json:"sourceTestSuite,omitempty"`
}

type CloneTestCaseParams

type CloneTestCaseParams struct {
	// Test Case Clone create parameters
	CloneOptions *test.CloneTestCaseOptions `json:"cloneOptions,omitempty"`
	// Information about destination Test Plan
	DestinationTestPlan *TestPlanReference `json:"destinationTestPlan,omitempty"`
	// Information about destination Test Suite
	DestinationTestSuite *DestinationTestSuiteInfo `json:"destinationTestSuite,omitempty"`
	// Information about source Test Plan
	SourceTestPlan *TestPlanReference `json:"sourceTestPlan,omitempty"`
	// Information about source Test Suite
	SourceTestSuite *SourceTestSuiteInfo `json:"sourceTestSuite,omitempty"`
	// Test Case IDs
	TestCaseIds *[]int `json:"testCaseIds,omitempty"`
}

Parameters for Test Suite clone operation

type CloneTestPlanArgs

type CloneTestPlanArgs struct {
	// (required) Plan Clone Request Body detail TestPlanCloneRequest
	CloneRequestBody *CloneTestPlanParams
	// (required) Project ID or project name
	Project *string
	// (optional) Clones all the associated test cases as well
	DeepClone *bool
}

Arguments for the CloneTestPlan function

type CloneTestPlanOperationInformation

type CloneTestPlanOperationInformation struct {
	// Various information related to the clone
	CloneOperationResponse *CloneOperationCommonResponse `json:"cloneOperationResponse,omitempty"`
	// Test Plan Clone create parameters
	CloneOptions *test.CloneOptions `json:"cloneOptions,omitempty"`
	// Information of destination Test Plan
	DestinationTestPlan *TestPlan `json:"destinationTestPlan,omitempty"`
	// Information of source Test Plan
	SourceTestPlan *SourceTestplanResponse `json:"sourceTestPlan,omitempty"`
}

Response for Test Plan clone operation

type CloneTestPlanParams

type CloneTestPlanParams struct {
	// Test Plan Clone create parameters
	CloneOptions *test.CloneOptions `json:"cloneOptions,omitempty"`
	// Information about destination Test Plan
	DestinationTestPlan *DestinationTestPlanCloneParams `json:"destinationTestPlan,omitempty"`
	// Information about source Test Plan
	SourceTestPlan *SourceTestPlanInfo `json:"sourceTestPlan,omitempty"`
}

Parameters for Test Plan clone operation

type CloneTestSuiteArgs

type CloneTestSuiteArgs struct {
	// (required) Suite Clone Request Body detail TestSuiteCloneRequest
	CloneRequestBody *CloneTestSuiteParams
	// (required) Project ID or project name
	Project *string
	// (optional) Clones all the associated test cases as well
	DeepClone *bool
}

Arguments for the CloneTestSuite function

type CloneTestSuiteOperationInformation

type CloneTestSuiteOperationInformation struct {
	// Information of newly cloned Test Suite
	ClonedTestSuite *TestSuiteReferenceWithProject `json:"clonedTestSuite,omitempty"`
	// Various information related to the clone
	CloneOperationResponse *CloneOperationCommonResponse `json:"cloneOperationResponse,omitempty"`
	// Test Plan Clone create parameters
	CloneOptions *test.CloneOptions `json:"cloneOptions,omitempty"`
	// Information of destination Test Suite
	DestinationTestSuite *TestSuiteReferenceWithProject `json:"destinationTestSuite,omitempty"`
	// Information of source Test Suite
	SourceTestSuite *TestSuiteReferenceWithProject `json:"sourceTestSuite,omitempty"`
}

Response for Test Suite clone operation

type CloneTestSuiteParams

type CloneTestSuiteParams struct {
	// Test Plan Clone create parameters
	CloneOptions *test.CloneOptions `json:"cloneOptions,omitempty"`
	// Information about destination Test Suite
	DestinationTestSuite *DestinationTestSuiteInfo `json:"destinationTestSuite,omitempty"`
	// Information about source Test Suite
	SourceTestSuite *SourceTestSuiteInfo `json:"sourceTestSuite,omitempty"`
}

Parameters for Test Suite clone operation

type Configuration

type Configuration struct {
	// Id of the Configuration Assigned to the Test Point
	ConfigurationId *int `json:"configurationId,omitempty"`
}

Configuration of the Test Point

type CreateTestConfigurationArgs

type CreateTestConfigurationArgs struct {
	// (required) TestConfigurationCreateUpdateParameters
	TestConfigurationCreateUpdateParameters *TestConfigurationCreateUpdateParameters
	// (required) Project ID or project name
	Project *string
}

Arguments for the CreateTestConfiguration function

type CreateTestPlanArgs

type CreateTestPlanArgs struct {
	// (required) A testPlanCreateParams object.TestPlanCreateParams
	TestPlanCreateParams *TestPlanCreateParams
	// (required) Project ID or project name
	Project *string
}

Arguments for the CreateTestPlan function

type CreateTestSuiteArgs

type CreateTestSuiteArgs struct {
	// (required) Parameters for suite creation
	TestSuiteCreateParams *TestSuiteCreateParams
	// (required) Project ID or project name
	Project *string
	// (required) ID of the test plan that contains the suites.
	PlanId *int
}

Arguments for the CreateTestSuite function

type CreateTestVariableArgs

type CreateTestVariableArgs struct {
	// (required) TestVariableCreateUpdateParameters
	TestVariableCreateUpdateParameters *TestVariableCreateUpdateParameters
	// (required) Project ID or project name
	Project *string
}

Arguments for the CreateTestVariable function

type DeleteTestCaseArgs

type DeleteTestCaseArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Id of test case to be deleted.
	TestCaseId *int
}

Arguments for the DeleteTestCase function

type DeleteTestConfgurationArgs

type DeleteTestConfgurationArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) ID of the test configuration to delete.
	TestConfiguartionId *int
}

Arguments for the DeleteTestConfguration function

type DeleteTestPlanArgs

type DeleteTestPlanArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) ID of the test plan to be deleted.
	PlanId *int
}

Arguments for the DeleteTestPlan function

type DeleteTestSuiteArgs

type DeleteTestSuiteArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) ID of the test plan that contains the suite.
	PlanId *int
	// (required) ID of the test suite to delete.
	SuiteId *int
}

Arguments for the DeleteTestSuite function

type DeleteTestVariableArgs

type DeleteTestVariableArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) ID of the test variable to delete.
	TestVariableId *int
}

Arguments for the DeleteTestVariable function

type DestinationTestPlanCloneParams

type DestinationTestPlanCloneParams struct {
	// Area of the test plan.
	AreaPath *string `json:"areaPath,omitempty"`
	// The Build Definition that generates a build associated with this test plan.
	BuildDefinition *BuildDefinitionReference `json:"buildDefinition,omitempty"`
	// Build to be tested.
	BuildId *int `json:"buildId,omitempty"`
	// Description of the test plan.
	Description *string `json:"description,omitempty"`
	// End date for the test plan.
	EndDate *azuredevops.Time `json:"endDate,omitempty"`
	// Iteration path of the test plan.
	Iteration *string `json:"iteration,omitempty"`
	// Name of the test plan.
	Name *string `json:"name,omitempty"`
	// Owner of the test plan.
	Owner *webapi.IdentityRef `json:"owner,omitempty"`
	// Release Environment to be used to deploy the build and run automated tests from this test plan.
	ReleaseEnvironmentDefinition *test.ReleaseEnvironmentDefinitionReference `json:"releaseEnvironmentDefinition,omitempty"`
	// Start date for the test plan.
	StartDate *azuredevops.Time `json:"startDate,omitempty"`
	// State of the test plan.
	State *string `json:"state,omitempty"`
	// Value to configure how same tests across test suites under a test plan need to behave
	TestOutcomeSettings *test.TestOutcomeSettings `json:"testOutcomeSettings,omitempty"`
	// Destination Project Name
	Project *string `json:"project,omitempty"`
}

Destination Test Plan create parameters

type DestinationTestSuiteInfo

type DestinationTestSuiteInfo struct {
	// Destination Suite Id
	Id *int `json:"id,omitempty"`
	// Destination Project Name
	Project *string `json:"project,omitempty"`
}

Destination Test Suite information for Test Suite clone operation

type ExcludeFlags

type ExcludeFlags string

[Flags] Exclude Flags for suite test case object. Exclude Flags exclude various objects from payload depending on the value passed

type FailureType

type FailureType string

type GetCloneInformationArgs

type GetCloneInformationArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Operation ID returned when we queue a clone operation
	CloneOperationId *int
}

Arguments for the GetCloneInformation function

type GetPointsArgs

type GetPointsArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) ID of the test plan for which test points are requested.
	PlanId *int
	// (required) ID of the test suite for which test points are requested.
	SuiteId *int
	// (required) ID of test point to be fetched.
	PointId *string
	// (optional) If set to true, returns the AssignedTo field in TestCaseReference as IdentityRef object.
	ReturnIdentityRef *bool
	// (optional) If set to false, will get a smaller payload containing only basic details about the test point object
	IncludePointDetails *bool
}

Arguments for the GetPoints function

type GetPointsListArgs

type GetPointsListArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) ID of the test plan for which test points are requested.
	PlanId *int
	// (required) ID of the test suite for which test points are requested
	SuiteId *int
	// (optional) ID of test points to fetch.
	TestPointIds *string
	// (optional) Get Test Points for specific test case Ids.
	TestCaseId *string
	// (optional) If the list of test point returned is not complete, a continuation token to query next batch of test points is included in the response header as "x-ms-continuationtoken". Omit this parameter to get the first batch of test points.
	ContinuationToken *string
	// (optional) If set to true, returns the AssignedTo field in TestCaseReference as IdentityRef object.
	ReturnIdentityRef *bool
	// (optional) If set to false, will get a smaller payload containing only basic details about the test point object
	IncludePointDetails *bool
	// (optional) If set to true, will also fetch test points belonging to child suites recursively.
	IsRecursive *bool
}

Arguments for the GetPointsList function

type GetPointsListResponseValue

type GetPointsListResponseValue struct {
	Value             []TestPoint
	ContinuationToken string
}

Return type for the GetPointsList function

type GetSuiteCloneInformationArgs

type GetSuiteCloneInformationArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Operation ID returned when we queue a clone operation
	CloneOperationId *int
}

Arguments for the GetSuiteCloneInformation function

type GetSuiteEntriesArgs

type GetSuiteEntriesArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Id of the parent suite.
	SuiteId *int
	// (optional)
	SuiteEntryType *SuiteEntryTypes
}

Arguments for the GetSuiteEntries function

type GetSuitesByTestCaseIdArgs

type GetSuitesByTestCaseIdArgs struct {
	// (required) ID of the test case for which suites need to be fetched.
	TestCaseId *int
}

Arguments for the GetSuitesByTestCaseId function

type GetTestCaseArgs

type GetTestCaseArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) ID of the test plan for which test cases are requested.
	PlanId *int
	// (required) ID of the test suite for which test cases are requested.
	SuiteId *int
	// (required) Test Case Id to be fetched.
	TestCaseId *string
	// (optional) Get the list of witFields.
	WitFields *string
	// (optional) If set to true, returns all identity fields, like AssignedTo, ActivatedBy etc., as IdentityRef objects. If set to false, these fields are returned as unique names in string format. This is false by default.
	ReturnIdentityRef *bool
}

Arguments for the GetTestCase function

type GetTestCaseCloneInformationArgs

type GetTestCaseCloneInformationArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Operation ID returned when we queue a clone operation
	CloneOperationId *int
}

Arguments for the GetTestCaseCloneInformation function

type GetTestCaseListArgs

type GetTestCaseListArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) ID of the test plan for which test cases are requested.
	PlanId *int
	// (required) ID of the test suite for which test cases are requested.
	SuiteId *int
	// (optional) Test Case Ids to be fetched.
	TestIds *string
	// (optional) Fetch Test Cases which contains all the configuration Ids specified.
	ConfigurationIds *string
	// (optional) Get the list of witFields.
	WitFields *string
	// (optional) If the list of test cases returned is not complete, a continuation token to query next batch of test cases is included in the response header as "x-ms-continuationtoken". Omit this parameter to get the first batch of test cases.
	ContinuationToken *string
	// (optional) If set to true, returns all identity fields, like AssignedTo, ActivatedBy etc., as IdentityRef objects. If set to false, these fields are returned as unique names in string format. This is false by default.
	ReturnIdentityRef *bool
	// (optional) If set to false, will get a smaller payload containing only basic details about the suite test case object
	Expand *bool
	// (optional) Flag to exclude various values from payload. For example to remove point assignments pass exclude = 1. To remove extra information (links, test plan , test suite) pass exclude = 2. To remove both extra information and point assignments pass exclude = 3 (1 + 2).
	ExcludeFlags *ExcludeFlags
	// (optional)
	IsRecursive *bool
}

Arguments for the GetTestCaseList function

type GetTestCaseListResponseValue

type GetTestCaseListResponseValue struct {
	Value             []TestCase
	ContinuationToken string
}

Return type for the GetTestCaseList function

type GetTestConfigurationByIdArgs

type GetTestConfigurationByIdArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) ID of the test configuration to get.
	TestConfigurationId *int
}

Arguments for the GetTestConfigurationById function

type GetTestConfigurationsArgs

type GetTestConfigurationsArgs struct {
	// (required) Project ID or project name
	Project *string
	// (optional) If the list of configurations returned is not complete, a continuation token to query next batch of configurations is included in the response header as "x-ms-continuationtoken". Omit this parameter to get the first batch of test configurations.
	ContinuationToken *string
}

Arguments for the GetTestConfigurations function

type GetTestConfigurationsResponseValue

type GetTestConfigurationsResponseValue struct {
	Value             []TestConfiguration
	ContinuationToken string
}

Return type for the GetTestConfigurations function

type GetTestPlanByIdArgs

type GetTestPlanByIdArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) ID of the test plan to get.
	PlanId *int
}

Arguments for the GetTestPlanById function

type GetTestPlansArgs

type GetTestPlansArgs struct {
	// (required) Project ID or project name
	Project *string
	// (optional) Filter for test plan by owner ID or name
	Owner *string
	// (optional) If the list of plans returned is not complete, a continuation token to query next batch of plans is included in the response header as "x-ms-continuationtoken". Omit this parameter to get the first batch of test plans.
	ContinuationToken *string
	// (optional) Get all properties of the test plan
	IncludePlanDetails *bool
	// (optional) Get just the active plans
	FilterActivePlans *bool
}

Arguments for the GetTestPlans function

type GetTestPlansResponseValue

type GetTestPlansResponseValue struct {
	Value             []TestPlan
	ContinuationToken string
}

Return type for the GetTestPlans function

type GetTestSuiteByIdArgs

type GetTestSuiteByIdArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) ID of the test plan that contains the suites.
	PlanId *int
	// (required) ID of the suite to get.
	SuiteId *int
	// (optional) Include the children suites and testers details
	Expand *SuiteExpand
}

Arguments for the GetTestSuiteById function

type GetTestSuitesForPlanArgs

type GetTestSuitesForPlanArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) ID of the test plan for which suites are requested.
	PlanId *int
	// (optional) Include the children suites and testers details.
	Expand *SuiteExpand
	// (optional) If the list of suites returned is not complete, a continuation token to query next batch of suites is included in the response header as "x-ms-continuationtoken". Omit this parameter to get the first batch of test suites.
	ContinuationToken *string
	// (optional) If the suites returned should be in a tree structure.
	AsTreeView *bool
}

Arguments for the GetTestSuitesForPlan function

type GetTestSuitesForPlanResponseValue

type GetTestSuitesForPlanResponseValue struct {
	Value             []TestSuite
	ContinuationToken string
}

Return type for the GetTestSuitesForPlan function

type GetTestVariableByIdArgs

type GetTestVariableByIdArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) ID of the test variable to get.
	TestVariableId *int
}

Arguments for the GetTestVariableById function

type GetTestVariablesArgs

type GetTestVariablesArgs struct {
	// (required) Project ID or project name
	Project *string
	// (optional) If the list of variables returned is not complete, a continuation token to query next batch of variables is included in the response header as "x-ms-continuationtoken". Omit this parameter to get the first batch of test variables.
	ContinuationToken *string
}

Arguments for the GetTestVariables function

type GetTestVariablesResponseValue

type GetTestVariablesResponseValue struct {
	Value             []TestVariable
	ContinuationToken string
}

Return type for the GetTestVariables function

type LastResolutionState

type LastResolutionState string

type LibraryTestCasesDataReturnCode

type LibraryTestCasesDataReturnCode string

Enum representing the return code of data provider.

type LibraryWorkItemsData

type LibraryWorkItemsData struct {
	// Specifies the column option field names
	ColumnOptions *[]string `json:"columnOptions,omitempty"`
	// Continuation token to fetch next set of elements. Present only when HasMoreElements is true.
	ContinuationToken *string `json:"continuationToken,omitempty"`
	// Boolean indicating if the WIQL query has exceeded the limit of items returned.
	ExceededWorkItemQueryLimit *bool `json:"exceededWorkItemQueryLimit,omitempty"`
	// Boolean indicating if there are more elements present than what are being sent.
	HasMoreElements *bool `json:"hasMoreElements,omitempty"`
	// Specifies if there was an error while execution of data provider.
	ReturnCode *LibraryTestCasesDataReturnCode `json:"returnCode,omitempty"`
	// List of work items returned when OrderByField is sent something other than Id.
	WorkItemIds *[]int `json:"workItemIds,omitempty"`
	// List of work items to be returned.
	WorkItems *[]WorkItemDetails `json:"workItems,omitempty"`
}

This data model is used in Work item-based tabs of Test Plans Library.

type LibraryWorkItemsDataProviderRequest

type LibraryWorkItemsDataProviderRequest struct {
	// Specifies the list of column options to show in test cases table.
	ColumnOptions *[]string `json:"columnOptions,omitempty"`
	// The continuation token required for paging of work items. This is required when getting subsequent sets of work items when OrderByField is Id.
	ContinuationToken *string `json:"continuationToken,omitempty"`
	// List of filter values to be supplied. Currently supported filters are Title, State, AssignedTo, Priority, AreaPath.
	FilterValues *[]TestPlansLibraryWorkItemFilter `json:"filterValues,omitempty"`
	// Whether the data is to be sorted in ascending or descending order. When not supplied, defaults to descending.
	IsAscending *bool `json:"isAscending,omitempty"`
	// The type of query to run.
	LibraryQueryType *TestPlansLibraryQuery `json:"libraryQueryType,omitempty"`
	// Work item field on which to order the results. When not supplied, defaults to work item IDs.
	OrderByField *string `json:"orderByField,omitempty"`
	// List of work items to query for field details. This is required when getting subsequent sets of work item fields when OrderByField is other than Id.
	WorkItemIds *[]int `json:"workItemIds,omitempty"`
}

This is the request data contract for LibraryTestCaseDataProvider.

type Outcome

type Outcome string

type PointAssignment

type PointAssignment struct {
	// Id of the Configuration Assigned to the Test Point
	ConfigurationId *int `json:"configurationId,omitempty"`
	// Name of the Configuration Assigned to the Test Point
	ConfigurationName *string `json:"configurationName,omitempty"`
	// Id of the Test Point
	Id *int `json:"id,omitempty"`
	// Tester Assigned to the Test Point
	Tester *webapi.IdentityRef `json:"tester,omitempty"`
}

Assignments for the Test Point

type PointState

type PointState string

type RemoveTestCasesFromSuiteArgs

type RemoveTestCasesFromSuiteArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) ID of the test plan from which test cases are to be removed.
	PlanId *int
	// (required) ID of the test suite from which test cases are to be removed.
	SuiteId *int
	// (required) Test Case Ids to be removed.
	TestCaseIds *string
}

Arguments for the RemoveTestCasesFromSuite function

type RemoveTestCasesListFromSuiteArgs

type RemoveTestCasesListFromSuiteArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) ID of the test plan from which test cases are to be removed.
	PlanId *int
	// (required) ID of the test suite from which test cases are to be removed.
	SuiteId *int
	// (required) Comma separated string of Test Case Ids to be removed.
	TestIds *string
}

Arguments for the RemoveTestCasesListFromSuite function

type ReorderSuiteEntriesArgs

type ReorderSuiteEntriesArgs struct {
	// (required) List of SuiteEntry to reorder.
	SuiteEntries *[]SuiteEntryUpdateParams
	// (required) Project ID or project name
	Project *string
	// (required) Id of the parent test suite.
	SuiteId *int
}

Arguments for the ReorderSuiteEntries function

type ResultState

type ResultState string

type Results

type Results struct {
	// Outcome of the Test Point
	Outcome *Outcome `json:"outcome,omitempty"`
}

Results class for Test Point

type SourceTestPlanInfo

type SourceTestPlanInfo struct {
	// ID of the source Test Plan
	Id *int `json:"id,omitempty"`
	// Id of suites to be cloned inside source Test Plan
	SuiteIds *[]int `json:"suiteIds,omitempty"`
}

Source Test Plan information for Test Plan clone operation

type SourceTestSuiteInfo

type SourceTestSuiteInfo struct {
	// Id of the Source Test Suite
	Id *int `json:"id,omitempty"`
}

Source Test Suite information for Test Suite clone operation

type SourceTestSuiteResponse

type SourceTestSuiteResponse struct {
	// ID of the test suite.
	Id *int `json:"id,omitempty"`
	// Name of the test suite.
	Name *string `json:"name,omitempty"`
	// project reference
	Project *core.TeamProjectReference `json:"project,omitempty"`
	// Id of suites to be cloned inside source Test Plan
	TestCaseIds *[]int `json:"testCaseIds,omitempty"`
}

Source Test Suite Response for Test Case clone operation

type SourceTestplanResponse

type SourceTestplanResponse struct {
	// ID of the test plan.
	Id *int `json:"id,omitempty"`
	// Name of the test plan.
	Name *string `json:"name,omitempty"`
	// project reference
	Project *core.TeamProjectReference `json:"project,omitempty"`
	// Id of suites to be cloned inside source Test Plan
	SuiteIds *[]int `json:"suiteIds,omitempty"`
}

Source Test Plan Response for Test Plan clone operation

type SuiteEntry

type SuiteEntry struct {
	// Id of the suite entry in the test suite: either a test case id or child suite id.
	Id *int `json:"id,omitempty"`
	// Sequence number for the suite entry object in the test suite.
	SequenceNumber *int `json:"sequenceNumber,omitempty"`
	// Defines whether the entry is of type test case or suite.
	SuiteEntryType *SuiteEntryTypes `json:"suiteEntryType,omitempty"`
	// Id for the test suite.
	SuiteId *int `json:"suiteId,omitempty"`
}

A suite entry defines properties for a test suite.

type SuiteEntryTypes

type SuiteEntryTypes string

type SuiteEntryUpdateParams

type SuiteEntryUpdateParams struct {
	// Id of the suite entry in the test suite: either a test case id or child suite id.
	Id *int `json:"id,omitempty"`
	// Sequence number for the suite entry object in the test suite.
	SequenceNumber *int `json:"sequenceNumber,omitempty"`
	// Defines whether the entry is of type test case or suite.
	SuiteEntryType *SuiteEntryTypes `json:"suiteEntryType,omitempty"`
}

A suite entry defines properties for a test suite.

type SuiteExpand

type SuiteExpand string

[Flags] Option to get details in response

type SuiteTestCaseCreateUpdateParameters

type SuiteTestCaseCreateUpdateParameters struct {
	// Configurations Ids
	PointAssignments *[]Configuration `json:"pointAssignments,omitempty"`
	// Id of Test Case to be updated or created
	WorkItem *WorkItem `json:"workItem,omitempty"`
}

Create and Update Suite Test Case Parameters

type TestCase

type TestCase struct {
	// Reference links
	Links interface{} `json:"links,omitempty"`
	// Order of the TestCase in the Suite
	Order *int `json:"order,omitempty"`
	// List of Points associated with the Test Case
	PointAssignments *[]PointAssignment `json:"pointAssignments,omitempty"`
	// Project under which the Test Case is
	Project *core.TeamProjectReference `json:"project,omitempty"`
	// Test Plan under which the Test Case is
	TestPlan *TestPlanReference `json:"testPlan,omitempty"`
	// Test Suite under which the Test Case is
	TestSuite *TestSuiteReference `json:"testSuite,omitempty"`
	// Work Item details of the TestCase
	WorkItem *WorkItemDetails `json:"workItem,omitempty"`
}

Test Case Class

type TestCaseAssociatedResult

type TestCaseAssociatedResult struct {
	CompletedDate *azuredevops.Time           `json:"completedDate,omitempty"`
	Configuration *TestConfigurationReference `json:"configuration,omitempty"`
	Outcome       *UserFriendlyTestOutcome    `json:"outcome,omitempty"`
	Plan          *TestPlanReference          `json:"plan,omitempty"`
	PointId       *int                        `json:"pointId,omitempty"`
	ResultId      *int                        `json:"resultId,omitempty"`
	RunBy         *webapi.IdentityRef         `json:"runBy,omitempty"`
	RunId         *int                        `json:"runId,omitempty"`
	Suite         *TestSuiteReference         `json:"suite,omitempty"`
	Tester        *webapi.IdentityRef         `json:"tester,omitempty"`
}

type TestCaseReference

type TestCaseReference struct {
	// Identity to whom the test case is assigned
	AssignedTo *webapi.IdentityRef `json:"assignedTo,omitempty"`
	// Test Case Id
	Id *int `json:"id,omitempty"`
	// Test Case Name
	Name *string `json:"name,omitempty"`
	// State of the test case work item
	State *string `json:"state,omitempty"`
}

Test Case Reference

type TestCaseResultsData

type TestCaseResultsData struct {
	// Point information from where the execution history was viewed. Used to set initial filters.
	ContextPoint *TestPointDetailedReference `json:"contextPoint,omitempty"`
	// Use to store the results displayed in the table
	Results *[]TestCaseAssociatedResult `json:"results,omitempty"`
	// Test Case Name to be displayed in the table header
	TestCaseName *string `json:"testCaseName,omitempty"`
}

This data model is used in TestCaseResultsDataProvider and populates the data required for initial page load

type TestConfiguration

type TestConfiguration struct {
	// Description of the configuration
	Description *string `json:"description,omitempty"`
	// Is the configuration a default for the test plans
	IsDefault *bool `json:"isDefault,omitempty"`
	// Name of the configuration
	Name *string `json:"name,omitempty"`
	// State of the configuration
	State *test.TestConfigurationState `json:"state,omitempty"`
	// Dictionary of Test Variable, Selected Value
	Values *[]test.NameValuePair `json:"values,omitempty"`
	// Id of the configuration
	Id *int `json:"id,omitempty"`
	// Id of the test configuration variable
	Project *core.TeamProjectReference `json:"project,omitempty"`
}

Test configuration

type TestConfigurationCreateUpdateParameters

type TestConfigurationCreateUpdateParameters struct {
	// Description of the configuration
	Description *string `json:"description,omitempty"`
	// Is the configuration a default for the test plans
	IsDefault *bool `json:"isDefault,omitempty"`
	// Name of the configuration
	Name *string `json:"name,omitempty"`
	// State of the configuration
	State *test.TestConfigurationState `json:"state,omitempty"`
	// Dictionary of Test Variable, Selected Value
	Values *[]test.NameValuePair `json:"values,omitempty"`
}

Test Configuration Create or Update Parameters

type TestConfigurationReference

type TestConfigurationReference struct {
	// Id of the configuration
	Id *int `json:"id,omitempty"`
	// Name of the configuration
	Name *string `json:"name,omitempty"`
}

Test Configuration Reference

type TestEntityCount

type TestEntityCount struct {
	// Test Entity Count
	Count *int `json:"count,omitempty"`
	// Test Plan under which the Test Entities are
	TestPlanId *int `json:"testPlanId,omitempty"`
	// Test Suite under which the Test Entities are
	TestSuiteId *int `json:"testSuiteId,omitempty"`
	// Total test entities in the suite without the applied filters
	TotalCount *int `json:"totalCount,omitempty"`
}

Test Entity Count Used to store test cases count (define tab) and test point count (execute tab) Used to store test cases count (define tab) and test point count (execute tab)

type TestEntityTypes

type TestEntityTypes string

type TestPlan

type TestPlan struct {
	// Area of the test plan.
	AreaPath *string `json:"areaPath,omitempty"`
	// The Build Definition that generates a build associated with this test plan.
	BuildDefinition *BuildDefinitionReference `json:"buildDefinition,omitempty"`
	// Build to be tested.
	BuildId *int `json:"buildId,omitempty"`
	// Description of the test plan.
	Description *string `json:"description,omitempty"`
	// End date for the test plan.
	EndDate *azuredevops.Time `json:"endDate,omitempty"`
	// Iteration path of the test plan.
	Iteration *string `json:"iteration,omitempty"`
	// Name of the test plan.
	Name *string `json:"name,omitempty"`
	// Owner of the test plan.
	Owner *webapi.IdentityRef `json:"owner,omitempty"`
	// Release Environment to be used to deploy the build and run automated tests from this test plan.
	ReleaseEnvironmentDefinition *test.ReleaseEnvironmentDefinitionReference `json:"releaseEnvironmentDefinition,omitempty"`
	// Start date for the test plan.
	StartDate *azuredevops.Time `json:"startDate,omitempty"`
	// State of the test plan.
	State *string `json:"state,omitempty"`
	// Value to configure how same tests across test suites under a test plan need to behave
	TestOutcomeSettings *test.TestOutcomeSettings `json:"testOutcomeSettings,omitempty"`
	// Revision of the test plan.
	Revision *int `json:"revision,omitempty"`
	// Relevant links
	Links interface{} `json:"_links,omitempty"`
	// ID of the test plan.
	Id *int `json:"id,omitempty"`
	// Previous build Id associated with the test plan
	PreviousBuildId *int `json:"previousBuildId,omitempty"`
	// Project which contains the test plan.
	Project *core.TeamProjectReference `json:"project,omitempty"`
	// Root test suite of the test plan.
	RootSuite *TestSuiteReference `json:"rootSuite,omitempty"`
	// Identity Reference for the last update of the test plan
	UpdatedBy *webapi.IdentityRef `json:"updatedBy,omitempty"`
	// Updated date of the test plan
	UpdatedDate *azuredevops.Time `json:"updatedDate,omitempty"`
}

The test plan resource.

type TestPlanCreateParams

type TestPlanCreateParams struct {
	// Area of the test plan.
	AreaPath *string `json:"areaPath,omitempty"`
	// The Build Definition that generates a build associated with this test plan.
	BuildDefinition *BuildDefinitionReference `json:"buildDefinition,omitempty"`
	// Build to be tested.
	BuildId *int `json:"buildId,omitempty"`
	// Description of the test plan.
	Description *string `json:"description,omitempty"`
	// End date for the test plan.
	EndDate *azuredevops.Time `json:"endDate,omitempty"`
	// Iteration path of the test plan.
	Iteration *string `json:"iteration,omitempty"`
	// Name of the test plan.
	Name *string `json:"name,omitempty"`
	// Owner of the test plan.
	Owner *webapi.IdentityRef `json:"owner,omitempty"`
	// Release Environment to be used to deploy the build and run automated tests from this test plan.
	ReleaseEnvironmentDefinition *test.ReleaseEnvironmentDefinitionReference `json:"releaseEnvironmentDefinition,omitempty"`
	// Start date for the test plan.
	StartDate *azuredevops.Time `json:"startDate,omitempty"`
	// State of the test plan.
	State *string `json:"state,omitempty"`
	// Value to configure how same tests across test suites under a test plan need to behave
	TestOutcomeSettings *test.TestOutcomeSettings `json:"testOutcomeSettings,omitempty"`
}

The test plan create parameters.

type TestPlanDetailedReference

type TestPlanDetailedReference struct {
	// ID of the test plan.
	Id *int `json:"id,omitempty"`
	// Name of the test plan.
	Name *string `json:"name,omitempty"`
	// Area of the test plan.
	AreaPath *string `json:"areaPath,omitempty"`
	// End date for the test plan.
	EndDate *azuredevops.Time `json:"endDate,omitempty"`
	// Iteration path of the test plan.
	Iteration *string `json:"iteration,omitempty"`
	// Root Suite Id
	RootSuiteId *int `json:"rootSuiteId,omitempty"`
	// Start date for the test plan.
	StartDate *azuredevops.Time `json:"startDate,omitempty"`
}

The test plan detailed reference resource. Contains additional workitem realted information

type TestPlanReference

type TestPlanReference struct {
	// ID of the test plan.
	Id *int `json:"id,omitempty"`
	// Name of the test plan.
	Name *string `json:"name,omitempty"`
}

The test plan reference resource.

type TestPlanUpdateParams

type TestPlanUpdateParams struct {
	// Area of the test plan.
	AreaPath *string `json:"areaPath,omitempty"`
	// The Build Definition that generates a build associated with this test plan.
	BuildDefinition *BuildDefinitionReference `json:"buildDefinition,omitempty"`
	// Build to be tested.
	BuildId *int `json:"buildId,omitempty"`
	// Description of the test plan.
	Description *string `json:"description,omitempty"`
	// End date for the test plan.
	EndDate *azuredevops.Time `json:"endDate,omitempty"`
	// Iteration path of the test plan.
	Iteration *string `json:"iteration,omitempty"`
	// Name of the test plan.
	Name *string `json:"name,omitempty"`
	// Owner of the test plan.
	Owner *webapi.IdentityRef `json:"owner,omitempty"`
	// Release Environment to be used to deploy the build and run automated tests from this test plan.
	ReleaseEnvironmentDefinition *test.ReleaseEnvironmentDefinitionReference `json:"releaseEnvironmentDefinition,omitempty"`
	// Start date for the test plan.
	StartDate *azuredevops.Time `json:"startDate,omitempty"`
	// State of the test plan.
	State *string `json:"state,omitempty"`
	// Value to configure how same tests across test suites under a test plan need to behave
	TestOutcomeSettings *test.TestOutcomeSettings `json:"testOutcomeSettings,omitempty"`
	// Revision of the test plan.
	Revision *int `json:"revision,omitempty"`
}

The test plan update parameters.

type TestPlansHubRefreshData

type TestPlansHubRefreshData struct {
	DefineColumnOptionFields       *[]string                  `json:"defineColumnOptionFields,omitempty"`
	DefineTabCustomColumnFieldMap  *map[string]string         `json:"defineTabCustomColumnFieldMap,omitempty"`
	ErrorMessage                   *string                    `json:"errorMessage,omitempty"`
	ExecuteColumnOptionFields      *[]string                  `json:"executeColumnOptionFields,omitempty"`
	ExecuteTabCustomColumnFieldMap *map[string]string         `json:"executeTabCustomColumnFieldMap,omitempty"`
	IsAdvancedExtensionEnabled     *bool                      `json:"isAdvancedExtensionEnabled,omitempty"`
	SelectedPivotId                *string                    `json:"selectedPivotId,omitempty"`
	SelectedSuiteId                *int                       `json:"selectedSuiteId,omitempty"`
	TestCasePageSize               *int                       `json:"testCasePageSize,omitempty"`
	TestCases                      *[]TestCase                `json:"testCases,omitempty"`
	TestCasesContinuationToken     *string                    `json:"testCasesContinuationToken,omitempty"`
	TestPlan                       *TestPlanDetailedReference `json:"testPlan,omitempty"`
	TestPointPageSize              *int                       `json:"testPointPageSize,omitempty"`
	TestPoints                     *[]TestPoint               `json:"testPoints,omitempty"`
	TestPointsContinuationToken    *string                    `json:"testPointsContinuationToken,omitempty"`
	TestSuites                     *[]TestSuite               `json:"testSuites,omitempty"`
	TestSuitesContinuationToken    *string                    `json:"testSuitesContinuationToken,omitempty"`
}

This data model is used in TestPlansHubRefreshDataProvider and populates the data required for initial page load

type TestPlansLibraryQuery

type TestPlansLibraryQuery string

Enum used to define the queries used in Test Plans Library.

type TestPlansLibraryWorkItemFilter

type TestPlansLibraryWorkItemFilter struct {
	// Work item field name on which the items are to be filtered.
	FieldName *string `json:"fieldName,omitempty"`
	// Work item field values corresponding to the field name.
	FieldValues *[]string `json:"fieldValues,omitempty"`
	// Mode of the filter.
	FilterMode *TestPlansLibraryWorkItemFilterMode `json:"filterMode,omitempty"`
}

Container to hold information about a filter being applied in Test Plans Library.

type TestPlansLibraryWorkItemFilterMode

type TestPlansLibraryWorkItemFilterMode string

type TestPoint

type TestPoint struct {
	// Comment associated to the Test Point
	Comment *string `json:"comment,omitempty"`
	// Configuration associated with the Test Point
	Configuration *TestConfigurationReference `json:"configuration,omitempty"`
	// Id of the Test Point
	Id *int `json:"id,omitempty"`
	// Variable to decide whether the test case is Active or not
	IsActive *bool `json:"isActive,omitempty"`
	// Is the Test Point for Automated Test Case or Manual
	IsAutomated *bool `json:"isAutomated,omitempty"`
	// Last Reset to Active Time Stamp for the Test Point
	LastResetToActive *azuredevops.Time `json:"lastResetToActive,omitempty"`
	// Last Updated details for the Test Point
	LastUpdatedBy *webapi.IdentityRef `json:"lastUpdatedBy,omitempty"`
	// Last Update Time Stamp for the Test Point
	LastUpdatedDate *azuredevops.Time `json:"lastUpdatedDate,omitempty"`
	// Reference links
	Links interface{} `json:"links,omitempty"`
	// Project under which the Test Point is
	Project *core.TeamProjectReference `json:"project,omitempty"`
	// Results associated to the Test Point
	Results *TestPointResults `json:"results,omitempty"`
	// Test Case Reference
	TestCaseReference *TestCaseReference `json:"testCaseReference,omitempty"`
	// Tester associated with the Test Point
	Tester *webapi.IdentityRef `json:"tester,omitempty"`
	// Test Plan under which the Test Point is
	TestPlan *TestPlanReference `json:"testPlan,omitempty"`
	// Test Suite under which the Test Point is
	TestSuite *TestSuiteReference `json:"testSuite,omitempty"`
}

Test Point Class

type TestPointDetailedReference

type TestPointDetailedReference struct {
	Configuration *TestConfigurationReference `json:"configuration,omitempty"`
	Plan          *TestPlanReference          `json:"plan,omitempty"`
	PointId       *int                        `json:"pointId,omitempty"`
	Suite         *TestSuiteReference         `json:"suite,omitempty"`
	Tester        *webapi.IdentityRef         `json:"tester,omitempty"`
}

type TestPointResults

type TestPointResults struct {
	// Failure Type for the Test Point
	FailureType *FailureType `json:"failureType,omitempty"`
	// Last Resolution State Id for the Test Point
	LastResolutionState *LastResolutionState `json:"lastResolutionState,omitempty"`
	// Last Result Details for the Test Point
	LastResultDetails *test.LastResultDetails `json:"lastResultDetails,omitempty"`
	// Last Result Id
	LastResultId *int `json:"lastResultId,omitempty"`
	// Last Result State of the Test Point
	LastResultState *ResultState `json:"lastResultState,omitempty"`
	// Last RUn Build Number for the Test Point
	LastRunBuildNumber *string `json:"lastRunBuildNumber,omitempty"`
	// Last Test Run Id for the Test Point
	LastTestRunId *int `json:"lastTestRunId,omitempty"`
	// Outcome of the Test Point
	Outcome *Outcome `json:"outcome,omitempty"`
	// State of the Test Point
	State *PointState `json:"state,omitempty"`
}

Test Point Results

type TestPointUpdateParams

type TestPointUpdateParams struct {
	// Id of Test Point to be updated
	Id *int `json:"id,omitempty"`
	// Reset the Test Point to Active
	IsActive *bool `json:"isActive,omitempty"`
	// Results of the test point
	Results *Results `json:"results,omitempty"`
	// Tester of the Test Point
	Tester *webapi.IdentityRef `json:"tester,omitempty"`
}

Test Point Update Parameters

type TestSuite

type TestSuite struct {
	// Test suite default configurations.
	DefaultConfigurations *[]TestConfigurationReference `json:"defaultConfigurations,omitempty"`
	// Test suite default testers.
	DefaultTesters *[]webapi.IdentityRef `json:"defaultTesters,omitempty"`
	// Default configuration was inherited or not.
	InheritDefaultConfigurations *bool `json:"inheritDefaultConfigurations,omitempty"`
	// Name of test suite.
	Name *string `json:"name,omitempty"`
	// Test suite parent shallow reference.
	ParentSuite *TestSuiteReference `json:"parentSuite,omitempty"`
	// Test suite query string, for dynamic suites.
	QueryString *string `json:"queryString,omitempty"`
	// Test suite requirement id.
	RequirementId *int `json:"requirementId,omitempty"`
	// Test suite type.
	SuiteType *TestSuiteType `json:"suiteType,omitempty"`
	// Links: self, testPoints, testCases, parent
	Links interface{} `json:"_links,omitempty"`
	// Boolean value dictating if Child test suites are present
	HasChildren *bool `json:"hasChildren,omitempty"`
	// Child test suites of current test suite.
	Children *[]TestSuite `json:"children,omitempty"`
	// Id of test suite.
	Id *int `json:"id,omitempty"`
	// Last error for test suite.
	LastError *string `json:"lastError,omitempty"`
	// Last populated date.
	LastPopulatedDate *azuredevops.Time `json:"lastPopulatedDate,omitempty"`
	// IdentityRef of user who has updated test suite recently.
	LastUpdatedBy *webapi.IdentityRef `json:"lastUpdatedBy,omitempty"`
	// Last update date.
	LastUpdatedDate *azuredevops.Time `json:"lastUpdatedDate,omitempty"`
	// Test plan to which the test suite belongs.
	Plan *TestPlanReference `json:"plan,omitempty"`
	// Test suite project shallow reference.
	Project *core.TeamProjectReference `json:"project,omitempty"`
	// Test suite revision.
	Revision *int `json:"revision,omitempty"`
}

Test suite

type TestSuiteCreateParams

type TestSuiteCreateParams struct {
	// Test suite default configurations.
	DefaultConfigurations *[]TestConfigurationReference `json:"defaultConfigurations,omitempty"`
	// Test suite default testers.
	DefaultTesters *[]webapi.IdentityRef `json:"defaultTesters,omitempty"`
	// Default configuration was inherited or not.
	InheritDefaultConfigurations *bool `json:"inheritDefaultConfigurations,omitempty"`
	// Name of test suite.
	Name *string `json:"name,omitempty"`
	// Test suite parent shallow reference.
	ParentSuite *TestSuiteReference `json:"parentSuite,omitempty"`
	// Test suite query string, for dynamic suites.
	QueryString *string `json:"queryString,omitempty"`
	// Test suite requirement id.
	RequirementId *int `json:"requirementId,omitempty"`
	// Test suite type.
	SuiteType *TestSuiteType `json:"suiteType,omitempty"`
}

Test suite Create Parameters

type TestSuiteCreateUpdateCommonParams

type TestSuiteCreateUpdateCommonParams struct {
	// Test suite default configurations.
	DefaultConfigurations *[]TestConfigurationReference `json:"defaultConfigurations,omitempty"`
	// Test suite default testers.
	DefaultTesters *[]webapi.IdentityRef `json:"defaultTesters,omitempty"`
	// Default configuration was inherited or not.
	InheritDefaultConfigurations *bool `json:"inheritDefaultConfigurations,omitempty"`
	// Name of test suite.
	Name *string `json:"name,omitempty"`
	// Test suite parent shallow reference.
	ParentSuite *TestSuiteReference `json:"parentSuite,omitempty"`
	// Test suite query string, for dynamic suites.
	QueryString *string `json:"queryString,omitempty"`
}

Test Suite Create/Update Common Parameters

type TestSuiteReference

type TestSuiteReference struct {
	// ID of the test suite.
	Id *int `json:"id,omitempty"`
	// Name of the test suite.
	Name *string `json:"name,omitempty"`
}

The test suite reference resource.

type TestSuiteReferenceWithProject

type TestSuiteReferenceWithProject struct {
	// ID of the test suite.
	Id *int `json:"id,omitempty"`
	// Name of the test suite.
	Name *string `json:"name,omitempty"`
	// Reference of destination Project
	Project *core.TeamProjectReference `json:"project,omitempty"`
}

Test Suite Reference with Project

type TestSuiteType

type TestSuiteType string

Type of TestSuite

type TestSuiteUpdateParams

type TestSuiteUpdateParams struct {
	// Test suite default configurations.
	DefaultConfigurations *[]TestConfigurationReference `json:"defaultConfigurations,omitempty"`
	// Test suite default testers.
	DefaultTesters *[]webapi.IdentityRef `json:"defaultTesters,omitempty"`
	// Default configuration was inherited or not.
	InheritDefaultConfigurations *bool `json:"inheritDefaultConfigurations,omitempty"`
	// Name of test suite.
	Name *string `json:"name,omitempty"`
	// Test suite parent shallow reference.
	ParentSuite *TestSuiteReference `json:"parentSuite,omitempty"`
	// Test suite query string, for dynamic suites.
	QueryString *string `json:"queryString,omitempty"`
	// Test suite revision.
	Revision *int `json:"revision,omitempty"`
}

Test Suite Update Parameters

type TestVariable

type TestVariable struct {
	// Description of the test variable
	Description *string `json:"description,omitempty"`
	// Name of the test variable
	Name *string `json:"name,omitempty"`
	// List of allowed values
	Values *[]string `json:"values,omitempty"`
	// Id of the test variable
	Id *int `json:"id,omitempty"`
	// Id of the test variable
	Project *core.TeamProjectReference `json:"project,omitempty"`
}

Test Variable

type TestVariableCreateUpdateParameters

type TestVariableCreateUpdateParameters struct {
	// Description of the test variable
	Description *string `json:"description,omitempty"`
	// Name of the test variable
	Name *string `json:"name,omitempty"`
	// List of allowed values
	Values *[]string `json:"values,omitempty"`
}

Test Variable Create or Update Parameters

type UpdateSuiteTestCasesArgs

type UpdateSuiteTestCasesArgs struct {
	// (required) A SuiteTestCaseCreateUpdateParameters object.
	SuiteTestCaseCreateUpdateParameters *[]SuiteTestCaseCreateUpdateParameters
	// (required) Project ID or project name
	Project *string
	// (required) ID of the test plan to which test cases are to be updated.
	PlanId *int
	// (required) ID of the test suite to which test cases are to be updated.
	SuiteId *int
}

Arguments for the UpdateSuiteTestCases function

type UpdateTestConfigurationArgs

type UpdateTestConfigurationArgs struct {
	// (required) TestConfigurationCreateUpdateParameters
	TestConfigurationCreateUpdateParameters *TestConfigurationCreateUpdateParameters
	// (required) Project ID or project name
	Project *string
	// (required) ID of the test configuration to update.
	TestConfiguartionId *int
}

Arguments for the UpdateTestConfiguration function

type UpdateTestPlanArgs

type UpdateTestPlanArgs struct {
	// (required) A testPlanUpdateParams object.TestPlanUpdateParams
	TestPlanUpdateParams *TestPlanUpdateParams
	// (required) Project ID or project name
	Project *string
	// (required) ID of the test plan to be updated.
	PlanId *int
}

Arguments for the UpdateTestPlan function

type UpdateTestPointsArgs

type UpdateTestPointsArgs struct {
	// (required) A TestPointUpdateParams Object.
	TestPointUpdateParams *[]TestPointUpdateParams
	// (required) Project ID or project name
	Project *string
	// (required) ID of the test plan for which test points are requested.
	PlanId *int
	// (required) ID of the test suite for which test points are requested.
	SuiteId *int
	// (optional) If set to false, will get a smaller payload containing only basic details about the test point object
	IncludePointDetails *bool
	// (optional) If set to true, returns the AssignedTo field in TestCaseReference as IdentityRef object.
	ReturnIdentityRef *bool
}

Arguments for the UpdateTestPoints function

type UpdateTestSuiteArgs

type UpdateTestSuiteArgs struct {
	// (required) Parameters for suite updation
	TestSuiteUpdateParams *TestSuiteUpdateParams
	// (required) Project ID or project name
	Project *string
	// (required) ID of the test plan that contains the suites.
	PlanId *int
	// (required) ID of the parent suite.
	SuiteId *int
}

Arguments for the UpdateTestSuite function

type UpdateTestVariableArgs

type UpdateTestVariableArgs struct {
	// (required) TestVariableCreateUpdateParameters
	TestVariableCreateUpdateParameters *TestVariableCreateUpdateParameters
	// (required) Project ID or project name
	Project *string
	// (required) ID of the test variable to update.
	TestVariableId *int
}

Arguments for the UpdateTestVariable function

type UserFriendlyTestOutcome

type UserFriendlyTestOutcome string

type WorkItem

type WorkItem struct {
	// Id of the Work Item
	Id *int `json:"id,omitempty"`
}

Work Item

type WorkItemDetails

type WorkItemDetails struct {
	// Work Item Id
	Id *int `json:"id,omitempty"`
	// Work Item Name
	Name *string `json:"name,omitempty"`
	// Work Item Fields
	WorkItemFields *[]interface{} `json:"workItemFields,omitempty"`
}

Work Item Class

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL