config

type FTWConfiguration struct {
	// Logfile is the path to the file that contains the WAF logs to check. The path may be absolute or relative, in which case it will be interpreted as relative to the current working directory.
	LogFile string `koanf:"logfile"`
	// TestOverride holds the test overrides that will apply globally
	TestOverride FTWTestOverride `koanf:"testoverride"`
	// LogMarkerHeaderName is the name of the header that will be used by the test framework to mark positions in the log file
	LogMarkerHeaderName string `koanf:"logmarkerheadername"`
	// RunMode stores the mode used to interpret test results. See https://github.com/coreruleset/go-ftw/v2#%EF%B8%8F-cloud-mode.
	RunMode RunMode `koanf:"mode"`
	// MaxMarkerRetries is the maximum number of times the search for log markers will be repeated; each time an additional request is sent to the web server, eventually forcing the log to be flushed
	MaxMarkerRetries uint `koanf:"maxmarkerretries"`
	// MaxMarkerLogLines is the maximum number of lines to search for a marker before aborting
	MaxMarkerLogLines uint `koanf:"maxmarkerloglines"`
	// IncludeTests is a regular expression for tests to include, matched against the rule ID (same as --include)
	IncludeTests *FTWRegexp `koanf:"include"`
	// ExcludeTests is a regular expression for tests to exclude, matched against the rule ID (same as --exclude)
	ExcludeTests *FTWRegexp `koanf:"exclude"`
	// IncludeTags is a regular expression for tests to include, matched aginst the tags of tests (same as --tag)
	IncludeTags *FTWRegexp `koanf:"include_tags"`
	// to domains with a self-signed certificate.
	SkipTlsVerification bool `koanf:"skip_tls_verification"`
}

type FTWRegexp regexp.Regexp

type FTWTestOverride struct {
	Overrides Overrides             `koanf:"input"`
	Ignore    map[*FTWRegexp]string `koanf:"ignore"`
	ForcePass map[*FTWRegexp]string `koanf:"forcepass"`
	ForceFail map[*FTWRegexp]string `koanf:"forcefail"`
}

type Overrides struct {
	DestAddr *string `yaml:"dest_addr,omitempty" koanf:"dest_addr,omitempty"`
	Port     *int    `yaml:"port,omitempty" koanf:"port,omitempty"`
	Protocol *string `yaml:"protocol,omitempty" koanf:"protocol,omitempty"`
	URI      *string `yaml:"uri,omitempty" koanf:"uri,omitempty"`
	Version  *string `yaml:"version,omitempty" koanf:"version,omitempty"`
	// Deprecated: use OrderedHeaders instead
	Headers        map[string]string    `yaml:"headers,omitempty" koanf:"headers,omitempty"`
	OrderedHeaders []schema.HeaderTuple `yaml:"ordered_headers,omitempty" koanf:"ordered_headers,omitempty"`
	Method         *string              `yaml:"method,omitempty" koanf:"method,omitempty"`
	Data           *string              `yaml:"data,omitempty" koanf:"data,omitempty"`
	SaveCookie     *bool                `yaml:"save_cookie,omitempty" koanf:"save_cookie,omitempty"`
	// Deprecated: replaced with AutocompleteHeaders
	StopMagic               *bool   `yaml:"stop_magic" koanf:"stop_magic,omitempty"`
	AutocompleteHeaders     *bool   `yaml:"autocomplete_headers" koanf:"autocomplete_headers,omitempty"`
	EncodedRequest          *string `yaml:"encoded_request,omitempty" koanf:"encoded_request,omitempty"`
	OverrideEmptyHostHeader *bool   `yaml:"override_empty_host_header,omitempty" koanf:"override_empty_host_header,omitempty"`
	VirtualHostMode         *bool   `yaml:"virtual_host_mode,omitempty" koanf:"virtual_host_mode,omitempty"`
}

type PlatformOverrides struct {
	schema.FTWOverrides
	OverridesMap map[uint][]*schema.TestOverride
}

type RunMode string

type RunnerConfig struct {
	// Include is a regular expression to filter tests to include. If nil, all tests are included.
	Include *regexp.Regexp
	// Exclude is a regular expression to filter tests to exclude. If nil, no tests are excluded.
	Exclude *regexp.Regexp
	// IncludeTags is a regular expression to filter tests to count the ones tagged with the mathing label. If nil, no impact on test runner.
	IncludeTags *regexp.Regexp
	// ShowTime determines whether to show the time taken to run each test.
	ShowTime bool
	// ShowOnlyFailed will only output information related to failed tests
	ShowOnlyFailed bool
	// Output determines the type of output the user wants.
	Output output.Type
	// ConnectTimeout is the timeout for connecting to endpoints during test execution.
	ConnectTimeout time.Duration
	// ReadTimeout is the timeout for receiving responses during test execution.
	ReadTimeout time.Duration
	// RateLimit is the rate limit for requests to the server. 0 is unlimited.
	RateLimit time.Duration
	// FailFast determines whether to stop running tests when the first failure is encountered.
	FailFast            bool
	RunMode             RunMode
	LogMarkerHeaderName string
	LogFilePath         string
	PlatformOverrides   PlatformOverrides
	TestOverride        FTWTestOverride
	MaxMarkerRetries    uint
	MaxMarkerLogLines   uint
	// SkipTlsVerification skips certificate validation. Useful for connecting
	// to domains with a self-signed certificate.
	SkipTlsVerification bool
}