admincontract

Documentation

Index

• func AssertPaginationContract(t *testing.T, list ListFunc, cfg PaginationContractConfig)
• type ListFunc
• type ListOptions
• type ListPredicate
• type PaginationContractConfig

Functions

func AssertPaginationContract

func AssertPaginationContract(t *testing.T, list ListFunc, cfg PaginationContractConfig)

AssertPaginationContract verifies that total is stable across pages and page slicing honors total/per-page semantics.

Types

type ListFunc

type ListFunc func(context.Context, ListOptions) ([]map[string]any, int, error)

ListFunc describes the contract target list function.

type ListOptions

type ListOptions struct {
	Page       int
	PerPage    int
	SortBy     string
	SortDesc   bool
	Filters    map[string]any
	Predicates []ListPredicate
	Fields     []string
	Search     string
}

ListOptions is a transport-agnostic list query shape for list contracts.

type ListPredicate

type ListPredicate struct {
	Field    string
	Operator string
	Values   []string
}

ListPredicate is a transport-agnostic predicate shape for list contracts.

type PaginationContractConfig

type PaginationContractConfig struct {
	TotalExpected int
	PerPage       int
	SortBy        string
	SortDesc      bool
	Filters       map[string]any
	Predicates    []ListPredicate
	Search        string
	UniqueKey     string
}

PaginationContractConfig configures assertions for a list total/pagination contract.