> For the complete documentation index, see [llms.txt](https://docs.konsist.lemonappdev.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.konsist.lemonappdev.com/samples/starter-test-snippets/general-test-snippets.md). # General Test Snippets ## 1. Files In `ext` Package Must Have Name Ending With `Ext` ```kotlin @Test fun `files in 'ext' package must have name ending with 'Ext'`() { Konsist .scopeFromProject() .files .withPackage("..ext..") .assertTrue { it.hasNameEndingWith("Ext") } } ``` ## 2. All Data Class Properties Are Defined In Constructor ```kotlin @Test fun `all data class properties are defined in constructor`() { Konsist .scopeFromProject() .classes() .withModifier(KoModifier.DATA) .properties() .assertTrue { it.isConstructorDefined } } ``` ## 3. Every Class Has Test ```kotlin @Test fun `every class has test`() { Konsist .scopeFromProduction() .classes() .assertTrue { it.hasTestClasses() } } ``` ## 4. Every Class - Except Data And Value Class - Has Test ```kotlin @Test fun `every class - except data and value class - has test`() { Konsist .scopeFromProduction() .classes() .withoutModifier(KoModifier.DATA, KoModifier.VALUE) .assertTrue { it.hasTestClasses() } } ``` ## 5. Properties Are Declared Before Functions ```kotlin @Test fun `properties are declared before functions`() { Konsist .scopeFromProject() .classes() .assertTrue { val lastKoPropertyDeclarationIndex = it .declarations(includeNested = false, includeLocal = false) .indexOfLastInstance() val firstKoFunctionDeclarationIndex = it .declarations(includeNested = false, includeLocal = false) .indexOfFirstInstance() if (lastKoPropertyDeclarationIndex != -1 && firstKoFunctionDeclarationIndex != -1) { lastKoPropertyDeclarationIndex < firstKoFunctionDeclarationIndex } else { true } } } ``` ## 6. Every Constructor Parameter Has Name Derived From Parameter Type ```kotlin @Test fun `every constructor parameter has name derived from parameter type`() { Konsist .scopeFromProject() .classes() .constructors .parameters .assertTrue { val nameTitleCase = it.name.replaceFirstChar { char -> char.titlecase(Locale.getDefault()) } nameTitleCase == it.type.sourceType } } ``` ## 7. Every Class Constructor Has Alphabetically Ordered Parameters ```kotlin @Test fun `every class constructor has alphabetically ordered parameters`() { Konsist .scopeFromProject() .classes() .constructors .assertTrue { it.parameters.isSortedByName() } } ``` ## 8. Enums Have Alphabetically Ordered Constants ```kotlin @Test fun `enums have alphabetically ordered constants`() { Konsist .scopeFromProduction() .classes() .withAllModifiers(KoModifier.ENUM) .assertTrue { it.enumConstants.isSortedByName() } } ``` ## 9. Companion Object Is Last Declaration In The Class ```kotlin @Test fun `companion object is last declaration in the class`() { Konsist .scopeFromProject() .classes() .assertTrue { val companionObject = it.objects(includeNested = false).lastOrNull { obj -> obj.hasModifier(KoModifier.COMPANION) } if (companionObject != null) { it.declarations(includeNested = false, includeLocal = false).last() == companionObject } else { true } } } ``` ## 10. Every Value Class Has Parameter Named `value` ```kotlin @Test fun `every value class has parameter named 'value'`() { Konsist .scopeFromProject() .classes() .withValueModifier() .primaryConstructors .assertTrue { it.hasParameterWithName("value") } } ``` ## 11. No Empty Files Allowed ```kotlin @Test fun `no empty files allowed`() { Konsist .scopeFromProject() .files .assertFalse { it.text.isEmpty() } } ``` ## 12. No Field Should Have `m` Prefix ```kotlin @Test fun `no field should have 'm' prefix`() { Konsist .scopeFromProject() .classes() .properties() .assertFalse { val secondCharacterIsUppercase = it.name.getOrNull(1)?.isUpperCase() ?: false it.name.startsWith('m') && secondCharacterIsUppercase } } ``` ## 13. No Class Should Use Field Injection ```kotlin @Test fun `no class should use field injection`() { Konsist .scopeFromProject() .classes() .properties() .assertFalse { it.hasAnnotationOf() } } ``` ## 14. No Class Should Use Java Util Logging ```kotlin @Test fun `no class should use Java util logging`() { Konsist .scopeFromProject() .files .assertFalse { it.hasImport { import -> import.hasNameStartingWith("java.util.logging") } } } ``` ## 15. Package Name Must Match File Path ```kotlin @Test fun `package name must match file path`() { Konsist .scopeFromProject() .packages .assertTrue { it.hasMatchingPath } } ``` ## 16. No Wildcard Imports Allowed ```kotlin @Test fun `no wildcard imports allowed`() { Konsist .scopeFromProject() .imports .assertFalse { it.isWildcard } } ``` ## 17. Forbid The Usage Of `forbiddenString` In File ```kotlin @Test fun `forbid the usage of 'forbiddenString' in file`() { Konsist .scopeFromProject() .files .assertFalse { it.hasTextContaining("forbiddenString") } } ``` ## 18. All Function Parameters Are Interfaces ```kotlin @Test fun `all function parameters are interfaces`() { Konsist .scopeFromProject() .functions() .parameters .types .assertTrue { it.sourceDeclaration?.isInterface } } ``` ## 19. All Parent Interfaces Are Public ```kotlin @Test fun `all parent interfaces are public`() { Konsist .scopeFromProject() .classes() .parentInterfaces() .sourceDeclarations() .interfaceDeclarations() .assertTrue { it.hasPublicModifier } } ``` ## 20. Return Types Of All Functions Are Immutable ```kotlin @Test fun `return types of all functions are immutable`() { Konsist .scopeFromProject() .functions() .returnTypes .assertFalse { it.isMutableType } } ``` ## 21. Every Repository Function Has Logger Context Parameter ```kotlin @Test fun `every repository function has Logger context parameter`() { Konsist .scopeFromProject() .interfaces() .withNameEndingWith("Repository") .functions() .assertTrue { it.hasContextParameter { parameter -> parameter.hasType { type -> type.name == "Logger" } } } } ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.konsist.lemonappdev.com/samples/starter-test-snippets/general-test-snippets.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.