contract

package

v0.7.3 Latest Latest Go to latest Published: Feb 17, 2026 License: MIT Imports: 4 Imported by: 0

Details

Package contract provides contract test assertions for Roady syncer plugins.

This section is empty.

This section is empty.

This section is empty.

type ContractSuite struct {
	// contains filtered or unexported fields
}

ContractSuite runs all contract assertions against a plugin binary.

func NewContractSuite() *ContractSuite

NewContractSuite creates a new contract suite.

func (s *ContractSuite) RunBinary(path string) (*SuiteResult, error)

RunBinary loads a plugin binary and runs the full contract suite.

func (s *ContractSuite) RunWithSyncer(syncer domainPlugin.Syncer) *SuiteResult

RunWithSyncer runs the contract suite against an already-loaded syncer instance.

type Result struct {
	Name    string
	Passed  bool
	Message string
}

Result captures the outcome of a single contract assertion.

func AssertInitSuccess(syncer domainPlugin.Syncer) Result

AssertInitSuccess verifies that Init succeeds with valid config.

func AssertInitWithBadConfig(syncer domainPlugin.Syncer) Result

AssertInitWithBadConfig verifies that Init returns an error for bad config.

func AssertPushInvalidTask(syncer domainPlugin.Syncer) Result

AssertPushInvalidTask verifies Push handles an empty task ID gracefully.

func AssertPushValidTask(syncer domainPlugin.Syncer) Result

AssertPushValidTask verifies Push accepts a valid task transition.

func AssertSyncEmptyPlan(syncer domainPlugin.Syncer) Result

AssertSyncEmptyPlan verifies Sync handles an empty plan without error.

func AssertSyncWithTasks(syncer domainPlugin.Syncer) Result

AssertSyncWithTasks verifies Sync processes tasks and returns status updates.

type SuiteResult struct {
	Results []Result
	Passed  int
	Failed  int
}

SuiteResult aggregates results from running the full contract suite.