simulate

package

Go to main page

Versions in this module

v0

v0.4.0

Oct 15, 2026

Changes in this version

+ var ErrCompileGate = errors.New("compile gate failed")

+ var ErrInfrastructure = errors.New("go tool infrastructure failure")

+ func Checkout(ctx context.Context, cloner Cloner, ...) (dir string, cleanup func(), err error)

+ func CompileCgoLimited(arch string, env BuildEnv) bool

+ func ModrootDir(root, modroot string) string

+ func OmnibumpVersion() string

+ func TargetArches(arches []string) []string

+ type BuildEnv struct

+ CGO string

+ GOExperiment string

+ type BuildTarget struct

+ Arches []string

+ Env BuildEnv

+ Patterns []string

+ Tags []string

type Candidate

+ Rungs []Rung

+ Severity string

+ type CompileReport struct

+ Failed map[string][]string

+ FileModules map[string]string

+ Imports map[string][]string

+ Modules map[string]string

+ type Compiler interface

+ Compile func(ctx context.Context, dir string, target BuildTarget, arch string) (*CompileReport, error)

+ ModuleRequires func(ctx context.Context, dir, module, version string) (map[string]string, error)

+ ModuleVersions func(ctx context.Context, dir, module string) ([]string, error)

type DroppedCandidate

+ Hygiene bool

+ Redundant bool

+ type Engine int

+ const EngineGobump

+ const EngineOmnibump

+ func (e Engine) String() string

type GoToolchain

+ func (t *GoToolchain) Compile(ctx context.Context, dir string, target BuildTarget, arch string) (*CompileReport, error)

+ func (t *GoToolchain) ModuleRequires(ctx context.Context, dir, modulePath, version string) (map[string]string, error)

+ func (t *GoToolchain) ModuleVersions(ctx context.Context, dir, modulePath string) ([]string, error)

+ func (t *GoToolchain) RequiredBy(ctx context.Context, dir string) (map[string]map[string]string, error)

+ func (t *GoToolchain) ResolveQuery(ctx context.Context, dir, modulePath, query string) (string, error)

+ type HygieneModule struct

+ Module string

+ Version string

+ VulnIDs []string

+ type Linkage struct

+ Embeds []UnmatchedEmbed

+ Modules map[string]struct{}

+ Packages map[string]struct{}

type ModrootRequest

+ Arches []string

+ Engine Engine

+ Env BuildEnv

+ GoVersion string

+ NoTidy bool

+ ProbeTidy bool

+ Tags []string

type ModrootResult

+ BaselineTidies bool

+ GateUnchecked int

+ GateUncheckedFirst string

+ HygieneModules []HygieneModule

+ HygieneSkipped string

+ LinkageError string

+ UnmatchedEmbeds []UnmatchedEmbed

type Options

+ NoCompile bool

+ type Rung struct

+ Severity string

+ Version string

+ VulnIDs []string

+ func FixRungs(vulns []scan.Vulnerability, module string, ids []string, also ...string) []Rung

+ type UnmatchedEmbed struct

+ Package string

+ Pattern string

v0.3.0

Aug 14, 2026

Changes in this version

+ type Candidate struct

+ FromCVE bool

+ Module string

+ Replace bool

+ ReplaceOld string

+ Version string

+ VulnIDs []string

+ func (c Candidate) OldPath() string

+ type Cloner interface

+ CloneAtTag func(ctx context.Context, repoURL, tag, destDir string) error

+ HeadCommit func(dir string) (string, error)

+ type DroppedCandidate struct

+ Module string

+ Reason string

+ Version string

+ type GoToolchain struct

+ func NewToolchain(commandTimeout time.Duration) (*GoToolchain, error)

+ func (t *GoToolchain) DepGoVersions(ctx context.Context, dir string) (map[string]string, error)

+ func (t *GoToolchain) Get(ctx context.Context, dir, moduleAtVersion string) error

+ func (t *GoToolchain) Linked(ctx context.Context, dir string, patterns []string) (modules, packages map[string]struct{}, err error)

+ func (t *GoToolchain) LinkedStd(ctx context.Context, dir string, patterns []string) (map[string]struct{}, error)

+ func (t *GoToolchain) ListModules(ctx context.Context, dir string) (map[string]string, error)

+ func (t *GoToolchain) ModTidy(ctx context.Context, dir string) error

+ func (t *GoToolchain) Replace(ctx context.Context, dir, oldPath, newPath, version string) error

+ func (t *GoToolchain) Replaces(_ context.Context, dir string) (map[string]ReplaceTarget, error)

+ func (t *GoToolchain) Requirements(_ context.Context, dir string) (map[string]string, error)

+ type ModrootRequest struct

+ Baseline map[string]string

+ BaselineVulnIDs map[string]struct{}

+ Modroot string

+ Packages []string

+ Seeds []Candidate

+ VulnImports map[string][]string

+ type ModrootResult struct

+ CVEBackedModules []string

+ Converged bool

+ Dropped []DroppedCandidate

+ FinalDeps []string

+ FinalReplaces []string

+ Iterations int

+ Linked map[string]struct{}

+ LinkedPackages map[string]struct{}

+ MaxDepGoVersion string

+ Modroot string

+ RemainingVulnIDs []string

+ Requires map[string]string

+ Residuals []Residual

+ Resolved map[string]string

+ StdPackages map[string]struct{}

+ UnrequiredModules map[string]struct{}

+ func RunLoop(ctx context.Context, tc Toolchain, sc Scanner, dir string, req ModrootRequest, ...) (*ModrootResult, error)

+ type Options struct

+ Budget time.Duration

+ CommandTimeout time.Duration

+ MaxIterations int

+ func (o Options) WithDefaults() Options

+ type ReplaceTarget struct

+ Path string

+ Version string

+ type Residual struct

+ FixedVersion string

+ Introduced bool

+ Module string

+ Reason string

+ ResolvedVersion string

+ VulnIDs []string

+ type Scanner interface

+ ScanPackages func(ctx context.Context, pkgs []scan.Package) (*scan.ScanResult, error)

+ type Simulator struct

+ func NewSimulator(cloner Cloner, tc Toolchain, sc Scanner, tempDir string, opts Options) *Simulator

+ func (s *Simulator) Simulate(ctx context.Context, repoURL, tag, expectedCommit string, ...) (map[string]*ModrootResult, error)

+ type Toolchain interface

+ DepGoVersions func(ctx context.Context, dir string) (map[string]string, error)

+ Get func(ctx context.Context, dir, moduleAtVersion string) error

+ Linked func(ctx context.Context, dir string, patterns []string) (modules, packages map[string]struct{}, err error)

+ LinkedStd func(ctx context.Context, dir string, patterns []string) (map[string]struct{}, error)

+ ListModules func(ctx context.Context, dir string) (map[string]string, error)

+ ModTidy func(ctx context.Context, dir string) error

+ Replace func(ctx context.Context, dir, oldPath, newPath, version string) error

+ Replaces func(ctx context.Context, dir string) (map[string]ReplaceTarget, error)

+ Requirements func(ctx context.Context, dir string) (map[string]string, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL