Package io.micronaut.starter.feature.test

Class KoTest

java.lang.Object

io.micronaut.starter.feature.test.KoTest

All Implemented Interfaces:

io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, Feature, TestFeature

@Requires(property="micronaut.starter.feature.kotest.enabled",
          value="true",
          defaultValue="true")
@Singleton
public class KoTest
extends Object
implements TestFeature

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ARTIFACT_ID_KOTEST_ASSERTIONS_CORE_JVM
protected static final String	ARTIFACT_ID_KOTEST_RUNNER_JUNIT_5_JVM
protected static final String	ARTIFACT_ID_MICRONAUT_KOTEST5
protected static final Dependency	DEPENDENCY_MICRONAUT_TEST_KOTEST

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
KoTest()

Method Summary

Modifier and Type	Method	Description
void	apply(GeneratorContext generatorContext)	If this method is called for a given feature that means the feature was explicitly selected, included by default as a result of DefaultFeature.shouldApply(io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature).
String	getFrameworkDocumentation(GeneratorContext generatorContext)
@NonNull String	getName()	The name of the feature.
TestFramework	getTestFramework()
String	getThirdPartyDocumentation(GeneratorContext generatorContext)
String	getTitle()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.micronaut.core.naming.Described

getDescription

Methods inherited from interface io.micronaut.projectgen.core.feature.Feature

getCategory, getDescription, isCommunity, isPreview, processSelectedFeatures, supports

Methods inherited from interface io.micronaut.projectgen.core.feature.TestFeature

getOrder, isJunit, isKoTest, isKotlinTestFramework, isSpock, isVisible

Field Details

ARTIFACT_ID_MICRONAUT_KOTEST5

protected static final String ARTIFACT_ID_MICRONAUT_KOTEST5

See Also:

• Constant Field Values

DEPENDENCY_MICRONAUT_TEST_KOTEST

protected static final Dependency DEPENDENCY_MICRONAUT_TEST_KOTEST

ARTIFACT_ID_KOTEST_RUNNER_JUNIT_5_JVM

protected static final String ARTIFACT_ID_KOTEST_RUNNER_JUNIT_5_JVM

See Also:

• Constant Field Values

ARTIFACT_ID_KOTEST_ASSERTIONS_CORE_JVM

protected static final String ARTIFACT_ID_KOTEST_ASSERTIONS_CORE_JVM

See Also:

• Constant Field Values

Constructor Details

KoTest

public KoTest()

Method Details

getName

@NonNull
public @NonNull String getName()

Description copied from interface: Feature

The name of the feature. It must be unique.

Specified by:

getName in interface Feature

Specified by:

getName in interface io.micronaut.core.naming.Named

Returns:

the name of the feature

apply

public void apply(GeneratorContext generatorContext)

Description copied from interface: Feature

If this method is called for a given feature that means the feature was explicitly selected, included by default as a result of DefaultFeature.shouldApply(io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature). At this point the feature list is set and cannot change. This method can be implemented to modify the generated project. The feature can add templates by executing GeneratorContext.addTemplate(String, io.micronaut.starter.template.Template), modify configuration by modifying GeneratorContext.getConfiguration() or GeneratorContext.getBootstrapConfiguration(), or modify build properties through GeneratorContext.getBuildProperties().

Specified by:

apply in interface Feature

Parameters:

generatorContext - THe generator context

getTestFramework

public TestFramework getTestFramework()

Specified by:

getTestFramework in interface TestFeature

getTitle

public String getTitle()

Specified by:

getTitle in interface Feature

Returns:

The title of the feature

getFrameworkDocumentation

public String getFrameworkDocumentation(GeneratorContext generatorContext)

Specified by:

getFrameworkDocumentation in interface Feature

Parameters:

generatorContext - Generator Context

Returns:

Returns a link to Framework documentation about the feature. eg. https://micronaut-projects.github.io/micronaut-cache/latest/guide/index.html#hazelcast

getThirdPartyDocumentation

public String getThirdPartyDocumentation(GeneratorContext generatorContext)

Specified by:

getThirdPartyDocumentation in interface Feature

Parameters:

generatorContext - Generator Context

Returns:

Returns a link to third party. E.g. https://hazelcast.org