When appium starts it prevents the initialisation of a RealmDB #793

patrickdargel · 2022-06-14T07:56:38Z

The Problem

When starting the Andoird App via Appium, the driver terminates with the message: "org.openqa.selenium.SessionNotCreatedException: Could not start a new session. Response code 500. Message: A new session could not be created."
logcat shows following issue: "Caused by: kotlin.UninitializedPropertyAccessException: lateinit property filesDir has not been initialized"
From our point of view it seems like the Android app gets started in a way, the prevents or fails the initialisation of the realmDB.

Environment

Android App

Hilt 2.42
Realm Kotlin DB (https://github.com/realm/realm-kotlin) 0.10.2
Jetpack Compose 1.1.0
Kotlin 1.6.10
espresso-core 3.4.0

Test automation

appium@2.0.0-beta.40
appium java-client 8.1.1
selenium 4.2.1
spresso-driver espresso@2.5.0
espressoBuildConfig capability:
- "{"compileSdk":31} ," +
- ""additionalAndroidTestDependencies": " +
  - "["androidx.compose.runtime:runtime:1.1.1" , " +
  - ""androidx.compose.ui:ui-tooling:1.1.1" , " +
  - ""androidx.compose.foundation:foundation:1.1.1" , " +
  - ""androidx.compose.material:material:1.1.1" ] }");

### Details
logcat output:

06-08 15:03:02.695  2067  2067 E MonitoringInstr: java.lang.RuntimeException: java.lang.reflect.InvocationTargetException
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:612)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:1130)
06-08 15:03:02.695  2067  2067 E MonitoringInstr: Caused by: java.lang.reflect.InvocationTargetException
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at java.lang.reflect.Method.invoke(Native Method)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:602)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   ... 1 more
06-08 15:03:02.695  2067  2067 E MonitoringInstr: Caused by: kotlin.UninitializedPropertyAccessException_bGF0ZWluaXQgcHJvcGVydHkgZmlsZXNEaXIgaGFzIG5vdCBiZWVuIGluaXRpYWxpemVk: lateinit property filesDir has not been initialized
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at de.gematik.ti.erp.app.di.RealmModule.provideRealmDatabase(RealmModule.kt:66)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at de.gematik.ti.erp.app.di.RealmModule_ProvideRealmDatabaseFactory.provideRealmDatabase(RealmModule_ProvideRealmDatabaseFactory.java:47)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at de.gematik.ti.erp.app.DaggerApp_HiltComponents_SingletonC$SingletonCImpl$SwitchingProvider.get(DaggerApp_HiltComponents_SingletonC.java:1148)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at dagger.internal.DoubleCheck.get(DoubleCheck.java:47)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at de.gematik.ti.erp.app.DaggerApp_HiltComponents_SingletonC$SingletonCImpl.settingsRepository(DaggerApp_HiltComponents_SingletonC.java:1018)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at de.gematik.ti.erp.app.DaggerApp_HiltComponents_SingletonC$SingletonCImpl.settingsUseCase(DaggerApp_HiltComponents_SingletonC.java:1022)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at de.gematik.ti.erp.app.DaggerApp_HiltComponents_SingletonC$SingletonCImpl.access$2700(DaggerApp_HiltComponents_SingletonC.java:948)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at de.gematik.ti.erp.app.DaggerApp_HiltComponents_SingletonC$SingletonCImpl$SwitchingProvider.get(DaggerApp_HiltComponents_SingletonC.java:1145)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at dagger.internal.DoubleCheck.get(DoubleCheck.java:47)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at de.gematik.ti.erp.app.DaggerApp_HiltComponents_SingletonC$SingletonCImpl.injectApp2(DaggerApp_HiltComponents_SingletonC.java:1125)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at de.gematik.ti.erp.app.DaggerApp_HiltComponents_SingletonC$SingletonCImpl.injectApp(DaggerApp_HiltComponents_SingletonC.java:1120)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at de.gematik.ti.erp.app.Hilt_App.hiltInternalInject(Hilt_App.java:49)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at de.gematik.ti.erp.app.Hilt_App.onCreate(Hilt_App.java:40)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at de.gematik.ti.erp.app.App.onCreate(App.kt:26)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at android.app.Instrumentation.callApplicationOnCreate(Instrumentation.java:1192)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at androidx.test.runner.MonitoringInstrumentation.callApplicationOnCreate(MonitoringInstrumentation.java:442)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at android.app.ActivityThread.handleBindApplication(ActivityThread.java:7573)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at android.app.ActivityThread.access$1500(ActivityThread.java:301)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at android.app.ActivityThread$H.handleMessage(ActivityThread.java:2166)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at android.os.Handler.dispatchMessage(Handler.java:106)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at android.os.Looper.loop(Looper.java:246)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at android.app.ActivityThread.main(ActivityThread.java:8633)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   ... 3 more
06-08 15:03:02.695  2067  2067 E MonitoringInstr: Caused by: kotlin.UninitializedPropertyAccessException: lateinit property filesDir has not been initialized
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at io.realm.internal.platform.RealmInitializer$Companion.getFilesDir(RealmInitializer.kt:32)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at io.realm.internal.platform.SystemUtilsAndroidKt.appFilesDirectory(SystemUtilsAndroid.kt:11)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at io.realm.internal.ConfigurationImpl.normalizePath(ConfigurationImpl.kt:180)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at io.realm.internal.ConfigurationImpl.<init>(ConfigurationImpl.kt:88)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at io.realm.internal.RealmConfigurationImpl.<init>(RealmConfigurationImpl.kt:42)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at io.realm.RealmConfiguration$Builder.build(RealmConfiguration.kt:79)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at io.realm.RealmConfiguration$Builder.build(RealmConfiguration.kt:47)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at de.gematik.ti.erp.app.db.SchemaKt.openRealmWith(Schema.kt:47)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   at de.gematik.ti.erp.app.di.RealmModule.provideRealmDatabase(RealmModule.kt:52)
06-08 15:03:02.695  2067  2067 E MonitoringInstr:   ... 24 more

The text was updated successfully, but these errors were encountered:

KazuCocoa · 2022-06-14T21:31:41Z

The initialization should be proper place. Probably your app under test does not work with Espresso framework (by Google) with current implementation.

patrickdargel · 2022-06-15T12:22:59Z

@KazuCocoa Thanks a lot for your quick response.
I tried to highlight it under the environment part, but I will try to outline it a little bit clearer:
The app under test works with the Espresso framework in its current implementation.
I have added the respective espresso version androidx.test.espresso:espresso-core:3.4.0 to the environment

I sincerely hope I did not misunderstand you.

KazuCocoa · 2022-06-15T16:40:02Z

hm, thank you.

The app start itself as same as vanilla espresso does since Appium espresso driver itself does not launch the app under test. Espresso framework does.

The app under test works with the Espresso framework in its current implementation.

Do your code do something in the Espresso test code side?

patrickdargel · 2022-06-17T11:58:36Z

thank you.

Our code does not do anything to the Espresso test code side.
Our current test code is very basic so, if desired, I could share the class with you.

KazuCocoa · 2022-06-18T07:39:01Z

This espresso driver starts with androidx.test.runner.AndroidJUnitRunner as below, so basically the lifecycle also depends on androidx.test.runner.AndroidJUnitRunner. We do not customize it.

appium-espresso-driver/lib/espresso-runner.js

Lines 231 to 243 in 2d78337

    
           const cmd = [ 
        
             'shell', 
        
             'am', 'instrument', 
        
             '-w', 
        
             '-e', 'debug', process.env.ESPRESSO_JAVA_DEBUG === 'true', 
        
             '-e', 'disableAnalytics', true, // To avoid unexpected error by google analytics 
        
           ]; 
        
           if (_.isBoolean(this.disableSuppressAccessibilityService)) { 
        
             cmd.push('-e', 'DISABLE_SUPPRESS_ACCESSIBILITY_SERVICES', this.disableSuppressAccessibilityService); 
        
           } 
        
           cmd.push(`${TEST_APK_PKG}/androidx.test.runner.AndroidJUnitRunner`);

appium-espresso-driver/espresso-server/app/build.gradle.kts

Line 20 in 60fd588

testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"

I haven't used Realm, but when is https://github.com/realm/realm-kotlin/blob/4fb30d70e0a7ef671d98c47249079bbaf8a9b764/packages/library-base/src/androidMain/kotlin/io/realm/kotlin/internal/platform/RealmInitializer.kt#L35 called?

patrickdargel · 2022-06-20T14:49:39Z

The RealmInitializer is called in the AndroidManifest.xml

   <application>
        <provider
                android:name="androidx.startup.InitializationProvider"
                tools:node="merge"
                android:authorities="${applicationId}.androidx-startup"
                android:exported="false">
            <meta-data
                    android:name="io.realm.kotlin.internal.platform.RealmInitializer"
                    android:value="androidx.startup" />
        </provider>
    </application>

https://github.com/realm/realm-kotlin/blob/4fb30d70e0a7ef671d98c47249079bbaf8a9b764/packages/library-base/src/androidMain/AndroidManifest.xml

KazuCocoa · 2022-06-20T16:30:23Z

Should the Manifest in the espresso's apk one? So, should the android test package also have it?

patrickdargel · 2022-06-28T08:39:17Z

Sorry for the long delay. Thank you for the suggestion KazuCocoa. We try to include as much of the dependencies as we could and also tried to bring the Manifest into the Automation Suite.
Sadly, the issue could not be solved.

KazuCocoa · 2022-07-02T05:45:53Z

mm, then, potentially should https://github.com/appium/appium-espresso-driver/blob/master/espresso-server/app/src/androidTest/java/io/appium/espressoserver/EspressoServerRunnerTest.kt#L64 have something for RealmDB usage...?

okafke · 2022-07-07T10:53:33Z

Should the Manifest in the espresso's apk one? So, should the android test package also have it?

By adding the realm dependency to the espresso build config the generated espresso apk's Manifest will contain the Initializer, but it still won't get called.

It also needs to be mentioned that this issue is not limited to the RealmDB. With Appium-Espresso none of the androidx.startup.Initializers from the Manifest will get called. I was able to recreate this on multiple apps that use other App Startup Initializers. To name two:

https://github.com/blipinsk/app-startup-hilt-sample displays a "is initialized = false" because the Initializer hasn't been called.
https://github.com/guichristovao/app-startup crashes, because the Initializer uses a lateinit var, similarly to the RealmDB.

All these apps are fine when started normally.

The one workaround I was able to find is to initialize the Initializer manually before it's needed, like this:

AppInitializer.getInstance(applicationContext).initializeComponent(RealmInitializer::class.java)

but I think it would be much more feasible if Initializers would also work in the documented way with Appium Espresso.

mm, then, potentially should https://github.com/appium/appium-espresso-driver/blob/master/espresso-server/app/src/androidTest/java/io/appium/espressoserver/EspressoServerRunnerTest.kt#L64 have something for RealmDB usage...?

I'm not deep enough into the matter to help, but sure, support for App Startup in general would be nice.

okafke · 2023-01-26T11:06:04Z

I checked the code that starts the app in ActivityHelpers and I do not see anything that could cause this. Could this be an issue of Androidx Startup itself?

This ticket seems related: https://issuetracker.google.com/issues/230844558
When running instrumented tests, Androidx start up may run it's initializers before the instrumentation is ready.

KazuCocoa · 2023-01-29T17:41:26Z

hm, thank for the informatin

KazuCocoa added the question label Jun 14, 2022

Roman-Markov mentioned this issue Jul 24, 2024

During tests app crashes when trying to initialize WorkManager / WorkManager initializer is not invoked from androidx.startup.InitializationProvider #1026

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

When appium starts it prevents the initialisation of a RealmDB #793

When appium starts it prevents the initialisation of a RealmDB #793

patrickdargel commented Jun 14, 2022 •

edited

Loading

KazuCocoa commented Jun 14, 2022

patrickdargel commented Jun 15, 2022 •

edited

Loading

KazuCocoa commented Jun 15, 2022

patrickdargel commented Jun 17, 2022

KazuCocoa commented Jun 18, 2022

patrickdargel commented Jun 20, 2022 •

edited

Loading

KazuCocoa commented Jun 20, 2022

patrickdargel commented Jun 28, 2022

KazuCocoa commented Jul 2, 2022

okafke commented Jul 7, 2022

okafke commented Jan 26, 2023

KazuCocoa commented Jan 29, 2023

When appium starts it prevents the initialisation of a RealmDB #793

When appium starts it prevents the initialisation of a RealmDB #793

Comments

patrickdargel commented Jun 14, 2022 • edited Loading

The Problem

Environment

Android App

Test automation

KazuCocoa commented Jun 14, 2022

patrickdargel commented Jun 15, 2022 • edited Loading

KazuCocoa commented Jun 15, 2022

patrickdargel commented Jun 17, 2022

KazuCocoa commented Jun 18, 2022

patrickdargel commented Jun 20, 2022 • edited Loading

KazuCocoa commented Jun 20, 2022

patrickdargel commented Jun 28, 2022

KazuCocoa commented Jul 2, 2022

okafke commented Jul 7, 2022

okafke commented Jan 26, 2023

KazuCocoa commented Jan 29, 2023

patrickdargel commented Jun 14, 2022 •

edited

Loading

patrickdargel commented Jun 15, 2022 •

edited

Loading

patrickdargel commented Jun 20, 2022 •

edited

Loading