harness

type Approval ¶

type Approval struct {
	Err      error
	Requests []core.ApprovalRequest
}

Approval is an approving-by-default core.Approver.

func (a *Approval) Require(_ context.Context, req core.ApprovalRequest) error

type Artifacts ¶

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

Artifacts is an in-memory core.ArtifactStore.

func (a *Artifacts) Delete(_ context.Context, path string) error

func (a *Artifacts) Get(_ context.Context, path string) ([]byte, error)

func (a *Artifacts) Put(_ context.Context, name string, data []byte) (string, error)

type Audit ¶

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

Audit records every core.AuditEvent it receives.

func (a *Audit) Events() []core.AuditEvent

func (a *Audit) Record(_ context.Context, ev core.AuditEvent)

type Binaries ¶

type Binaries struct {
	Path  string
	State core.BinaryStatus
	Err   error
}

Binaries is a scripted core.BinaryManager reporting every binary installed.

func (b *Binaries) Ensure(context.Context, string, string) (string, core.BinaryStatus, error)

func (b *Binaries) Status(context.Context, string) (core.BinaryStatus, error)

func (b *Binaries) Update(context.Context, string, string) (core.BinaryStatus, error)

type Clock ¶

type Clock struct {
	Now_ time.Time
	Step time.Duration
	// contains filtered or unexported fields
}

Clock is a manual clock. Every call to Now advances by Step, so a test that needs distinct timestamps gets them without sleeping.

func NewClock(t time.Time) *Clock

func (c *Clock) Advance(d time.Duration)

func (c *Clock) Now() time.Time

func (c *Clock) Set(t time.Time)

type CloudSignRequest ¶

type CloudSignRequest struct {
	Request   core.Request
	AccessKey string
	SecretKey string
	At        time.Time
}

CloudSignRequest is one recorded signing request.

type CloudSigner ¶

type CloudSigner struct {
	// Signature is the value embedded in the Authorization header.
	Signature string
	// AccessKey, when set, overrides the credential echoed into the header.
	AccessKey string
	Err       error
	// contains filtered or unexported fields
}

CloudSigner is a scripted cloud request signer. It records every request it was asked to sign and stamps a deterministic Authorization header, so a cloud tool can be exercised offline: the test asserts on what would have been sent without ever reaching a vendor API.

It satisfies cloudkit's Signer interface structurally, which keeps this package free of kit imports.

func (s *CloudSigner) SignRequest(req core.Request, accessKey, secretKey string, now time.Time) (core.Request, error)

func (s *CloudSigner) Signed() []CloudSignRequest

type Completer ¶ added in v0.5.0

type Completer struct {
	Reply  string
	Err    error
	Calls  int
	System []string
	User   []string
}

Completer is a scripted core.Completer. Reply is returned verbatim, so a test can feed a canned model answer — or a malformed one.

func (c *Completer) Complete(_ context.Context, system, user string, _ int) (string, error)

type Engine ¶

type Engine struct {
	KindName string
	Result   core.Result
	Err      error
}

Engine is a scripted core.TemplateEngine.

func (e *Engine) Execute(context.Context, []core.TemplateRef, core.Target, map[string]any) (core.Result, error)

func (e *Engine) Kind() string

type Evidence ¶

type Evidence struct {
	Prefix string
	Err    error
	// contains filtered or unexported fields
}

Evidence stores every core.Evidence it is handed and returns "<Prefix><n>".

func (e *Evidence) Record(_ context.Context, ev core.Evidence) (string, error)

func (e *Evidence) Records() []core.Evidence

type Fingerprints ¶

type Fingerprints struct {
	Result []core.Fingerprint
	Err    error
}

Fingerprints is a scripted core.FingerprintProvider.

func (f *Fingerprints) Fingerprint(context.Context, core.Target) ([]core.Fingerprint, error)

type HTTP ¶

type HTTP struct {
	// Default answers any request no route matches.
	Default Route
	// Routes are checked in order before Default.
	Routes []Route
	// Queue answers the first len(Queue) calls in order, before Routes and
	// Default apply, and is consumed as it is used. It exists for protocol-level
	// sequences a route table cannot express — "the invocation does not exist
	// yet on the first poll, succeeds on the second" — where the answer depends
	// on how many calls came before rather than on the request itself.
	Queue []Route
	// Err fails every call regardless of routes.
	Err error
	// contains filtered or unexported fields
}

HTTP is a scripted core.HTTPDoer and core.Fetcher. It answers from a route table, falling back to the default response, and records every request in call order.

func NewHTTP(status int, body string) *HTTP

func NewHTTPJSON(body string) *HTTP

func (h *HTTP) Calls() int

func (h *HTTP) Do(ctx context.Context, req core.Request) (*core.Response, error)

func (h *HTTP) Fetch(ctx context.Context, req core.Request) (*core.Response, error)

func (h *HTTP) Last() (core.Request, bool)

func (h *HTTP) Requests() []core.Request

type IDs ¶

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

IDs is a deterministic core.IDGenerator: the n-th call for a prefix returns "<prefix>-<n>".

func (g *IDs) New(prefix string) string

type Intel ¶ added in v0.5.0

type Intel struct {
	Items []core.IntelItem
	Err   error
	// contains filtered or unexported fields
}

Intel is a scripted core.IntelStore. It keeps what it was given, so a test can assert the kit handed the host exactly what it claims.

func (i *Intel) Get(_ context.Context, id string) (*core.IntelItem, error)

func (i *Intel) Query(_ context.Context, q core.IntelQuery) ([]core.IntelItem, error)

func (i *Intel) Upsert(_ context.Context, item core.IntelItem) (string, bool, error)

type Limiter ¶

type Limiter struct {
	Err      error
	Acquired []string
}

Limiter is a non-blocking core.Limiter that records the keys it admitted.

func (l *Limiter) Acquire(_ context.Context, key string, _ core.RateLimitSpec) (func(), error)

type Logger ¶

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

Logger keeps every line it is given.

func (l *Logger) Error(msg string, kv ...any)

func (l *Logger) Info(msg string, kv ...any)

func (l *Logger) Lines() []string

func (l *Logger) Warn(msg string, kv ...any)

type Ports ¶

type Ports struct {
	HTTP     *HTTP
	Fetcher  *HTTP
	Scope    *Scope
	Approval *Approval
	Limiter  *Limiter
	Audit    *Audit
	Evidence *Evidence
	Settings *Settings
	Sealer   Sealer
	Logger   *Logger
	Clock    *Clock
	IDs      *IDs
	Process  *Process
	Artifact *Artifacts
	Binaries *Binaries

	Fingerprints *Fingerprints
	Templates    *Templates
	Engine       *Engine
	Sessions     *Sessions
	Intel        *Intel
	Completer    *Completer
}

Ports is the assembled fake port set. Fields are exposed so a test can swap one fake for a stricter one.

func NewPorts() *Ports

func (p *Ports) Deps() core.Deps

type Process ¶

type Process struct {
	Stdout   []byte
	Stderr   []byte
	ExitCode int
	Err      error
	// Handler, when set, overrides the preset and answers per spec.
	Handler func(core.ProcessSpec) (*core.ProcessResult, error)
	// contains filtered or unexported fields
}

Process is a scripted core.ProcessRunner: every Run returns the preset stdout/stderr/exit code and records the spec.

func (p *Process) Calls() []core.ProcessSpec

func (p *Process) Last() (core.ProcessSpec, bool)

func (p *Process) Run(_ context.Context, spec core.ProcessSpec) (*core.ProcessResult, error)

type Route ¶

type Route struct {
	Match   string
	Status  int
	Body    string
	Headers map[string][]string
	Err     error
}

Route is one scripted HTTP answer. When Match is non-empty only requests whose URL contains it take this route; otherwise it is the fallback.

type Scope ¶

type Scope struct {
	Denied  []string
	Err     error
	Checked []core.Target
}

Scope is a permissive-by-default core.ScopeChecker. Denied lists the hosts that must be refused; Err denies everything.

func (s *Scope) Check(_ context.Context, t core.Target) error

type Sealer ¶

type Sealer struct{ Key byte }

Sealer is a reversible XOR sealer for tests. It is not cryptographic and must never be used outside a test.

func (s Sealer) Open(sealed string) (string, error)

func (s Sealer) Seal(plain string) (string, error)

type Session ¶

type Session struct {
	SessionInfo core.SessionInfo
	Stdout      string
	Stderr      string
	ExitCode    int
	Err         error
	// contains filtered or unexported fields
}

Session is a scripted core.Session: Exec answers with the preset output.

func NewSession(id string) *Session

func (s *Session) Calls() []string

func (s *Session) Close() error

func (s *Session) Exec(_ context.Context, cmd string, _ core.ExecOpts) (core.Output, error)

func (s *Session) Info() core.SessionInfo

type Sessions ¶

type Sessions struct {
	OpenErr error
	// contains filtered or unexported fields
}

Sessions is an in-memory core.SessionManager. NewSessions starts empty; NewSessionsWith pre-registers the given sessions.

func NewSessions() *Sessions

func NewSessionsWith(list ...*Session) *Sessions

func (m *Sessions) Add(s *Session)

func (m *Sessions) Close(id string) error

func (m *Sessions) Get(id string) (core.Session, bool)

func (m *Sessions) List() []core.SessionInfo

func (m *Sessions) NextID(prefix string) string

func (m *Sessions) Open(_ context.Context, spec core.SessionSpec) (core.SessionInfo, error)

type Settings ¶

type Settings struct {
	Strings map[string]string
	Bools   map[string]bool
	Ints    map[string]int64
}

Settings is an in-memory core.Settings.

func NewSettings() *Settings

func (s *Settings) GetBool(_ context.Context, key string) (bool, bool)

func (s *Settings) GetInt(_ context.Context, key string) (int64, bool)

func (s *Settings) GetString(_ context.Context, key string) (string, bool)

type Templates ¶

type Templates struct {
	Refs []core.TemplateRef
	Err  error
}

Templates is an in-memory core.TemplateCatalog.

func (t *Templates) Get(_ context.Context, id string) (core.TemplateRef, bool, error)

func (t *Templates) Search(context.Context, core.TemplateQuery) ([]core.TemplateRef, error)