Documentation
¶
Overview ¶
Package observe shows runs observed in real systems in walkthroughs.
Apply matches an observation to a walkthrough's scenarios and writes each scenario instance found as its own scenario entry. The entry keeps every step's explanation and example and adds the exchange that was observed, with its tokens decoded but not verified, the step's status, and the exchanges that matched no step, each after the step it followed. Raw token, signature and credential values are masked unless asked for.
Index ¶
Constants ¶
const ( MaskJWT = "[redacted:jwt]" MaskValue = "[redacted]" )
Masks put in place of redacted values.
Variables ¶
This section is empty.
Functions ¶
func Apply ¶
func Apply(p *pidl.Protocol, w *pidl.Walkthrough, o *pidl.Observation, b *pidl.Binding, opts Options) (*match.Report, error)
Apply matches o to w's scenarios and adds an entry for each scenario instance found, right after the scenario it is an instance of. p supplies the token definitions; b may be nil.
Types ¶
type Options ¶
type Options struct {
// Scenarios names the scenarios to look for, in order; empty means
// every scenario that is not a fragment.
Scenarios []string
// From and To limit matching to exchanges in a time range.
From, To *time.Time
// Raw keeps raw token, signature and credential values; by default
// they are masked and decoded claims are kept.
Raw bool
}
Options controls matching and output.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
adapter
|
|
|
sandbox
Package sandbox reads the message trace of the aauth-go sandbox as a PIDL observation.
|
Package sandbox reads the message trace of the aauth-go sandbox as a PIDL observation. |
|
Package match matches observed exchanges to the steps of a walkthrough's scenarios.
|
Package match matches observed exchanges to the steps of a walkthrough's scenarios. |