runner

Documentation

Overview

SPDX-License-Identifier: MIT

SPDX-License-Identifier: MIT

Index

• type Option
  • func WithOutput(w io.Writer) Option
  • func WithProbeTimeout(d time.Duration) Option
  • func WithRateLimit(rps float64) Option
  • func WithVerbose(v bool) Option
  • func WithWorkers(n int) Option
• type Options
• type RateLimiter
  • func NewRateLimiter(rate float64) *RateLimiter
  • func (r *RateLimiter) Wait(ctx context.Context) error
• type Runner
  • func New(adapter transport.Adapter, j judge.Judge, opts ...Option) *Runner
  • func (r *Runner) Run(ctx context.Context, t target.Config, probes []probe.Resolved) (*report.Report, error)

Types

type Option

type Option func(*Options)

Option is a functional option for the runner.

func WithOutput

func WithOutput(w io.Writer) Option

func WithProbeTimeout

func WithProbeTimeout(d time.Duration) Option

func WithRateLimit

func WithRateLimit(rps float64) Option

func WithVerbose

func WithVerbose(v bool) Option

func WithWorkers

func WithWorkers(n int) Option

type Options

type Options struct {
	Workers      int
	RateLimit    float64
	ProbeTimeout time.Duration // per-probe execution timeout (0 = no timeout)
	Verbose      bool
	Output       io.Writer // for progress output
}

Options configures the runner.

type RateLimiter

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

RateLimiter implements a token bucket rate limiter.

func NewRateLimiter

func NewRateLimiter(rate float64) *RateLimiter

NewRateLimiter creates a rate limiter that allows rate requests per second.

func (*RateLimiter) Wait

func (r *RateLimiter) Wait(ctx context.Context) error

Wait blocks until a token is available or the context is cancelled.

type Runner

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

Runner orchestrates probe execution.

func New

func New(adapter transport.Adapter, j judge.Judge, opts ...Option) *Runner

New creates a runner with the given adapter, judge, and options.

func (*Runner) Run

func (r *Runner) Run(ctx context.Context, t target.Config, probes []probe.Resolved) (*report.Report, error)

Run executes all probes against the target and returns a report.