fake

package
v0.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 30, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package fake provides in-memory implementations of the control-plane seams (controlplane.Clock, Kubernetes, Registry, Database) for tests. They are deterministic and controllable: time is explicit, state is inspectable, and errors can be injected per operation so engine logic can be exercised against absence and failure without a real cluster, registry, or database (ADR-0010).

The fakes are concurrency-safe so later fault-injection tests can drive them from multiple goroutines under the race detector. This package is licensed Apache-2.0 (see LICENSING.md and ADR-0033); it lives under controlplane/internal so it is importable only by the control plane it supports.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func URLFor 

func URLFor(app string) string

URLFor is the deterministic connection string the fake returns for app — exposed so a test can assert the engine wrote exactly this value into the secret without the value leaking elsewhere.

Types

type Clock 

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

Clock is a controllable controlplane.Clock. It does not advance on its own; tests move it with Advance or Set, so every time-dependent result is deterministic.

func NewClock 

func NewClock(start time.Time) *Clock

NewClock returns a Clock fixed at start.

func (*Clock) Advance 

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

Advance moves the clock forward by d.

func (*Clock) Now 

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

Now returns the current fake time.

func (*Clock) Set 

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

Set moves the clock to t.

type ClusterProber 

type ClusterProber struct {
	Caps controlplane.ClusterCapabilities
	Err  error
}

ClusterProber is an in-memory controlplane.ClusterProber: it returns a canned capability report (ADR-0034) so engine tests can drive ClusterCapabilities without a cluster. The cluster-derived fields are seeded; the engine fills the DNS field from the providers registry. An error can be injected to exercise the failure path.

func NewClusterProber 

func NewClusterProber(caps controlplane.ClusterCapabilities) *ClusterProber

NewClusterProber returns a prober reporting caps.

func (*ClusterProber) DetectCapabilities 

func (p *ClusterProber) DetectCapabilities(_ context.Context) (controlplane.ClusterCapabilities, error)

DetectCapabilities returns the seeded report (or the injected error).

type Credentials 

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

Credentials is an in-memory controlplane.Credentials. Tests seed tokens with Set, read what SetToken wrote with Get, and inject failure with SetError (OpToken, OpSetToken).

func NewCredentials 

func NewCredentials() *Credentials

NewCredentials returns an empty fake credential store.

func (*Credentials) Get 

func (c *Credentials) Get(key string) (string, bool)

Get returns the token stored under key and whether it is present, so a test can assert what SetToken wrote into the credential store.

func (*Credentials) Set 

func (c *Credentials) Set(key, token string)

Set records that key holds token, seeding the store directly (e.g. a token a prior set wrote).

func (*Credentials) SetError 

func (c *Credentials) SetError(op Op, err error)

SetError makes the Token op return err until cleared with SetError(OpToken, nil).

func (*Credentials) SetToken 

func (c *Credentials) SetToken(ctx context.Context, key, value string) error

SetToken upserts key=value into the in-memory store, modelling burrowd writing the token it received over the control-plane API into burrow-credentials (ADR-0030). An OpSetToken error can be injected to exercise the failure path.

func (*Credentials) Token 

func (c *Credentials) Token(ctx context.Context, key string) (string, error)

type DNSFactory 

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

DNSFactory is an in-memory controlplane.DNSFactory. Every DNS(...) returns the same shared provider (so a test can configure and inspect it), unless SetFactoryError makes DNS(...) itself fail. It records the (type, token) pairs it was asked for, so a test can assert the engine read and passed the right token.

func NewDNSFactory 

func NewDNSFactory() *DNSFactory

NewDNSFactory returns a factory whose shared provider accepts any token.

func (*DNSFactory) DNS 

func (f *DNSFactory) DNS(t controlplane.ProviderType, token string) (controlplane.DNSProvider, error)

func (*DNSFactory) LastToken 

func (f *DNSFactory) LastToken() (string, int)

LastToken returns the token most recently passed to DNS, and how many times DNS was called.

func (*DNSFactory) Provider 

func (f *DNSFactory) Provider() *DNSProvider

Provider returns the shared provider the factory hands out, for configuration and inspection.

func (*DNSFactory) SetDeleteError 

func (f *DNSFactory) SetDeleteError(err error)

SetDeleteError makes the shared provider fail DeleteRecord with err.

func (*DNSFactory) SetEnsureError 

func (f *DNSFactory) SetEnsureError(err error)

SetEnsureError makes the shared provider fail EnsureRecord with err.

func (*DNSFactory) SetFactoryError 

func (f *DNSFactory) SetFactoryError(err error)

SetFactoryError makes DNS(...) return err without handing out a provider.

func (*DNSFactory) SetVerifyError 

func (f *DNSFactory) SetVerifyError(err error)

SetVerifyError makes the shared provider reject VerifyAccess with err.

type DNSProvider 

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

DNSProvider is an in-memory controlplane.DNSProvider. VerifyAccess and the record operations return their configured error (nil = success); successful EnsureRecord/ DeleteRecord update an inspectable in-memory record set.

func (*DNSProvider) Calls 

func (p *DNSProvider) Calls() (ensure, delete int)

Calls returns how many times EnsureRecord and DeleteRecord were invoked.

func (*DNSProvider) DeleteRecord 

func (p *DNSProvider) DeleteRecord(ctx context.Context, host string) error

func (*DNSProvider) EnsureRecord 

func (p *DNSProvider) EnsureRecord(ctx context.Context, r controlplane.DNSRecord) error

func (*DNSProvider) Record 

func (p *DNSProvider) Record(name string) (controlplane.DNSRecord, bool)

Record returns the record currently held for name, and whether one exists.

func (*DNSProvider) VerifyAccess 

func (p *DNSProvider) VerifyAccess(ctx context.Context) error

type Database 

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

Database is an in-memory controlplane.Database. It stores releases by ID and tracks per-app save order so LatestRelease and Releases are deterministic. Records are deep copied in and out, so callers never share Env/Command memory with the store — the same isolation a real database gives. Errors can be injected per operation.

func NewDatabase 

func NewDatabase() *Database

NewDatabase returns an empty fake database with the default guardrail policy.

func (*Database) Addon 

func (d *Database) Addon(ctx context.Context, name string) (controlplane.AddonInfo, error)

func (*Database) Addons 

func (d *Database) Addons(ctx context.Context) ([]controlplane.AddonInfo, error)

func (*Database) AppEnv 

func (d *Database) AppEnv(ctx context.Context, app string) (map[string]string, error)

AppEnv returns a copy of the non-secret env store for app. An app with no env yields an empty map and no error.

func (*Database) AppendAudit 

func (d *Database) AppendAudit(ctx context.Context, e controlplane.AuditEntry) error

AppendAudit appends one audit row in append order (the append-only log). It deep-copies the args map so the store never aliases the caller's map, matching a real database.

func (*Database) Audit 

func (d *Database) Audit(ctx context.Context, filter controlplane.AuditFilter) ([]controlplane.AuditEntry, error)

Audit returns the rows matching filter, newest first, capped by filter.Limit (a default when unset). The filter clauses are ANDed.

func (*Database) AuditRows 

func (d *Database) AuditRows() []controlplane.AuditEntry

AuditRows returns a copy of every appended audit row in append order, for tests asserting on what the engine recorded.

func (*Database) DeleteAddon 

func (d *Database) DeleteAddon(ctx context.Context, name string) error

func (*Database) DeleteReleases 

func (d *Database) DeleteReleases(ctx context.Context, app string) error

DeleteReleases removes every release record for app, including its save-order tracking. Deleting the releases of an app that has none is a no-op, not an error.

func (*Database) GetBackup 

func (d *Database) GetBackup(ctx context.Context, id string) (controlplane.Backup, error)

GetBackup returns the backup with the given id, or ErrNotFound.

func (*Database) LatestRelease 

func (d *Database) LatestRelease(ctx context.Context, app string) (controlplane.Release, error)

func (*Database) ListBackups 

func (d *Database) ListBackups(ctx context.Context, app string) ([]controlplane.Backup, error)

ListBackups returns recorded backups newest first (reverse record order). An empty app lists all.

func (*Database) Policy 

func (d *Database) Policy(ctx context.Context) (controlplane.Policy, error)

Policy returns the current guardrail policy.

func (*Database) Provider 

func (d *Database) Provider(ctx context.Context, name string) (controlplane.Provider, error)

func (*Database) Providers 

func (d *Database) Providers(ctx context.Context) ([]controlplane.Provider, error)

func (*Database) RecordBackup 

func (d *Database) RecordBackup(ctx context.Context, b controlplane.Backup) error

RecordBackup persists a new backup row, tracking record order for deterministic listing. An existing row with the same ID is overwritten in place.

func (*Database) Release 

func (d *Database) Release(ctx context.Context, id string) (controlplane.Release, error)

func (*Database) Releases 

func (d *Database) Releases(ctx context.Context, app string) ([]controlplane.Release, error)

func (*Database) SaveAddon 

func (d *Database) SaveAddon(ctx context.Context, a controlplane.AddonInfo) error

SaveAddon upserts an add-on by name. It stores only the non-secret registry entry; Ready is a live property and is not persisted here.

func (*Database) SaveProvider 

func (d *Database) SaveProvider(ctx context.Context, p controlplane.Provider) error

SaveProvider upserts a provider by name. It stores only the non-secret registry entry.

func (*Database) SaveRelease 

func (d *Database) SaveRelease(ctx context.Context, r controlplane.Release) error

func (*Database) SetAppEnv 

func (d *Database) SetAppEnv(ctx context.Context, app, key, value string) error

SetAppEnv upserts one env key for app.

func (*Database) SetBackupStatus 

func (d *Database) SetBackupStatus(ctx context.Context, id string, status controlplane.BackupStatus, sizeBytes int64) error

SetBackupStatus updates a recorded backup's status and size. An unknown id is ErrNotFound.

func (*Database) SetError 

func (d *Database) SetError(op Op, err error)

SetError makes op return err until cleared with SetError(op, nil).

func (*Database) SetGuardrail 

func (d *Database) SetGuardrail(ctx context.Context, code controlplane.GuardrailCode, disp controlplane.Disposition) error

SetGuardrail persists one guardrail's disposition, overlaying it on the current policy.

func (*Database) SetPolicy 

func (d *Database) SetPolicy(p controlplane.Policy)

SetPolicy replaces the whole guardrail policy. It is a test helper for arranging a specific policy before exercising the engine.

func (*Database) UnsetAppEnv 

func (d *Database) UnsetAppEnv(ctx context.Context, app, key string) error

UnsetAppEnv removes one env key for app. Removing a key that is not set is a no-op.

type IDs 

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

IDs is a deterministic controlplane.IDSource that hands out "r1", "r2", ... so tests can predict release identifiers.

func NewIDs 

func NewIDs() *IDs

NewIDs returns an ID source starting at r1.

func (*IDs) NewID 

func (i *IDs) NewID() string

NewID returns the next sequential identifier.

type Kubernetes 

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

Kubernetes is an in-memory controlplane.Kubernetes. Applied workloads are stored and inspectable; by default a workload is healthy (ready == desired) immediately, and tests can override readiness (SetReady) and seed logs (SetLogs) to model partial or failed rollouts. Errors can be injected per operation with SetError.

func NewKubernetes 

func NewKubernetes() *Kubernetes

NewKubernetes returns an empty fake cluster.

func (*Kubernetes) AddonReady 

func (k *Kubernetes) AddonReady(ctx context.Context, name string) (bool, error)

AddonReady reports whether the named add-on was deployed (and thus ready) in this fake cluster. A deployed add-on is ready by default; an unknown one is not ready.

func (*Kubernetes) ApplyWorkload 

func (k *Kubernetes) ApplyWorkload(ctx context.Context, spec controlplane.WorkloadSpec) error

func (*Kubernetes) BackupJobs 

func (k *Kubernetes) BackupJobs() []backupCall

BackupJobs returns the (app, backupID) pairs RunBackupJob was called with, in order.

func (*Kubernetes) DeleteAddon 

func (k *Kubernetes) DeleteAddon(ctx context.Context, name string) error

func (*Kubernetes) DeleteWorkload 

func (k *Kubernetes) DeleteWorkload(ctx context.Context, app string) error

func (*Kubernetes) DeployAddon 

func (k *Kubernetes) DeployAddon(ctx context.Context, spec controlplane.AddonSpec) (controlplane.AddonInfo, error)

func (*Kubernetes) Expose 

func (k *Kubernetes) Expose(ctx context.Context, spec controlplane.ExposeSpec) error

func (*Kubernetes) Exposure 

func (k *Kubernetes) Exposure(app string) (controlplane.ExposeSpec, bool)

Exposure returns the recorded exposure for app and whether one exists.

func (*Kubernetes) ExposureStatus 

func (k *Kubernetes) ExposureStatus(ctx context.Context, app string) (controlplane.ExposureStatus, error)

func (*Kubernetes) ListWorkloads 

func (k *Kubernetes) ListWorkloads(ctx context.Context) ([]controlplane.WorkloadStatus, error)

func (*Kubernetes) Logs 

func (k *Kubernetes) Logs(ctx context.Context, app string, opts controlplane.LogOptions) ([]controlplane.LogLine, error)

func (*Kubernetes) RestartWorkload 

func (k *Kubernetes) RestartWorkload(ctx context.Context, app string, at time.Time) error

func (*Kubernetes) RestartedAt 

func (k *Kubernetes) RestartedAt(app string) (time.Time, bool)

RestartedAt returns the last RestartWorkload timestamp for app and whether the workload was ever rolled by a restart bump.

func (*Kubernetes) RestoreJobs 

func (k *Kubernetes) RestoreJobs() []backupCall

RestoreJobs returns the (app, backupID) pairs RunRestoreJob was called with, in order.

func (*Kubernetes) RunBackupJob 

func (k *Kubernetes) RunBackupJob(ctx context.Context, app, backupID string) (int64, error)

func (*Kubernetes) RunRestoreJob 

func (k *Kubernetes) RunRestoreJob(ctx context.Context, app, backupID string) error

func (*Kubernetes) ScaleWorkload 

func (k *Kubernetes) ScaleWorkload(ctx context.Context, app string, replicas int32) error

func (*Kubernetes) SecretKeys 

func (k *Kubernetes) SecretKeys(ctx context.Context, app string) ([]string, error)

func (*Kubernetes) SecretValue 

func (k *Kubernetes) SecretValue(app, key string) (string, bool)

SecretValue returns the stored value under key for app and whether it is present — test-only introspection (the real seam never exposes values).

func (*Kubernetes) SetBackupSize 

func (k *Kubernetes) SetBackupSize(n int64)

SetBackupSize sets the byte size RunBackupJob reports, modelling the dump container reporting it.

func (*Kubernetes) SetCertReady 

func (k *Kubernetes) SetCertReady(app string, ready bool)

SetCertReady sets whether the requested TLS certificate reported for app's exposure has been issued, modelling cert-manager having populated the certificate Secret.

func (*Kubernetes) SetError 

func (k *Kubernetes) SetError(op Op, err error)

SetError makes op return err until cleared with SetError(op, nil).

func (*Kubernetes) SetIngressAddress 

func (k *Kubernetes) SetIngressAddress(app, addr string)

SetIngressAddress sets the controller-assigned external address reported for app's exposure, modelling the ingress controller having processed the Ingress.

func (*Kubernetes) SetLogs 

func (k *Kubernetes) SetLogs(app string, lines []controlplane.LogLine)

SetLogs replaces the stored log lines for app.

func (*Kubernetes) SetReady 

func (k *Kubernetes) SetReady(app string, ready int32)

SetReady overrides the ready replica count for app, modelling a partial rollout. It is a no-op if app has no workload.

func (*Kubernetes) SetSecret 

func (k *Kubernetes) SetSecret(app, key, value string)

SetSecret seeds app's per-app Secret with key=value, modelling a `secret set` done over the kubeconfig path (which never goes through this engine seam). Tests use it to set up list/unset.

func (*Kubernetes) SetSecretValue 

func (k *Kubernetes) SetSecretValue(ctx context.Context, app, key, value string) error

SetSecretValue upserts key=value into app's per-app Secret map (ADR-0029), modelling burrowd writing the value it received over the control-plane API. SecretKeys/SecretValue read the same map. An OpSetSecretValue error can be injected to exercise the failure path.

func (*Kubernetes) Spec 

func (k *Kubernetes) Spec(app string) (controlplane.WorkloadSpec, bool)

Spec returns the currently applied spec for app and whether a workload exists.

func (*Kubernetes) Unexpose 

func (k *Kubernetes) Unexpose(ctx context.Context, app string) error

func (*Kubernetes) UnsetSecretKey 

func (k *Kubernetes) UnsetSecretKey(ctx context.Context, app, key string) error

func (*Kubernetes) WorkloadStatus 

func (k *Kubernetes) WorkloadStatus(ctx context.Context, app string) (controlplane.WorkloadStatus, error)

type Op 

type Op string

Op names a seam method for error injection. Pass one to a fake's SetError to make that method return the given error until it is cleared (SetError(op, nil)). 

const (
	OpApply           Op = "ApplyWorkload"
	OpStatus          Op = "WorkloadStatus"
	OpScale           Op = "ScaleWorkload"
	OpLogs            Op = "Logs"
	OpDelete          Op = "DeleteWorkload"
	OpExpose          Op = "Expose"
	OpUnexpose        Op = "Unexpose"
	OpExposureStatus  Op = "ExposureStatus"
	OpSecretKeys      Op = "SecretKeys"
	OpSetSecretValue  Op = "SetSecretValue"
	OpUnsetSecretKey  Op = "UnsetSecretKey"
	OpRestartWorkload Op = "RestartWorkload"
	OpAddonReady      Op = "AddonReady"
	OpResolve         Op = "Resolve"
	OpSaveAddon       Op = "SaveAddon"
	OpAddon           Op = "Addon"
	OpAddons          Op = "Addons"
	OpDeleteAddon     Op = "DeleteAddon"
	OpSaveRelease     Op = "SaveRelease"
	OpRelease         Op = "Release"
	OpLatestRelease   Op = "LatestRelease"
	OpReleases        Op = "Releases"
	OpDeleteReleases  Op = "DeleteReleases"
	OpAppEnv          Op = "AppEnv"
	OpSetAppEnv       Op = "SetAppEnv"
	OpUnsetAppEnv     Op = "UnsetAppEnv"
	OpPolicy          Op = "Policy"
	OpSetGuardrail    Op = "SetGuardrail"
	OpSaveProvider    Op = "SaveProvider"
	OpProvider        Op = "Provider"
	OpProviders       Op = "Providers"
	OpToken           Op = "Token"
	OpSetToken        Op = "SetToken"
	OpDNS             Op = "DNS"
	OpVerifyAccess    Op = "VerifyAccess"
	OpAppendAudit     Op = "AppendAudit"
	OpAudit           Op = "Audit"
	OpRecordBackup    Op = "RecordBackup"
	OpSetBackupStatus Op = "SetBackupStatus"
	OpListBackups     Op = "ListBackups"
	OpGetBackup       Op = "GetBackup"
	OpRunBackupJob    Op = "RunBackupJob"
	OpRunRestoreJob   Op = "RunRestoreJob"
)

type Provisioner 

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

Provisioner is an in-memory controlplane.DatabaseProvisioner. It records the apps it provisioned and returns a deterministic connection string per app, so an attach test can assert the engine called EnsureAppDatabase and threaded the URL into the secret path without standing up Postgres. Errors can be injected to exercise the failure path.

func NewProvisioner 

func NewProvisioner() *Provisioner

NewProvisioner returns an empty fake provisioner.

func (*Provisioner) DropAppDatabase 

func (p *Provisioner) DropAppDatabase(_ context.Context, app string) error

func (*Provisioner) Dropped 

func (p *Provisioner) Dropped() []string

Dropped returns the apps DropAppDatabase was called with, in order.

func (*Provisioner) EnsureAppDatabase 

func (p *Provisioner) EnsureAppDatabase(_ context.Context, app string) (string, error)

func (*Provisioner) Ensured 

func (p *Provisioner) Ensured() []string

Ensured returns the apps EnsureAppDatabase was called with, in order.

func (*Provisioner) SetDropError 

func (p *Provisioner) SetDropError(err error)

SetDropError makes DropAppDatabase return err (nil clears it).

func (*Provisioner) SetEnsureError 

func (p *Provisioner) SetEnsureError(err error)

SetEnsureError makes EnsureAppDatabase return err (nil clears it).

type Registry 

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

Registry is an in-memory controlplane.Registry. Tests seed known references with Add and inject failure with SetError.

func NewRegistry 

func NewRegistry() *Registry

NewRegistry returns an empty fake registry.

func (*Registry) Add 

func (r *Registry) Add(reference, digest string)

Add records that reference resolves to digest.

func (*Registry) Resolve 

func (r *Registry) Resolve(ctx context.Context, reference string) (controlplane.ImageInfo, error)

func (*Registry) SetError 

func (r *Registry) SetError(op Op, err error)

SetError makes op return err until cleared with SetError(op, nil). Only OpResolve is meaningful for the registry.

type Resolver 

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

Resolver is an in-memory controlplane.Resolver. Seed what a host resolves to with Set; an unseeded host returns an error, modelling NXDOMAIN.

func NewResolver 

func NewResolver() *Resolver

NewResolver returns a resolver that knows no hosts.

func (*Resolver) LookupHost 

func (r *Resolver) LookupHost(ctx context.Context, host string) ([]string, error)

func (*Resolver) Set 

func (r *Resolver) Set(host string, addrs ...string)

Set makes host resolve to addrs.

func (*Resolver) SetError 

func (r *Resolver) SetError(err error)

SetError makes every lookup return err until cleared with SetError(nil).

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.