README.md

Kensa

##Documentation

Kensa is an acceptance test tool which supports Java, Kotlin and JUnit5.

Kotlin and Java are both fully supported as of version 105.
On request, forking will be made available. ### Dependency: ``` dev.kensa kensa 105 ``` ``` implementation("dev.kensa:kensa:105") ```

Wiring Kensa into the application

Either add the following static initialiser to an existing application configuration class or create a standalone Kensa configuration class

For Java

class YourAppNameExtension implements org.junit.jupiter.api.extension.Extension {
static {
        Kensa.configure()
                .withAcronyms(
                        Acronym.of("SA", "some Acronym")
                )
                .withIssueTrackerUrl("https://cbsjira.bskyb.com/browse/")
                .withOutputStyle(MultiFile);
    }
}

For Kotlin

class YourAppNameExtension : org.junit.jupiter.api.extension.Extension {
    companion object {
        init {
            Kensa.konfigure {
                withAcronyms(
                        Acronym.of("SA", "some Acronym")
                )
                issueTrackerUrl = URL("https://my-issue-tracker.com/")
                outputStyle = MultiFile
            }
        }
    }
}

This is a basic example of the configuration required for a simple application.
Acronym - Configuring acronyms is completely optional. They underline preconfigured words, which show the full definition on hover over.
IssueTrackerUrl - This adds a query parameter to the issueTrackerUrl, using the parameter object of the @Issue({"myQueryParameter"}) annotation.
OutputStyle - This sets the format for how Kensa generates the test files.

ParameterizedTests are fully supported.

Implementing Kensa in Acceptance Tests

Annotate the test class with the @ExtendWith annotation

For Java:

@ExtendWith(KensaConfiguritionClassName.class)
class MyTest implements JavaKensaTest, WithHamcrest {}

For Kotlin:

@ExtendWith(KensaConfiguritionClassName::class)
class MyTest : KotlinKensaTest, WithAssertJ {}

JavaKensaTest and KotlinKensaTest provide givens builders and actions under test WithHamcrest and WithAssertJ provide state extractors

Test Annotations of Interest

@Issue replaces @Notes from Yatspec to link to issue tracker.
@Notes print comments, this works at method and class level.
@Highlight can be used on field declarations and highlight the field / field value in the test output.
@SentenceValue can be used on field declarations or parameter declarations and shows the field or variable value in the test output.
@Scenario enables you to replace the words of a method call with the return value of the method.
@NestedSentence collapses multiple assertions within a method and replaces them with a summary taken from the method name. On click the assertions made are visible.
@Emphasise emphasises text passages of interest. The annotation can be used for methods / functions or fields. Available text styles are textStyles, textColor and backgroundColor.

For Java:

@Emphasise(textStyles = {dev.kensa.TextStyle.TextWeightBold, dev.kensa.TextStyle.TextDecorationUnderline}, backgroundColor = dev.kensa.Colour.TextPrimaryDark)

For Kotlin:

@Emphasise(textStyles = [dev.kensa.TextStyle.TextWeightBold, dev.kensa.TextStyle.TextDecorationUnderline], backgroundColor = [dev.kensa.Colour.BackgroundWarningLight])

Specify 'Time Passing' for timeouts etc

interactions.captureTimePassing("Message")
interactions.divider("Message") is also available to give a double divider line in diagrams