#404: Using documents to avoid storage restrictions #423

Nikitae57 · 2022-11-15T09:00:15Z

Closes #407, #404, #425 and #418
Also repaired allure video recording

…ideos

… test

kaspresso/src/main/kotlin/com/kaspersky/kaspresso/files/dirs/DefaultDirsProvider.kt

...src/main/kotlin/com/kaspersky/kaspresso/files/resources/impl/DefaultResourceFilesProvider.kt

kaspresso/src/main/kotlin/com/kaspersky/kaspresso/kaspresso/Kaspresso.kt

...kotlin/com/kaspersky/components/alluresupport/interceptors/testrun/MoveReportsInterceptor.kt

AzamatCherchesov · 2022-11-17T22:27:40Z

...kotlin/com/kaspersky/components/alluresupport/interceptors/testrun/MoveReportsInterceptor.kt

+     * /sdcard/Documents/.../allure-results
+     * @return allure target directory on sdcard
+     */
+    private fun moveAllureReportToSdCard(): File {


nit: maybe it would be better if the moveAllureReportToSdCard() method didn't return anything?

Why? Personally I like when file manipulation methods do this like createDirIfNeeded() does

...kotlin/com/kaspersky/components/alluresupport/interceptors/testrun/MoveReportsInterceptor.kt

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

AzamatCherchesov · 2022-11-18T14:36:43Z

Discussed with @Nikitae57 to remove all permission rules in the repository.

# Conflicts: # tutorial/src/androidTest/kotlin/com/kaspersky/kaspresso/tutorial/kautomator_test/UiSimpleTest.kt # tutorial/src/androidTest/kotlin/com/kaspersky/kaspresso/tutorial/test/SimpleTest.kt

…ure properties to get allure dir name

…ctions' into issue-404/Support_storage_restrictions # Conflicts: # wiki/09_Kaspresso-Allure.md

Co-authored-by: Egor Kurnikov <[email protected]>

…ctions' into issue-404/Support_storage_restrictions

eakurnikov · 2022-11-23T13:25:45Z

...kotlin/com/kaspersky/components/alluresupport/interceptors/testrun/MoveReportsInterceptor.kt

+
+    private var lastTestCaseUuid: String? = null
+
+    override fun onMainSectionStarted(testInfo: TestInfo) {


Why is it onMainSectionStarted and not onTestStarted by the way?

We're starting the video recording in the onTestStarted, so if there will be failure in before block the test will be finished without calling onMainSectionStarted. Thus to save the video we will use the lastTestCaseUuid from the previous test.

eakurnikov · 2022-11-23T13:31:02Z

...kotlin/com/kaspersky/components/alluresupport/interceptors/testrun/MoveReportsInterceptor.kt

+     */
+    private fun removeStubs(allureTargetDir: File) {
+        allureTargetDir.listFiles()?.forEach {
+            if (it.extension.contains(MP4_EXTENSION, ignoreCase = true)) {


Maybe we could define the stub more precisely? Not just any mp4 file

eakurnikov · 2022-11-23T13:36:06Z

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

+    override val screenshotsRootDir = File("screenshots")
+    override val videoRootDir = File("video")
+    override val viewHierarchy = File("view_hierarchy")
+    override val allureRootDir = File(PropertiesUtils.resultsDirectoryPath)


Since the allure.properties can't be changed in runtime maybe we could cache the PropertiesUtils.resultsDirectoryPath's result and access the cached value in MoveReportsInterceptor to not load it on each call?

eakurnikov · 2022-11-23T13:45:43Z

...kotlin/com/kaspersky/components/alluresupport/interceptors/testrun/MoveReportsInterceptor.kt

+     * @param allureTargetDir allure directory under /sdcard
+     */
+    private fun saveAttachedVideo(attachedVideo: AttachedVideo, allureTargetDir: File) {
+        val allureReportFile = allureTargetDir.resolve("${lastTestCaseUuid ?: ""}-result.json")


Seems like we should use io.qameta.allure.kotlin.AllureConstants.TEST_RESULT_FILE_SUFFIX here instead.

eakurnikov · 2022-11-23T14:17:22Z

...kotlin/com/kaspersky/components/alluresupport/interceptors/testrun/MoveReportsInterceptor.kt

+    }
+
+    override fun onTestFinished(testInfo: TestInfo, success: Boolean) {
+        val allureTargetDir = moveAllureReportToSdCard()


If the user adds custom interceptors after this one he wouldn't be able to see its results in the report. For example AllureSupportCustomizeTest will write custom view hierarchy which will not be added to the report.

The construction like Kaspresso.Builder.simple().addAllureSupport().apply { ... } loses any sense in such a case. So this should be fixed.

First I would suggest to move here that hacky forcing the allure to write down the report to have something like:

override fun onTestFinished(testInfo: TestInfo, success: Boolean) { forceAllureTestFinished(success) val allureTargetDir = moveAllureReportToSdCard() removeStubs(allureTargetDir) moveAttachedVideosToProperDirectories(allureTargetDir) cleanUp() } fun forceAllureTestFinished(success: Boolean) { val uuid = Allure.lifecycle.getCurrentTestCase() ?: “” Allure.lifecycle.updateTestCase { it.status = if (success) Status.PASSED else Status.FAILED } Allure.lifecycle.stopTestCase(uuid) Allure.lifecycle.writeTestCase(uuid) }

And then we should guarantee that this MoveReportsInterceptor is called last no matter how much interceptors the user added by himself. How to achieve this is need to be designed.

eakurnikov · 2022-11-23T14:33:10Z

...kotlin/com/kaspersky/components/alluresupport/interceptors/testrun/MoveReportsInterceptor.kt

+        val videosDir = dirsProvider.provideNew(rootDirsProvider.videoRootDir)
+        device.executeShellCommand("rm -rf ${videosDir.absolutePath}")
+
+        dirsProvider.provideNew(rootDirsProvider.screenshotsRootDir).deleteRecursively()


This would be a behaviour breaking change. Not sure that we have to clear all these dirs in this line and below, previously these files were just copied to the report. I would say we can leave it as it was, but I don't insist, need more opinions here. At least it should be mentioned in the changelog.

…ure results hack refactored

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

eakurnikov · 2022-11-30T10:51:28Z

If someone needs more context, pls take a look at the description and comments here

AzamatCherchesov · 2022-11-30T12:37:31Z

...ple/src/androidTest/kotlin/com/kaspersky/kaspressample/device_tests/DeviceFilesSampleTest.kt

 import org.junit.Assert.assertFalse
 import org.junit.Assert.assertTrue
 import org.junit.Rule
 import org.junit.Test
+import java.io.File


Why this dependency declaration was moved?

AzamatCherchesov · 2022-11-30T12:39:47Z

.../src/androidTest/kotlin/com/kaspersky/kaspressample/device_tests/DeviceLanguageSampleTest.kt

 import org.junit.Rule
 import org.junit.Test
+import java.util.Locale


why this dependency declaration was moved?

AzamatCherchesov · 2022-12-01T09:44:31Z

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

+ */
+// TODO implement allure support sanity test in another way. Current code doesn't fail test if report is invalid
+@Ignore("Since we switched to run notifiers this test can no longer be functional")
+class AllureSupportSanityTest : TestCase(


let's move to allure-support module

Moved to a separate folder

AzamatCherchesov · 2022-12-01T09:46:38Z

...o-sample/src/androidTest/kotlin/com/kaspersky/kaspressample/docloc_tests/DocLocSanityTest.kt

+/**
+ * Check that doc loc tests are sane
+ */
+class DocLocSanityTest : DocLocScreenshotTestCase(


let's move to Kaspresso module

Moved to a separate folder

AzamatCherchesov · 2022-12-01T09:48:02Z

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)


let's add more comments

AzamatCherchesov · 2022-12-01T09:48:25Z

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

+import org.junit.runner.notification.Failure
+import org.junit.runner.notification.RunListener
+
+internal class SpyRunListener : RunListener() {


add Java doc

AzamatCherchesov · 2022-12-01T09:50:43Z

...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 {


make note that this is an allure copy

Left comments

AzamatCherchesov · 2022-12-01T10:12:26Z

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

+        testStarted(cache.firstTestStartedDescription)
+    }
+
+    class Cache {


Add some info in comments what is it about. Move to notifier class

AzamatCherchesov · 2022-12-01T10:14:09Z

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

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


add some info in comments why do we need this method invocation. (Because some listeners are added after tests started and they left call back invocations)

Allure listener and allure runner

AzamatCherchesov · 2022-12-01T10:15:04Z

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

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


why it is late? Add some details

…tion to get run notifier from instrumentation

#404: Using documents to avoid storage restrictions; allure records v…

72818f4

…ideos

Nikitae57 requested review from matzuk, AzamatCherchesov, eakurnikov and RuslanMingaliev as code owners November 15, 2022 09:00

Nikitae57 added 15 commits November 15, 2022 13:42

#404: Fixed AllureTestRunStateHolderTest; added allure support sanity…

179634d

… test

#404: Added doc loc sanity test

1fe295c

#404: Reconfigured CI artifacts pulling

e9ed8c3

#404: KAutomator tests fix experiment

aee987f

#404: KAutomator tests fix experiment

4cbbdfb

#404: KAutomator tests fix experiment

856c07d

#404: KAutomator tests fix experiment

51b57b5

#404: KAutomator tests fix experiment

f17d7e9

#404: KAutomator tests fix experiment

6ff1a79

#404: KAutomator tests fix experiment

0bc7a75

#404: KAutomator tests fix experiment

8550036

#404: KAutomator tests fix experiment

d0b1d68

#404: Reverted CI config experiments fixed lint

054fec0

#404: Fixed roboleptric test

6b011b5

#404: Updated docs

300b885

AzamatCherchesov requested changes Nov 17, 2022

View reviewed changes

AzamatCherchesov reviewed Nov 17, 2022

View reviewed changes

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

#404: Removed redundant interceptor; removed unused parameter; clean up

bea6ff9

Nikitae57 changed the title ~~[Draft] #404: Using documents to avoid storage restrictions~~ #404: Using documents to avoid storage restrictions Nov 18, 2022

#404: Removed redundant check

f3c266e

Nikitae57 added 4 commits November 21, 2022 12:15

#404: Removed storage rules

0ed5c74

Merge branch 'master' into issue-404/Support_storage_restrictions

4078373

# Conflicts: # tutorial/src/androidTest/kotlin/com/kaspersky/kaspresso/tutorial/kautomator_test/UiSimpleTest.kt # tutorial/src/androidTest/kotlin/com/kaspersky/kaspresso/tutorial/test/SimpleTest.kt

#404: Removed empty file

5923522

#404: Bump some libs

7b0c7bf

Nikitae57 and others added 5 commits November 22, 2022 17:28

#404: Moved "provideStubVideoFile" method to file provider; using all…

9916eb1

…ure properties to get allure dir name

Merge remote-tracking branch 'origin/issue-404/Support_storage_restri…

043463a

…ctions' into issue-404/Support_storage_restrictions # Conflicts: # wiki/09_Kaspresso-Allure.md

Update wiki/09_Kaspresso-Allure.md

1eba818

Co-authored-by: Egor Kurnikov <[email protected]>

#404: Added comment

f7e6f15

Merge remote-tracking branch 'origin/issue-404/Support_storage_restri…

567abe1

…ctions' into issue-404/Support_storage_restrictions

eakurnikov reviewed Nov 23, 2022

View reviewed changes

eakurnikov and others added 3 commits November 23, 2022 21:44

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

2164349

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

27c0d15

…ure results hack refactored

Merge pull request #438 from KasperskyLab/issue-404/runner-fix

ba58338

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

#404: Lint

7b94ea1

AzamatCherchesov reviewed Nov 30, 2022

View reviewed changes

AzamatCherchesov reviewed Dec 1, 2022

View reviewed changes

Nikitae57 added 2 commits December 1, 2022 16:35

#404: Added more docs; moved Cache to run notifier; avoid code genera…

26136ed

…tion to get run notifier from instrumentation

#404: Moved sanity tests to separate folders

6849701

AzamatCherchesov previously approved these changes Dec 1, 2022

View reviewed changes

#404: Updated docs; fixed a couple of typos

cf52cb8

Nikitae57 dismissed AzamatCherchesov’s stale review via cf52cb8 December 1, 2022 14:25

AzamatCherchesov approved these changes Dec 1, 2022

View reviewed changes

VladislavSumin approved these changes Dec 1, 2022

View reviewed changes

AzamatCherchesov merged commit 079e9a5 into master Dec 1, 2022

AzamatCherchesov deleted the issue-404/Support_storage_restrictions branch December 1, 2022 14:55

AzamatCherchesov restored the issue-404/Support_storage_restrictions branch December 1, 2022 19:13

AzamatCherchesov deleted the issue-404/Support_storage_restrictions branch September 7, 2023 09:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#404: Using documents to avoid storage restrictions #423

#404: Using documents to avoid storage restrictions #423

Nikitae57 commented Nov 15, 2022 •

edited

Loading

AzamatCherchesov Nov 17, 2022

Nikitae57 Nov 18, 2022 •

edited

Loading

AzamatCherchesov commented Nov 18, 2022

eakurnikov Nov 23, 2022

eakurnikov Nov 23, 2022 •

edited

Loading

eakurnikov Nov 23, 2022 •

edited

Loading

eakurnikov Nov 23, 2022

eakurnikov Nov 23, 2022

eakurnikov Nov 23, 2022 •

edited

Loading

eakurnikov Nov 23, 2022

eakurnikov Nov 23, 2022 •

edited

Loading

eakurnikov commented Nov 30, 2022 •

edited

Loading

AzamatCherchesov Nov 30, 2022

AzamatCherchesov Nov 30, 2022

AzamatCherchesov Dec 1, 2022

Nikitae57 Dec 1, 2022

AzamatCherchesov Dec 1, 2022

Nikitae57 Dec 1, 2022

AzamatCherchesov Dec 1, 2022

Nikitae57 Dec 1, 2022

AzamatCherchesov Dec 1, 2022

Nikitae57 Dec 1, 2022

AzamatCherchesov Dec 1, 2022

Nikitae57 Dec 1, 2022 •

edited

Loading

AzamatCherchesov Dec 1, 2022

Nikitae57 Dec 1, 2022

AzamatCherchesov Dec 1, 2022

AzamatCherchesov Dec 1, 2022

Nikitae57 Dec 1, 2022

AzamatCherchesov Dec 1, 2022

Nikitae57 Dec 1, 2022


		private var lastTestCaseUuid: String? = null

		override fun onMainSectionStarted(testInfo: TestInfo) {


		import org.junit.runner.Description

		interface KaspressoLateRunListener : KaspressoRunListener {

#404: Using documents to avoid storage restrictions #423

#404: Using documents to avoid storage restrictions #423

Conversation

Nikitae57 commented Nov 15, 2022 • edited Loading

Choose a reason for hiding this comment

Nikitae57 Nov 18, 2022 • edited Loading

Choose a reason for hiding this comment

AzamatCherchesov commented Nov 18, 2022

Choose a reason for hiding this comment

eakurnikov Nov 23, 2022 • edited Loading

Choose a reason for hiding this comment

eakurnikov Nov 23, 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 23, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eakurnikov Nov 23, 2022 • edited Loading

Choose a reason for hiding this comment

eakurnikov commented 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

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

Nikitae57 Dec 1, 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Nikitae57 commented Nov 15, 2022 •

edited

Loading

Nikitae57 Nov 18, 2022 •

edited

Loading

eakurnikov Nov 23, 2022 •

edited

Loading

eakurnikov Nov 23, 2022 •

edited

Loading

eakurnikov Nov 23, 2022 •

edited

Loading

eakurnikov Nov 23, 2022 •

edited

Loading

eakurnikov commented Nov 30, 2022 •

edited

Loading

Nikitae57 Dec 1, 2022 •

edited

Loading