io_pact_plugin

type Body struct {

	// The content type of the body in MIME format (i.e. application/json)
	ContentType string `protobuf:"bytes,1,opt,name=contentType,proto3" json:"contentType,omitempty"`
	// Bytes of the actual content
	Content *wrapperspb.BytesValue `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	// Content type override to apply (if required). If omitted, the default rules of the Pact implementation
	// will be used
	ContentTypeHint Body_ContentTypeHint `protobuf:"varint,3,opt,name=contentTypeHint,proto3,enum=io.pact.plugin.Body_ContentTypeHint" json:"contentTypeHint,omitempty"`
	// contains filtered or unexported fields
}

type Body_ContentTypeHint int32

type Catalogue struct {

	// List of entries from the core catalogue
	Catalogue []*CatalogueEntry `protobuf:"bytes,1,rep,name=catalogue,proto3" json:"catalogue,omitempty"`
	// contains filtered or unexported fields
}

type CatalogueEntry struct {

	// Entry type
	Type CatalogueEntry_EntryType `protobuf:"varint,1,opt,name=type,proto3,enum=io.pact.plugin.CatalogueEntry_EntryType" json:"type,omitempty"`
	// Entry key
	Key string `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
	// Associated data required for the entry. For CONTENT_MATCHER and CONTENT_GENERATOR types, a "content-types"
	// value (separated by semi-colons) is required for all the content types the plugin supports.
	Values map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

type CatalogueEntry_EntryType int32

type CompareContentsRequest struct {

	// Expected body from the Pact interaction
	Expected *Body `protobuf:"bytes,1,opt,name=expected,proto3" json:"expected,omitempty"`
	// Actual received body
	Actual *Body `protobuf:"bytes,2,opt,name=actual,proto3" json:"actual,omitempty"`
	// If unexpected keys or attributes should be allowed. Setting this to false results in additional keys or fields
	// will cause a mismatch
	AllowUnexpectedKeys bool `protobuf:"varint,3,opt,name=allow_unexpected_keys,json=allowUnexpectedKeys,proto3" json:"allow_unexpected_keys,omitempty"`
	// Map of expressions to matching rules. The expressions follow the documented Pact matching rule expressions
	Rules map[string]*MatchingRules `` /* 151-byte string literal not displayed */
	// Additional data added to the Pact/Interaction by the plugin
	PluginConfiguration *PluginConfiguration `protobuf:"bytes,5,opt,name=pluginConfiguration,proto3" json:"pluginConfiguration,omitempty"`
	// contains filtered or unexported fields
}

type CompareContentsResponse struct {

	// Error message if an error occurred. If this field is set, the remaining fields will be ignored and the
	// verification marked as failed
	Error string `protobuf:"bytes,1,opt,name=error,proto3" json:"error,omitempty"`
	// There was a mismatch with the types of content. If this is set, the results may not be set.
	TypeMismatch *ContentTypeMismatch `protobuf:"bytes,2,opt,name=typeMismatch,proto3" json:"typeMismatch,omitempty"`
	// Results of the match, keyed by matching rule expression
	Results map[string]*ContentMismatches `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

type ConfigureInteractionRequest struct {

	// Content type of the interaction (MIME format)
	ContentType string `protobuf:"bytes,1,opt,name=contentType,proto3" json:"contentType,omitempty"`
	// This is data specified by the user in the consumer test
	ContentsConfig *structpb.Struct `protobuf:"bytes,2,opt,name=contentsConfig,proto3" json:"contentsConfig,omitempty"`
	// contains filtered or unexported fields
}

type ConfigureInteractionResponse struct {

	// If an error occurred. In this case, the other fields will be ignored/not set
	Error string `protobuf:"bytes,1,opt,name=error,proto3" json:"error,omitempty"`
	// The actual response if no error occurred.
	Interaction []*InteractionResponse `protobuf:"bytes,2,rep,name=interaction,proto3" json:"interaction,omitempty"`
	// Plugin specific data to be persisted in the pact file
	PluginConfiguration *PluginConfiguration `protobuf:"bytes,3,opt,name=pluginConfiguration,proto3" json:"pluginConfiguration,omitempty"`
	// contains filtered or unexported fields
}

type ContentMismatch struct {

	// Expected data bytes
	Expected *wrapperspb.BytesValue `protobuf:"bytes,1,opt,name=expected,proto3" json:"expected,omitempty"`
	// Actual data bytes
	Actual *wrapperspb.BytesValue `protobuf:"bytes,2,opt,name=actual,proto3" json:"actual,omitempty"`
	// Description of the mismatch
	Mismatch string `protobuf:"bytes,3,opt,name=mismatch,proto3" json:"mismatch,omitempty"`
	// Path to the item that was matched. This is the value as per the documented Pact matching rule expressions.
	Path string `protobuf:"bytes,4,opt,name=path,proto3" json:"path,omitempty"`
	// Optional diff of the contents
	Diff string `protobuf:"bytes,5,opt,name=diff,proto3" json:"diff,omitempty"`
	// contains filtered or unexported fields
}

type ContentMismatches struct {
	Mismatches []*ContentMismatch `protobuf:"bytes,1,rep,name=mismatches,proto3" json:"mismatches,omitempty"`
	// contains filtered or unexported fields
}

type ContentTypeMismatch struct {

	// Expected content type (MIME format)
	Expected string `protobuf:"bytes,1,opt,name=expected,proto3" json:"expected,omitempty"`
	// Actual content type received (MIME format)
	Actual string `protobuf:"bytes,2,opt,name=actual,proto3" json:"actual,omitempty"`
	// contains filtered or unexported fields
}

type GenerateContentRequest struct {

	// Original contents
	Contents *Body `protobuf:"bytes,1,opt,name=contents,proto3" json:"contents,omitempty"`
	// Generators to apply
	Generators map[string]*Generator `` /* 161-byte string literal not displayed */
	// Additional data added to the Pact/Interaction by the plugin
	PluginConfiguration *PluginConfiguration `protobuf:"bytes,3,opt,name=pluginConfiguration,proto3" json:"pluginConfiguration,omitempty"`
	// contains filtered or unexported fields
}

type GenerateContentResponse struct {
	Contents *Body `protobuf:"bytes,1,opt,name=contents,proto3" json:"contents,omitempty"`
	// contains filtered or unexported fields
}

type Generator struct {

	// Type of generator
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// Associated data for the generator
	Values *structpb.Struct `protobuf:"bytes,2,opt,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

type InitPluginRequest struct {

	// Implementation calling the plugin
	Implementation string `protobuf:"bytes,1,opt,name=implementation,proto3" json:"implementation,omitempty"`
	// Version of the implementation
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

type InitPluginResponse struct {

	// List of entries the plugin supports
	Catalogue []*CatalogueEntry `protobuf:"bytes,1,rep,name=catalogue,proto3" json:"catalogue,omitempty"`
	// contains filtered or unexported fields
}

type InteractionData struct {

	// Request/Response body as bytes
	Body *Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Metadata associated with the request/response
	Metadata map[string]*MetadataValue `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

type InteractionResponse struct {

	// Contents for the interaction
	Contents *Body `protobuf:"bytes,1,opt,name=contents,proto3" json:"contents,omitempty"`
	// All matching rules to apply
	Rules map[string]*MatchingRules `` /* 151-byte string literal not displayed */
	// Generators to apply
	Generators map[string]*Generator `` /* 161-byte string literal not displayed */
	// For message interactions, any metadata to be applied
	MessageMetadata *structpb.Struct `protobuf:"bytes,4,opt,name=messageMetadata,proto3" json:"messageMetadata,omitempty"`
	// Plugin specific data to be persisted in the pact file
	PluginConfiguration *PluginConfiguration `protobuf:"bytes,5,opt,name=pluginConfiguration,proto3" json:"pluginConfiguration,omitempty"`
	// Markdown/HTML formatted text representation of the interaction
	InteractionMarkup     string                         `protobuf:"bytes,6,opt,name=interactionMarkup,proto3" json:"interactionMarkup,omitempty"`
	InteractionMarkupType InteractionResponse_MarkupType `` /* 147-byte string literal not displayed */
	// Description of what part this interaction belongs to (in the case of there being more than one, for instance,
	// request/response messages)
	PartName string `protobuf:"bytes,8,opt,name=partName,proto3" json:"partName,omitempty"`
	// contains filtered or unexported fields
}

type InteractionResponse_MarkupType int32

type MatchingRule struct {

	// Type of the matching rule
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// Associated data for the matching rule
	Values *structpb.Struct `protobuf:"bytes,2,opt,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

type MatchingRules struct {
	Rule []*MatchingRule `protobuf:"bytes,1,rep,name=rule,proto3" json:"rule,omitempty"`
	// contains filtered or unexported fields
}

type MetadataValue struct {

	// Types that are assignable to Value:
	//	*MetadataValue_NonBinaryValue
	//	*MetadataValue_BinaryValue
	Value isMetadataValue_Value `protobuf_oneof:"value"`
	// contains filtered or unexported fields
}

type MetadataValue_BinaryValue struct {
	BinaryValue []byte `protobuf:"bytes,2,opt,name=binaryValue,proto3,oneof"`
}

type MetadataValue_NonBinaryValue struct {
	NonBinaryValue *structpb.Value `protobuf:"bytes,1,opt,name=nonBinaryValue,proto3,oneof"`
}

type MockServerDetails struct {

	// Mock server unique ID
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// Port the mock server is running on
	Port uint32 `protobuf:"varint,2,opt,name=port,proto3" json:"port,omitempty"`
	// IP address the mock server is bound to. Probably an IP6 address, but may be IP4
	Address string `protobuf:"bytes,3,opt,name=address,proto3" json:"address,omitempty"`
	// contains filtered or unexported fields
}

type MockServerRequest struct {

	// The server ID to shutdown
	ServerKey string `protobuf:"bytes,1,opt,name=serverKey,proto3" json:"serverKey,omitempty"`
	// contains filtered or unexported fields
}

type MockServerResult struct {

	// service + method that was requested
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// If an error occurred trying to handle the request
	Error string `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"`
	// Any mismatches that occurred
	Mismatches []*ContentMismatch `protobuf:"bytes,3,rep,name=mismatches,proto3" json:"mismatches,omitempty"`
	// contains filtered or unexported fields
}

type MockServerResults struct {

	// If the mock status is all ok
	Ok bool `protobuf:"varint,1,opt,name=ok,proto3" json:"ok,omitempty"`
	// The results of the test run, will contain an entry for each request received by the mock server
	Results []*MockServerResult `protobuf:"bytes,2,rep,name=results,proto3" json:"results,omitempty"`
	// contains filtered or unexported fields
}

type PactPluginClient interface {
	// Check that the plugin loaded OK. Returns the catalogue entries describing what the plugin provides
	InitPlugin(ctx context.Context, in *InitPluginRequest, opts ...grpc.CallOption) (*InitPluginResponse, error)
	// Updated catalogue. This will be sent when the core catalogue has been updated (probably by a plugin loading).
	UpdateCatalogue(ctx context.Context, in *Catalogue, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Request to perform a comparison of some contents (matching request)
	CompareContents(ctx context.Context, in *CompareContentsRequest, opts ...grpc.CallOption) (*CompareContentsResponse, error)
	// Request to configure/setup the interaction for later verification. Data returned will be persisted in the pact file.
	ConfigureInteraction(ctx context.Context, in *ConfigureInteractionRequest, opts ...grpc.CallOption) (*ConfigureInteractionResponse, error)
	// Request to generate the content using any defined generators
	GenerateContent(ctx context.Context, in *GenerateContentRequest, opts ...grpc.CallOption) (*GenerateContentResponse, error)
	// Start a mock server
	StartMockServer(ctx context.Context, in *StartMockServerRequest, opts ...grpc.CallOption) (*StartMockServerResponse, error)
	// Shutdown a running mock server
	// TODO: Replace the message types with MockServerRequest and MockServerResults in the next major version
	ShutdownMockServer(ctx context.Context, in *ShutdownMockServerRequest, opts ...grpc.CallOption) (*ShutdownMockServerResponse, error)
	// Get the matching results from a running mock server
	GetMockServerResults(ctx context.Context, in *MockServerRequest, opts ...grpc.CallOption) (*MockServerResults, error)
	// Prepare an interaction for verification. This should return any data required to construct any request
	// so that it can be amended before the verification is run
	PrepareInteractionForVerification(ctx context.Context, in *VerificationPreparationRequest, opts ...grpc.CallOption) (*VerificationPreparationResponse, error)
	// Execute the verification for the interaction.
	VerifyInteraction(ctx context.Context, in *VerifyInteractionRequest, opts ...grpc.CallOption) (*VerifyInteractionResponse, error)
}

type PactPluginServer interface {
	// Check that the plugin loaded OK. Returns the catalogue entries describing what the plugin provides
	InitPlugin(context.Context, *InitPluginRequest) (*InitPluginResponse, error)
	// Updated catalogue. This will be sent when the core catalogue has been updated (probably by a plugin loading).
	UpdateCatalogue(context.Context, *Catalogue) (*emptypb.Empty, error)
	// Request to perform a comparison of some contents (matching request)
	CompareContents(context.Context, *CompareContentsRequest) (*CompareContentsResponse, error)
	// Request to configure/setup the interaction for later verification. Data returned will be persisted in the pact file.
	ConfigureInteraction(context.Context, *ConfigureInteractionRequest) (*ConfigureInteractionResponse, error)
	// Request to generate the content using any defined generators
	GenerateContent(context.Context, *GenerateContentRequest) (*GenerateContentResponse, error)
	// Start a mock server
	StartMockServer(context.Context, *StartMockServerRequest) (*StartMockServerResponse, error)
	// Shutdown a running mock server
	// TODO: Replace the message types with MockServerRequest and MockServerResults in the next major version
	ShutdownMockServer(context.Context, *ShutdownMockServerRequest) (*ShutdownMockServerResponse, error)
	// Get the matching results from a running mock server
	GetMockServerResults(context.Context, *MockServerRequest) (*MockServerResults, error)
	// Prepare an interaction for verification. This should return any data required to construct any request
	// so that it can be amended before the verification is run
	PrepareInteractionForVerification(context.Context, *VerificationPreparationRequest) (*VerificationPreparationResponse, error)
	// Execute the verification for the interaction.
	VerifyInteraction(context.Context, *VerifyInteractionRequest) (*VerifyInteractionResponse, error)
	// contains filtered or unexported methods
}

type PluginConfiguration struct {

	// Data to be persisted against the interaction
	InteractionConfiguration *structpb.Struct `protobuf:"bytes,1,opt,name=interactionConfiguration,proto3" json:"interactionConfiguration,omitempty"`
	// Data to be persisted in the Pact file metadata (Global data)
	PactConfiguration *structpb.Struct `protobuf:"bytes,2,opt,name=pactConfiguration,proto3" json:"pactConfiguration,omitempty"`
	// contains filtered or unexported fields
}

type ShutdownMockServerRequest struct {

	// The server ID to shutdown
	ServerKey string `protobuf:"bytes,1,opt,name=serverKey,proto3" json:"serverKey,omitempty"`
	// contains filtered or unexported fields
}

type ShutdownMockServerResponse struct {

	// If the mock status is all ok
	Ok bool `protobuf:"varint,1,opt,name=ok,proto3" json:"ok,omitempty"`
	// The results of the test run, will contain an entry for each request received by the mock server
	Results []*MockServerResult `protobuf:"bytes,2,rep,name=results,proto3" json:"results,omitempty"`
	// contains filtered or unexported fields
}

type StartMockServerRequest struct {

	// Interface to bind to. Will default to the loopback adapter
	HostInterface string `protobuf:"bytes,1,opt,name=hostInterface,proto3" json:"hostInterface,omitempty"`
	// Port to bind to. Default (or a value of 0) get the OS to open a random port
	Port uint32 `protobuf:"varint,2,opt,name=port,proto3" json:"port,omitempty"`
	// If TLS should be used (if supported by the mock server)
	Tls bool `protobuf:"varint,3,opt,name=tls,proto3" json:"tls,omitempty"`
	// Pact as JSON to use for the mock server behaviour
	Pact string `protobuf:"bytes,4,opt,name=pact,proto3" json:"pact,omitempty"`
	// contains filtered or unexported fields
}

type StartMockServerResponse struct {

	// Types that are assignable to Response:
	//	*StartMockServerResponse_Error
	//	*StartMockServerResponse_Details
	Response isStartMockServerResponse_Response `protobuf_oneof:"response"`
	// contains filtered or unexported fields
}

type StartMockServerResponse_Details struct {
	// Mock server details
	Details *MockServerDetails `protobuf:"bytes,2,opt,name=details,proto3,oneof"`
}

type StartMockServerResponse_Error struct {
	// If an error occurred
	Error string `protobuf:"bytes,1,opt,name=error,proto3,oneof"`
}

type UnimplementedPactPluginServer struct {
}

type UnsafePactPluginServer interface {
	// contains filtered or unexported methods
}

type VerificationPreparationRequest struct {

	// Pact as JSON to use for the verification
	Pact string `protobuf:"bytes,1,opt,name=pact,proto3" json:"pact,omitempty"`
	// Interaction key for the interaction from the Pact that is being verified
	InteractionKey string `protobuf:"bytes,2,opt,name=interactionKey,proto3" json:"interactionKey,omitempty"`
	// Any data supplied by the user to verify the interaction
	Config *structpb.Struct `protobuf:"bytes,3,opt,name=config,proto3" json:"config,omitempty"`
	// contains filtered or unexported fields
}

type VerificationPreparationResponse struct {

	// Types that are assignable to Response:
	//	*VerificationPreparationResponse_Error
	//	*VerificationPreparationResponse_InteractionData
	Response isVerificationPreparationResponse_Response `protobuf_oneof:"response"`
	// contains filtered or unexported fields
}

type VerificationPreparationResponse_Error struct {
	// If an error occurred
	Error string `protobuf:"bytes,1,opt,name=error,proto3,oneof"`
}

type VerificationPreparationResponse_InteractionData struct {
	// Interaction data required to construct any request
	InteractionData *InteractionData `protobuf:"bytes,2,opt,name=interactionData,proto3,oneof"`
}

type VerificationResult struct {

	// Was the verification successful?
	Success bool `protobuf:"varint,1,opt,name=success,proto3" json:"success,omitempty"`
	// Interaction data retrieved from the provider (optional)
	ResponseData *InteractionData `protobuf:"bytes,2,opt,name=responseData,proto3" json:"responseData,omitempty"`
	// Any mismatches that occurred
	Mismatches []*VerificationResultItem `protobuf:"bytes,3,rep,name=mismatches,proto3" json:"mismatches,omitempty"`
	// Output for the verification to display to the user
	Output []string `protobuf:"bytes,4,rep,name=output,proto3" json:"output,omitempty"`
	// contains filtered or unexported fields
}

type VerificationResultItem struct {

	// Types that are assignable to Result:
	//	*VerificationResultItem_Error
	//	*VerificationResultItem_Mismatch
	Result isVerificationResultItem_Result `protobuf_oneof:"result"`
	// contains filtered or unexported fields
}

type VerificationResultItem_Error struct {
	Error string `protobuf:"bytes,1,opt,name=error,proto3,oneof"`
}

type VerificationResultItem_Mismatch struct {
	Mismatch *ContentMismatch `protobuf:"bytes,2,opt,name=mismatch,proto3,oneof"`
}

type VerifyInteractionRequest struct {

	// Interaction data required to construct the request
	InteractionData *InteractionData `protobuf:"bytes,1,opt,name=interactionData,proto3" json:"interactionData,omitempty"`
	// Any data supplied by the user to verify the interaction
	Config *structpb.Struct `protobuf:"bytes,2,opt,name=config,proto3" json:"config,omitempty"`
	// Pact as JSON to use for the verification
	Pact string `protobuf:"bytes,3,opt,name=pact,proto3" json:"pact,omitempty"`
	// Interaction key for the interaction from the Pact that is being verified
	InteractionKey string `protobuf:"bytes,4,opt,name=interactionKey,proto3" json:"interactionKey,omitempty"`
	// contains filtered or unexported fields
}

type VerifyInteractionResponse struct {

	// Types that are assignable to Response:
	//	*VerifyInteractionResponse_Error
	//	*VerifyInteractionResponse_Result
	Response isVerifyInteractionResponse_Response `protobuf_oneof:"response"`
	// contains filtered or unexported fields
}

type VerifyInteractionResponse_Error struct {
	// If an error occurred trying to run the verification
	Error string `protobuf:"bytes,1,opt,name=error,proto3,oneof"`
}

type VerifyInteractionResponse_Result struct {
	Result *VerificationResult `protobuf:"bytes,2,opt,name=result,proto3,oneof"`
}