{"id":869,"date":"2024-02-12T17:50:58","date_gmt":"2024-02-12T14:50:58","guid":{"rendered":"https:\/\/barisuslucan.com\/en\/?p=869"},"modified":"2024-02-12T18:50:19","modified_gmt":"2024-02-12T15:50:19","slug":"testing-of-composable-functions-in-daggerhilt-jetpack-compose-projects","status":"publish","type":"post","link":"https:\/\/barisuslucan.com\/en\/kotlin\/testing-of-composable-functions-in-daggerhilt-jetpack-compose-projects\/","title":{"rendered":"Testing of Composable Functions in DaggerHilt Jetpack Compose Projects"},"content":{"rendered":"

When utilizing Jetpack Compose alongside Dagger Hilt for dependency management, your application does not recognize your current app module in test cases. To address this issue and facilitate the testing of composable functions when leveraging Dagger Hilt, it becomes necessary to supply a dedicated test module.<\/p>\n

When discussing this topic, I intend to create abstract service and repository classes, along with defining the corresponding module.<\/p>\n

To begin, I assume that you already possess your repository, service, and module. Following this assumption, I proceed to create a delegated module. Be sure that you impelemented your dependencies:<\/p>\n\n\n

<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
    <\/span>implementation<\/span>(<\/span>"<\/span>com.google.dagger:hilt-android:2.48<\/span>"<\/span>)<\/span><\/span>\n    <\/span>implementation<\/span>(<\/span>"<\/span>androidx.hilt:hilt-navigation-compose:1.1.0<\/span>"<\/span>)<\/span><\/span>\n    <\/span>ksp<\/span>(<\/span>"<\/span>com.google.dagger:hilt-android-compiler:2.48<\/span>"<\/span>)<\/span><\/span>\n    <\/span>androidTestImplementation<\/span>(<\/span>"<\/span>com.google.dagger:hilt-android-testing:2.48<\/span>"<\/span>)<\/span><\/span>\n    <\/span>kspTest<\/span>(<\/span>"<\/span>com.google.dagger:hilt-android-compiler:2.48<\/span>"<\/span>)<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
interface<\/span> MyService <\/span>{<\/span><\/span>\n    <\/span>\/\/ Your Services<\/span><\/span>\n}<\/span><\/span>\n<\/span>\nclass<\/span> <\/span>MyRepository<\/span> @<\/span>Inject<\/span> <\/span>constructor<\/span>(<\/span>myService<\/span>: <\/span>MyService<\/span>) <\/span>{<\/span><\/span>\n    <\/span>\/\/ Your Repository<\/span><\/span>\n}<\/span><\/span>\n<\/span>\n@Module<\/span><\/span>\n@InstallIn<\/span>(<\/span>SingletonComponent<\/span>::<\/span>class<\/span>)<\/span><\/span>\nobject<\/span> <\/span>Module<\/span> <\/span>{<\/span><\/span>\n    <\/span>\/\/ Set your module here such as sharedPreferences, Room, Retrofit etc..<\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n

Let’s prepare our UI:\u00a0<\/p>\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
@AndroidEntryPoint<\/span><\/span>\nclass<\/span> <\/span>MainActivity<\/span> : <\/span>ComponentActivity<\/span>() <\/span>{<\/span><\/span>\n    <\/span>override<\/span> <\/span>fun<\/span> <\/span>onCreate<\/span>(<\/span>savedInstanceState<\/span>:<\/span> Bundle<\/span>?<\/span>)<\/span> <\/span>{<\/span><\/span>\n        <\/span>super<\/span>.<\/span>onCreate<\/span>(<\/span>savedInstanceState<\/span>)<\/span><\/span>\n        <\/span>setContent<\/span> <\/span>{<\/span><\/span>\n            <\/span>MyAppTheme<\/span> <\/span>{<\/span><\/span>\n                <\/span>MyNavigatipnGraph<\/span>(<\/span>rememberNavController<\/span>())<\/span><\/span>\n            <\/span>}<\/span><\/span>\n        <\/span>}<\/span><\/span>\n    <\/span>}<\/span><\/span>\n}<\/span><\/span>\n<\/span>\n@Composable<\/span><\/span>\nfun<\/span> <\/span>MyNavigationGraph<\/span>(<\/span><\/span>\n    <\/span>navHostController<\/span>: <\/span>NavHostController<\/span><\/span>\n) <\/span>{<\/span><\/span>\n    <\/span>NavHost<\/span>(<\/span><\/span>\n        <\/span>navController<\/span> <\/span>=<\/span> <\/span>navHostController<\/span>,<\/span><\/span>\n        <\/span>route<\/span> <\/span>=<\/span> <\/span>Graph<\/span>.<\/span>ROOT<\/span>,<\/span><\/span>\n        <\/span>startDestination<\/span> <\/span>=<\/span> <\/span>Screens<\/span>.<\/span>MyMainScreen<\/span>.<\/span>route<\/span><\/span>\n    ) <\/span>{<\/span><\/span>\n        <\/span>authNavGraph<\/span>(<\/span>navController<\/span> <\/span>=<\/span> <\/span>navHostController<\/span>)<\/span><\/span>\n        <\/span>composable<\/span>(<\/span>route<\/span> <\/span>=<\/span> <\/span>Screens<\/span>.<\/span>MyMainScreen<\/span>.<\/span>route<\/span>) <\/span>{<\/span><\/span>\n            <\/span>MyMainScreen<\/span>()<\/span><\/span>\n        <\/span>}<\/span><\/span>\n    <\/span>}<\/span><\/span>\n}<\/span><\/span>\n<\/span>\n@Composable<\/span><\/span>\nfun<\/span> <\/span>MyMainScreen<\/span>(<\/span><\/span>\n    <\/span>viewModel<\/span>: <\/span>MyMainScreenViewModel<\/span> <\/span>=<\/span> <\/span>hiltViewModel<\/span>()<\/span><\/span>\n) <\/span>{<\/span><\/span>\n    <\/span>val<\/span> <\/span>result<\/span> <\/span>by<\/span> <\/span>viewModel<\/span>.<\/span>resultState<\/span>.<\/span>collectAsState<\/span>()<\/span><\/span>\n    <\/span>Text<\/span>(<\/span><\/span>\n        <\/span>text<\/span> <\/span>=<\/span> <\/span>result<\/span><\/span>\n    )<\/span><\/span>\n}<\/span><\/span>\n<\/span>\nobject<\/span> <\/span>Graph<\/span> <\/span>{<\/span><\/span>\n <\/span>ROOT<\/span> <\/span>=<\/span> <\/span>"<\/span>ROOT_GRAPH<\/span>"<\/span><\/span>\n}<\/span><\/span>\n<\/span>\nsealed<\/span> <\/span>class<\/span> <\/span>Screens<\/span>(<\/span>val<\/span> <\/span>route<\/span>: <\/span>String<\/span>) <\/span>{<\/span><\/span>\n <\/span>data<\/span> <\/span>object<\/span> MyMainScreen<\/span>:<\/span> Screens<\/span>(<\/span>route<\/span> <\/span>=<\/span> <\/span>"<\/span>MY_MAIN_SCREEN<\/span>"<\/span>)<\/span> <\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
@HiltViewModel<\/span><\/span>\nclass<\/span> <\/span>MyMainScreenViewModel<\/span> @<\/span>Inject<\/span> <\/span>constructor<\/span>(<\/span>private<\/span> <\/span>val<\/span> <\/span>myRepository<\/span>: <\/span>MyRepository<\/span>): <\/span>ViewModel<\/span>() <\/span>{<\/span><\/span>\n    <\/span>\/\/ your viewModel<\/span><\/span>\n    <\/span>private<\/span> <\/span>val<\/span> _resultState <\/span>=<\/span> <\/span>MutableStateFlow<\/span>(<\/span>"<\/span>ui-test-app<\/span>"<\/span>)<\/span><\/span>\n    <\/span>val<\/span> resultState <\/span>=<\/span> <\/span>_resultState<\/span>.<\/span>asStateFlow<\/span>()<\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n

Create a new file named “HiltTestModule”.<\/p>\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
@Module<\/span><\/span>\n@InstallIn<\/span>(<\/span>SingletonComponent<\/span>::<\/span>class<\/span>)<\/span><\/span>\nobject<\/span> <\/span>HiltTestAppModule<\/span> <\/span>{<\/span> <\/span><\/span>\n <\/span>\/\/ In your app module, you have the option to directly duplicate your original module by copy-pasting. However, in cases where you employ databases such as Realm or Room, it is advisable to utilize the 'inMemory' option directly instead of employing a database for your UI test cases.<\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n

Subsequently, proceed to create your TestRunner class to facilitate the utilization of your Test Module. Within this function, it is imperative to directly specify ‘HiltTestApplication::class.java.name’ as demonstrated.<\/p>\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
class<\/span> <\/span>HiltTestRunner<\/span>: <\/span>AndroidJUnitRunner<\/span>() <\/span>{<\/span><\/span>\n    <\/span>override<\/span> <\/span>fun<\/span> <\/span>newApplication<\/span>(<\/span>cl<\/span>:<\/span> ClassLoader<\/span>?<\/span>,<\/span> <\/span>className<\/span>:<\/span> String<\/span>?<\/span>,<\/span> <\/span>context<\/span>:<\/span> Context<\/span>?<\/span>)<\/span>:<\/span> Application <\/span>{<\/span><\/span>\n        <\/span>return<\/span> <\/span>super<\/span>.<\/span>newApplication<\/span>(<\/span>cl<\/span>,<\/span> <\/span>HiltTestApplication<\/span>::<\/span>class<\/span>.<\/span>java<\/span>.<\/span>name<\/span>,<\/span> <\/span>context<\/span>)<\/span><\/span>\n    <\/span>}<\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n

And then, at build.gradle (App Level) file set your testInstrumentationRunner like this:<\/p>\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
android<\/span> <\/span>{<\/span><\/span>\n    <\/span>defaultConfig<\/span> <\/span>{<\/span><\/span>\n        <\/span>testInstrumentationRunner<\/span> <\/span>=<\/span> <\/span>"<\/span>yourPackageName.HiltTestRunner<\/span>"<\/span><\/span><\/code><\/pre><\/div>\n\n\n

After completing these steps, we can proceed to create our UI test class and execute our tests as demonstrated below:<\/p>\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
@UninstallModules<\/span>(<\/span>AppModule<\/span>::<\/span>class<\/span>)<\/span><\/span>\n@HiltAndroidTest<\/span><\/span>\nclass<\/span> <\/span>MyMainUiScreenTest<\/span> <\/span>{<\/span><\/span>\n<\/span>\n    <\/span>@get<\/span>:<\/span>Rule<\/span>(<\/span>order<\/span> <\/span>=<\/span> <\/span>0<\/span>)<\/span><\/span>\n    <\/span>var<\/span> hiltRule <\/span>=<\/span> <\/span>HiltAndroidRule<\/span>(<\/span>this<\/span>)<\/span><\/span>\n<\/span>\n    <\/span>@get<\/span>:<\/span>Rule<\/span>(<\/span>order<\/span> <\/span>=<\/span> <\/span>1<\/span>)<\/span><\/span>\n    <\/span>var<\/span> composeRule <\/span>=<\/span> <\/span>createAndroidComposeRule<\/span><<\/span>MainActivity<\/span>><\/span>()<\/span><\/span>\n<\/span>\n    <\/span>@Before<\/span><\/span>\n    <\/span>fun<\/span> <\/span>setup<\/span>()<\/span> <\/span>{<\/span><\/span>\n        <\/span>hiltRule<\/span>.<\/span>inject<\/span>()<\/span><\/span>\n<\/span>\n        <\/span>composeRule<\/span>.<\/span>activity<\/span>.<\/span>setContent<\/span> <\/span>{<\/span><\/span>\n            <\/span>val<\/span> <\/span>navController<\/span> <\/span>=<\/span> <\/span>rememberNavController<\/span>()<\/span><\/span>\n            <\/span>MyAppTheme<\/span> <\/span>{<\/span><\/span>\n                <\/span>NavHost<\/span>(<\/span><\/span>\n                    <\/span>navController<\/span> <\/span>=<\/span> <\/span>navController<\/span>,<\/span><\/span>\n                    <\/span>startDestination<\/span> <\/span>=<\/span> <\/span>Screens<\/span>.<\/span>MyMainScreen<\/span>.<\/span>route<\/span>,<\/span><\/span>\n                    <\/span>route<\/span> <\/span>=<\/span> <\/span>Graph<\/span>.<\/span>ROOT<\/span><\/span>\n                ) <\/span>{<\/span><\/span>\n                    <\/span>composable<\/span>(<\/span>route<\/span> <\/span>=<\/span> <\/span>Screens<\/span>.<\/span>MyMainScreen<\/span>.<\/span>route<\/span>) <\/span>{<\/span><\/span>\n                        <\/span>MyMainScreen<\/span>()<\/span><\/span>\n                    <\/span>}<\/span><\/span>\n                <\/span>}<\/span><\/span>\n            <\/span>}<\/span><\/span>\n        <\/span>}<\/span><\/span>\n    <\/span>}<\/span><\/span>\n<\/span>\n    <\/span>@Test<\/span><\/span>\n    <\/span>fun<\/span> <\/span>uiTextTest<\/span>()<\/span> <\/span>{<\/span><\/span>\n        <\/span>val<\/span> <\/span>result<\/span> <\/span>=<\/span> <\/span>"<\/span>ui-test-app<\/span>"<\/span><\/span>\n        <\/span>composeRule<\/span>.<\/span>onNodeWithText<\/span>(<\/span>result<\/span>)<\/span>.<\/span>assertExists<\/span>()<\/span><\/span>\n    <\/span>}<\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n

When utilizing your application, it is necessary to uninstall the current modules due to the requirement of employing your test module. This operation can be executed with the @UninstallModules() annotation. Furthermore, it is imperative to define hiltRule to facilitate the automatic execution of injections. The order of rules, denoted by \u2018Rule Order\u2019, specifies the sequence in which rules are applied. Rules with a higher value are applied internally<\/p>","protected":false},"excerpt":{"rendered":"
When utilizing Jetpack Compose alongside Dagger Hilt for dependency management, your application does not recognize your current app module in test cases. To address this issue and facilitate the testing of composable functions when leveraging Dagger Hilt, it becomes necessary to supply a dedicated test module. When discussing this topic, I intend to create abstract service and repository classes, along with defining the corresponding module. To begin, I assume that you already possess your repository, service, and module. Following this assumption, I proceed to create a delegated module. Be sure that you impelemented your dependencies: Let’s prepare our UI:\u00a0 Create…<\/p>\n","protected":false},"author":1,"featured_media":789,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"om_disable_all_campaigns":false,"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"footnotes":""},"categories":[29],"tags":[],"class_list":["post-869","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-kotlin"],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/barisuslucan.com\/en\/wp-json\/wp\/v2\/posts\/869","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/barisuslucan.com\/en\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/barisuslucan.com\/en\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/barisuslucan.com\/en\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/barisuslucan.com\/en\/wp-json\/wp\/v2\/comments?post=869"}],"version-history":[{"count":4,"href":"https:\/\/barisuslucan.com\/en\/wp-json\/wp\/v2\/posts\/869\/revisions"}],"predecessor-version":[{"id":874,"href":"https:\/\/barisuslucan.com\/en\/wp-json\/wp\/v2\/posts\/869\/revisions\/874"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/barisuslucan.com\/en\/wp-json\/wp\/v2\/media\/789"}],"wp:attachment":[{"href":"https:\/\/barisuslucan.com\/en\/wp-json\/wp\/v2\/media?parent=869"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/barisuslucan.com\/en\/wp-json\/wp\/v2\/categories?post=869"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/barisuslucan.com\/en\/wp-json\/wp\/v2\/tags?post=869"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}