assertions

Documentation

Index

• Constants
• func GenerateAssertionsCatalog(moduleName string, genInfo *GenInfo)
• func IsGeneratedFile(file_name string) bool
• type AntExpect
• type AntGuidance
• type AssertionFuncInfo
• type AssertionHints
  • func SetupHintMap() AssertionHints
  • func (m AssertionHints) HintsForName(name string) *AssertionFuncInfo
• type AssertionScanner
  • func NewAssertionScanner(verbose bool, moduleName string, symbolTableName string, sourceDir string, ...) *AssertionScanner
  • func (aScanner *AssertionScanner) GetLogger() *common.LogWriter
  • func (aScanner *AssertionScanner) HasAssertionsDefined() bool
  • func (aScanner *AssertionScanner) ScanFile(file_path string)
  • func (aScanner *AssertionScanner) SummarizeWork()
  • func (aScanner *AssertionScanner) WriteAssertionCatalog(versionText string)
• type GenInfo
• type GuidanceFnType
• type GuidanceFuncInfo
• type GuidanceHints
  • func SetupGuidanceHintMap() GuidanceHints
  • func (m GuidanceHints) GuidanceHintsForName(name string) *GuidanceFuncInfo

Constants

const (
	Cond_false = iota
	Cond_true
	Was_hit
	Not_hit
	Must_be_hit
	Optionally_hit
	Universal_test
	Existential_test
	Reachability_test
	Num_conditions
)

Functions

func GenerateAssertionsCatalog

func GenerateAssertionsCatalog(moduleName string, genInfo *GenInfo)

func IsGeneratedFile

func IsGeneratedFile(file_name string) bool

Types

type AntExpect

type AntExpect struct {
	*AssertionFuncInfo
	Assertion string
	Message   string
	Classname string
	Funcname  string
	Receiver  string
	Filename  string
	Line      int
}

type AntGuidance

type AntGuidance struct {
	*GuidanceFuncInfo
	Assertion string
	Message   string
	Classname string
	Funcname  string
	Receiver  string
	Filename  string
	Line      int
}

type AssertionFuncInfo

type AssertionFuncInfo struct {
	TargetFunc string
	AssertType string
	MustHit    bool
	Condition  bool
	MessageArg int
}

-------------------------------------------------------------------------------- Assertion Hints --------------------------------------------------------------------------------

type AssertionHints

type AssertionHints map[string]*AssertionFuncInfo

func SetupHintMap

func SetupHintMap() AssertionHints

func (AssertionHints) HintsForName

func (m AssertionHints) HintsForName(name string) *AssertionFuncInfo

type AssertionScanner

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

Capitalized struct items are accessed outside this file

func NewAssertionScanner

func NewAssertionScanner(verbose bool, moduleName string, symbolTableName string, sourceDir string, targetDir string) *AssertionScanner

func (*AssertionScanner) GetLogger

func (aScanner *AssertionScanner) GetLogger() *common.LogWriter

func (*AssertionScanner) HasAssertionsDefined

func (aScanner *AssertionScanner) HasAssertionsDefined() bool

func (*AssertionScanner) ScanFile

func (aScanner *AssertionScanner) ScanFile(file_path string)

func (*AssertionScanner) SummarizeWork

func (aScanner *AssertionScanner) SummarizeWork()

func (*AssertionScanner) WriteAssertionCatalog

func (aScanner *AssertionScanner) WriteAssertionCatalog(versionText string)

type GenInfo

type GenInfo struct {
	ConstMap map[string]bool

	AssertPackageName   string
	VersionText         string
	CreateDate          string
	ExpectedVals        []*AntExpect
	NumericGuidanceVals []*AntGuidance
	BooleanGuidanceVals []*AntGuidance
	HasAssertions       bool
	HasNumericGuidance  bool
	HasBooleanGuidance  bool
	// contains filtered or unexported fields
}

type GuidanceFnType

type GuidanceFnType int

A type for writing raw assertions. GuidanceFnType allows the assertion to provide guidance to the Antithesis platform when testing in Antithesis. Regular users of the assert package should not use it.

const (
	GuidanceFnMaximize GuidanceFnType = iota // Maximize (left - right) values
	GuidanceFnMinimize                       // Minimize (left - right) values
	GuidanceFnWantAll                        // Encourages fuzzing explorations where boolean values are true
	GuidanceFnWantNone                       // Encourages fuzzing explorations where boolean values are false
	GuidanceFnExplore
)

type GuidanceFuncInfo

type GuidanceFuncInfo struct {
	AssertionFuncInfo
	GuidanceFn GuidanceFnType
}

-------------------------------------------------------------------------------- Guidance Hints --------------------------------------------------------------------------------

type GuidanceHints

type GuidanceHints map[string]*GuidanceFuncInfo

func SetupGuidanceHintMap

func SetupGuidanceHintMap() GuidanceHints

func (GuidanceHints) GuidanceHintsForName

func (m GuidanceHints) GuidanceHintsForName(name string) *GuidanceFuncInfo