[WIP] Screenshots and screen recordings of tests #541
Conversation
--take-screenshots and --record-videos flags can be passed to `detox test' to produce screenshots and videos of tests.
detox/src/devices/EmulatorDriver.js
Outdated
|
|
||
| function spawnRecording(width, height) { | ||
| return adb.spawn(deviceId, [ | ||
| 'shell', 'screenrecord', '--size', width + 'x' + height, '--verbose', '/sdcard/recording.mp4' |
There was a problem hiding this comment.
from https://developer.android.com/studio/command-line/adb.html
"Sets the video size: 1280x720. The default value is the device's native display resolution (if supported), 1280x720 if not. For best results, use a size supported by your device's Advanced Video Coding (AVC) encoder."
Did you encounter any issues with default values ?
Why do you use twice the native resolution for recording ?
There was a problem hiding this comment.
It was left over from my tests, will be removed.
|
This PR relates to #171 |
detox/src/devices/EmulatorDriver.js
Outdated
| async stopVideo(deviceId) { | ||
| if (this._video) { | ||
| this._video.kill(2); | ||
| await this.adb.adbCmd(deviceId, 'shell sleep 1'); |
There was a problem hiding this comment.
I removed this line and saw the corrupted videos you talked about.
The thing is, this slows down the tests a lot!
I am trying to think of a way to mitigate the penalty:
- Let's create each file on the device with a different name.
- when test is done, create a copy+cleanup task
- add this task to a queue and let this queue run independently of the test lifecycle.
WDYT ?
New spawnAndLog() utility. Couple of ADB methods for specific adb commands.
This avoids video corruption problems for Android, but requires more space to be available on /sdcard (or /tmp for iOS tests.)
|
Awesome job @donataswix! Question - I looked at the PR but I can't see the flexibility to give the screenshot (or video) a name. As an example, If I want to document a user journey and have screenshots taken at different screens, I might want to name them "login", "profile", "settings" or something similar. Could you add that to the PR? |
|
All artifacts are being picked up by ArtifactsCopier, which then renames them with the same name as the test description. |
|
@rotemmiz I see several issues with that, it will conflict (overwrite) or have "test description 1|2|3.png" if you would do several screenshot calls in the same test (assuming you can call it imperatively in the test). It also dictates the name itself which I don't see the need for, defaulting to the test description could work (although it might lead to long file names). However, providing that functionality can come in a later PR but it would be nice to add it in this one. I can see it adding value for several use cases. |
|
@Cederman this should work: it('...', () => {
// do something
await device._takeScreenshot('between-things');
// do another thing
});As you can tell by the |
Now it's possible to record videos and screenshots when running on device.
Screenshots and videos will be saved only for failed tests if "failing" value is passed to --take-screenshots and --record-videos respectively. This requires that detox is given success indication in afterEach() callback inside init.js file.
|
Hello, any more progress on this? We've just picked up Detox and think it's great but we need the screenshot functionality to do visual regression and user flow testing. |
|
I hope we will merge this by the end of the week. |
|
any chance on this getting merged soon? I know you guys are pretty busy, happy to help out fixing the conflicts if needed. |
|
Do you guys need any help with this? Would be really nice to have. |
|
Hi! It'd be great to get this in! We'd love to use it. We're happy to contribute, if you let us know what needs to be done in order to merge it, we'll look into it as well. |
|
Closing this in favor of #734 |
No description provided.