package smat

Import Path
	github.com/mschoch/smat (on go.dev)

Dependency Relation
	imports 7 packages, and imported by one package

Involved Source Files

	    actionseq.go
	    smat.go
Package-Level Type Names (total 7)

	/* sort by: alphabet | popularity */
	 type Action (func)
		Action is any function which returns the next state to transition to
		it can optionally mutate the provided context object
		if any error occurs, it may return an error which will abort execution

	 type ActionID int (basic type)
		ActionID is a unique identifier for an action

		As Outputs Of (at least one exported)
			func PercentExecute(next byte, pas ...PercentAction) ActionID
		As Inputs Of (at least 3)
			func Fuzz(ctx Context, setup, teardown ActionID, actionMap ActionMap, data []byte) int
			func Longevity(ctx Context, setup, teardown ActionID, actionMap ActionMap, seed int64, closeChan chan struct{}) error
			func ActionSeq.ByteEncoding(ctx Context, setup, teardown ActionID, actionMap ActionMap) ([]byte, error)
		As Types Of (only one)
			  var NopAction

	 type ActionMap (map)
		ActionMap is a mapping form ActionID to Action

		As Inputs Of (at least 3)
			func Fuzz(ctx Context, setup, teardown ActionID, actionMap ActionMap, data []byte) int
			func Longevity(ctx Context, setup, teardown ActionID, actionMap ActionMap, seed int64, closeChan chan struct{}) error
			func ActionSeq.ByteEncoding(ctx Context, setup, teardown ActionID, actionMap ActionMap) ([]byte, error)

	 type ActionSeq ([])
		ActionSeq represents a sequence of actions, used for populating a corpus
		of byte sequences for the corresponding fuzz tests

		Methods (only one)
			( ActionSeq) ByteEncoding(ctx Context, setup, teardown ActionID, actionMap ActionMap) ([]byte, error)
				ByteEncoding runs the FSM to produce a byte sequence to trigger the
				desired action


	 type Context (interface)
		Context is a container for any user state

		As Inputs Of (at least 3)
			func Fuzz(ctx Context, setup, teardown ActionID, actionMap ActionMap, data []byte) int
			func Longevity(ctx Context, setup, teardown ActionID, actionMap ActionMap, seed int64, closeChan chan struct{}) error
			func ActionSeq.ByteEncoding(ctx Context, setup, teardown ActionID, actionMap ActionMap) ([]byte, error)

	 type PercentAction (struct)
		PercentAction describes the frequency with which an action should occur
		for example: Action{Percent:10, Action:DonateMoney} means that 10% of
		the time you should donate money.

		Fields (total 2)
			Action ActionID
			Percent int
		As Inputs Of (at least one exported)
			func PercentExecute(next byte, pas ...PercentAction) ActionID

	 type State (func)
		State is a function which describes which action to perform in the event
		that a particular byte is seen


Package-Level Functions (total 3)

	 func Fuzz(ctx Context, setup, teardown ActionID, actionMap ActionMap, data []byte) int
		Fuzz runs the fuzzing state machine with the provided context
		first, the setup action is executed unconditionally
		the start state is determined by this action
		actionMap is a lookup table for all actions
		the data byte slice determines all future state transitions
		finally, the teardown action is executed unconditionally for cleanup

	 func Longevity(ctx Context, setup, teardown ActionID, actionMap ActionMap, seed int64, closeChan chan struct{}) error
		Longevity runs the state machine with the provided context
		first, the setup action is executed unconditionally
		the start state is determined by this action
		actionMap is a lookup table for all actions
		random bytes are generated to determine all future state transitions
		finally, the teardown action is executed unconditionally for cleanup

	 func PercentExecute(next byte, pas ...PercentAction) ActionID
		PercentExecute interprets the next byte as a random value and normalizes it
		to values 0-99, it then looks to see which action should be execued based
		on the action distributions


Package-Level Variables (total 6)

	  var ErrActionNotPossible error
		ErrActionNotPossible is returned when an action is encountered in a
		FuzzCase that is not possible in the current state

	  var ErrClosed error
		ErrClosed is returned when the closeChan was closed to cancel the op

	  var ErrSetupMissing error
		ErrSetupMissing is returned when the setup action cannot be found

	  var ErrTeardownMissing error
		ErrTeardownMissing is returned when the teardown action cannot be found

	  var Logger *log.Logger
		Logger is a configurable logger used by this package
		by default output is discarded

	  var NopAction ActionID
		NopAction does nothing and simply continues to the next input

The pages are generated with Golds v0.8.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.