Variist/com.tegonal.variist.config

Package-level declarations

Configuration related classes such as VariistConfig.

Types

class ArgsRangeOptions(val profile: String? = null, val requestedMinArgs: Int? = null, val maxArgs: Int? = null)

Represents options which influences an ArgsRangeDecider on what ArgsRange to choose.

class ComponentFactory(val build: (ComponentFactoryContainer) -> Any, val producesSingleton: Boolean)

Provides a build lambda which produces the component and specifies via producesSingleton whether this component should be treated as singleton or not.

ComponentFactoryContainer

interface ComponentFactoryContainer

Manages the factories to create the different components of Variist.

ComponentFactoryContainerFactory

interface ComponentFactoryContainerFactory

Responsible to create a ComponentFactoryContainer.

ComponentFactoryContainerProvider

interface ComponentFactoryContainerProvider

Type which provides a ComponentFactoryContainer via property componentFactoryContainer.

Env

enum Env : Enum<Env>

Predefined environment names.

IsComponentFactoryContainerProvider

interface IsComponentFactoryContainerProvider

Marker interface for types which can safely be cast to ComponentFactoryContainerProvider.

RandomFactory

interface RandomFactory

Factory to create a Random.

Seed

@JvmInline

value class Seed(val value: Int)

Represents the Variist seed, typically used for kotlin.random.Random and as offset in SemiOrderedArgsGenerator.generate.

TestConfig

class TestConfig(val maxArgs: Int)

A configuration specific to a test profile and environment.

TestProfiles

interface TestProfiles

A collection of TestConfigs grouped by environment and profile name.

TestType

enum TestType : Enum<TestType>

Predefined test type names (e.g. to use as profile names for TestProfiles).

VariistConfig

class VariistConfig(val seed: Seed = Seed(Random.nextInt()), val skip: Int? = null, val requestedMinArgs: Int? = null, val maxArgs: Int? = null, val activeArgsRangeDecider: String = ProfileBasedArgsRangeDecider::class.qualifiedName ?: error( "cannot determine qualified name of ${ProfileBasedArgsRangeDecider::class.simpleName} " ), val activeSuffixArgsGeneratorDecider: String = SuffixArgsGeneratorNeverDecider::class.qualifiedName ?: error( "cannot determine qualified name of ${SuffixArgsGeneratorNeverDecider::class.simpleName} " ), val defaultProfile: String = TestType.Integration.name, val activeEnv: String = Env.Local.name, val testProfiles: TestProfiles = defaultTestProfiles)

The configuration of Variist which steers the generation of values.

VariistConfigBuilder

class VariistConfigBuilder(var seed: Int, var skip: Int?, var maxArgs: Int?, var requestedMinArgs: Int?, var activeArgsRangeDecider: String, var activeSuffixArgsGeneratorDecider: String, var activeEnv: String, var defaultProfile: String, var testProfiles: MutableList<Pair<String, MutableList<Pair<String, TestConfig>>>>)

Builder to create a VariistConfig in a mutable way.

VariistConfigException

abstract class VariistConfigException(message: String, cause: Throwable?) : RuntimeException

The base class of Exceptions which are raised in conjunction with VariistConfig.

VariistDeadlineException

class VariistDeadlineException(message: String) : VariistConfigException

Caused in case a specified deadline passed.

VariistParseException

class VariistParseException(message: String, cause: Throwable? = null) : VariistConfigException

Caused in case a config file cannot be parsed.

VariistPropertiesLoaderConfig

class VariistPropertiesLoaderConfig(var remindAboutFixedPropertiesAfterMinutes: Int = 60, var localPropertiesDir: Path = Paths.get("./src/test/resources"), var errorDeadlines: HashMap<String, LocalDateTime> = HashMap(), var localPropertiesResourceName: String? = null, var localPropertiesPrefix: String? = null)

Contains properties which are not exposed via VariistConfig and influence the loading of the local VariistConfig file.

Properties

_components

val IsComponentFactoryContainerProvider._components: ComponentFactoryContainer

Casts this to a ComponentFactoryContainerProvider and returns the ComponentFactoryContainerProvider.componentFactoryContainer.

arb

val ComponentFactoryContainer.arb: ArbExtensionPoint

Creates an ArbExtensionPoint based on this ComponentFactoryContainer.

config

val ComponentFactoryContainer.config: VariistConfig

Quick access to build a VariistConfig from this ComponentFactoryContainer.

ordered

val ComponentFactoryContainer.ordered: OrderedExtensionPoint

Creates an OrderedExtensionPoint based on this ComponentFactoryContainer.

semiOrdered

val ComponentFactoryContainer.semiOrdered: SemiOrderedExtensionPoint

Creates an SemiOrderedExtensionPoint based on this ComponentFactoryContainer.

Functions

build

inline fun <T : Any> ComponentFactoryContainer.build(): T

Returns the component of type T using a corresponding factory or throws an IllegalStateException in case no factory was found which is able to build a component of the given type.

buildChained

inline fun <T : Any> ComponentFactoryContainer.buildChained(): Sequence<T>

Returns a chain of components of type T using a corresponding factory or throws an IllegalStateException in case no factory was found which is able to build a chain of components of the given type.

contains

operator fun TestProfiles.contains(testType: TestType): Boolean

Indicates if the given testType is used as profile name in this TestProfiles collection or not.

create

fun ComponentFactoryContainer.Companion.create(components: Map<KClass<*>, ComponentFactory>, chainedComponents: Map<KClass<*>, Sequence<ComponentFactory>> = emptyMap()): ComponentFactoryContainer

Creates a ComponentFactoryContainer based on the given components and chainedComponents.

fun TestProfiles.Companion.create(profile: Pair<TestType, List<Pair<Env, TestConfig>>>, vararg otherProfiles: Pair<TestType, List<Pair<Env, TestConfig>>>): TestProfiles

Creates a TestProfiles based on the given profile and otherProfiles which use one of the predefined TestType as profile name and Env as env name.

createBasedOnConfig

fun ComponentFactoryContainer.Companion.createBasedOnConfig(config: VariistConfig): ComponentFactoryContainer

Creates a ComponentFactoryContainer based on the given config.

createVariistRandom

fun ComponentFactoryContainer.createVariistRandom(seedOffset: Int): Random

Creates a Random whose seed is based on the VariistConfig.seed of this ComponentFactoryContainer and the given seedOffset.

merge

fun ArgsRangeOptions.merge(other: ArgsRangeOptions): ArgsRangeOptions

Merges this ArgsRangeOptions with the given other where the properties of the other take precedence.

toBuilder

fun VariistConfig.toBuilder(): VariistConfigBuilder

toOffset

fun Seed.toOffset(): Int

Turns this seed into a positive Int so that it can be used as offset in an SemiOrderedArgsGenerator.