configuration

package

v0.5.0 Latest Latest Go to latest Published: Dec 19, 2023 License: Apache-2.0 Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/go-gremlins/gremlins

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Get[T any](k string) T
func Init(cPaths []string) error
func IsDefaultEnabled(mt mutator.Type) bool
func MutantTypeEnabledKey(mt mutator.Type) string
func Reset()
func Set[T any](k string, v T)

Constants ¶

View Source

const (
	GremlinsSilentKey            = "silent"
	UnleashDryRunKey             = "unleash.dry-run"
	UnleashOutputKey             = "unleash.output"
	UnleashTagsKey               = "unleash.tags"
	UnleashCoverPkgKey           = "unleash.coverpkg"
	UnleashWorkersKey            = "unleash.workers"
	UnleashTestCPUKey            = "unleash.test-cpu"
	UnleashTimeoutCoefficientKey = "unleash.timeout-coefficient"
	UnleashIntegrationMode       = "unleash.integration"
	UnleashDiffRef               = "unleash.diff"
	UnleashThresholdEfficacyKey  = "unleash.threshold.efficacy"
	UnleashThresholdMCoverageKey = "unleash.threshold.mutant-coverage"
)

This is the list of the keys available in config files and as flags.

Variables ¶

This section is empty.

Functions ¶

func Get ¶

func Get[T any](k string) T

Get offers synchronised access to Viper.

func Init ¶

func Init(cPaths []string) error

Init initializes the viper configuration for Gremlins.

It sets the configuration file name as .gremlins.yaml, adds the passed paths as ConfigPaths AutomaticEnv configuration having GREMLINS as prefix. The environment variables take precedence over the configuration file and must be set in the format:

GREMLINS_<COMMAND NAME>_<FLAG NAME>

func IsDefaultEnabled ¶

func IsDefaultEnabled(mt mutator.Type) bool

IsDefaultEnabled returns the default enabled/disabled state of the mutation. It gets the state from the table above that must be kept up to date when adding new mutant types.

func MutantTypeEnabledKey ¶

func MutantTypeEnabledKey(mt mutator.Type) string

MutantTypeEnabledKey returns the configuration key for a mutant. The generated key will have the format 'mutants.mutant-name.enabled", which corresponds to the Yaml:

	mutants:
 		mutant-name:
 			enabled: [bool]

func Reset ¶

func Reset()

Reset is used mainly for testing purposes, in order to clean up the Viper instance.

func Set ¶

func Set[T any](k string, v T)

Set offers synchronised access to Viper.

Types ¶

This section is empty.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL