package io.pact.plugin

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc InitPlugin (InitPluginRequest, InitPluginResponse)

  plugin.proto:398

  Check that the plugin loaded OK. Returns the catalogue entries describing what the plugin provides

  message InitPluginRequest

  plugin.proto:13

  Request to verify the plugin has loaded OK

  • string implementation = 1

    Implementation calling the plugin

  • string version = 2

    Version of the implementation

  message InitPluginResponse

  plugin.proto:45

  Response to init plugin, providing the catalogue entries the plugin provides

  • repeated CatalogueEntry catalogue = 1

    List of entries the plugin supports

• rpc UpdateCatalogue (Catalogue, google.protobuf.Empty)

  plugin.proto:400

  Updated catalogue. This will be sent when the core catalogue has been updated (probably by a plugin loading).

  message Catalogue

  plugin.proto:51

  Catalogue of Core Pact + Plugin features

  • repeated CatalogueEntry catalogue = 1

    List of entries from the core catalogue

• rpc CompareContents (CompareContentsRequest, CompareContentsResponse)

  plugin.proto:402

  Request to perform a comparison of some contents (matching request)

  message CompareContentsRequest

  plugin.proto:77

  Request to preform a comparison on an actual body given the expected one

  • optional Body expected = 1

    Expected body from the Pact interaction

  • optional Body actual = 2

    Actual received body

  • bool allow_unexpected_keys = 3

    If unexpected keys or attributes should be allowed. Setting this to false results in additional keys or fields will cause a mismatch

  • map<string, MatchingRules> rules = 4

    Map of expressions to matching rules. The expressions follow the documented Pact matching rule expressions

  • optional PluginConfiguration pluginConfiguration = 5

    Additional data added to the Pact/Interaction by the plugin

  message CompareContentsResponse

  plugin.proto:121

  Response to the CompareContentsRequest with the results of the comparison

  • string error = 1

    Error message if an error occurred. If this field is set, the remaining fields will be ignored and the verification marked as failed

  • optional ContentTypeMismatch typeMismatch = 2

    There was a mismatch with the types of content. If this is set, the results may not be set.

  • map<string, ContentMismatches> results = 3

    Results of the match, keyed by matching rule expression

• rpc ConfigureInteraction (ConfigureInteractionRequest, ConfigureInteractionResponse)

  plugin.proto:404

  Request to configure/setup the interaction for later verification. Data returned will be persisted in the pact file.

  message ConfigureInteractionRequest

  plugin.proto:132

  Request to configure/setup an interaction so that it can be verified later

  • string contentType = 1

    Content type of the interaction (MIME format)

  • optional google.protobuf.Struct contentsConfig = 2

    This is data specified by the user in the consumer test

  message ConfigureInteractionResponse

  plugin.proto:200

  Response to the configure/setup an interaction request

  • string error = 1

    If an error occurred. In this case, the other fields will be ignored/not set

  • repeated InteractionResponse interaction = 2

    The actual response if no error occurred.

  • optional PluginConfiguration pluginConfiguration = 3

    Plugin specific data to be persisted in the pact file

• rpc GenerateContent (GenerateContentRequest, GenerateContentResponse)

  plugin.proto:406

  Request to generate the content using any defined generators

  message GenerateContentRequest

  plugin.proto:210

  Request to generate the contents using any defined generators

  • optional Body contents = 1

    Original contents

  • map<string, Generator> generators = 2

    Generators to apply

  • optional PluginConfiguration pluginConfiguration = 3

    Additional data added to the Pact/Interaction by the plugin

  • optional google.protobuf.Struct testContext = 4

    Context data provided by the test framework

  • GenerateContentRequest.TestMode testMode = 5

  • GenerateContentRequest.ContentFor contentFor = 6

  message GenerateContentResponse

  plugin.proto:239

  Generated body/message response

  • optional Body contents = 1

• rpc StartMockServer (StartMockServerRequest, StartMockServerResponse)

  plugin.proto:409

  Start a mock server

  message StartMockServerRequest

  plugin.proto:244

  Request to start a mock server

  • string hostInterface = 1

    Interface to bind to. Will default to the loopback adapter

  • uint32 port = 2

    Port to bind to. Default (or a value of 0) get the OS to open a random port

  • bool tls = 3

    If TLS should be used (if supported by the mock server)

  • string pact = 4

    Pact as JSON to use for the mock server behaviour

  • optional google.protobuf.Struct testContext = 5

    Context data provided by the test framework

  message StartMockServerResponse

  plugin.proto:258

  Response to the start mock server request

  • oneof response

    • string error = 1

      If an error occurred

    • MockServerDetails details = 2

      Mock server details

• rpc ShutdownMockServer (ShutdownMockServerRequest, ShutdownMockServerResponse)

  plugin.proto:412

  Shutdown a running mock server TODO: Replace the message types with MockServerRequest and MockServerResults in the next major version

  message ShutdownMockServerRequest

  plugin.proto:280

  Request to shut down a running mock server TODO: replace this with MockServerRequest in the next major version

  • string serverKey = 1

    The server ID to shutdown

  message ShutdownMockServerResponse

  plugin.proto:303

  Response to the shut down mock server request TODO: replace this with MockServerResults in the next major version

  • bool ok = 1

    If the mock status is all ok

  • repeated MockServerResult results = 2

    The results of the test run, will contain an entry for each request received by the mock server

• rpc GetMockServerResults (MockServerRequest, MockServerResults)

  plugin.proto:414

  Get the matching results from a running mock server

  message MockServerRequest

  plugin.proto:286

  Request for a running mock server by ID

  • string serverKey = 1

    The server ID to shutdown

  message MockServerResults

  plugin.proto:311

  Matching results of the mock server.

  • bool ok = 1

    If the mock status is all ok

  • repeated MockServerResult results = 2

    The results of the test run, will contain an entry for each request received by the mock server

• rpc PrepareInteractionForVerification (VerificationPreparationRequest, VerificationPreparationResponse)

  plugin.proto:418

  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

  message VerificationPreparationRequest

  plugin.proto:319

  Request to prepare an interaction for verification

  • string pact = 1

    Pact as JSON to use for the verification

  • string interactionKey = 2

    Interaction key for the interaction from the Pact that is being verified

  • optional google.protobuf.Struct config = 3

    Any data supplied by the user to verify the interaction

  message VerificationPreparationResponse

  plugin.proto:345

  Response for the prepare an interaction for verification request

  • oneof response

    • string error = 1

      If an error occurred

    • InteractionData interactionData = 2

      Interaction data required to construct any request

• rpc VerifyInteraction (VerifyInteractionRequest, VerifyInteractionResponse)

  plugin.proto:420

  Execute the verification for the interaction.

  message VerifyInteractionRequest

  plugin.proto:356

  Request data to verify an interaction

  • optional InteractionData interactionData = 1

    Interaction data required to construct the request

  • optional google.protobuf.Struct config = 2

    Any data supplied by the user to verify the interaction

  • string pact = 3

    Pact as JSON to use for the verification

  • string interactionKey = 4

    Interaction key for the interaction from the Pact that is being verified

  message VerifyInteractionResponse

  plugin.proto:387

  Result of running the verification

  • oneof response

    • string error = 1

      If an error occurred trying to run the verification

    • VerificationResult result = 2

Message representing a request, response or message body

Used in: CompareContentsRequest, GenerateContentRequest, GenerateContentResponse, InteractionData, InteractionResponse

• string contentType = 1

  The content type of the body in MIME format (i.e. application/json)

• optional google.protobuf.BytesValue content = 2

  Bytes of the actual content

• Body.ContentTypeHint contentTypeHint = 3

  Content type override to apply (if required). If omitted, the default rules of the Pact implementation will be used

Enum of content type override. This is a hint on how the content type should be treated.

Used in: Body

• DEFAULT = 0

  Determine the form of the content using the default rules of the Pact implementation

• TEXT = 1

  Contents must always be treated as a text form

• BINARY = 2

  Contents must always be treated as a binary form

Entry to be added to the core catalogue. Each entry describes one of the features the plugin provides. Entries will be stored in the catalogue under the key "plugin/$name/$type/$key".

Used in: Catalogue, InitPluginResponse

• CatalogueEntry.EntryType type = 1

  Entry type

• string key = 2

  Entry key

• map<string, string> values = 3

  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.

Used in: CatalogueEntry

• CONTENT_MATCHER = 0

  Matcher for contents of messages, requests or response bodies

• CONTENT_GENERATOR = 1

  Generator for contents of messages, requests or response bodies

• TRANSPORT = 2

  Transport for a network protocol

• MATCHER = 3

  Matching rule for content field/values

• INTERACTION = 4

  Type of interaction

A mismatch for an particular item of content

Used in: ContentMismatches, MockServerResult, VerificationResultItem

• optional google.protobuf.BytesValue expected = 1

  Expected data bytes

• optional google.protobuf.BytesValue actual = 2

  Actual data bytes

• string mismatch = 3

  Description of the mismatch

• string path = 4

  Path to the item that was matched. This is the value as per the documented Pact matching rule expressions.

• string diff = 5

  Optional diff of the contents

• string mismatchType = 6

  Part of the interaction that the mismatch is for: body, headers, metadata, etc.

List of content mismatches

Used in: CompareContentsResponse

• repeated ContentMismatch mismatches = 1

Indicates that there was a mismatch with the content type

Used in: CompareContentsResponse

• string expected = 1

  Expected content type (MIME format)

• string actual = 2

  Actual content type received (MIME format)

Which part the content is for

Used in: GenerateContentRequest

• Request = 0

• Response = 1

The mode of the generation, if running from a consumer test or during provider verification

Used in: GenerateContentRequest

• Unknown = 0

• Consumer = 1

  Running on the consumer side

• Provider = 2

  Running on the provider side

Example generator

Used in: GenerateContentRequest, InteractionResponse

• string type = 1

  Type of generator

• optional google.protobuf.Struct values = 2

  Associated data for the generator

Interaction request data to be sent or received for verification

Used in: VerificationPreparationResponse, VerificationResult, VerifyInteractionRequest

• optional Body body = 1

  Request/Response body as bytes

• map<string, MetadataValue> metadata = 2

  Metadata associated with the request/response

Response to the configure/setup an interaction request

Used in: ConfigureInteractionResponse

• optional Body contents = 1

  Contents for the interaction

• map<string, MatchingRules> rules = 2

  All matching rules to apply

• map<string, Generator> generators = 3

  Generators to apply

• optional google.protobuf.Struct messageMetadata = 4

  For message interactions, any metadata to be applied

• optional PluginConfiguration pluginConfiguration = 5

  Plugin specific data to be persisted in the pact file

• string interactionMarkup = 6

  Markdown/HTML formatted text representation of the interaction

• InteractionResponse.MarkupType interactionMarkupType = 7

• string partName = 8

  Description of what part this interaction belongs to (in the case of there being more than one, for instance, request/response messages)

• map<string, MatchingRules> metadata_rules = 9

  All matching rules to apply to any message metadata

• map<string, Generator> metadata_generators = 10

  Generators to apply to any message metadata

Type of markup used

Used in: InteractionResponse

• COMMON_MARK = 0

  CommonMark format

• HTML = 1

  HTML format

Represents a matching rule

Used in: MatchingRules

• string type = 1

  Type of the matching rule

• optional google.protobuf.Struct values = 2

  Associated data for the matching rule

List of matching rules

Used in: CompareContentsRequest, InteractionResponse

• repeated MatchingRule rule = 1

Request metadata value. Will either be a JSON-like value, or binary data

Used in: InteractionData

• oneof value

  • google.protobuf.Value nonBinaryValue = 1

  • bytes binaryValue = 2

Details on a running mock server

Used in: StartMockServerResponse

• string key = 1

  Mock server unique ID

• uint32 port = 2

  Port the mock server is running on

• string address = 3

  IP address the mock server is bound to. Probably an IP6 address, but may be IP4

Result of a request that the mock server received

Used in: MockServerResults, ShutdownMockServerResponse

• string path = 1

  service + method that was requested

• string error = 2

  If an error occurred trying to handle the request

• repeated ContentMismatch mismatches = 3

  Any mismatches that occurred

Plugin configuration added to the pact file by the ConfigureInteraction step

Used in: CompareContentsRequest, ConfigureInteractionResponse, GenerateContentRequest, InteractionResponse

• optional google.protobuf.Struct interactionConfiguration = 1

  Data to be persisted against the interaction

• optional google.protobuf.Struct pactConfiguration = 2

  Data to be persisted in the Pact file metadata (Global data)

Result of running the verification

Used in: VerifyInteractionResponse

• bool success = 1

  Was the verification successful?

• optional InteractionData responseData = 2

  Interaction data retrieved from the provider (optional)

• repeated VerificationResultItem mismatches = 3

  Any mismatches that occurred

• repeated string output = 4

  Output for the verification to display to the user

Used in: VerificationResult

• oneof result

  • string error = 1

  • ContentMismatch mismatch = 2