models

type ActionDispatcher struct {

	// used to explicitly order the actions run when a behavior triggers
	Order int64 `json:"order,omitempty"`

	// publish amqp
	PublishAmqp *ActionPublishAMQP `json:"publish_amqp,omitempty"`

	// publish kafka
	PublishKafka *ActionPublishKafka `json:"publish_kafka,omitempty"`

	// redis
	Redis ActionRedis `json:"redis,omitempty"`

	// reply grpc
	ReplyGrpc *ActionReplyGRPC `json:"reply_grpc,omitempty"`

	// reply http
	ReplyHTTP *ActionReplyHTTP `json:"reply_http,omitempty"`

	// send http
	SendHTTP *ActionSendHTTP `json:"send_http,omitempty"`

	// sleep
	Sleep *ActionSleep `json:"sleep,omitempty"`
}

type ActionPerformed struct {

	// publish kafka action performed
	PublishKafkaActionPerformed *PublishKafkaActionPerformed `json:"publish_kafka_action_performed,omitempty"`

	// reply http action performed
	ReplyHTTPActionPerformed *ReplyHTTPActionPerformed `json:"reply_http_action_performed,omitempty"`
}

type ActionPublishAMQP struct {

	// AMQP exchange name
	Exchange string `json:"exchange,omitempty"`

	// string payload to send on AMQP
	Payload string `json:"payload,omitempty"`

	// file path (relative to OPENMOCK_TEMPLATES_DIR of OM) to load body from
	PayloadFromFile string `json:"payload_from_file,omitempty"`

	// AMQP routing key
	RoutingKey string `json:"routing_key,omitempty"`
}

type ActionPublishKafka struct {

	// string payload to send on AMQP
	Payload string `json:"payload,omitempty"`

	// file path (relative to OPENMOCK_TEMPLATES_DIR of OM) to load body from
	PayloadFromFile string `json:"payload_from_file,omitempty"`

	// kafka topic to publish on
	Topic string `json:"topic,omitempty"`
}

type ActionRedis []string

type ActionReplyGRPC struct {

	// map of string to string specifying gRPC headers to attach to our message
	Headers interface{} `json:"headers,omitempty"`

	// string payload to send via GRPC, this should be a json string that maps to the protobuf response object
	Payload string `json:"payload,omitempty"`

	// file path (relative to OPENMOCK_TEMPLATES_DIR of OM) to load payload from, this should be a json string that maps to the protobuf response object
	PayloadFromFile string `json:"payload_from_file,omitempty"`
}

type ActionReplyHTTP struct {

	// Text body to send over HTTP, can use templating
	Body string `json:"body,omitempty"`

	// file name (relative to working directory of OM) to load HTTP body from
	BodyFromFile string `json:"body_from_file,omitempty"`

	// map of string to string specifying HTTP headers to attach to our message
	Headers interface{} `json:"headers,omitempty"`

	// HTTP status code to reply with
	StatusCode *int64 `json:"status_code,omitempty"`
}

type ActionSendHTTP struct {

	// Text body to send over HTTP, can use templating
	Body string `json:"body,omitempty"`

	// file path (relative to OPENMOCK_TEMPLATES_DIR of OM) to load HTTP body from
	BodyFromFile string `json:"body_from_file,omitempty"`

	// map of string to string specifying HTTP headers to attach to our message
	Headers interface{} `json:"headers,omitempty"`

	// HTTP method to use for the send
	// Enum: [POST GET DELETE PUT OPTIONS HEAD]
	Method string `json:"method,omitempty"`

	// The URL to send HTTP to
	URL string `json:"url,omitempty"`
}

type ActionSleep struct {

	// time to wait in seconds; e.g. '1s'
	Duration string `json:"duration,omitempty"`
}

type Error struct {

	// message
	// Min Length: 1
	Message string `json:"message,omitempty"`
}

type EvalContext struct {

	// http context
	HTTPContext *EvalHTTPContext `json:"http_context,omitempty"`

	// kafka context
	KafkaContext *EvalKafkaContext `json:"kafka_context,omitempty"`
}

type EvalHTTPContext struct {

	// body
	Body string `json:"body,omitempty"`

	// headers
	Headers interface{} `json:"headers,omitempty"`

	// method
	Method string `json:"method,omitempty"`

	// path
	Path string `json:"path,omitempty"`

	// query string
	QueryString string `json:"query_string,omitempty"`
}

type EvalKafkaContext struct {

	// payload
	Payload string `json:"payload,omitempty"`

	// topic
	Topic string `json:"topic,omitempty"`
}

type Expect struct {

	// amqp
	Amqp *ExpectAMQP `json:"amqp,omitempty"`

	// a go template that determines if this behavior triggers
	Condition string `json:"condition,omitempty"`

	// grpc
	Grpc *ExpectGRPC `json:"grpc,omitempty"`

	// http
	HTTP *ExpectHTTP `json:"http,omitempty"`

	// kafka
	Kafka *ExpectKafka `json:"kafka,omitempty"`
}

type ExpectAMQP struct {

	// TODO
	Exchange string `json:"exchange,omitempty"`

	// TODO
	Queue string `json:"queue,omitempty"`

	// TODO
	RoutingKey string `json:"routing_key,omitempty"`
}

type ExpectGRPC struct {

	// GRPC method to expect to trigger this behavior
	Method string `json:"method,omitempty"`

	// GRPC service to expect to trigger this behavior
	Service string `json:"service,omitempty"`
}

type ExpectHTTP struct {

	// HTTP method to expect to trigger this behavior
	// Enum: [POST GET DELETE PUT OPTIONS HEAD]
	Method string `json:"method,omitempty"`

	// HTTP path to expect to trigger this behavior
	Path string `json:"path,omitempty"`
}

type ExpectKafka struct {

	// kafka topic to listen on
	Topic string `json:"topic,omitempty"`
}

type Health struct {

	// status
	Status string `json:"status,omitempty"`
}

type Mock struct {

	// for behaviors, the actions this mock would do when the expect is met
	Actions []*ActionDispatcher `json:"actions"`

	// expect
	Expect *Expect `json:"expect,omitempty"`

	// for behaviors, makes this behavior extend a specified AbstractBehavior
	Extend string `json:"extend,omitempty"`

	// Unique key for the item in OM's model
	// Pattern: [\w_\-\.]+
	Key string `json:"key,omitempty"`

	// The type of item this is. possible types are: Behavior - creates a new mock behavior  AbstractBehavior - allows behaviors to use common features from this item Template - used in template language rendering to do fancy stuff
	//
	// Enum: [Behavior AbstractBehavior Template]
	Kind string `json:"kind,omitempty"`

	// a go template to be embedded in other templates
	Template string `json:"template,omitempty"`

	// Arbitrary values that can be used in go templates rendered by this item
	Values interface{} `json:"values,omitempty"`
}

type MockEvalRequest struct {

	// The context to evaluate the mock
	Context *EvalContext `json:"context,omitempty"`

	// The mock to evaluate
	Mock *Mock `json:"mock,omitempty"`
}

type MockEvalResponse struct {

	// list of responses the mock performed (assuming the condition passed)
	ActionsPerformed []*ActionPerformed `json:"actions_performed"`

	// whether the condition passed when evaluated, so the actions would take place
	ConditionPassed bool `json:"condition_passed,omitempty"`

	// the rendered value of the mock's expect's condition when evaluating with the context
	ConditionRendered string `json:"condition_rendered,omitempty"`

	// whether the channel-specific condition of the evaluation passed. For example for a mock with ExpectHTTP, this returns true if the HTTP path and method in the input context matched the ExpectHTTP.
	ExpectPassed bool `json:"expect_passed,omitempty"`
}

type Mocks []*Mock

type PublishKafkaActionPerformed struct {

	// rendered payload
	Payload string `json:"payload,omitempty"`

	// the kafka topic to send to
	Topic string `json:"topic,omitempty"`
}

type ReplyHTTPActionPerformed struct {

	// body bytes-converted-to-string returned in HTTP reply
	Body string `json:"body,omitempty"`

	// the HTTP content-type of the reply
	ContentType string `json:"content_type,omitempty"`

	// Key-value pair HTTP headers attached to the reply
	Headers interface{} `json:"headers,omitempty"`

	// HTTP status code in the reply
	StatusCode string `json:"status_code,omitempty"`
}