Documentation ¶
Index ¶
- Variables
- type CompletionStatus
- func (CompletionStatus) Descriptor() protoreflect.EnumDescriptor
- func (x CompletionStatus) Enum() *CompletionStatus
- func (CompletionStatus) EnumDescriptor() ([]byte, []int)deprecated
- func (x CompletionStatus) Number() protoreflect.EnumNumber
- func (x CompletionStatus) String() string
- func (CompletionStatus) Type() protoreflect.EnumType
- type GetSetOperResult
- func (*GetSetOperResult) Descriptor() ([]byte, []int)deprecated
- func (x *GetSetOperResult) GetGetResponse() *gnmi.GetResponse
- func (x *GetSetOperResult) GetGetResponseMatched() MatchResult
- func (x *GetSetOperResult) GetGetStatus() *status.Status
- func (x *GetSetOperResult) GetResult() Status
- func (x *GetSetOperResult) GetSetResponse() *gnmi.SetResponse
- func (x *GetSetOperResult) GetSetStatus() *status.Status
- func (*GetSetOperResult) ProtoMessage()
- func (x *GetSetOperResult) ProtoReflect() protoreflect.Message
- func (x *GetSetOperResult) Reset()
- func (x *GetSetOperResult) String() string
- type GetSetTestResult
- func (*GetSetTestResult) Descriptor() ([]byte, []int)deprecated
- func (x *GetSetTestResult) GetInitialiseOper() *GetSetOperResult
- func (x *GetSetTestResult) GetResult() Status
- func (x *GetSetTestResult) GetTest() *tests.Test
- func (x *GetSetTestResult) GetTestOper() *GetSetOperResult
- func (*GetSetTestResult) ProtoMessage()
- func (x *GetSetTestResult) ProtoReflect() protoreflect.Message
- func (x *GetSetTestResult) Reset()
- func (x *GetSetTestResult) String() string
- type Instance
- func (*Instance) Descriptor() ([]byte, []int)deprecated
- func (x *Instance) GetDescription() string
- func (x *Instance) GetExtensions() []*TestResult
- func (x *Instance) GetTest() *TestResult
- func (*Instance) ProtoMessage()
- func (x *Instance) ProtoReflect() protoreflect.Message
- func (x *Instance) Reset()
- func (x *Instance) String() string
- type InstanceGroup
- func (*InstanceGroup) Descriptor() ([]byte, []int)deprecated
- func (x *InstanceGroup) GetDescription() string
- func (x *InstanceGroup) GetInstance() []*Instance
- func (x *InstanceGroup) GetSkipped() bool
- func (*InstanceGroup) ProtoMessage()
- func (x *InstanceGroup) ProtoReflect() protoreflect.Message
- func (x *InstanceGroup) Reset()
- func (x *InstanceGroup) String() string
- type MatchResult
- func (MatchResult) Descriptor() protoreflect.EnumDescriptor
- func (x MatchResult) Enum() *MatchResult
- func (MatchResult) EnumDescriptor() ([]byte, []int)deprecated
- func (x MatchResult) Number() protoreflect.EnumNumber
- func (x MatchResult) String() string
- func (MatchResult) Type() protoreflect.EnumType
- type Report
- type Status
- type SubscribeResponseResult
- func (*SubscribeResponseResult) Descriptor() ([]byte, []int)deprecated
- func (x *SubscribeResponseResult) GetError() string
- func (x *SubscribeResponseResult) GetResponse() *gnmi.SubscribeResponse
- func (*SubscribeResponseResult) ProtoMessage()
- func (x *SubscribeResponseResult) ProtoReflect() protoreflect.Message
- func (x *SubscribeResponseResult) Reset()
- func (x *SubscribeResponseResult) String() string
- type SubscribeTestResult
- func (*SubscribeTestResult) Descriptor() ([]byte, []int)deprecated
- func (x *SubscribeTestResult) GetError() stringdeprecated
- func (x *SubscribeTestResult) GetErrors() []*TestError
- func (x *SubscribeTestResult) GetResponses() []*SubscribeResponseResult
- func (x *SubscribeTestResult) GetStatus() CompletionStatus
- func (*SubscribeTestResult) ProtoMessage()
- func (x *SubscribeTestResult) ProtoReflect() protoreflect.Message
- func (x *SubscribeTestResult) Reset()
- func (x *SubscribeTestResult) String() string
- type TestError
- func (*TestError) Descriptor() ([]byte, []int)deprecated
- func (x *TestError) GetDetails() *any.Any
- func (x *TestError) GetMessage() string
- func (x *TestError) GetPath() *gnmi.Path
- func (*TestError) ProtoMessage()
- func (x *TestError) ProtoReflect() protoreflect.Message
- func (x *TestError) Reset()
- func (x *TestError) String() string
- type TestResult
- func (*TestResult) Descriptor() ([]byte, []int)deprecated
- func (x *TestResult) GetGetset() *GetSetTestResult
- func (x *TestResult) GetResult() Status
- func (x *TestResult) GetSubscribe() *SubscribeTestResult
- func (x *TestResult) GetTest() *tests.Test
- func (m *TestResult) GetType() isTestResult_Type
- func (*TestResult) ProtoMessage()
- func (x *TestResult) ProtoReflect() protoreflect.Message
- func (x *TestResult) Reset()
- func (x *TestResult) String() string
- type TestResult_Getset
- type TestResult_Subscribe
Constants ¶
This section is empty.
Variables ¶
var ( CompletionStatus_name = map[int32]string{ 0: "UNKNOWN", 1: "FINISHED", 2: "EARLY_FINISHED", 3: "RPC_ERROR", 4: "TIMEOUT", } CompletionStatus_value = map[string]int32{ "UNKNOWN": 0, "FINISHED": 1, "EARLY_FINISHED": 2, "RPC_ERROR": 3, "TIMEOUT": 4, } )
Enum value maps for CompletionStatus.
var ( Status_name = map[int32]string{ 0: "UNSET", 1: "SUCCESS", 2: "FAIL", } Status_value = map[string]int32{ "UNSET": 0, "SUCCESS": 1, "FAIL": 2, } )
Enum value maps for Status.
var ( MatchResult_name = map[int32]string{ 0: "MR_UNSET", 1: "MR_EQUAL", 2: "MR_UNEQUAL", } MatchResult_value = map[string]int32{ "MR_UNSET": 0, "MR_EQUAL": 1, "MR_UNEQUAL": 2, } )
Enum value maps for MatchResult.
var File_proto_report_report_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type CompletionStatus ¶
type CompletionStatus int32
CompletionStatus indicates the reason why the test ended.
const ( // Test finished with an unknown reason. CompletionStatus_UNKNOWN CompletionStatus = 0 // Test successfully runs to completion. CompletionStatus_FINISHED CompletionStatus = 1 // Test successfully runs to completion, but the completion is triggered by // test. CompletionStatus_EARLY_FINISHED CompletionStatus = 2 // RPC request fails during test execution. CompletionStatus_RPC_ERROR CompletionStatus = 3 // Test execution finished because of RPC request timeout. CompletionStatus_TIMEOUT CompletionStatus = 4 )
func (CompletionStatus) Descriptor ¶
func (CompletionStatus) Descriptor() protoreflect.EnumDescriptor
func (CompletionStatus) Enum ¶
func (x CompletionStatus) Enum() *CompletionStatus
func (CompletionStatus) EnumDescriptor
deprecated
func (CompletionStatus) EnumDescriptor() ([]byte, []int)
Deprecated: Use CompletionStatus.Descriptor instead.
func (CompletionStatus) Number ¶
func (x CompletionStatus) Number() protoreflect.EnumNumber
func (CompletionStatus) String ¶
func (x CompletionStatus) String() string
func (CompletionStatus) Type ¶
func (CompletionStatus) Type() protoreflect.EnumType
type GetSetOperResult ¶
type GetSetOperResult struct { // Result of the operation. Result Status `protobuf:"varint,1,opt,name=result,proto3,enum=report.Status" json:"result,omitempty"` // set_responses is the SetResponse message received from the target. SetResponse *gnmi.SetResponse `protobuf:"bytes,2,opt,name=set_response,json=setResponse,proto3" json:"set_response,omitempty"` // set_status is the status.proto message received from the target in // response to the Set RPC within the operation. SetStatus *status.Status `protobuf:"bytes,3,opt,name=set_status,json=setStatus,proto3" json:"set_status,omitempty"` // get_response is the GetResponse received from the target. GetResponse *gnmi.GetResponse `protobuf:"bytes,4,opt,name=get_response,json=getResponse,proto3" json:"get_response,omitempty"` // get_status is the status.proto message received from the target in // response to the Get RPC within the operation. GetStatus *status.Status `protobuf:"bytes,5,opt,name=get_status,json=getStatus,proto3" json:"get_status,omitempty"` // get_response_matched indicates whether the GetResponse received from // the target matched that specified in the test. GetResponseMatched MatchResult `` /* 142-byte string literal not displayed */ // contains filtered or unexported fields }
GetSetOperResult is the result of an individual operation within the GetSetTest.
func (*GetSetOperResult) Descriptor
deprecated
func (*GetSetOperResult) Descriptor() ([]byte, []int)
Deprecated: Use GetSetOperResult.ProtoReflect.Descriptor instead.
func (*GetSetOperResult) GetGetResponse ¶
func (x *GetSetOperResult) GetGetResponse() *gnmi.GetResponse
func (*GetSetOperResult) GetGetResponseMatched ¶
func (x *GetSetOperResult) GetGetResponseMatched() MatchResult
func (*GetSetOperResult) GetGetStatus ¶
func (x *GetSetOperResult) GetGetStatus() *status.Status
func (*GetSetOperResult) GetResult ¶
func (x *GetSetOperResult) GetResult() Status
func (*GetSetOperResult) GetSetResponse ¶
func (x *GetSetOperResult) GetSetResponse() *gnmi.SetResponse
func (*GetSetOperResult) GetSetStatus ¶
func (x *GetSetOperResult) GetSetStatus() *status.Status
func (*GetSetOperResult) ProtoMessage ¶
func (*GetSetOperResult) ProtoMessage()
func (*GetSetOperResult) ProtoReflect ¶
func (x *GetSetOperResult) ProtoReflect() protoreflect.Message
func (*GetSetOperResult) Reset ¶
func (x *GetSetOperResult) Reset()
func (*GetSetOperResult) String ¶
func (x *GetSetOperResult) String() string
type GetSetTestResult ¶
type GetSetTestResult struct { Test *tests.Test `protobuf:"bytes,1,opt,name=test,proto3" json:"test,omitempty"` // Result of running the test. Result Status `protobuf:"varint,2,opt,name=result,proto3,enum=report.Status" json:"result,omitempty"` // Result of the initialisation operation specified in the input test. InitialiseOper *GetSetOperResult `protobuf:"bytes,3,opt,name=initialise_oper,json=initialiseOper,proto3" json:"initialise_oper,omitempty"` // Result of the test operation specified in the input test. TestOper *GetSetOperResult `protobuf:"bytes,4,opt,name=test_oper,json=testOper,proto3" json:"test_oper,omitempty"` // contains filtered or unexported fields }
GetSetTestResult is the result of a GetSet test towards a target.
func (*GetSetTestResult) Descriptor
deprecated
func (*GetSetTestResult) Descriptor() ([]byte, []int)
Deprecated: Use GetSetTestResult.ProtoReflect.Descriptor instead.
func (*GetSetTestResult) GetInitialiseOper ¶
func (x *GetSetTestResult) GetInitialiseOper() *GetSetOperResult
func (*GetSetTestResult) GetResult ¶
func (x *GetSetTestResult) GetResult() Status
func (*GetSetTestResult) GetTest ¶
func (x *GetSetTestResult) GetTest() *tests.Test
func (*GetSetTestResult) GetTestOper ¶
func (x *GetSetTestResult) GetTestOper() *GetSetOperResult
func (*GetSetTestResult) ProtoMessage ¶
func (*GetSetTestResult) ProtoMessage()
func (*GetSetTestResult) ProtoReflect ¶
func (x *GetSetTestResult) ProtoReflect() protoreflect.Message
func (*GetSetTestResult) Reset ¶
func (x *GetSetTestResult) Reset()
func (*GetSetTestResult) String ¶
func (x *GetSetTestResult) String() string
type Instance ¶
type Instance struct { Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"` Test *TestResult `protobuf:"bytes,2,opt,name=test,proto3" json:"test,omitempty"` Extensions []*TestResult `protobuf:"bytes,3,rep,name=extensions,proto3" json:"extensions,omitempty"` // contains filtered or unexported fields }
Instance stores test results of main test and its extensions.
func (*Instance) Descriptor
deprecated
func (*Instance) GetDescription ¶
func (*Instance) GetExtensions ¶
func (x *Instance) GetExtensions() []*TestResult
func (*Instance) GetTest ¶
func (x *Instance) GetTest() *TestResult
func (*Instance) ProtoMessage ¶
func (*Instance) ProtoMessage()
func (*Instance) ProtoReflect ¶
func (x *Instance) ProtoReflect() protoreflect.Message
type InstanceGroup ¶
type InstanceGroup struct { Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"` Instance []*Instance `protobuf:"bytes,2,rep,name=instance,proto3" json:"instance,omitempty"` // Skipped indicates whether the instance group was skipped during // test execution based on a prior group being fatal. Skipped bool `protobuf:"varint,3,opt,name=skipped,proto3" json:"skipped,omitempty"` // contains filtered or unexported fields }
InstanceGroup stores a set of Instances.
func (*InstanceGroup) Descriptor
deprecated
func (*InstanceGroup) Descriptor() ([]byte, []int)
Deprecated: Use InstanceGroup.ProtoReflect.Descriptor instead.
func (*InstanceGroup) GetDescription ¶
func (x *InstanceGroup) GetDescription() string
func (*InstanceGroup) GetInstance ¶
func (x *InstanceGroup) GetInstance() []*Instance
func (*InstanceGroup) GetSkipped ¶
func (x *InstanceGroup) GetSkipped() bool
func (*InstanceGroup) ProtoMessage ¶
func (*InstanceGroup) ProtoMessage()
func (*InstanceGroup) ProtoReflect ¶
func (x *InstanceGroup) ProtoReflect() protoreflect.Message
func (*InstanceGroup) Reset ¶
func (x *InstanceGroup) Reset()
func (*InstanceGroup) String ¶
func (x *InstanceGroup) String() string
type MatchResult ¶
type MatchResult int32
MatchResult enumerates the outcome of a match comparison.
const ( MatchResult_MR_UNSET MatchResult = 0 MatchResult_MR_EQUAL MatchResult = 1 MatchResult_MR_UNEQUAL MatchResult = 2 )
func (MatchResult) Descriptor ¶
func (MatchResult) Descriptor() protoreflect.EnumDescriptor
func (MatchResult) Enum ¶
func (x MatchResult) Enum() *MatchResult
func (MatchResult) EnumDescriptor
deprecated
func (MatchResult) EnumDescriptor() ([]byte, []int)
Deprecated: Use MatchResult.Descriptor instead.
func (MatchResult) Number ¶
func (x MatchResult) Number() protoreflect.EnumNumber
func (MatchResult) String ¶
func (x MatchResult) String() string
func (MatchResult) Type ¶
func (MatchResult) Type() protoreflect.EnumType
type Report ¶
type Report struct { Results []*InstanceGroup `protobuf:"bytes,1,rep,name=results,proto3" json:"results,omitempty"` // contains filtered or unexported fields }
Report is result of running suite.Suite
func (*Report) Descriptor
deprecated
func (*Report) GetResults ¶
func (x *Report) GetResults() []*InstanceGroup
func (*Report) ProtoMessage ¶
func (*Report) ProtoMessage()
func (*Report) ProtoReflect ¶
func (x *Report) ProtoReflect() protoreflect.Message
type Status ¶
type Status int32
Result of running an individual test.
func (Status) Descriptor ¶
func (Status) Descriptor() protoreflect.EnumDescriptor
func (Status) EnumDescriptor
deprecated
func (Status) Number ¶
func (x Status) Number() protoreflect.EnumNumber
func (Status) Type ¶
func (Status) Type() protoreflect.EnumType
type SubscribeResponseResult ¶
type SubscribeResponseResult struct { // gnmi SubscribeResponse received by the test. Response *gnmi.SubscribeResponse `protobuf:"bytes,1,opt,name=response,proto3" json:"response,omitempty"` // error returned by Process function of the test. Error string `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"` // contains filtered or unexported fields }
SubscribeResponseResult proto is used to pair a gnmi SubscribeResponse and the error returned from Process function of the test.
func (*SubscribeResponseResult) Descriptor
deprecated
func (*SubscribeResponseResult) Descriptor() ([]byte, []int)
Deprecated: Use SubscribeResponseResult.ProtoReflect.Descriptor instead.
func (*SubscribeResponseResult) GetError ¶
func (x *SubscribeResponseResult) GetError() string
func (*SubscribeResponseResult) GetResponse ¶
func (x *SubscribeResponseResult) GetResponse() *gnmi.SubscribeResponse
func (*SubscribeResponseResult) ProtoMessage ¶
func (*SubscribeResponseResult) ProtoMessage()
func (*SubscribeResponseResult) ProtoReflect ¶
func (x *SubscribeResponseResult) ProtoReflect() protoreflect.Message
func (*SubscribeResponseResult) Reset ¶
func (x *SubscribeResponseResult) Reset()
func (*SubscribeResponseResult) String ¶
func (x *SubscribeResponseResult) String() string
type SubscribeTestResult ¶
type SubscribeTestResult struct { // SubscribeResponse messages received as a result of subscription. Responses []*SubscribeResponseResult `protobuf:"bytes,1,rep,name=responses,proto3" json:"responses,omitempty"` // If test is stateful, error is set as a result of calling Check function of // the test. If test is stateless, error set here can be ignored. // // Deprecated: Do not use. Error string `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"` // CompletionStatus indicates why the test ended. Status CompletionStatus `protobuf:"varint,3,opt,name=status,proto3,enum=report.CompletionStatus" json:"status,omitempty"` // List of errors received while running the test. Errors []*TestError `protobuf:"bytes,4,rep,name=errors,proto3" json:"errors,omitempty"` // contains filtered or unexported fields }
SubscribeTestResult is result of running an individual suite.SubscribeTest.
func (*SubscribeTestResult) Descriptor
deprecated
func (*SubscribeTestResult) Descriptor() ([]byte, []int)
Deprecated: Use SubscribeTestResult.ProtoReflect.Descriptor instead.
func (*SubscribeTestResult) GetError
deprecated
func (x *SubscribeTestResult) GetError() string
Deprecated: Do not use.
func (*SubscribeTestResult) GetErrors ¶
func (x *SubscribeTestResult) GetErrors() []*TestError
func (*SubscribeTestResult) GetResponses ¶
func (x *SubscribeTestResult) GetResponses() []*SubscribeResponseResult
func (*SubscribeTestResult) GetStatus ¶
func (x *SubscribeTestResult) GetStatus() CompletionStatus
func (*SubscribeTestResult) ProtoMessage ¶
func (*SubscribeTestResult) ProtoMessage()
func (*SubscribeTestResult) ProtoReflect ¶
func (x *SubscribeTestResult) ProtoReflect() protoreflect.Message
func (*SubscribeTestResult) Reset ¶
func (x *SubscribeTestResult) Reset()
func (*SubscribeTestResult) String ¶
func (x *SubscribeTestResult) String() string
type TestError ¶
type TestError struct { // Message has human readable error that is set by the test. Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"` // gnmi path corresponding to the message set. path is set by test as well. Path *gnmi.Path `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"` // Additional details test can provide in the error. Details *any.Any `protobuf:"bytes,3,opt,name=details,proto3" json:"details,omitempty"` // contains filtered or unexported fields }
TestError corresponds to a single error case reported during execution of a test. Test can emit multiple errors as a result of processing single SubscribeResponse message.
func (*TestError) Descriptor
deprecated
func (*TestError) GetDetails ¶
func (*TestError) GetMessage ¶
func (*TestError) ProtoMessage ¶
func (*TestError) ProtoMessage()
func (*TestError) ProtoReflect ¶
func (x *TestError) ProtoReflect() protoreflect.Message
type TestResult ¶
type TestResult struct { Test *tests.Test `protobuf:"bytes,1,opt,name=test,proto3" json:"test,omitempty"` // Result of running the test. Result Status `protobuf:"varint,2,opt,name=result,proto3,enum=report.Status" json:"result,omitempty"` // Oneof field can be expanded to include results of other gnmi RPCs. // // Types that are assignable to Type: // *TestResult_Subscribe // *TestResult_Getset Type isTestResult_Type `protobuf_oneof:"type"` // contains filtered or unexported fields }
Test is used to pair a tests.Test and its result.
func (*TestResult) Descriptor
deprecated
func (*TestResult) Descriptor() ([]byte, []int)
Deprecated: Use TestResult.ProtoReflect.Descriptor instead.
func (*TestResult) GetGetset ¶
func (x *TestResult) GetGetset() *GetSetTestResult
func (*TestResult) GetResult ¶
func (x *TestResult) GetResult() Status
func (*TestResult) GetSubscribe ¶
func (x *TestResult) GetSubscribe() *SubscribeTestResult
func (*TestResult) GetTest ¶
func (x *TestResult) GetTest() *tests.Test
func (*TestResult) GetType ¶
func (m *TestResult) GetType() isTestResult_Type
func (*TestResult) ProtoMessage ¶
func (*TestResult) ProtoMessage()
func (*TestResult) ProtoReflect ¶
func (x *TestResult) ProtoReflect() protoreflect.Message
func (*TestResult) Reset ¶
func (x *TestResult) Reset()
func (*TestResult) String ¶
func (x *TestResult) String() string
type TestResult_Getset ¶
type TestResult_Getset struct {
Getset *GetSetTestResult `protobuf:"bytes,11,opt,name=getset,proto3,oneof"`
}
type TestResult_Subscribe ¶
type TestResult_Subscribe struct {
Subscribe *SubscribeTestResult `protobuf:"bytes,10,opt,name=subscribe,proto3,oneof"`
}