models

type AllureLabel struct {
	Name  string `json:"name" yaml:"name"`
	Value string `json:"value" yaml:"value"`
}

type AllureLink struct {
	Name string `json:"name" yaml:"name"`
	URL  string `json:"url" yaml:"url"`
	Type string `json:"type" yaml:"type"`
}

type AllureMetadata struct {
	Links      []AllureLink      `json:"links" yaml:"links"`
	Labels     []AllureLabel     `json:"labels" yaml:"labels"`
	Parameters []AllureParameter `json:"parameters" yaml:"parameters"`
}

type AllureParameter struct {
	Name  string `json:"name" yaml:"name"`
	Value string `json:"value" yaml:"value"`
}

type CheckError struct {
	Category   ErrorCategory
	Identifier string
	Message    string
	Err        error
}

type DatabaseCheck interface {
	DbNameString() string
	DbQueryString() string
	DbResponseJson() []string

	SetDbQueryString(string)
	SetDbResponseJson([]string)
}

type DatabaseResult struct {
	Query    string
	Response []string
}

type ErrorCategory string

type Fixture struct {
	DbName string   `json:"dbName" yaml:"dbName"`
	Files  []string `json:"files" yaml:"files"`
}

type FixturesMultiDb []Fixture

type Form struct {
	Files  map[string]string `json:"files" yaml:"files"`
	Fields map[string]string `json:"fields" yaml:"fields"`
}

type GrpcProtoSource struct {
	// Type is the source type: "reflection" or "protoset".
	Type string `json:"type" yaml:"type"`
	// ProtosetFile is the path to the .protoset file (used when Type is "protoset").
	ProtosetFile string `json:"protoset_file" yaml:"protoset_file"`
}

type Result struct {
	Path                string // TODO: remove
	Query               string // TODO: remove
	RequestBody         string
	ResponseStatusCode  int
	ResponseStatus      string
	ResponseContentType string
	ResponseBody        string
	ResponseHeaders     map[string][]string
	GrpcStatusCode      int
	GrpcStatusMessage   string
	GrpcTrailers        map[string][]string
	Errors              []error
	Test                TestInterface
	DatabaseResult      []DatabaseResult
}

type Summary struct {
	Success bool
	Failed  int
	Skipped int
	Broken  int
	Total   int
}

type TestInterface interface {
	ToQuery() string
	GetRequest() string
	ToJSON() ([]byte, error)
	GetMethod() string
	Path() string
	GetResponses() map[int]string
	GetResponse(code int) (string, bool)
	GetResponseHeaders(code int) (map[string]string, bool)
	GetName() string
	GetDescription() string
	GetStatus() string
	SetStatus(string)
	Fixtures() []string
	FixturesMultiDb() FixturesMultiDb
	ServiceMocks() map[string]interface{}
	GrpcServiceMocks() map[string]interface{}
	Pause() int
	BeforeScriptPath() string
	BeforeScriptTimeout() int
	AfterRequestScriptPath() string
	AfterRequestScriptTimeout() int
	Cookies() map[string]string
	Headers() map[string]string
	ContentType() string
	GetForm() *Form
	DbNameString() string
	DbQueryString() string
	DbResponseJson() []string
	GetVariables() map[string]string
	GetCombinedVariables() map[string]string
	GetVariablesToSet() map[int]map[string]string
	GetDatabaseChecks() []DatabaseCheck
	SetDatabaseChecks([]DatabaseCheck)

	GetFileName() string

	// setters
	SetQuery(string)
	SetMethod(string)
	SetPath(string)
	SetRequest(string)
	SetForm(form *Form)
	SetResponses(map[int]string)
	SetHeaders(map[string]string)
	SetDbQueryString(string)
	SetDbResponseJson([]string)

	// comparison properties
	NeedsCheckingValues() bool
	IgnoreArraysOrdering() bool
	DisallowExtraFields() bool
	IgnoreDbOrdering() bool

	// Clone returns copy of current object
	Clone() TestInterface

	// gRPC transport methods
	GetTransport() string
	GetProtoSource() *GrpcProtoSource

	// Allure metadata for TMS integration
	GetAllureMetadata() *AllureMetadata
}