Packages

final case class TestConfig(pluginConfig: PluginConfig, bootstrapPluginConfig: PluginConfig = PluginConfig.empty, activation: distage.Activation = StandardAxis.testProdActivation, moduleOverrides: distage.Module = Module.empty, bootstrapOverrides: distage.BootstrapModule = BootstrapModule.empty, memoizationRoots: Set[_ <: distage.DIKey] = Set.empty, forcedRoots: Set[_ <: distage.DIKey] = Set.empty, parallelEnvs: ParallelLevel = ParallelLevel.Unlimited, parallelSuites: ParallelLevel = ParallelLevel.Unlimited, parallelTests: ParallelLevel = ParallelLevel.Unlimited, configBaseName: String, configOverrides: Option[distage.config.AppConfig] = None, planningOptions: PlanningOptions = PlanningOptions(), logLevel: Level = Log.Level.Info, debugOutput: Boolean = false) extends Product with Serializable

General options:

pluginConfig

Source of module definitions from which to build object graphs for each test. Changes to PluginConfig that alter implementations of components in memoizationRoots OR their dependencies will cause the test to execute in a new memoization environment, check the initial log output in tests for information about the memoization environments in your tests. Components specified in memoizationRoots will be memoized only for the tests in the same memoization environment.

bootstrapPluginConfig

Same as pluginConfig, but for BootstrapModule. Every distinct bootstrapPluginConfig will create a distinct memoization environment.

activation

Chosen activation axes. Changes in Activation that alter implementations of components in memoizationRoots OR their dependencies will cause the test to execute in a new memoization environment, check the initial log output in tests for information about the memoization environments in your tests.

moduleOverrides

Override loaded plugins with a given Module. As long as overriden bindings are not memoized, or dependencies of memoized components, using overrides will NOT create a new memoization environment. Changes to moduleOverrides that alter implementations of components in memoizationRoots OR their dependencies will cause the test to execute in a new memoization environment, check the initial log output in tests for information about the memoization environments in your tests.

bootstrapOverrides

Same as moduleOverrides, but for BootstrapModule Every distinct bootstrapPluginConfig will create a distinct memoization environment. Parallelism options:

memoizationRoots

Specifies the components that will be created *once* and shared across all tests within the same memoization environment (i.e. with the same TestConfig) Every distinct set of memoizationRoots will create a distinct memoization environment

forcedRoots

Specifies components that will be treated as if they are a dependency of every test within this memoization environment. Components designated as forced roots will not be garbage collected even if there are no components or tests that depend on them. When combined with memoizationRoots, a distage.DIResource binding can be used to implement a global start/stop action (beforeAll/afterAll) for all tests within this memoization environment. Changes to forcedRoots that alter implementations of components in memoizationRoots OR their dependencies will cause the test to execute in a new memoization environment, check the initial log output in tests for information about the memoization environments in your tests.

parallelEnvs

ParallelLevel of distinct memoization environments run, default: ParallelLevel.Unlimited. Sequential envs will run in sequence after the parallel ones.

parallelSuites

ParallelLevel of test suites run, default: ParallelLevel.Unlimited. Sequential suites will run in sequence after the parallel ones.

parallelTests

ParallelLevel of test cases run, default: ParallelLevel.Unlimited. Sequential tests will run in sequence after the parallel ones. Other options, Tests with different other options will run in distinct memoization environments:

configBaseName

Search for config in HOCON resource files with names $configBaseName.conf, $configBaseName-reference.conf, $configBaseName-reference-dev.conf (see izumi.distage.framework.services.ConfigLoader

configOverrides

Overriding definitions on top of main loaded config, default None

planningOptions

PlanningOptions, debug options for distage.Planner

logLevel

Log level for the logstage.IzLogger used in testkit and provided to the tests (will be overriden by plugin / module bindings if exist)

debugOutput

Print testkit debug messages, including those helping diagnose memoization environment issues, default: false, also controlled by DebugProperties.`izumi.distage.testkit.debug` system property

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TestConfig
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new TestConfig(pluginConfig: PluginConfig, bootstrapPluginConfig: PluginConfig = PluginConfig.empty, activation: distage.Activation = StandardAxis.testProdActivation, moduleOverrides: distage.Module = Module.empty, bootstrapOverrides: distage.BootstrapModule = BootstrapModule.empty, memoizationRoots: Set[_ <: distage.DIKey] = Set.empty, forcedRoots: Set[_ <: distage.DIKey] = Set.empty, parallelEnvs: ParallelLevel = ParallelLevel.Unlimited, parallelSuites: ParallelLevel = ParallelLevel.Unlimited, parallelTests: ParallelLevel = ParallelLevel.Unlimited, configBaseName: String, configOverrides: Option[distage.config.AppConfig] = None, planningOptions: PlanningOptions = PlanningOptions(), logLevel: Level = Log.Level.Info, debugOutput: Boolean = false)

    pluginConfig

    Source of module definitions from which to build object graphs for each test. Changes to PluginConfig that alter implementations of components in memoizationRoots OR their dependencies will cause the test to execute in a new memoization environment, check the initial log output in tests for information about the memoization environments in your tests. Components specified in memoizationRoots will be memoized only for the tests in the same memoization environment.

    bootstrapPluginConfig

    Same as pluginConfig, but for BootstrapModule. Every distinct bootstrapPluginConfig will create a distinct memoization environment.

    activation

    Chosen activation axes. Changes in Activation that alter implementations of components in memoizationRoots OR their dependencies will cause the test to execute in a new memoization environment, check the initial log output in tests for information about the memoization environments in your tests.

    moduleOverrides

    Override loaded plugins with a given Module. As long as overriden bindings are not memoized, or dependencies of memoized components, using overrides will NOT create a new memoization environment. Changes to moduleOverrides that alter implementations of components in memoizationRoots OR their dependencies will cause the test to execute in a new memoization environment, check the initial log output in tests for information about the memoization environments in your tests.

    bootstrapOverrides

    Same as moduleOverrides, but for BootstrapModule Every distinct bootstrapPluginConfig will create a distinct memoization environment. Parallelism options:

    memoizationRoots

    Specifies the components that will be created *once* and shared across all tests within the same memoization environment (i.e. with the same TestConfig) Every distinct set of memoizationRoots will create a distinct memoization environment

    forcedRoots

    Specifies components that will be treated as if they are a dependency of every test within this memoization environment. Components designated as forced roots will not be garbage collected even if there are no components or tests that depend on them. When combined with memoizationRoots, a distage.DIResource binding can be used to implement a global start/stop action (beforeAll/afterAll) for all tests within this memoization environment. Changes to forcedRoots that alter implementations of components in memoizationRoots OR their dependencies will cause the test to execute in a new memoization environment, check the initial log output in tests for information about the memoization environments in your tests.

    parallelEnvs

    ParallelLevel of distinct memoization environments run, default: ParallelLevel.Unlimited. Sequential envs will run in sequence after the parallel ones.

    parallelSuites

    ParallelLevel of test suites run, default: ParallelLevel.Unlimited. Sequential suites will run in sequence after the parallel ones.

    parallelTests

    ParallelLevel of test cases run, default: ParallelLevel.Unlimited. Sequential tests will run in sequence after the parallel ones. Other options, Tests with different other options will run in distinct memoization environments:

    configBaseName

    Search for config in HOCON resource files with names $configBaseName.conf, $configBaseName-reference.conf, $configBaseName-reference-dev.conf (see izumi.distage.framework.services.ConfigLoader

    configOverrides

    Overriding definitions on top of main loaded config, default None

    planningOptions

    PlanningOptions, debug options for distage.Planner

    logLevel

    Log level for the logstage.IzLogger used in testkit and provided to the tests (will be overriden by plugin / module bindings if exist)

    debugOutput

    Print testkit debug messages, including those helping diagnose memoization environment issues, default: false, also controlled by DebugProperties.`izumi.distage.testkit.debug` system property

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val activation: distage.Activation
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. val bootstrapOverrides: distage.BootstrapModule
  7. val bootstrapPluginConfig: PluginConfig
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  9. val configBaseName: String
  10. val configOverrides: Option[distage.config.AppConfig]
  11. val debugOutput: Boolean
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. val forcedRoots: Set[_ <: distage.DIKey]
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. val logLevel: Level
  17. val memoizationRoots: Set[_ <: distage.DIKey]
  18. val moduleOverrides: distage.Module
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. val parallelEnvs: ParallelLevel
  23. val parallelSuites: ParallelLevel
  24. val parallelTests: ParallelLevel
  25. val planningOptions: PlanningOptions
  26. val pluginConfig: PluginConfig
  27. def productElementNames: Iterator[String]
    Definition Classes
    Product
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped