contract

type DataResolver interface {

	// Host attempts to come up with a valid host name based on the input
	// host hint, which is a spec-specific host identifier.
	// F.e. it's a name for OAS3, but may be index or a literal host for other
	// spec standards.
	Host(hostHint string) ParameterSource
	Security(secName string) Security
	Response(status int64, CT string) Validator
}

type EntityTrait struct {
	Log Logger
}

type Expectation func(*OperationResult) bool

type LogStyle interface {
	Default(...interface{}) string
	URL(...interface{}) string
	Method(...interface{}) string
	Op(...interface{}) string
	OK(...interface{}) string
	Failure(...interface{}) string
	Success(...interface{}) string
	Error(...interface{}) string
	ID(...interface{}) string
	ValueExpected(...interface{}) string
	ValueActual(...interface{}) string
	Value(...interface{}) string
}

type Logger interface {
	NOMESSAGE(msg string, args ...interface{})
	Parameters(name string, params ParameterSource)

	Print(l int64, msg string, args ...interface{})

	Usage()
	Error(err error)
	LoadingSpec(path string)
	LoadingScript(path string)

	PrintOperations(ops OperationIterator)
	TestingProject(p ProjectInfo)
	TestingOperation(res Operation)

	UsingSecurity(sec Security)
	SecurityHasNoData(sec Security)

	Requesting(method string, url string)

	UsingParameterExample(paramName string, in string, container string, value string)

	Expecting(what string, v string)
	ExpectingProperty(what string, v string)

	HeaderHasNoValue(hdr string)
	ResponseHasWrongStatus(expectedStatus int, actualStatus int)
	ResponseHasWrongContentType(expectedCT string, actualCT string)
	ResponseHasWrongPropertyValue(propName string, expected string, actual string)

	OperationOK()
	OperationFail()

	SchemaOK(schemaName string)
	SchemaFail(schemaName string, errors []gojsonschema.ResultError)

	ScriptExecutionStart(node string)

	XError(err error, style LogStyle, tab TabFn)
}

type Operation interface {
	ID() string
	Name() string
	Description() string
	Method() string
	Path() string

	Data() *OperationData
	Result() *OperationResult
	Resolve() DataResolver

	GetRequest() (*http.Request, error)
}

type OperationAccess interface {
	Operations() OperationIterator
	GetOperation(id string) Operation
}

type OperationData struct {
	URL     StringParameters
	Query   RequestEnrichmentParameters
	Headers RequestEnrichmentParameters
	Body    RequestEnrichmentParameters
}

type OperationIterator chan Operation

type OperationResult struct {
	Success       bool
	HTTPRequest   *http.Request
	HTTPResponse  *http.Response
	ResponseBytes []byte
}

type OperationResults map[string]*OperationResult

type Parameter struct {
	V      ParameterAccess
	Source string
}

type ParameterAccess func() string

type ParameterIterator chan ParameterTuple

type ParameterSource interface {
	Iterate() ParameterIterator
}

type ParameterTuple struct {
	Parameter
	N string
}

type ProjectInfo interface {
	Title() string
	Description() string
	Version() string
}

type Request interface {
	Enrich(en RequestEnrichment)
	Execute() *OperationResult
}

type RequestEnrichment interface {
	Enrich(request *http.Request, log Logger)
}

type RequestEnrichmentParameters interface {
	Set
	RequestEnrichment
}

type Script interface {
	GetExecutionGraph() gcontract.Graph
}

type Security interface {
	RequestEnrichment
	GetName() string
}

type Set interface {
	Load(src ParameterSource)
	Reload()
	Require(paramName string)
	Validate() error
	Iterate() ParameterIterator
}

type Spec interface {
	ProjectInfo
	OperationAccess
}

type StringParameters interface {
	Set
	String() string
}

type TabFn func(log Logger)

type Validator interface {
	Validate(*OperationResult) *OperationResult
	Expect(Expectation)
}