gotestguide

type Argument struct {
	Name      string    `json:"name"`
	Value     string    `json:"value"`
	Direction Direction `json:"direction"`
}

type Artifact struct {
	ID             string                 `json:"id"`
	FileName       string                 `json:"fileName"`
	Extension      string                 `json:"extension"`
	FileSize       int64                  `json:"fileSize"`
	Hash           string                 `json:"hash"`
	UploadDate     time.Time              `json:"uploadDate"`
	LastAccessDate time.Time              `json:"lastAccessDate"`
	Uploader       string                 `json:"uploader"`
	AttributeList  []*ArtifactAttribute   `json:"attributeList"`
	Shares         []*ArtifactShare       `json:"shares"`
	LockedBy       []*LockedArtifactGroup `json:"lockedBy"`
}

type ArtifactAttribute struct {
	Key    string   `json:"key"`
	Values []string `json:"values"`
}

type ArtifactCreatedResponse struct {
	ID string `json:"artifactId"`
}

type ArtifactRef struct {
	Ref      string `json:"ref,omitempty"`
	Md5      string `json:"md5,omitempty"`
	FileSize int64  `json:"fileSize,omitempty"`
}

type ArtifactShare struct {
	ID          string    `json:"id"`
	Link        string    `json:"link"`
	Description string    `json:"description"`
	Creator     string    `json:"creator"`
	CreateDate  time.Time `json:"createDate"`
}

type ArtifactsService struct {
	// contains filtered or unexported fields
}

type ArtifactsServiceInterface interface {
	// Create a depository.
	CreateDepository(projectId int, depositoryId string, depositoryName string) (*DepositoryIdResponse, *http.Response, error)
	// Retrieve all depositories.
	GetDepositories(projectId int) ([]*Depository, *http.Response, error)
	// Get all information of a depository.
	GetDepository(depositoryId string) (*Depository, *http.Response, error)
	// Delete a depository.
	DeleteDepository(depositoryId string) (*http.Response, error)
	// Upload an artifact.
	UploadArtifact(depositoryId string, artifactPath string, attributes ...*Attribute) (*ArtifactCreatedResponse, *http.Response, error)
	// Get all information of an artifact.
	GetArtifact(artifactId string) (*Artifact, *http.Response, error)
	// Get all storages of a given depository.
	GetStorages(depositoryId string) ([]IStorage, *http.Response, error)
	// Get all information of a storage.
	GetStorage(depositoryId string, storageNumber int) (IStorage, *http.Response, error)
	// Create Storage.
	CreateStorage(depositoryId string, storage IStorage) (*StorageNumberResponse, *http.Response, error)
	// Delete the given storage. Files in the storage are not automatically removed.
	DeleteStorage(depositoryId string, storageNumber int, removeAllFilesFromStorage *bool) (*TaskRef, *http.Response, error)
	// Activate this storage.
	ActivateStorage(depositoryId string, storageNumber int) (*http.Response, error)
	// Deactivate the currently active storage in this depository.
	DeactivateStorage(depositoryId string) (*http.Response, error)
}

type Attribute struct {
	Key    string   `json:"key"`
	Value  string   `json:"value,omitempty"`
	Values []string `json:"values,omitempty"`
}

type AwsS3StorageClass string

type AzureAuthenticationInfo struct {
	Type AzureAuthenticationType `json:"type"`
}

type AzureAuthenticationType string

type AzureBasicAuthenticationInfo struct {
	*AzureAuthenticationInfo
	UserName string `json:"userName"`
	Password string `json:"password"`
}

type AzureSasAuthenticationInfo struct {
	*AzureAuthenticationInfo
	Token string `json:"token"`
}

type AzureSharedKeyAuthenticationInfo struct {
	*AzureAuthenticationInfo
	AccountName string `json:"accountName"`
	AccountKey  string `json:"accountKey"`
}

type Client struct {

	// API for up- and download of artifacts to/from test.guide.
	Artifacts ArtifactsServiceInterface
	// API for handling project and system settings in test.guide.
	Platform PlatformServiceInterface
	// API for handling test reports (test case executions) in test.guide.
	ReportManagement ReportManagementServiceInterface
	// API for accessing user management functionality of test.guide.
	UserManagement UserManagementServiceInterface
	// contains filtered or unexported fields
}

type Constant struct {
	Key    string   `json:"key"`
	Value  string   `json:"value,omitempty"`
	Values []string `json:"values,omitempty"`
}

type Converter struct {
	ID      string `json:"id"`
	Version string `json:"version"`
}

type CreateStorageOption func(*StorageBase)

type DeleteStatus struct {
	Status          string `json:"status"`
	DetailedMessage string `json:"detailedMessage"`
}

type Depository struct {
	ID            string `json:"id"`
	ProjectId     int    `json:"projectId"`
	ActiveStorage int    `json:"activeStorage"`
	Name          string `json:"name"`
}

type DepositoryIdResponse struct {
	ID string `json:"id"`
}

type Direction string

type FileReference struct {
	ID          int64     `json:"id"`
	Filename    string    `json:"filename"`
	RelPath     string    `json:"relPath"`
	UploadDate  time.Time `json:"uploadDate"`
	DownloadURL string    `json:"downloadUrl"`
	FileSize    int64     `json:"fileSize"`
	FileHash    string    `json:"fileHash"`
	FilePath    string    `json:"filePath"`
}

type Filter struct {
	FilterId    int64             `json:"filterId"`
	Name        string            `json:"name"`
	Category    string            `json:"category,omitempty"`
	Description string            `json:"description,omitempty"`
	Parameters  *FilterParameters `json:"parameters,omitempty"`
}

type FilterInformation struct {
	FilterId    int64  `json:"filterId"`
	Name        string `json:"name"`
	Category    string `json:"category,omitempty"`
	Description string `json:"description,omitempty"`
}

type FilterParameters struct {
	TestCaseTagSetID       *int64              `json:"testCaseTagSetId,omitempty"`
	TestSuiteName          []string            `json:"testSuiteName,omitempty"`
	TestCaseName           []string            `json:"testCaseName,omitempty"`
	ParameterSetName       []string            `json:"parameterSetName,omitempty"`
	TestEnvironments       []string            `json:"testEnvironments,omitempty"`
	Attributes             []*KeyValuesFilter  `json:"attributes,omitempty"`
	Constants              []*KeyValuesFilter  `json:"constants,omitempty"`
	ExecutionTimeMin       *int                `json:"executionTimeMin,omitempty"`
	ExecutionTimeMax       *int                `json:"executionTimeMax,omitempty"`
	PlannedTestCaseFolder  []string            `json:"plannedTestCaseFolder,omitempty"`
	DateFrom               *time.Time          `json:"dateFrom,omitempty"`
	DateTo                 *time.Time          `json:"dateTo,omitempty"`
	ArchiveFiles           []string            `json:"archiveFiles,omitempty"`
	TestArgumentExpr       string              `json:"testArgumentExpr,omitempty"`
	TestArgumentDirections []Direction         `json:"testArgumentDirections,omitempty"`
	AtxIds                 []int64             `json:"atxIds,omitempty"`
	Verdicts               []Verdict           `json:"verdicts,omitempty"`
	ReviewExists           string              `json:"reviewExists,omitempty"`
	IncludeObsoleteReviews *bool               `json:"includeObsoleteReviews,omitempty"`
	ReviewAuthor           string              `json:"reviewAuthor,omitempty"`
	ReviewComment          string              `json:"reviewComment,omitempty"`
	ReviewSummary          string              `json:"reviewSummary,omitempty"`
	ReviewVerdicts         []ReviewVerdict     `json:"reviewVerdicts,omitempty"`
	InvalidRuns            *ValidityConstraint `json:"invalidRuns,omitempty"`
	ReviewDefectClass      string              `json:"reviewDefectClass,omitempty"`
	ReviewDefectPriority   string              `json:"reviewDefectPriority,omitempty"`
	ReviewTags             []string            `json:"reviewTags,omitempty"`
	ReviewCustomEvaluation string              `json:"reviewCustomEvaluation"`
	ReviewTickets          []string            `json:"reviewTickets"`
}

type IAbstractTestStep interface {
	GetType() TestStepType
	AsTestStep() *TestStep
	AsTestStepFolder() *TestStepFolder
}

type IAbstractUploadTestCase interface {
	GetType() TestCaseType
	AsTestCase() *UploadTestCase
	AsTestCaseFolder() *UploadTestCaseFolder
}

type IAzureAuthenticationInfo interface {
	GetType() AzureAuthenticationType
	AsBasic() *AzureBasicAuthenticationInfo
	AsSas() *AzureSasAuthenticationInfo
	AsSharedKey() *AzureSharedKeyAuthenticationInfo
}

type ISftpAuthenticationInfo interface {
	GetType() SftpAuthenticationType
	AsBasic() *SftpAuthenticationInfoBasic
	AsSshKey() *SftpAuthenticationInfoSshKey
}

type IStorage interface {
	GetType() StorageType
	AsFileStorage() *StorageFile
	AsSmbStorage() *StorageSmb
	AsArtifactoryStorage() *StorageArtifactory
	AsAwsS3Storage() *StorageAwsS3
	AsSftpStorage() *StorageSftp
	AsAzureBlobStorage() *StorageAzureBlob
}

type KeyValuesFilter struct {
	Key     string   `json:"key"`
	Values  []string `json:"values"`
	Negated *bool    `json:"negated,omitempty"`
}

type LockedArtifactGroup struct {
	Name string `json:"name"`
}

type PlatformService struct {
	// contains filtered or unexported fields
}

type PlatformServiceInterface interface {
	// Retrieve project data.
	GetProject(projectId int) (*Project, *http.Response, error)
}

type Project struct {
	ID          int                 `json:"projectId"`
	Name        string              `json:"projectName"`
	Description string              `json:"projectDescription"`
	IsActive    bool                `json:"isActive"`
	Deleted     ProjectDeletedState `json:"deleted"`
}

type ProjectDeletedState string

type ProjectRole struct {
	ID   int64  `json:"id"`
	Name string `json:"name"`
}

type Recording struct {
	Name      string    `json:"name"`
	Direction Direction `json:"direction"`
	FileHash  string    `json:"fileHash"`
}

type ReportHistoryItem struct {
	ReportID      int64        `json:"reportId"`
	TestPlanName  string       `json:"testPlanName"`
	Status        ReportStatus `json:"status"`
	UploadDate    time.Time    `json:"uploadDate"`
	ExecutionDate time.Time    `json:"executionDate"`
	FileSize      int64        `json:"fileSize"`
}

type ReportManagementService struct {
	// contains filtered or unexported fields
}

type ReportManagementServiceInterface interface {
	// Retrieve information about all available X2ATX converters.
	GetConverters() ([]*Converter, *http.Response, error)
	// Upload a new report.
	UploadReport(projectId int, converterId string, reportPath string) (*TaskRef, *http.Response, error)
	// Uploads a new report from the given objects.
	UploadReportTyped(projectId int, report *UploadReport) (*TaskRef, *http.Response, error)
	// Delete the report with the given report ID (ATX ID).
	DeleteReport(reportId int64) (*TaskRef, *http.Response, error)
	// Retrieve all test case executions for the supplied report ID (ATX ID).
	GetTestCaseExecutions(reportId int64) ([]*TestCaseExecutionLink, *http.Response, error)
	// Retrieve details about a specific test case execution.
	GetTestCaseExecution(tceId int64) (*TestCaseExecution, *http.Response, error)
	// Retrieve current state of report upload.
	GetUploadStatus(taskId string) (*UploadStatus, *http.Response, error)
	// Retrieve delete task status.
	GetDeleteStatus(taskId string) (*DeleteStatus, *http.Response, error)
	// Provides metadata for uploaded reports.
	GetHistory(projectId int, startDate time.Time, endTime time.Time, offset int, limit int) ([]*ReportHistoryItem, *http.Response, error)
	// Adds an artifact to an existing test case execution.
	AddArtifact(tceId int64, filePath string, comment string, category string) (*http.Response, error)
	// Retrieve project filters.
	GetFilters(projectId int, offset *int, limit *int) ([]*FilterInformation, *http.Response, error)
	// Retrieve a specific project filter including its parameters.
	GetFilter(filterId int64) (*Filter, *http.Response, error)
	// Get test case executions matching the filter parameters.
	GetTestCaseExecutionsByFilter(projectId int, offset *int, limit *int, filter *FilterParameters) ([]*TestCaseExecution, *http.Response, error)
	// Get test case executions of the specified project filter.
	GetTestCaseExecutionsByProjectFilter(filterId int64, offset *int, limit *int) ([]*TestCaseExecution, *http.Response, error)
}

type ReportStatus string

type Review struct {
	ID               int64            `json:"id"`
	ProjectID        int              `json:"projectId"`
	Attachments      []*FileReference `json:"attachments"`
	Summary          string           `json:"summary,omitempty"`
	Comment          string           `json:"comment"`
	Verdict          Verdict          `json:"verdict,omitempty"`
	CustomEvaluation string           `json:"customEvaluation,omitempty"`
	Reviewer         string           `json:"reviewer"`
	ReviewDate       time.Time        `json:"reviewDate"`
	Contacts         []string         `json:"contacts,omitempty"`
	Tickets          []string         `json:"tickets,omitempty"`
	Tags             []string         `json:"tags,omitempty"`
	DefectClass      string           `json:"defectClass,omitempty"`
	DefectPriority   string           `json:"defectPriority,omitempty"`
	InvalidRun       bool             `json:"invalidRun,omitempty"`
}

type ReviewVerdict string

type SftpAuthenticationInfo struct {
	Type     SftpAuthenticationType `json:"type"`
	UserName string                 `json:"userName"`
}

type SftpAuthenticationInfoBasic struct {
	*SftpAuthenticationInfo
	Password string `json:"password"`
}

type SftpAuthenticationInfoSshKey struct {
	*SftpAuthenticationInfo
	PrivateKey string `json:"privateKey"`
}

type SftpAuthenticationType string

type SmbDialect string

type StorageArtifactory struct {
	*StorageBase
	URL               string `json:"url"`
	RepoKey           string `json:"repoKey"`
	UserName          string `json:"userName"`
	ApiKey            string `json:"apiKey"`
	ConnectionTimeout *int   `json:"connectionTimeout,omitempty"`
	SocketTimeout     *int   `json:"socketTimeout,omitempty"`
}

type StorageAwsS3 struct {
	*StorageBase
	BucketName        string            `json:"bucketName"`
	CustomEndpoint    string            `json:"customEndpoint"`
	UserName          string            `json:"userName"`
	Password          string            `json:"password"`
	ObjectKeyPrefix   string            `json:"objectKeyPrefix"`
	StorageClass      AwsS3StorageClass `json:"storageClass"`
	AwsRegion         string            `json:"awsRegion"`
	ConnectionTimeout *int              `json:"connectionTimeout,omitempty"`
	SocketTimeout     *int              `json:"socketTimeout,omitempty"`
}

type StorageAzureBlob struct {
	*StorageBase
	StorageAccount     string                   `json:"storageAccount"`
	ContainerName      string                   `json:"containerName"`
	BlobNamePrefix     string                   `json:"blobNamePrefix"`
	AuthenticationInfo IAzureAuthenticationInfo `json:"authenticationInfo"`
}

type StorageBase struct {
	StorageType                           StorageType                   `json:"storageType"`
	StorageNumber                         int                           `json:"storageNumber"`
	Name                                  string                        `json:"name"`
	KeepFileInStorageWhenDeletingArtifact bool                          `json:"keepFileInStorageWhenDeletingArtifact"`
	MigrationRole                         string                        `json:"migrationRole"`
	DeletionState                         string                        `json:"deletionState"`
	Quota                                 *StorageQuota                 `json:"quota"`
	ConnectionCheck                       *StorageConnectionCheckConfig `json:"connectionCheck"`
}

type StorageConnectionCheckConfig struct {
	CronExpression                 string `json:"cronExpression,omitempty"`
	TimeZone                       string `json:"timeZone,omitempty"`
	NotifyProjectManagersOnFailure *bool  `json:"notifyProjectManagersOnFailure,omitempty"`
}

type StorageFile struct {
	*StorageBase
	// Path to local folder where the files should be stored.
	Folder string `json:"folder,omitempty"`
}

type StorageNumberResponse struct {
	StorageNumber int `json:"storageNumber"`
}

type StorageQuota struct {
	LimitInGiB                                int   `json:"limitInGiB"`
	RejectUpload                              *bool `json:"rejectUpload,omitempty"`
	NotifyDepositoryManagerThresholdInPercent int   `json:"notifyDepositoryManagerThresholdInPercent"`
	NotifyDepositoryUsersThresholdInPercent   int   `json:"notifyDepositoryUsersThresholdInPercent"`
}

type StorageSftp struct {
	*StorageBase
	Host               string                  `json:"host"`
	Port               *int                    `json:"port,omitempty"`
	AuthenticationInfo ISftpAuthenticationInfo `json:"authenticationInfo"`
	FolderPath         string                  `json:"folderPath"`
}

type StorageSmb struct {
	*StorageBase
	UserName                   string     `json:"userName"`
	Password                   string     `json:"password"`
	Domain                     string     `json:"domain,omitempty"`
	Host                       string     `json:"host"`
	Port                       *int       `json:"port,omitempty"`
	Share                      string     `json:"share,omitempty"`
	FolderPath                 string     `json:"folderPath"`
	DfsEnabled                 *bool      `json:"dfsEnabled,omitempty"`
	Dialect                    SmbDialect `json:"dialect"`
	TransportEncryptionEnabled *bool      `json:"transportEncryptionEnabled,omitempty"`
}

type StorageType string

type TaskRef struct {
	TaskID string `json:"taskId"`
}

type TestCaseExecution struct {
	ID                 int64              `json:"id"`
	ProjectID          int                `json:"projectId"`
	ReportID           int64              `json:"reportId"`
	TestSuiteName      string             `json:"testSuiteName"`
	TestCaseName       string             `json:"testCaseName"`
	ExecutionTimestamp time.Time          `json:"executionTimestamp"`
	Verdict            Verdict            `json:"verdict"`
	EffectiveVerdict   Verdict            `json:"effectiveVerdict"`
	TestEnvironments   []*TestEnvironment `json:"testEnvironments"`
	Attributes         []*Attribute       `json:"attributes"`
	Constants          []*Constant        `json:"constants"`
	Arguments          []*Argument        `json:"arguments"`
	Recordings         []*Recording       `json:"recordings"`
	ParameterSet       string             `json:"parameterSet"`
	TestSteps          *TestSteps         `json:"testSteps"`
	LastReview         *Review            `json:"lastReview"`
	Artifacts          []*FileReference   `json:"artifacts"`
	ExecutionTime      int                `json:"executionTime"`
	Releases           []int64            `json:"releases"`
}

type TestCaseExecutionLink struct {
	TceID int64  `json:"tceId"`
	Rel   string `json:"rel"`
	Href  string `json:"href"`
}

type TestCaseType string

type TestEnvironment struct {
	Key   string `json:"key"`
	Value string `json:"value"`
	Desc  string `json:"desc,omitempty"`
}

type TestStep struct {
	Name           string `json:"name"`
	Description    string `json:"description,omitempty"`
	Verdict        string `json:"verdict,omitempty"`
	ExpectedResult string `json:"expectedResult,omitempty"`
}

type TestStepFolder struct {
	Name           string              `json:"name"`
	Description    string              `json:"description,omitempty"`
	Verdict        Verdict             `json:"verdict,omitempty"`
	ExpectedResult string              `json:"expectedResult,omitempty"`
	TestSteps      []IAbstractTestStep `json:"teststeps"`
}

type TestStepType string

type TestSteps struct {
	Setup     []IAbstractTestStep `json:"setup"`
	Execution []IAbstractTestStep `json:"execution"`
	Teardown  []IAbstractTestStep `json:"teardown"`
}

type UploadReport struct {
	// Name of the report
	Name string `json:"name"`
	// Timestamp of the report with milliseconds
	Timestamp                int64                     `json:"timestamp"`
	TestCases                []IAbstractUploadTestCase `json:"testcases"`
	OptionalReportIdentifier string                    `json:"optionalReportIdentifier,omitempty"`
}

type UploadStatus struct {
	Status       string `json:"status"`
	UploadResult struct {
		UploadReturnCode int      `json:"uploadReturnCode"`
		ReportID         int      `json:"reportId"`
		ResultMessages   []string `json:"resultMessages"`
		IsDoubleUpload   bool     `json:"isDoubleUpload"`
	} `json:"uploadResult"`
}

type UploadTestCase struct {
	Name          string  `json:"name"`
	Description   string  `json:"description,omitempty"`
	Verdict       Verdict `json:"verdict"`
	Timestamp     int64   `json:"timestamp"`
	ExecutionTime int     `json:"executionTime,omitempty"`

	Constants  []*Constant  `json:"constants,omitempty"`
	Attributes []*Attribute `json:"attributes,omitempty"`

	SetupTestSteps     []IAbstractTestStep `json:"setupTestSteps,omitempty"`
	ExecutionTestSteps []IAbstractTestStep `json:"executionTestSteps,omitempty"`
	TeardownTestSteps  []IAbstractTestStep `json:"teardownTestSteps,omitempty"`
	Parameters         []*Argument         `json:"parameters,omitempty"`
	Artifacts          []string            `json:"artifacts,omitempty"`
	ArtifactRefs       []*ArtifactRef      `json:"artifactRefs,omitempty"`
	Review             *Review             `json:"review,omitempty"`
	ParamSet           string              `json:"paramSet,omitempty"`
	Environments       []*TestEnvironment  `json:"environments,omitempty"`
	Recordings         []*Recording        `json:"recordings,omitempty"`
}

type UploadTestCaseFolder struct {
	Name      string                    `json:"name"`
	TestCases []IAbstractUploadTestCase `json:"testcases"`
}

type User struct {
	ID                         int64                 `json:"id"`
	UserName                   string                `json:"userName"`
	DisplayName                string                `json:"displayName"`
	Email                      string                `json:"email"`
	Company                    string                `json:"company"`
	AssociatedProjects         []*UserProjectContext `json:"associatedProjects"`
	SystemGroups               []string              `json:"systemGroups"`
	GlobalPermissions          []string              `json:"globalPermissions"`
	UserType                   UserType              `json:"userType"`
	ConfirmedDisclaimerVersion int                   `json:"confirmedDisclaimerVersion"`
	// An approximate indication of when the user last logged into web interface. Scaled in weeks, months etc. for privacy reasons.
	LastSeen string `json:"lastSeen"`
}

type UserActivationStatus string

type UserManagementService struct {
	// contains filtered or unexported fields
}

type UserManagementServiceInterface interface {
	// Retrieve information about the current user.
	Whoami() (*User, *http.Response, error)
	// Retrieve information on all users.
	GetUsers() ([]*User, *http.Response, error)
	// Retrieve all project roles for a project.
	GetRoles(projectId int) ([]*ProjectRole, *http.Response, error)
}

type UserProjectContext struct {
	ProjectID               int                  `json:"projectId"`
	ActivationStatus        UserActivationStatus `json:"activationStatus"`
	IndividualPermissions   []string             `json:"individualPermissions"`
	ProjectRoles            []int64              `json:"projectRoles"`
	IndividualProjectRoles  []int64              `json:"individualProjectRoles"`
	SystemGroupProjectRoles []int64              `json:"systemGroupProjectRoles"`
	EffectivePermissions    []string             `json:"effectivePermissions"`
}

type UserType string

type ValidityConstraint string

type Verdict string