plugin

Documentation

Overview

Package plugin discovers and executes out-of-process Pacto plugins. A plugin is a pacto-plugin-<name> binary that reads a GenerateRequest as JSON on stdin and writes a GenerateResponse as JSON on stdout; the runner handles binary discovery, process lifecycle, and timeout enforcement so plugins can produce deployment artifacts from a contract.

Index

• Constants
• type GenerateRequest
• type GenerateResponse
• type GeneratedFile
• type SubprocessRunner
  • func (r *SubprocessRunner) Run(ctx context.Context, name string, req GenerateRequest) (*GenerateResponse, error)

Constants

const ProtocolVersion = "1"

ProtocolVersion is the current plugin protocol version.

Types

type GenerateRequest

type GenerateRequest struct {
	ProtocolVersion string             `json:"protocolVersion"`
	Contract        *contract.Contract `json:"contract"`
	BundleDir       string             `json:"bundleDir"`
	OutputDir       string             `json:"outputDir"`
	Options         map[string]any     `json:"options,omitempty"`
}

GenerateRequest is the JSON payload written to a plugin's stdin.

type GenerateResponse

type GenerateResponse struct {
	Files   []GeneratedFile `json:"files"`
	Message string          `json:"message,omitempty"`
}

GenerateResponse is the JSON payload read from a plugin's stdout.

type GeneratedFile

type GeneratedFile struct {
	Path    string `json:"path"`
	Content string `json:"content"`
}

GeneratedFile describes a single file produced by a plugin.

type SubprocessRunner

type SubprocessRunner struct{}

SubprocessRunner discovers and executes plugin binaries via stdin/stdout JSON.

func (*SubprocessRunner) Run

func (r *SubprocessRunner) Run(ctx context.Context, name string, req GenerateRequest) (*GenerateResponse, error)

Run finds the plugin binary, spawns it, writes the request JSON to stdin, and reads the response JSON from stdout.