Add `Konsist` as a arch unit test library by alesrazym · Pull Request #20 · havlisimo/rocket-app

alesrazym · 2024-01-15T21:11:41Z

I have checked arch unit test libraries and implement sample with Konsist. If we go to use it, I can cover with more tests. If we have another library/solution, let's park now.

havlisimo · 2024-01-16T08:21:29Z

zatim jsme vzdy pouzivali https://www.archunit.org/ je to sice pro Javu, ale tim, ze se Kotlin stejne prelozi do Javovskeho bytekodu, tak jsme s tim nemeli problem. Nicmene ten Konsist take nevypada spatne vzhledem k tomu ze je to primo psany pro Kotlin. U ArchUnit obcas narazime na nejaky problem ze necemu z Kotlinu nerozumi a pak se to ruzne hackuje

alesrazym · 2024-01-16T14:23:26Z

Prosvistel jsem clanky https://proandroiddev.com/archunit-vs-konsist-why-did-we-need-another-linter-972c4ff2622d a https://medium.com/the-house-of-code/archunit-vs-konsist-in-android-kotlin-oriented-codebase-b72c6c698b0b. Ja bych ten Konsist urcite zkusil :) Ale rozhodnuti tohoto typu maji delat nejzkusenejsi clenove tymu ;)

Pokud do toho pujdem, prozkoumal bych vzorovou integraci https://github.com/LemonAppDev/konsist/tree/develop/samples/starter-projects/konsist-starter-kmp-gradle-kotlin-junit5 a https://github.com/LemonAppDev/konsist/tree/develop/samples/starter-projects/konsist-starter-kmp-gradle-kotlin-kotest a jeste bych zvazil, zda neprejit na JUnit5 (to ted netusim, jestli to ma nejake potencialni problemy)

…ArchUnit`.

…erEvaluate

…ther projects

…ure layer`

…les to match contents.

…endencies() extension.

…, rfc ModulesStructureTest

alesrazym · 2024-06-11T11:03:33Z

build-logic/convention/src/main/kotlin/config/Constants.kt

@@ -0,0 +1,5 @@
+package config
+
+const val NAMESPACE_ID = "cz.quanti.rocketapp"


sloucil jsem const do build-logic, at se definuji jen jednou. Btw, build-logic uz je asi naming convention v gradle 8.5 a 8.8 https://docs.gradle.org/current/userguide/intro_multi_project_builds.html

alesrazym · 2024-06-11T11:04:00Z

build-logic/convention/src/main/kotlin/plugins/AndroidAppConventionPlugin.kt

                apply(pluginId("kotlin-serialization"))
            }
            extensions.configure<ApplicationExtension> {
+                namespace = "$NAMESPACE_ID.$ANDROID_MODULE_ID"


rfc dle novych projektu

alesrazym · 2024-06-11T11:05:33Z

.../test/java/cz/quanti/rocketapp/android/lib/architecturetest/domain/ArchitectureLayersTest.kt

+class ArchitectureLayersTest {
+    @Test
+    fun `clean architecture layers have correct dependencies`() {
+        // TODO handle MainApplication.kt


jak resis main application, ktera zavisi na DI?

alesrazym · 2024-06-11T11:40:22Z

build-logic/convention/src/main/kotlin/plugins/KmpLibConventionPlugin.kt

            implementation(libs.library("test-coroutines"))
+
+            // Add SLF4J NOP to get rid of error message in ktor test.
+            implementation(libs.library("slf4j-nop"))


pridal jsem NOP logger, koukni, jestli neznas

alesrazym · 2024-06-11T11:41:46Z

android/lib/architecture-test/build.gradle.kts

+}
+
+android {
+    buildFeatures.buildConfig = true


pres buildConfig predam hodnoty z build-logic

alesrazym · 2024-06-11T11:42:14Z

.../test/java/cz/quanti/rocketapp/android/lib/architecturetest/domain/ArchitectureLayersTest.kt

+            .apply {
+                assertArchitecture {
+                    ArchitectureLayer.entries.forEach { layer ->
+                        if (isLayerEmpty(layer)) {


trochu jsem to tu refaktoroval, koukni, jestli to dava smysl

alesrazym · 2024-06-11T11:42:45Z

...st/src/test/java/cz/quanti/rocketapp/android/lib/architecturetest/model/ArchitectureLayer.kt

+import com.lemonappdev.konsist.api.architecture.Layer
+
+enum class ArchitectureLayer(val layerName: String) {
+    /**


pridal jsem commenty viz wiki

alesrazym · 2024-06-11T11:43:40Z

...st/src/test/java/cz/quanti/rocketapp/android/lib/architecturetest/model/ArchitectureLayer.kt

+    return Layer(name, "${PackagePatterns.ROOT_PACKAGE}..$layerName..")
+}
+
+fun ArchitectureLayer.dependencies(): List<ArchitectureLayer> = when (this) {


udelal jsem extension na dependencies, prijde mi to citelnejsi nez primo v testu. Nelze dat dependecy primo do enum, protoze je to cyklicka zavislost..

alesrazym · 2024-06-11T11:44:29Z

...c/test/java/cz/quanti/rocketapp/android/lib/architecturetest/model/ArchitectureTestsScope.kt

+fun Konsist.appScope(): KoScope = scopeFromModules(modulesInScope)
+
+fun Konsist.allScope(): KoScope = scopeFromProject()
+    .minus(Konsist.scopeFromModule("build-logic.*"))


mozna tohle jeste extrahovat

alesrazym · 2024-06-11T11:44:44Z

...est/src/test/java/cz/quanti/rocketapp/android/lib/architecturetest/domain/DomainLayerTest.kt

+        }
+    }
+
+    // TODO add tests for Repositories and domain models (Azure task number: 89759)


co vsechno za testy chceme pridat?

alesrazym · 2024-06-11T11:45:44Z

...itecture-test/src/test/java/cz/quanti/rocketapp/android/lib/architecturetest/model/Module.kt

+
+import com.lemonappdev.konsist.api.architecture.Layer
+
+enum class Module(val moduleType: ModuleType, val platform: Platform) {


dal jsem dohromady modul a platform, at je to citelnejsi. Plus doc z wiki a dependency jako u layers

alesrazym · 2024-06-11T11:46:13Z

...test/src/test/java/cz/quanti/rocketapp/android/lib/architecturetest/model/PackagePatterns.kt

+import cz.quanti.rocketapp.android.architecturetest.BuildConfig
+
+object PackagePatterns {
+    const val ROOT_PACKAGE = BuildConfig.ROOT_PACKAGE


tady to z build configu taham

alesrazym · 2024-06-11T11:46:28Z

...ecture-test/src/test/java/cz/quanti/rocketapp/android/lib/architecturetest/model/Platform.kt

+import cz.quanti.rocketapp.android.architecturetest.BuildConfig
+
+enum class Platform(val platformName: String) {
+    Android(BuildConfig.ANDROID_ID),


a tady taky

alesrazym · 2024-06-11T11:47:57Z

...ystem/src/main/java/cz/quanti/rocketapp/android/lib/uisystem/system/ShowMessageInSnackBar.kt

+ * so the caller is responsible for checking there is a message to show.
+ */
+@Composable
+fun UiScreenState.Data<*>.ShowMessageInSnackBar() {


nevim, jestli je to idealni deleni, donutila me k tomu architektura - pouzivam zde localSnackbar ze system, a presentetion UiScreenState nemuze zaviset na system..

alesrazym · 2024-06-21T10:58:05Z

...c/test/java/cz/quanti/rocketapp/android/lib/architecturetest/model/ArchitectureTestsScope.kt

+    "${PackagePatterns.ANDROID_ID}.*",
+)
+
+fun Konsist.appScope(): KoScope = scopeFromModules(modulesInScope)


appScope predpoklada, ze neni zadny jinak pojmenovany modul

alesrazym · 2024-06-21T10:59:46Z

...st/src/test/java/cz/quanti/rocketapp/android/lib/architecturetest/model/KonsistExtensions.kt

+    val arg = dependencies.first()
+    val args = dependencies.drop(1)
+        .toTypedArray()
+    thisLayer.dependsOn(arg, *args)


tohle je trochu divne, ze knihovna ma fci s parametry (X, vararg X ) nebo neco takoveho

alesrazym · 2024-06-21T11:17:38Z

...st/src/test/java/cz/quanti/rocketapp/android/lib/architecturetest/model/KonsistExtensions.kt

+
+private fun String.toModuleNameInPackage(): String {
+    return this
+        .replace('\\', '/')


win stroje potrebuji zmenit lomitka

…, and printing files under test.

alesrazym requested a review from havlisimo January 15, 2024 21:11

alesrazym self-assigned this Jan 15, 2024

alesrazym force-pushed the feature/kmm_shared_modules branch 2 times, most recently from 1815086 to 165b503 Compare January 19, 2024 08:16

alesrazym force-pushed the feature/kmm_konsist branch from 8919ef5 to 608b229 Compare January 19, 2024 08:33

alesrazym changed the base branch from feature/kmm_shared_modules to feature/kmm_rebased January 22, 2024 07:22

alesrazym force-pushed the feature/kmm_rebased branch from 165b503 to 3f26286 Compare June 5, 2024 09:11

FEAT: Add Konsist for Architecture unit test as an alternative to `…

8c0e947

…ArchUnit`.

alesrazym deleted the branch develop June 5, 2024 09:14

alesrazym closed this Jun 5, 2024

alesrazym reopened this Jun 5, 2024

alesrazym changed the base branch from feature/kmm_rebased to develop June 5, 2024 09:17

alesrazym force-pushed the feature/kmm_konsist branch from 608b229 to 8c0e947 Compare June 5, 2024 09:18

Aleš Razým added 3 commits June 5, 2024 12:11

FIX: Add testClasses tasks to KmpLibConventionPlugin instead of aft…

135143a

…erEvaluate

LIB: Update AGP to 8.2.2, detekt 1.23.6

7fb1fcb

FIX: Update Konsist UseCase Test

cf5abb4

alesrazym force-pushed the feature/kmm_konsist branch from a71b0fc to cf5abb4 Compare June 5, 2024 10:25

Aleš Razým added 11 commits June 5, 2024 14:17

REF: Create separate module for architecture-test

688ac63

LIB: Update konsist to 0.15.1

f13868d

FIX: Move namespace to convention plugins, add some extensions from o…

f638c8f

…ther projects

FEAT: Add architecture (package) test

587877c

FIX: Fix architecture (package) test `all files are in some architect…

50f2aa1

…ure layer`

FIX: Fix architecture - rename ui module to ui-system, rename some fi…

b063cc3

…les to match contents.

REF: Refactor architecture test dependencies to ArchitectureLayer.dep…

54d1650

…endencies() extension.

REF: Add modules test and move all files to valid layer

cfb0d2f

REF: Change layers so that they are as per wiki

26cbf66

REF: Change layers so that they are as per wiki

e796804

REF: Add Module class, fix architecture layers, add module extensions…

430a907

…, rfc ModulesStructureTest

Aleš Razým added 2 commits June 11, 2024 12:56

REF: Add/rfc UseCase Test

ddd20a5

Dont warn StaticLoggerBinder

23cb0d4

alesrazym force-pushed the feature/kmm_konsist branch from 53cbc18 to 23cb0d4 Compare June 11, 2024 10:56

alesrazym commented Jun 11, 2024

View reviewed changes

Aleš Razým added 3 commits June 11, 2024 13:27

Fix architecture layers

c00b68c

Ref architecture test to be more readable

cdf820c

Add slf4j-nop

df10937

alesrazym commented Jun 11, 2024

View reviewed changes

Detekt autocorrect

615a2ee

alesrazym commented Jun 21, 2024

View reviewed changes

Aleš Razým added 4 commits June 21, 2024 16:39

Do not test dependencies of MainApplication

457de8d

Add Repository test

cb2df66

Fix repository test result

54e60c4

Possible change from assertTrue that does not handle clue to shouldBe…

4c5fb4e

…, and printing files under test.

		@@ -0,0 +1,5 @@
		package config

		const val NAMESPACE_ID = "cz.quanti.rocketapp"


		import com.lemonappdev.konsist.api.architecture.Layer

		enum class Module(val moduleType: ModuleType, val platform: Platform) {

Conversation

alesrazym commented Jan 15, 2024

Uh oh!

havlisimo commented Jan 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alesrazym commented Jan 16, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

havlisimo commented Jan 16, 2024 •

edited

Loading