scenario

Documentation

Index

• Variables
• type Scenario
  • func (*Scenario) Descriptor() ([]byte, []int)
  • func (x *Scenario) GetAutomated() bool
  • func (x *Scenario) GetDescription() string
  • func (x *Scenario) GetIdentity() *metadata.Identity
  • func (x *Scenario) GetIssues() []*metadata.LinkedIssue
  • func (x *Scenario) GetLabels() []string
  • func (x *Scenario) GetName() string
  • func (x *Scenario) GetPrerequisites() string
  • func (x *Scenario) GetProjectId() string
  • func (x *Scenario) GetSteps() []*Step
  • func (*Scenario) ProtoMessage()
  • func (x *Scenario) ProtoReflect() protoreflect.Message
  • func (x *Scenario) Reset()
  • func (x *Scenario) String() string
  • func (s *Scenario) Validate() error
• type Step
  • func (*Step) Descriptor() ([]byte, []int)
  • func (x *Step) GetAction() string
  • func (x *Step) GetDescription() string
  • func (x *Step) GetExpectedOutcome() string
  • func (x *Step) GetName() string
  • func (x *Step) GetPosition() int32
  • func (*Step) ProtoMessage()
  • func (x *Step) ProtoReflect() protoreflect.Message
  • func (x *Step) Reset()
  • func (x *Step) String() string
  • func (s *Step) Validate() error

Variables

var File_scenario_proto protoreflect.FileDescriptor

Types

type Scenario

type Scenario struct {
	Identity *metadata.Identity `protobuf:"bytes,1,opt,name=identity,proto3" json:"identity,omitempty"`
	// ID of the project that owns the scenario. MANDATORY
	ProjectId string `protobuf:"bytes,2,opt,name=projectId,proto3" json:"projectId,omitempty"`
	// Used for unique identification. It should be a brief description of what you are testing. MANDATORY
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// Description is used to add detailed information
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// Prerequisites is used to define what you expect to already be done before testing
	Prerequisites string `protobuf:"bytes,5,opt,name=prerequisites,proto3" json:"prerequisites,omitempty"`
	// A list of actions to be taken in order to verify if the functionality works as expected
	Steps  []*Step                 `protobuf:"bytes,6,rep,name=steps,proto3" json:"steps,omitempty"`
	Issues []*metadata.LinkedIssue `protobuf:"bytes,7,rep,name=issues,proto3" json:"issues,omitempty"`
	// Labels are used to help connect different items toghether
	Labels []string `protobuf:"bytes,8,rep,name=labels,proto3" json:"labels,omitempty"`
	// Whether the test has been automated or not
	Automated bool `protobuf:"varint,9,opt,name=automated,proto3" json:"automated,omitempty"`
	// contains filtered or unexported fields
}

A user defined test to validate a functionality

func (*Scenario) Descriptor

func (*Scenario) Descriptor() ([]byte, []int)

Deprecated: Use Scenario.ProtoReflect.Descriptor instead.

func (*Scenario) GetAutomated

func (x *Scenario) GetAutomated() bool

func (*Scenario) GetDescription

func (x *Scenario) GetDescription() string

func (*Scenario) GetIdentity

func (x *Scenario) GetIdentity() *metadata.Identity

func (*Scenario) GetIssues

func (x *Scenario) GetIssues() []*metadata.LinkedIssue

func (*Scenario) GetLabels

func (x *Scenario) GetLabels() []string

func (*Scenario) GetName

func (x *Scenario) GetName() string

func (*Scenario) GetPrerequisites

func (x *Scenario) GetPrerequisites() string

func (*Scenario) GetProjectId

func (x *Scenario) GetProjectId() string

func (*Scenario) GetSteps

func (x *Scenario) GetSteps() []*Step

func (*Scenario) ProtoMessage

func (*Scenario) ProtoMessage()

func (*Scenario) ProtoReflect

func (x *Scenario) ProtoReflect() protoreflect.Message

func (*Scenario) Reset

func (x *Scenario) Reset()

func (*Scenario) String

func (x *Scenario) String() string

func (*Scenario) Validate

func (s *Scenario) Validate() error

Validate is used to check the integrity of the scenario object

type Step

type Step struct {

	// Used to order step execution
	Position int32 `protobuf:"varint,1,opt,name=position,proto3" json:"position,omitempty"`
	// Name of the step
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Describe what the step intention is
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Describe what needs to be done in order to perform the step
	Action string `protobuf:"bytes,4,opt,name=action,proto3" json:"action,omitempty"`
	// Describe what you expect the resoult of the action to be
	ExpectedOutcome string `protobuf:"bytes,5,opt,name=expectedOutcome,proto3" json:"expectedOutcome,omitempty"`
	// contains filtered or unexported fields
}

Represents a step that has to be completed in order to complete the test

func (*Step) Descriptor

func (*Step) Descriptor() ([]byte, []int)

Deprecated: Use Step.ProtoReflect.Descriptor instead.

func (*Step) GetAction

func (x *Step) GetAction() string

func (*Step) GetDescription

func (x *Step) GetDescription() string

func (*Step) GetExpectedOutcome

func (x *Step) GetExpectedOutcome() string

func (*Step) GetName

func (x *Step) GetName() string

func (*Step) GetPosition

func (x *Step) GetPosition() int32

func (*Step) ProtoMessage

func (*Step) ProtoMessage()

func (*Step) ProtoReflect

func (x *Step) ProtoReflect() protoreflect.Message

func (*Step) Reset

func (x *Step) Reset()

func (*Step) String

func (x *Step) String() string

func (*Step) Validate

func (s *Step) Validate() error

Validate is used to check the integrity of a scenario step