ISSUE-404: added kaspresso runner, added kaspresso run listeners, allure results hack refactored #438

eakurnikov · 2022-11-23T17:32:14Z

Added KaspressoRunner, it simply sets the SpyRunListener, which then calls the runner back on each junit lifecycle event. The runner being a KaspressoRunNotifier propagates each event to the list of KaspressoRunListeners which it stores.

This listeners interface is pretty much the same as junits RunListener but we have more control over it. Junit listeners are set on instrumentation runner creation and on each AndroidJunit4's run call which happens before each test and before the Kaspresso builder is called. This means that we can't add these runners dynamically in runtime, but we have to, as KaspressoRunner should live in the common module (not allure support) and should know nothing about allure support. That's why we need a list of KaspressoRunListeners that can be set in runtime.

We dynamically set AllureSupportRunner and AllureResultsHack in the Kaspresso.Builder. AllureSupportRunner is used to run the allure lifecycle without using allures runner.

AllureResultsHack is being notified by the HackyVideoRecordingTestInterceptor on each video is recorded and stores the binding between the test uuid and both stub and real video files. After all tests are finished it copies all the allure results to the SD card and replaces the stub video files attached to the report with the real videos. So this injection takes place only once when all tests are finished. It is ok to have a state like that in this case as all the tests are being run sequentially in the instrumentation thread, and after all of them are finished the thread is killed (if we're using the orchestration the number of the tests being run is just 1).

TODO: docs and tests

...com/kaspersky/components/alluresupport/interceptors/testrun/VideoRecordingTestInterceptor.kt

...ort/src/main/kotlin/com/kaspersky/components/alluresupport/report/AttachVideoToReportHack.kt

samples/kaspresso-allure-support-sample/build.gradle.kts

...mple/src/androidTest/kotlin/com/kaspersky/kaspresso/alluresupport/AllureSupportSanityTest.kt

…ure results hack refactored

eakurnikov · 2022-11-30T01:53:08Z

...port/src/main/kotlin/com/kaspersky/components/alluresupport/AllureSupportKaspressoBuilder.kt

@@ -31,13 +36,6 @@ fun Kaspresso.Builder.Companion.withAllureSupport(
 */
 fun Kaspresso.Builder.addAllureSupport(): Kaspresso.Builder = apply {


Reverted all the changes in it to have no breaking changes and added a withForcedAllureSupport builder

eakurnikov · 2022-11-30T01:58:16Z

...port/src/main/kotlin/com/kaspersky/components/alluresupport/AllureSupportKaspressoBuilder.kt

+    customize.invoke(this)
+    val instrumentalDependencyProvider =
+        instrumentalDependencyProviderFactory.getComponentProvider<Kaspresso>(instrumentation)
+    forceAllureSupportFileProviders(instrumentalDependencyProvider)


Forcing the allure support file providers entities here. We override the users entities here to avoid a complete mess with them. For example a user can set its own DirProvider which is used in other entities. If we simply wrap it with our AllureDirsProvider, it can lead to unexpected interaction between them, we don't know what behavior has the wrapped entity. So the solution here is simply force our file providers if the user wants to use our hack. The name withForcedAllureSupport is also descriptive

eakurnikov · 2022-11-30T02:01:43Z

...n/com/kaspersky/components/alluresupport/files/resources/impl/AllureResourceFilesProvider.kt

+     */
+    fun provideStubVideoFile(actualVideoFile: File): File {
+        val resFileName: String = actualVideoFile.name
+        return resourcesDirsProvider.provide(resourcesRootDirsProvider.stubVideoDir)


Use dirs hierarchy here as stubs are being overridden if we run multiple tests one after another inside the single instrumentation.

eakurnikov · 2022-11-30T02:02:08Z

...rsky/components/alluresupport/files/resources/impl/DefaultAllureResourcesRootDirsProvider.kt

Just for consistency

eakurnikov · 2022-11-30T02:03:33Z

...pport/src/main/kotlin/com/kaspersky/components/alluresupport/results/AllureResultInjector.kt

+import androidx.test.uiautomator.UiDevice
+import java.io.File
+
+class AllureResultInjector(


A separate entity responsible to replace all stubs in the results dir with real videos

eakurnikov · 2022-11-30T02:05:40Z

...pport/src/main/kotlin/com/kaspersky/components/alluresupport/results/AllureResultInjector.kt

+    }
+
+    private fun File.replaceWith(actualVideo: File) {
+        uiDevice.executeShellCommand("cp ${actualVideo.absolutePath} $this")


Not removing the source video files (not processed by allure) along with other resources. Keeping the current behaviour.

eakurnikov · 2022-11-30T02:06:04Z

...ort/src/main/kotlin/com/kaspersky/components/alluresupport/results/AllureResultJsonParser.kt

+import org.json.JSONObject
+import java.io.File
+
+class AllureResultJsonParser {


A separate entity that knows how to parse allure results json

eakurnikov · 2022-11-30T02:09:53Z

...-support/src/main/kotlin/com/kaspersky/components/alluresupport/results/AllureResultsHack.kt

+import org.junit.runner.Result
+import java.io.File
+
+class AllureResultsHack(


All the trick is in one place. It lives as long as the instrumentation lives. Stores the stub-to-real videos bindings and injects them into allure results when all the tests are finished. Files are being moved and copied only once.

Being a KaspressoRunListener it is stored in our KaspressoRunner.

eakurnikov · 2022-11-30T02:10:47Z

...ort/src/main/kotlin/com/kaspersky/components/alluresupport/runlisteners/AllureRunListener.kt

+import org.junit.runner.Result
+import org.junit.runner.notification.Failure
+
+class AllureRunListener : KaspressoLateRunListener {


Runs the allure lifecycle. We can't use the allure runner no more and so need to manage it by ourselves.

eakurnikov · 2022-11-30T02:11:53Z

kaspresso/src/main/kotlin/com/kaspersky/kaspresso/runner/KaspressoRunner.kt

+class KaspressoRunner : AndroidJUnitRunner(), KaspressoRunNotifier by KaspressoRunNotifierImpl() {
+
+    override fun onCreate(arguments: Bundle) {
+        arguments.putArgs("listener", SpyRunListener::class.java.name)


Simply set the SpyRunListener to JUnit. This listener notifies us back on the test's lifecycle events, so we can notify our custom KaspressoRunListeners and propagate the junit lifecycle.

eakurnikov · 2022-11-30T02:15:14Z

kaspresso/src/main/kotlin/com/kaspersky/kaspresso/runner/listener/KaspressoRunListener.kt

+import org.junit.runner.Result
+import org.junit.runner.notification.Failure
+
+interface KaspressoRunListener {


Pretty much the same as junit's RunListener, but it can be set in runtime instead.

eakurnikov · 2022-11-30T02:19:14Z

kaspresso/src/main/kotlin/com/kaspersky/kaspresso/runner/listener/KaspressoLateRunListener.kt

+
+import org.junit.runner.Description
+
+interface KaspressoLateRunListener : KaspressoRunListener {


KaspressoRunListeners are being set to runner when creating Kaspresso.Builder. At this moment testRunStarted and testStarted are already called, but the listener may need to handle these events little bit later. For example AllureRunListener shouldn't miss testStarted event. So KaspressoLateRunListener is a dedicated interface for them.

eakurnikov · 2022-11-30T02:22:19Z

kaspresso/src/main/kotlin/com/kaspersky/kaspresso/runner/listener/KaspressoRunNotifier.kt

+
+internal class KaspressoRunNotifierImpl : KaspressoRunNotifier {
+    private val cache = KaspressoLateRunListener.Cache()
+    override val listeners: MutableList<KaspressoRunListener> = arrayListOf()


Maybe it is better to have LinkedHashMap<KaspressoRunListener::class, KaspressoRunListener> here, will think about it tomorrow

eakurnikov · 2022-11-30T02:23:18Z

kaspresso/src/main/kotlin/com/kaspersky/kaspresso/runner/listener/KaspressoRunNotifier.kt

+
+    override fun addListener(listener: KaspressoRunListener) {
+        if (listener is KaspressoLateRunListener) {
+            listener.lateInit(cache)


Initializing late run listeners here and passing the data they missed.

eakurnikov · 2022-11-30T07:41:00Z

...port/src/main/kotlin/com/kaspersky/components/alluresupport/AllureSupportKaspressoBuilder.kt

+            DumpLogcatTestInterceptor(logcatDumper),
+            ScreenshotTestInterceptor(screenshots),
+            DumpViewsTestInterceptor(viewHierarchyDumper),
+            HackyVideoRecordingTestInterceptor(videos, allureResourcesFilesProvider, provider.runNotifier.getUniqueListener())


Taking the hack out of the listeners list. Another option is to have AllureResultsHack instance simply in static. It would be simpler and not so much different in behavior, as the instance is single in both ways and dies with the process.

eakurnikov · 2022-11-30T07:51:49Z

kaspresso/src/main/kotlin/com/kaspersky/kaspresso/runner/KaspressoRunner.kt

+    }
+
+    private fun Bundle.putArgs(key: String, vararg values: CharSequence?) {
+        val valuesArg: String = listOfNotNull<CharSequence>(


The listeners class names are stored in a string, so we just add our listener to the end of it.

eakurnikov · 2022-11-30T07:55:33Z

kaspresso/src/main/kotlin/com/kaspersky/kaspresso/runner/listener/KaspressoRunNotifier.kt

+import org.junit.runner.notification.Failure
+import java.lang.IllegalStateException
+
+interface KaspressoRunNotifier : KaspressoRunListener {


It is notified about the junit lifecycle as a listener and propagates it to the list of other listeners.

eakurnikov · 2022-11-30T07:57:16Z

kaspresso/src/main/kotlin/com/kaspersky/kaspresso/runner/listener/KaspressoLateRunListener.kt

+interface KaspressoLateRunListener : KaspressoRunListener {
+
+    fun lateInit(cache: Cache) {
+        testRunStarted(cache.testRunStartedDescription)


Once this listener is created and added to the notifier, this method is called with all the cached data from missed events.

eakurnikov requested review from matzuk, AzamatCherchesov, RuslanMingaliev and Nikitae57 as code owners November 23, 2022 17:32

eakurnikov force-pushed the issue-404/runner-fix branch 2 times, most recently from 7a8c308 to 2a9121f Compare November 23, 2022 17:42

ISSUE-404: add both instr runner and junit4 runner as a draft fix

2164349

eakurnikov force-pushed the issue-404/runner-fix branch from 2a9121f to 2164349 Compare November 23, 2022 17:44

Nikitae57 reviewed Nov 25, 2022

View reviewed changes

...com/kaspersky/components/alluresupport/interceptors/testrun/VideoRecordingTestInterceptor.kt Outdated Show resolved Hide resolved

Nikitae57 reviewed Nov 25, 2022

View reviewed changes

...ort/src/main/kotlin/com/kaspersky/components/alluresupport/report/AttachVideoToReportHack.kt Outdated Show resolved Hide resolved

Nikitae57 reviewed Nov 25, 2022

View reviewed changes

samples/kaspresso-allure-support-sample/build.gradle.kts Outdated Show resolved Hide resolved

Nikitae57 reviewed Nov 25, 2022

View reviewed changes

...mple/src/androidTest/kotlin/com/kaspersky/kaspresso/alluresupport/AllureSupportSanityTest.kt Outdated Show resolved Hide resolved

ISSUE-404: added kaspresso runner, added kaspresso run listeners, all…

27c0d15

…ure results hack refactored

eakurnikov force-pushed the issue-404/runner-fix branch from 4c7d090 to 27c0d15 Compare November 30, 2022 01:50

eakurnikov commented Nov 30, 2022

View reviewed changes

eakurnikov changed the title ~~ISSUE-404: add both instr runner and junit4 runner as a draft fix~~ ISSUE-404: added kaspresso runner, added kaspresso run listeners, allure results hack refactored Nov 30, 2022

Nikitae57 merged commit ba58338 into issue-404/Support_storage_restrictions Nov 30, 2022

Nikitae57 deleted the issue-404/runner-fix branch November 30, 2022 10:11

eakurnikov mentioned this pull request Nov 30, 2022

#404: Using documents to avoid storage restrictions #423

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ISSUE-404: added kaspresso runner, added kaspresso run listeners, allure results hack refactored #438

ISSUE-404: added kaspresso runner, added kaspresso run listeners, allure results hack refactored #438

eakurnikov commented Nov 23, 2022 •

edited

Loading

eakurnikov Nov 30, 2022 •

edited

Loading

eakurnikov Nov 30, 2022 •

edited

Loading

eakurnikov Nov 30, 2022 •

edited

Loading

eakurnikov Nov 30, 2022

eakurnikov Nov 30, 2022

eakurnikov Nov 30, 2022 •

edited

Loading

eakurnikov Nov 30, 2022

eakurnikov Nov 30, 2022

eakurnikov Nov 30, 2022 •

edited

Loading

eakurnikov Nov 30, 2022 •

edited

Loading

eakurnikov Nov 30, 2022 •

edited

Loading

eakurnikov Nov 30, 2022 •

edited

Loading

eakurnikov Nov 30, 2022 •

edited

Loading

eakurnikov Nov 30, 2022

eakurnikov Nov 30, 2022

eakurnikov Nov 30, 2022

eakurnikov Nov 30, 2022

eakurnikov Nov 30, 2022

		@@ -31,13 +36,6 @@ fun Kaspresso.Builder.Companion.withAllureSupport(
		*/
		fun Kaspresso.Builder.addAllureSupport(): Kaspresso.Builder = apply {


		import org.junit.runner.Description

		interface KaspressoLateRunListener : KaspressoRunListener {

ISSUE-404: added kaspresso runner, added kaspresso run listeners, allure results hack refactored #438

ISSUE-404: added kaspresso runner, added kaspresso run listeners, allure results hack refactored #438

Conversation

eakurnikov commented Nov 23, 2022 • edited Loading

eakurnikov Nov 30, 2022 • edited Loading

Choose a reason for hiding this comment

eakurnikov Nov 30, 2022 • edited Loading

Choose a reason for hiding this comment

eakurnikov Nov 30, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eakurnikov Nov 30, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eakurnikov Nov 30, 2022 • edited Loading

Choose a reason for hiding this comment

eakurnikov Nov 30, 2022 • edited Loading

Choose a reason for hiding this comment

eakurnikov Nov 30, 2022 • edited Loading

Choose a reason for hiding this comment

eakurnikov Nov 30, 2022 • edited Loading

Choose a reason for hiding this comment

eakurnikov Nov 30, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eakurnikov commented Nov 23, 2022 •

edited

Loading

eakurnikov Nov 30, 2022 •

edited

Loading

eakurnikov Nov 30, 2022 •

edited

Loading

eakurnikov Nov 30, 2022 •

edited

Loading

eakurnikov Nov 30, 2022 •

edited

Loading

eakurnikov Nov 30, 2022 •

edited

Loading

eakurnikov Nov 30, 2022 •

edited

Loading

eakurnikov Nov 30, 2022 •

edited

Loading

eakurnikov Nov 30, 2022 •

edited

Loading

eakurnikov Nov 30, 2022 •

edited

Loading