conformance

Documentation

Overview

Package conformance provides a test suite that verifies a murli-enabled CLI binary satisfies the murli 1.0 contract. Import it in your CLI's test suite to get continuous contract compliance checks.

Usage:

func TestConformance(t *testing.T) {
    suite := conformance.NewSuite("/path/to/your/binary")
    suite.Check(t)
}

Index

• type Suite
  • func NewSuite(binaryPath string) *Suite
  • func (s *Suite) Check(t *testing.T)
  • func (s *Suite) CheckDescribe(t *testing.T)

Types

type Suite

type Suite struct {
	// BinaryPath is the path to the CLI binary to test.
	BinaryPath string
}

Suite runs conformance checks against a murli-enabled CLI binary.

func NewSuite

func NewSuite(binaryPath string) *Suite

NewSuite creates a conformance test suite for the binary at path.

func (*Suite) Check

func (s *Suite) Check(t *testing.T)

Check runs all generic conformance checks. Call from your TestConformance function.

func (*Suite) CheckDescribe

func (s *Suite) CheckDescribe(t *testing.T)

CheckDescribe verifies that `binary describe` returns valid JSON satisfying the murli DescribeOutput contract: schema_version, name, and capabilities are present.