pact-avro-plugin

Pact Avro Plugin

This plugin supports Avro encoded message paylod for the Pact framework.

Repository Structure

├── go.mod                  # Go module                                     
├── main.go                 # Entrypoint for the application
├── plugin.go               # Stub gRPC methods (to be implemented)
├── configureinteraction/   # Implementation to build interaction data for pact file
├── Makefile                # Build configuration
├── io_pact_plugin/         # Location of protobuf and gRPC definitions for Plugin Framework
├── log.go                  # Logging utility
├── pact-plugin.json        # Plugin configuration file
├── pact.go                 # Pact type definitions
├── server.go               # The gRPC server implementation
├── RELEASING.md            # Instructions on how to release 🚀

Current State

The plugin in its current form can do the following

• Configure/build pact interaction with Avro encoded payload along with matching rules that are required to be persisited in pact file. Works for most of the primitive and complex data types.
• Verify interaction. Supports only exact match at the moment.

To do:

• Map the following Pact DSL logical types to appropriate avro format. This can be acheived by using information from avro schema or adding optional config (indicating avro types) for these logical types and updating Matching Rule Definition Grammar (.g4) accordingly.

• Matching rules path for certain scenarios needs to be fixed. Failing tests are in place - Implement code to pass those tests.
• Verify interaction based on Matching Rules. Explore if FFI is available before starting working on this.
• Implement Generators. Explore if FFI is available before starting working on this.

Plugin usage examples

Refer to following example projects where this plugin is being used. Please note that these example projects are being constantly updated for various experimentation purposes, so they are not in a robust state yet.

• consumer java kafka example
• provider java kafka example

Install

pact-plugin-cli -y install https://github.com/perodem/pact-avro-plugin/releases/tag/v0.0.1

Developing plugin

Local Development

The following command will build the plugin, and install into the correct plugin directory for local development:

make install_local

You can then reference your plugin in local tests to try it out.

Supported targets

This code base automatically create artifacts for the following OS/Architecture combinations:

Publish plugin

Follow the steps in Releasing to publish a new version of the Plugin.