Getting Started

This plugin will register itself with the Pact framework for the avro/binary,application/avro, application/*+avro and avro/bytes content types.

Using this plugin, you can write Pact tests that verify a single message (i.e. a message provider sends a message to a consumer).

Tests are supported by using the V4 asynchronous message Pact format, and the service method calls use the V4 synchronous message Pact format.

Installation

The plugin is a single native binary. Releases publish one binary per platform.

Table 1. Supported platforms
OS Architectures

Linux

x86_64, aarch64

macOS

x86_64, aarch64

Windows

x86_64, aarch64

Linux binaries need glibc 2.35 or newer (for example Ubuntu 22.04 and Debian 12 and later).

Plugin installation requires the plugin executable and the plugin manifest in a Pact plugin directory. By default this is .pact/plugins/avro-<version> in the home directory ($HOME/.pact/plugins/avro-0.0.6 for version 0.0.6).

Automated

The pact-plugin-cli installs the plugin. See the CLI installation instructions.

pact-plugin-cli -y install https://github.com/hominux/pact-avro-plugin/releases/latest

Manual

curl -fsSL https://github.com/hominux/pact-avro-plugin/releases/latest/download/install-plugin.sh | sh
INFORMATION

Set the PACT_PLUGIN_DIR environment variable to change the default plugin directory ($HOME/.pact/plugins).