Issue 699 compose doc loc metadata #700
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| package com.kaspersky.kaspresso.docloc.metadata | ||
|
|
||
| internal data class Metadata(val window: Window) | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| package com.kaspersky.kaspresso.docloc.metadata.extractor | ||
|
|
||
| import com.kaspersky.kaspresso.docloc.metadata.Metadata | ||
|
|
||
| internal interface MetadataExtractor { | ||
| fun getMetadata(): Metadata | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| package com.kaspersky.kaspresso.docloc.metadata.extractor | ||
|
|
||
| import com.kaspersky.kaspresso.docloc.metadata.LocalizedString | ||
|
|
||
| internal class MetadataExtractorHelper { | ||
| fun resolveAmbiguous(localizedStrings: List<LocalizedString>): List<LocalizedString> { | ||
| return localizedStrings.groupBy { it.locValueDescription } | ||
| .values | ||
| .flatMap { groupedById -> | ||
| if (groupedById.size == 1) groupedById else addIndexes( | ||
| groupedById | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| private fun addIndexes(groupedById: List<LocalizedString>): List<LocalizedString> { | ||
| return groupedById.mapIndexed { index, locString -> | ||
| locString.copy(locValueDescription = "${locString.locValueDescription}$INDEX_SEPARATOR${index + 1}") | ||
| } | ||
| } | ||
|
|
||
| companion object { | ||
| private const val INDEX_SEPARATOR = '_' | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| package com.kaspersky.kaspresso.docloc.metadata.extractor | ||
|
|
||
| import android.app.Activity | ||
| import androidx.test.uiautomator.By | ||
| import androidx.test.uiautomator.StaleObjectException | ||
| import androidx.test.uiautomator.UiDevice | ||
| import com.kaspersky.kaspresso.device.activities.Activities | ||
| import com.kaspersky.kaspresso.docloc.metadata.LocalizedString | ||
| import com.kaspersky.kaspresso.docloc.metadata.Metadata | ||
| import com.kaspersky.kaspresso.docloc.metadata.Window | ||
| import com.kaspersky.kaspresso.logger.UiTestLogger | ||
|
|
||
| internal class UiMetadataExtractor( | ||
| private val uiDevice: UiDevice, | ||
| private val activities: Activities, | ||
| private val logger: UiTestLogger, | ||
| ) : MetadataExtractor { | ||
|
|
||
| private val metadataExtractorHelper = MetadataExtractorHelper() | ||
|
|
||
| override fun getMetadata(): Metadata { | ||
| val activity = activities.getResumed() ?: throw RuntimeException("Failed to get current activity") | ||
| return createMetadata(activity) | ||
| } | ||
|
|
||
| private fun createMetadata(activity: Activity): Metadata { | ||
| val localizedStrings = metadataExtractorHelper.resolveAmbiguous( | ||
| getLocalizedStrings() | ||
| ) | ||
| val window = activity.window.decorView.run { | ||
| Window( | ||
| left, | ||
| top, | ||
| width, | ||
| height, | ||
| localizedStrings | ||
| ) | ||
| } | ||
| return Metadata(window) | ||
| } | ||
|
|
||
| private fun getLocalizedStrings(): List<LocalizedString> { | ||
| uiDevice.setCompressedLayoutHierarchy(false) | ||
| val objectsWithText = uiDevice.findObjects(By.enabled(true)) | ||
|
There was a problem hiding this comment. 100% needs better UiObjects tree parsing. Probably would be better if we used recursion |
||
| .filterNotNull() | ||
| .filter { | ||
| try { | ||
| (it.resourceName != null && it.children.any { !it.text.isNullOrBlank() }) || | ||
| (!it.text.isNullOrBlank() && it.resourceName != null) | ||
| } catch (ex: StaleObjectException) { | ||
| logger.e("UiMetadataExtractor::getLocalizedStrings() - Error while loading object") | ||
| false | ||
| } | ||
| } | ||
|
|
||
| val localizedStrings = mutableListOf<LocalizedString>() | ||
| /* | ||
| There might be a case when the text itself won't have an ID, but rather the text container will. | ||
| For example if we set an id to the button, Ui automator will see it as a container with an id and a child - text view without an id | ||
|
|
||
| Probably buggy. Need better solution. | ||
| */ | ||
| for (obj in objectsWithText) { | ||
| try { | ||
| val resName = obj.resourceName ?: continue | ||
|
There was a problem hiding this comment. maybe it will be better to throw exception? Or we really need to skip item without res name? There was a problem hiding this comment. The idea is to pick the view that might be the text container or a text itself. Either way we need an id which might be nullable, but I don't think we have to throw an exception |
||
| if (obj.text.isNullOrBlank()) { // the text container | ||
| obj.children | ||
| .filter { !it.text.isNullOrBlank() } | ||
| .forEach { | ||
| val coords = it.visibleBounds | ||
| localizedStrings.add( | ||
| LocalizedString( | ||
| text = it.text, | ||
| locValueDescription = resName, | ||
| left = coords.left, | ||
| top = coords.top, | ||
| width = coords.width(), | ||
| height = coords.height(), | ||
| ) | ||
| ) | ||
| } | ||
| } else { // the text itself | ||
| val coords = obj.visibleBounds | ||
| localizedStrings.add( | ||
| LocalizedString( | ||
| text = obj.text, | ||
| locValueDescription = resName, | ||
| left = coords.left, | ||
| top = coords.top, | ||
| width = coords.width(), | ||
| height = coords.height(), | ||
| ) | ||
| ) | ||
| } | ||
| } catch (ex: StaleObjectException) { | ||
| logger.e("UiMetadataExtractor::getLocalizedStrings() - error while processing found objects") | ||
| } | ||
| } | ||
|
|
||
| return localizedStrings | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| package com.kaspersky.kaspresso.docloc.metadata.saver | ||
|
|
||
| import java.io.File | ||
|
|
||
| interface MetadataSaver { | ||
| fun saveScreenshotMetadata(folderPath: File, name: String) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
only import without usage?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is used in the consctructor. Before my changes MetadataSaver was in the same pachage as DocLocScreenshotCapturer. I made renamed it to the DefautMetadataSaver and extracted the interface MetadataSaver. Now it has to be imported