Android application - Revision history

Uwe at 17:46, 21 May 2026

2026-05-21T17:46:36Z

← Older revision		Revision as of 19:46, 21 May 2026
Line 162:		Line 162:

	Add compose screenshot testing for new composable		Add compose screenshot testing for new composable

			== Build ==
			Sync gradle and build in Android Studio.
			Run <code>./gradlew :shared:assemble</code> to assemble the shared KMP module.

	== Test strategy ==		== Test strategy ==

Uwe at 20:06, 20 May 2026

2026-05-20T20:06:32Z

← Older revision		Revision as of 22:06, 20 May 2026
Line 2:		Line 2:
	== Requirements ==		== Requirements ==
	== Architecture ==		== Architecture ==
	The app is written completely in Kotlin using Jetpack Compose~~, Dagger~~/~~Hilt and~~ aiming to implement a clean architecture.		The app is written completely in Kotlin
			* using Jetpack Compose
			* using [https://github.com/evant/kotlin-inject Kotlin-inject] for dependency injection
			* using [https://ktor.io Ktor] for server communication
			* aiming to implement clean architecture

	=== Module structure ===		=== Module structure ===
	Besides the main app module, the app consists of the following library modules:		Besides the main app module, the app consists of the following library modules:
Line 11:		Line 16:
	* heating		* heating
	* info		* info
	* ~~overview~~		* summary
	* refill		* refill
	* schedule		* schedule
Line 27:		Line 32:
	* <code>WebApiParams</code>, <code>WebApiPostRequest</code>, <code>WebApiPostRequestExecution</code>, <code>WebApiUrls</code>: Classes and objects used for communication from the app to the server.		* <code>WebApiParams</code>, <code>WebApiPostRequest</code>, <code>WebApiPostRequestExecution</code>, <code>WebApiUrls</code>: Classes and objects used for communication from the app to the server.
	* <code>ControllerProfileDao</code>, <code>ControllerProfileDatabase</code>: Classes which provide Room database functionality.		* <code>ControllerProfileDao</code>, <code>ControllerProfileDatabase</code>: Classes which provide Room database functionality.
	* Various classes used for dependency injection ~~(Hilt)~~		* Various classes used for dependency injection
	* <code>SetValsSanityCheckResult</code>: Class used for to communicate status of set values for <code>heating</code> and <code>ventilation</code> module.		* <code>SetValsSanityCheckResult</code>: Class used for to communicate status of set values for <code>heating</code> and <code>ventilation</code> module.
	* <code>ControllerProfile</code>: Class containing the profile data of the server (address, port, credentials, ...)		* <code>ControllerProfile</code>: Class containing the profile data of the server (address, port, credentials, ...)

Uwe: /* Test strategy */

2026-05-20T12:19:14Z

Test strategy

← Older revision		Revision as of 14:19, 20 May 2026
Line 160:		Line 160:
	== Test strategy ==		== Test strategy ==
	The app uses different testing approaches:		The app uses different testing approaches:
			* Linting
			* Unit tests
	* Compose preview screenshot testing		* Compose preview screenshot testing
	* Screenshot tests running as instrumented tests on emulator		* Screenshot tests running as instrumented tests on emulator
	* Unit tests
			=== Linting ===
			Run <code>./gradlew lint</code>: This command shall yield no warnings.
			Use the Android Studio code inspection for more detailed linting - some of the warnings cannot be resolved.

	=== Compose preview screenshot tests ===		=== Compose preview screenshot tests ===

Uwe: /* Unit tests */

2026-04-26T06:47:16Z

Unit tests

← Older revision		Revision as of 08:47, 26 April 2026
Line 216:		Line 216:

	The gradle task removes the injected code from the test coverage report: <code>./gradlew jacocoTestReport</code>		The gradle task removes the injected code from the test coverage report: <code>./gradlew jacocoTestReport</code>

			The report is stored in <code>[module]/build/reports/jacoco/jacocoTestReport/html</code>

	== Release procedure ==		== Release procedure ==

Uwe: /* Unit tests */

2026-04-26T06:44:03Z

Unit tests

← Older revision		Revision as of 08:44, 26 April 2026
Line 203:		Line 203:

	=== Unit tests ===		=== Unit tests ===
	As of April 2026, unit tests are ~~being~~ developed for:		As of April 2026, unit tests are developed for:
	* all view models ~~(finished)~~		* all view models
	* all repositories		* all repositories

Line 211:		Line 211:
	The unit test cases for the repositories use mock implementations of the <code>Retrofit</code> interface.		The unit test cases for the repositories use mock implementations of the <code>Retrofit</code> interface.

	All test cases are executed using the command: <code>./gradlew ~~test~~</code>		All unit test cases are executed using the command: <code>./gradlew :[module]:testDebugUnitTest</code>

	The code coverage report can be created using: <code>./gradlew createDebugUnitTestCoverageReport</code>		The code coverage report can be created using: <code>./gradlew createDebugUnitTestCoverageReport</code>

Uwe: /* Unit tests */

2026-04-25T08:45:29Z

Unit tests

@@ Line 203: / Line 203: @@
 === Unit tests ===
-As of November 2025, there are no unit tests.
+As of April 2026, unit tests are being developed for:
 == Release procedure ==

Uwe: /* Testing */

2026-04-18T13:44:12Z

Testing

← Older revision		Revision as of 15:44, 18 April 2026
Line 154:		Line 154:

	=== Testing ===		=== Testing ===
	Update existing screenshot testing		Update existing screenshot testing (compose screenshot testing and instrumented tests)

	Add screenshot testing for new composable		Add compose screenshot testing for new composable

	== Test strategy ==		== Test strategy ==

Uwe: /* Screen navigation */

2026-04-18T13:39:50Z

Screen navigation

← Older revision		Revision as of 15:39, 18 April 2026
Line 94:		Line 94:

	=== Screen navigation ===		=== Screen navigation ===
	The screen navigation is controlled by a <code>NavHostController</code> which is ~~instantiated~~ in <code>MainActivity</code>.		The screen navigation is controlled by a <code>NavHostController</code> which is created in <code>MainActivity</code> and remembered using <code>rememberNavController</code>.

			==== Modular navigation ====
	Each module adds its own navigation function to <code>NavHostController</code>.		Each module adds its own navigation function to <code>NavHostController</code>.
	These functions are stored in <code>[module]/presentation/navigation/[module]Navigator.kt</code>.		These extension functions are stored in <code>[module]/presentation/navigation/[module]Navigator.kt</code>.
			They encapsulate the routing logic for that specific module.

			==== Event-Driven Navigation ====
	The functions receive as parameter a specific sealed class <code>[module]NavigationEvent</code>.		The functions receive as parameter a specific sealed class <code>[module]NavigationEvent</code>.
	These sealed classes contain objects for each navigation event inside the module.		These sealed classes contain objects for each navigation event inside the module.

			==== Implementation pattern ====
	The navigation functions are used in the following locations:		The navigation functions are used in the following locations:
	* inside the lambda function passed to <code>NavHost</code> in <code>MainActivity</code> for each screen.		* inside the lambda function passed to <code>NavHost</code> in <code>MainActivity</code> for each screen.
	* inside composables themselves being passed as lambda function from within <code>MainActivity</code>		* inside composables themselves being passed as lambda function from within <code>MainActivity</code>
			:* The composable remain unaware of <code>NavHostController</code>

			==== Routes and arguments ====
	Source and destination of the routing is defined using strings from the object <code>ViewNavigationRoutes</code> where data that needs to be transferred between screens is embedded in the strings.		Source and destination of the routing is defined using strings from the object <code>ViewNavigationRoutes</code> where data that needs to be transferred between screens is embedded in the strings.

Uwe: /* Screen navigation */

2026-04-18T12:56:24Z

Screen navigation

← Older revision		Revision as of 14:56, 18 April 2026
Line 105:		Line 105:
	* inside the lambda function passed to <code>NavHost</code> in <code>MainActivity</code> for each screen.		* inside the lambda function passed to <code>NavHost</code> in <code>MainActivity</code> for each screen.
	* inside composables themselves being passed as lambda function from within <code>MainActivity</code>		* inside composables themselves being passed as lambda function from within <code>MainActivity</code>

			Source and destination of the routing is defined using strings from the object <code>ViewNavigationRoutes</code> where data that needs to be transferred between screens is embedded in the strings.

	== Example workflow for adding API communication ==		== Example workflow for adding API communication ==

Uwe: /* Implementation */

2026-04-18T12:29:54Z

Implementation

← Older revision		Revision as of 14:29, 18 April 2026
Line 137:		Line 137:
	* Added <code>PullToRefreshBox</code>		* Added <code>PullToRefreshBox</code>
	* Added parsing of <code>RefillUiState</code> and display of either		* Added parsing of <code>RefillUiState</code> and display of either
	:* <code>RefillStateComposable</code> in case of success		:* <code>RefillStateComposable</code> in case of success
	:* Text-based error message in case of error		:* Text-based error message in case of error
	:* <code>CircularProgressIndicator</code> in case of loading		:* <code>CircularProgressIndicator</code> in case of loading

	Inject <code>RefillUiState</code> into <code>RefillScreen</code> in the <code>MainActivity</code> and <code>RefillScreenTest</code> as well as in previews of <code>RefillScreen</code>		Inject <code>RefillUiState</code> into <code>RefillScreen</code> in the <code>MainActivity</code> and <code>RefillScreenTest</code> as well as in previews of <code>RefillScreen</code>