The following example provides the minimum setup for defining and running a single Konsist test.

At a high-level Konsist check is a Unit test following multiple implicit steps.

3 steps are required for a declaration check and 4 steps are required for an architecture check:

Konsist Declaration Checks provide a powerful mechanism for validating the structural elements of the Kotlin codebase. These checks allow developers to enforce structural rules and coding conventions by verifying classes, interfaces, functions, properties, and other code declarations. Here few things that can be verified with Konsist:

• All Use cases should reside in usecase specific package

• Repository classes must implement Repository interface

• All repository classes should have name ending with Repository

• data classes should have only val properties

• Test classes should have test subject named sut

• ...

Write First Declaration Check

Let's write a simple test to verify that all classes (all class declarations) residing in resides in controller package are annotated with the RestController annotation .

Overview

On a high level writing Konsist declaration check requires 4 steps:

Let's take a closer look at each of these steps.

1. Create The Scope

The first step is to get a list of Kotlin files to be verified.

The Konsist object is an entry point to the Konsist library.

The scopeFromX methods obtains the instance of the scope containing Kotlin project files. To get all Kotlin project files present in the project use the scopeFromProject method:

2. Retrieve Declarations

Each file in the scope contains set of declarations like classes, properties functions etc. (see ). To write this declaration check for all classes present in the scope query classes using classes method :

3. Filter Declarations

In this project controllers are defined as classes annotated with RestController annotation. Use withAllAnnotationsOf method to filter classes with with RestController annotation:

4. Define Assertion

To performa assertion use the assertTrue method:

To verify that classes are located in the controller package, use the resideInPackage method inside assertTrue block:

This verification applies to the entire collection of previously filtered classes, rather than examining just one class in isolation.

Wrap Konsist Code In Test

The declaration validation logic should be protected through automated testing. By wrapping Konsist checks within standard testing frameworks such as or , you can verify these rules with each :

Note that test class has a KonsistTest suffix. This is the recommended approach to name classes containing Konsist tests.

Summary

This section described the basic way of writing Konsist declaration test. To get a better understanding of how Konsist API works see and sections.

The above test will execute multiple assertions per test (all controllers will be verified in a single test). If you prefer better isolation each assertion can be executed as a separate test. See the page.

Add Maven Central Repository

Add mavenCentral repository:

Add Konsist Dependency

Konsist's Architectural Checks serve as a robust tool for maintaining layer isolation, enabling development teams to enforce strict boundaries between different architectural layers. Here few things that can be verified with Konsist:

• domain layer is independant

• data layer depends on domain layer

• ...

Write First Architectural Check

Let's write a simple test to verify that application architecture rules are preserved. In this scenario, the application follows a simple 3-layer architecture, where Presentation and Data layers depend on Domain layer and Domain layer is independant (from these layers):

Overview

On a high level writing Konsist architectural check requires 3 steps:

Let's take a closer look at each of these steps.

1. Define Layers

Create layers instances to represent project layers. Each Layer instance accepts the name (used for presenting architecture violation errors) and package used to define layers.

2. Create The Scope

The Konsist object is an entry point to the Konsist library.

The scopeFromX methods obtains the instance of the scope containing Kotlin project files. To get all Kotlin project files present in the project use the scopeFromProject method:

3. Assert Architecture

To performa assertion use the assertArchiteture method:

Utilize dependsX methods to validate that your project's layers adhere to the defined architectural dependencies:

Wrap Konsist Code In Test

The declaration validation logic should be protected through automated testing. By wrapping Konsist checks within standard testing frameworks such as or , you can verify these rules with each :

Note that test class has a KonsistTest suffix. This is the recommended approach to name classes containing Konsist tests.

Summary

This section described the basic way of writing Konsist architectural test. To get a better understanding of how Konsist API works see .