Android application - Revision history

Uwe: /* Layer structure */

2025-11-20T06:47:03Z

Layer structure

← Older revision		Revision as of 08:47, 20 November 2025
Line 40:		Line 40:
	The code is separated into the following layers:		The code is separated into the following layers:
	<code>		<code>

	[module]/		[module]/

Uwe at 17:09, 19 November 2025

2025-11-19T17:09:56Z

← Older revision		Revision as of 19:09, 19 November 2025
Line 138:		Line 138:

	== Release procedure ==		== Release procedure ==
	<code>		# Update <code>versionCode</code> and <code>versionName</code> in <code>build.gradle.kts</code> of <code>app</code> module.
			# Create a release branch (<code>release/[version]</code>), checkout, commit and push.
			# Change to release build variant.
			# Build
			# Generate a signed App bundle
			# Upload to play store

Uwe at 17:05, 19 November 2025

2025-11-19T17:05:38Z

← Older revision		Revision as of 19:05, 19 November 2025
Line 108:		Line 108:

	The tests are located in <code>[module]/src/screenshotTest/kotlin/com/aquariumcontrol/[module]/</code>.		The tests are located in <code>[module]/src/screenshotTest/kotlin/com/aquariumcontrol/[module]/</code>.

	The references are located in <code>[module]/src/screenshotTestDebug/kotlin/com/aquariumcontrol/[module]/</code>.		The references are located in <code>[module]/src/screenshotTestDebug/kotlin/com/aquariumcontrol/[module]/</code>.

			The test reports are located in <code>build/reports/screenshotTest/preview/debug/</code>. The test reports for the compose screenshot tests contain reference, actual and delta images.

	The images are generated with <code>./gradlew [module]:updateDebugScreenshotTest</code>.		The images are generated with <code>./gradlew [module]:updateDebugScreenshotTest</code>.

	The images are validated with <code>./gradlew [module]:validateDebugScreenshotTest</code>.		The images are validated with <code>./gradlew [module]:validateDebugScreenshotTest</code>.

			Omitting the module will execute all tests.

	=== Instrumented tests ===		=== Instrumented tests ===
			The tests run comparably long and are bound to an emulator device.
			As of November 2025, a Pixel 5 API S is used for the instrumented test.
			The instrumented tests only test the complete screens.

			Limitations:
			* <code>Info</code> screen is not tested due to <code>LibrariesContainer</code> (dynamic content which cannot be mocked and also does not allow execution of instrumented test).

			The test reports are located in <code>build/reports/androidTests/connected/debug/</code>. The test reports for the compose screenshot tests do not contain any images.

			The tests are executed with <code>./gradlew [module]:connectedDebugAndroidTest</code>.
			Omitting the module will execute all tests.

			A switch called <code>recordMode</code> inside each test class determines if the image is generated <code>(true)</code> or if the image is validated <code>(false)</code>. The images are generated on the device <code>(/data/data/com.laimburggasse.aquariumcontrol.[module].test/files/screenshots_output/)</code> and need to be downloaded to the repository.

	=== Unit tests ===		=== Unit tests ===

Uwe at 16:53, 19 November 2025

2025-11-19T16:53:22Z

@@ Line 93: / Line 93: @@
 == Test strategy ==
-=== Unit tests ===
+The app uses different testing approaches:
 === Compose preview screenshot tests ===
 === Instrumented tests ===
 == Release procedure ==
 <code>

Uwe: /* Layer structure */

2025-11-19T15:26:40Z

Layer structure

← Older revision		Revision as of 17:26, 19 November 2025
Line 39:		Line 39:
	=== Layer structure ===		=== Layer structure ===
	The code is separated into the following layers:		The code is separated into the following layers:
			<code>
	[module]/		[module]/

	├── src/main/kotlin/com/laimburggasse/aquariumcontrol/[module]/data/		├── src/main/kotlin/com/laimburggasse/aquariumcontrol/[module]/data/

	│ ├── remote/ // ~~Network/API service implementations (e.g., Retrofit)~~		│ ├── remote/ // Folder for data retrieval functionality

	│ │ └── dto/		│ │ └── dto/ // Folder for Data Transfer Objects

	│ │ └── ~~Dto~~.kt		│ │ └── [module][name]Import.kt

	│ │ └── ~~UserApiService~~.kt		│ │ └── [module][name]Reader.kt // Implementation of GET server request

	│ ├── ~~repository~~.kt		│ ├── [module][name]RepositoryImpl.kt // Repositories (implementation of interface)

	├── src/main/kotlin/com/laimburggasse/aquariumcontrol/[module]/domain/		├── src/main/kotlin/com/laimburggasse/aquariumcontrol/[module]/domain/

	│ ├── model/ // ~~Data Transfer Objects (DTOs)~~ for ~~network~~/~~database~~		│ ├── model/ // Folder for data definition classes

			│ │ └── [module][name].kt. // Classes for data definition

			│ ├── repository/ // Folder containing repository interface definitions

			│ │ └── [module][name]Repository.kt. // Interface defining the repository, used by view model

			├── src/main/kotlin/com/laimburggasse/aquariumcontrol/[module]/presentation/

			│ ├── entry/ // First screen of feature

			│ ├── [components]/ // Shared code between different screens

			│ ├── [screen name]/ // Folder for each screen

			│ │ └── [module][name]Screen.kt // Composable showing the complete screen

			│ │ └── [module][name]Composable.kt // Composable showing elements inside the screen

	│ │ └── ~~UserDto~~.kt		│ │ └── [module][name]UiEvent.kt // Sealed interface describing the communication from the composable to the view model

	│ ~~├── local/~~ // ~~Local persistence (e.g., Room DAOs, SharedPreferences)~~		│ │ └── [module][name]UiState.kt // Data class describing the content to be rendered by the composable

	│ │ └── ~~UserDao~~.kt		│ │ └── [module][name]ViewModel.kt // Class implementing the view model

	│ ├── ~~mapper~~/ // ~~Functions~~ to ~~map DTOs to Domain models and vice-versa~~		│ ├── navigation/ // Folder containing class and functionality related to screen navigation

	│ │ └── ~~UserMapper~~.kt		│ │ └── [module]NavigationEvent.kt // One sealed class per module containing the navigation intent of the user

	│ └── ~~repository~~/ /~~/ IMPLEMENTATIONS of the Domain repository interfaces~~		│ │ └── [module]Navigator.kt // Module-specific navigation functionality

	│ ~~└── UserRepositoryImpl.kt // Implements domain.repository.UserRepository~~		│
	└── build.gradle // ~~Dependencies for Room~~, ~~Retrofit~~, ~~etc.~~		└── build.gradle // Plugins, setting, dependencies
			</code>

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

Uwe: /* Layer structure */

2025-11-19T15:11:01Z

Layer structure

← Older revision		Revision as of 17:11, 19 November 2025
Line 39:		Line 39:
	=== Layer structure ===		=== Layer structure ===
	The code is separated into the following layers:		The code is separated into the following layers:
	~~<code>~~
	[module]/		[module]/

Line 72:		Line 72:
	│ └── UserRepositoryImpl.kt // Implements domain.repository.UserRepository		│ └── UserRepositoryImpl.kt // Implements domain.repository.UserRepository
	└── build.gradle // Dependencies for Room, Retrofit, etc.		└── build.gradle // Dependencies for Room, Retrofit, etc.
	~~</code>~~
	== Test strategy ==		== Test strategy ==
	=== Unit tests ===		=== Unit tests ===

Uwe at 15:10, 19 November 2025

2025-11-19T15:10:32Z

← Older revision		Revision as of 17:10, 19 November 2025
Line 41:		Line 41:
	<code>		<code>
	[module]/		[module]/

	├── src/main/kotlin/com/laimburggasse/aquariumcontrol/[module]/data/		├── src/main/kotlin/com/laimburggasse/aquariumcontrol/[module]/data/

	│ ├── remote/ // Network/API service implementations (e.g., Retrofit)		│ ├── remote/ // Network/API service implementations (e.g., Retrofit)

	│ │ └── dto/		│ │ └── dto/

	│ │ └── Dto.kt		│ │ └── Dto.kt

	│ │ └── UserApiService.kt		│ │ └── UserApiService.kt

	│ ├── repository.kt		│ ├── repository.kt

	├── src/main/kotlin/com/laimburggasse/aquariumcontrol/[module]/domain/		├── src/main/kotlin/com/laimburggasse/aquariumcontrol/[module]/domain/

	│ ├── model/ // Data Transfer Objects (DTOs) for network/database		│ ├── model/ // Data Transfer Objects (DTOs) for network/database

	│ │ └── UserDto.kt		│ │ └── UserDto.kt

	│ ├── local/ // Local persistence (e.g., Room DAOs, SharedPreferences)		│ ├── local/ // Local persistence (e.g., Room DAOs, SharedPreferences)

	│ │ └── UserDao.kt		│ │ └── UserDao.kt

	│ ├── mapper/ // Functions to map DTOs to Domain models and vice-versa		│ ├── mapper/ // Functions to map DTOs to Domain models and vice-versa

	│ │ └── UserMapper.kt		│ │ └── UserMapper.kt

	│ └── repository/ // IMPLEMENTATIONS of the Domain repository interfaces		│ └── repository/ // IMPLEMENTATIONS of the Domain repository interfaces

	│ └── UserRepositoryImpl.kt // Implements domain.repository.UserRepository		│ └── UserRepositoryImpl.kt // Implements domain.repository.UserRepository
	└── build.gradle // Dependencies for Room, Retrofit, etc.		└── build.gradle // Dependencies for Room, Retrofit, etc.

Uwe at 15:09, 19 November 2025

2025-11-19T15:09:51Z

@@ Line 2: / Line 2: @@
 == Requirements ==
 == Architecture ==
-The app uses Jetpack Compose, Dagger/Hilt and aims to implement a clean architecture.
+The app is written completely in Kotlin using Jetpack Compose, Dagger/Hilt and aiming to implement a clean architecture.
 === Module structure ===
 Besides the main app module, the app consists of the following library modules:
@@ Line 38: / Line 38: @@
 === Layer structure ===
 == Test strategy ==
 === Unit tests ===

Uwe at 15:00, 19 November 2025

2025-11-19T15:00:29Z

Uwe at 14:57, 19 November 2025

2025-11-19T14:57:31Z

@@ Line 2: / Line 2: @@
 == Requirements ==
 == Architecture ==
 === Module structure ===
 === Layer structure ===
 == Test strategy ==

← Older revision		Revision as of 17:00, 19 November 2025
Line 17:		Line 17:
	* ventilation		* ventilation

	The main {{app}} module contains the AndroidManifest and the main activity (As of November 2025, the app only uses one activity).		The main <code>app</code> module contains the AndroidManifest and the main activity (As of November 2025, the app only uses one activity).
	The activity contains the navigation {{NavHost}} in {{onCreate}}.		The activity contains the navigation <code>NavHost</code> in <code>onCreate</code>.

	None of the other modules has a dependency to the main {{app}} module.		None of the other modules has a dependency to the main <code>app</code> module.

	The {{common}} module provides low-level functionalities and layout elements used in various places.		The <code>common</code> module provides low-level functionalities and layout elements used in various places.
	The following functionalities are located in {{common}} module:		The following functionalities are located in <code>common</code> module:
	* {{DataFetchResult}}: A wrapper class indicating the status of data fetching operation ({{Success}}, {{Error}}, {{Loading}}, {{Empty}}).		* <code>DataFetchResult</code>: A wrapper class indicating the status of data fetching operation (<code>Success</code>, <code>Error</code>, <code>Loading</code>, <code>Empty</code>).
	* {{WebApiParams}}, {{WebApiPostRequest}}, {{WebApiPostRequestExecution}}, {{WebApiUrls}}: 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.
	* {{ControllerProfileDao}}, {{ControllerProfileDatabase}}: 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 (Hilt)
	* {{SetValsSanityCheckResult}}: Class used for to communicate status of set values for {{heating}} and {{ventilation}} module.		* <code>SetValsSanityCheckResult</code>: Class used for to communicate status of set values for <code>heating</code> and <code>ventilation</code> module.
	* {{ControllerProfile}}: 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, ...)
	* {{GlobalConstants}}: Mainly UI-related strings (non-context-related) and some minor functional constants		* <code>GlobalConstants</code>: Mainly UI-related strings (non-context-related) and some minor functional constants
	* Composable functions for the main drop down menu		* Composable functions for the main drop down menu
	* Composable functions for the theme		* Composable functions for the theme
	* Composable functions for hyperlinks, text edit fields, headline		* Composable functions for hyperlinks, text edit fields, headline
	* {{ViewNavigationRoutes}}: Object containing the routing information processed in main {{app}} module		* <code>ViewNavigationRoutes</code>: Object containing the routing information processed in main <code>app</code> module
	* {{ScreenshotTestHelper}}: Helper class for executing the instrumented snapshot testing using the emulator.		* <code>ScreenshotTestHelper</code>: Helper class for executing the instrumented snapshot testing using the emulator.

	=== Layer structure ===		=== Layer structure ===
Line 43:		Line 43:
	=== Instrumented tests ===		=== Instrumented tests ===
	== Release procedure ==		== Release procedure ==
			<code>