Skip to content

Stop calls to addGifFrameAsyncDelay to prevent collection of screenshots #688

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 26, 2025
Merged

Stop calls to addGifFrameAsyncDelay to prevent collection of screenshots #688

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e583e20
stop calls to addGifFrameAsyncDelay to prevent collection of screenshots
Mar 25, 2025
d5ad0e8
cleanup
Mar 25, 2025
253082f
fixed error and added TODO
Mar 25, 2025
dc44fa1
get and set Gif file path only when isDisableGifEncoder is false
Mar 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion agent/src/main/java/com/microsoft/hydralab/agent/runner/TestRunner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,9 @@ public void setup(TestTask testTask, TestRun testRun) throws Exception {
testRunDeviceOrchestrator.grantAllTaskNeededPermissions(testRunDevice, testTask, testRun.getLogger());

checkTestTaskCancel(testTask);
testRunDeviceOrchestrator.getScreenShot(testRunDevice, agentManagementService.getScreenshotDir(), testRun.getLogger());
if (!testTask.isDisableGifEncoder()) {
testRunDeviceOrchestrator.getScreenShot(testRunDevice, agentManagementService.getScreenshotDir(), testRun.getLogger());
}

if (performanceTestManagementService != null && testTask.getInspectionStrategies() != null) {
for (InspectionStrategy strategy : testTask.getInspectionStrategies()) {
Expand Down
4 changes: 3 additions & 1 deletion agent/src/main/java/com/microsoft/hydralab/agent/runner/appium/AppiumListener.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,9 @@ public void testStarted(Description description) {

testRun.addNewTestUnit(ongoingTestUnit);

testRunDeviceOrchestrator.addGifFrameAsyncDelay(testRunDevice, agentManagementService.getScreenshotDir(), 5, logger);
if (!testTask.isDisableGifEncoder()) {
testRunDeviceOrchestrator.addGifFrameAsyncDelay(testRunDevice, agentManagementService.getScreenshotDir(), 5, logger);
}
performanceTestListener.testStarted(ongoingTestUnit.getTitle());
}

Expand Down
8 changes: 6 additions & 2 deletions agent/src/main/java/com/microsoft/hydralab/agent/runner/appium/AppiumRunner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,9 @@ protected File runAndGetGif(File appiumJarFile, String appiumCommand, TestRunDev
checkTestTaskCancel(testTask);
startJunit5(appiumJarFile, appiumCommand, junit5Listener, reportLogger);
checkTestTaskCancel(testTask);
gifFile = junit5Listener.getGifFile();
if (!testTask.isDisableGifEncoder()) {
gifFile = junit5Listener.getGifFile();
}
} else {
/** xml report: parse listener */
reportLogger.info("Start init listener");
Expand All @@ -124,7 +126,9 @@ protected File runAndGetGif(File appiumJarFile, String appiumCommand, TestRunDev
checkTestTaskCancel(testTask);
startJunit(appiumJarFile, appiumCommand, listener, reportLogger);
checkTestTaskCancel(testTask);
gifFile = listener.getGifFile();
if (!testTask.isDisableGifEncoder()) {
gifFile = listener.getGifFile();
}
}
/** set paths */
String absoluteReportPath = deviceTestResultFolder.getAbsolutePath();
Expand Down
4 changes: 3 additions & 1 deletion agent/src/main/java/com/microsoft/hydralab/agent/runner/appium/Junit5Listener.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,9 @@ public void executionStarted(TestIdentifier testIdentifier) {

testRun.addNewTestUnit(ongoingTestUnit);

testRunDeviceOrchestrator.addGifFrameAsyncDelay(testRunDevice, agentManagementService.getScreenshotDir(), 5, logger);
if (!testTask.isDisableGifEncoder()) {
testRunDeviceOrchestrator.addGifFrameAsyncDelay(testRunDevice, agentManagementService.getScreenshotDir(), 5, logger);
}

performanceTestListener.testStarted(ongoingTestUnit.getTitle());
}
Expand Down
9 changes: 6 additions & 3 deletions agent/src/main/java/com/microsoft/hydralab/agent/runner/espresso/EspressoRunner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,9 +110,12 @@ public void processNewLines(@NotNull String[] lines) {
String absoluteReportPath = listener.getAbsoluteReportPath();
testRun.setTestXmlReportPath(
agentManagementService.getTestBaseRelPathInUrl(new File(absoluteReportPath)));
File gifFile = listener.getGifFile();
if (gifFile.exists() && gifFile.length() > 0) {
testRun.setTestGifPath(agentManagementService.getTestBaseRelPathInUrl(gifFile));

if (!testTask.isDisableGifEncoder()) {
File gifFile = listener.getGifFile();
if (gifFile.exists() && gifFile.length() > 0) {
testRun.setTestGifPath(agentManagementService.getTestBaseRelPathInUrl(gifFile));
}
}

} finally {
Expand Down
4 changes: 3 additions & 1 deletion .../java/com/microsoft/hydralab/agent/runner/espresso/EspressoTestInfoProcessorListener.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,9 @@ public void testStarted(TestIdentifier test) {

testRun.addNewTestUnit(ongoingTestUnit);

testRunDeviceOrchestrator.addGifFrameAsyncDelay(testRunDevice, agentManagementService.getScreenshotDir(), 5, logger);
if (!testTask.isDisableGifEncoder()) {
testRunDeviceOrchestrator.addGifFrameAsyncDelay(testRunDevice, agentManagementService.getScreenshotDir(), 5, logger);
}

performanceTestListener.testStarted(ongoingTestUnit.getTitle());
}
Expand Down
8 changes: 6 additions & 2 deletions agent/src/main/java/com/microsoft/hydralab/agent/runner/maestro/MaestroListener.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,9 @@ public void testRunStarted() {
testRunDeviceOrchestrator.setRunningTestName(testRunDevice, "MaestroTest.testRunStarted");
performanceTestListener.testRunStarted();
performanceTestListener.testStarted("MaestroTestCase" + index);
testRunDeviceOrchestrator.addGifFrameAsyncDelay(testRunDevice, agentManagementService.getScreenshotDir(), 5, logger);
if (!testTask.isDisableGifEncoder()) {
testRunDeviceOrchestrator.addGifFrameAsyncDelay(testRunDevice, agentManagementService.getScreenshotDir(), 5, logger);
}
}

private void initUnitCase(String caseName, int testSeconds) {
Expand All @@ -75,7 +77,9 @@ private void initUnitCase(String caseName, int testSeconds) {
testRun.addNewTimeTag(unitIndex + ". " + ongoingTestUnit.getTitle(),
System.currentTimeMillis() - testSeconds * 1000 - recordingStartTimeMillis);
testRunDeviceOrchestrator.setRunningTestName(testRunDevice, ongoingTestUnit.getTitle());
testRunDeviceOrchestrator.addGifFrameAsyncDelay(testRunDevice, agentManagementService.getScreenshotDir(), 5, logger);
if (!testTask.isDisableGifEncoder()) {
testRunDeviceOrchestrator.addGifFrameAsyncDelay(testRunDevice, agentManagementService.getScreenshotDir(), 5, logger);
}
performanceTestListener.testStarted("MaestroTestCase" + index);
}

Expand Down
8 changes: 5 additions & 3 deletions agent/src/main/java/com/microsoft/hydralab/agent/runner/maestro/MaestroRunner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,11 @@ protected void run(TestRunDevice testRunDevice, TestTask testTask, TestRun testR
/* set paths */
testRun.setTestXmlReportPath(
agentManagementService.getTestBaseRelPathInUrl(xmlFile));
File gifFile = maestroListener.getGifFile();
if (gifFile.exists() && gifFile.length() > 0) {
testRun.setTestGifPath(agentManagementService.getTestBaseRelPathInUrl(gifFile));
if (!testTask.isDisableGifEncoder()) {
File gifFile = maestroListener.getGifFile();
if (gifFile.exists() && gifFile.length() > 0) {
testRun.setTestGifPath(agentManagementService.getTestBaseRelPathInUrl(gifFile));
}
}
} catch (Exception e) {
logger.error("Maestro test failed", e);
Expand Down
12 changes: 8 additions & 4 deletions agent/src/main/java/com/microsoft/hydralab/agent/runner/monkey/AdbMonkeyRunner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,11 @@ protected void run(TestRunDevice testRunDevice, TestTask testTask, TestRun testR
/* set paths */
String absoluteReportPath = testRun.getResultFolder().getAbsolutePath();
testRun.setTestXmlReportPath(agentManagementService.getTestBaseRelPathInUrl(new File(absoluteReportPath)));
File gifFile = testRunDevice.getGifFile();
if (gifFile.exists() && gifFile.length() > 0) {
testRun.setTestGifPath(agentManagementService.getTestBaseRelPathInUrl(gifFile));
if (!testTask.isDisableGifEncoder()) {
File gifFile = testRunDevice.getGifFile();
if (gifFile.exists() && gifFile.length() > 0) {
testRun.setTestGifPath(agentManagementService.getTestBaseRelPathInUrl(gifFile));
}
}

}
Expand Down Expand Up @@ -124,7 +126,9 @@ public long runMonkeyTestOnce(TestRunDevice testRunDevice, TestTask testTask, Te
testRun.addNewTestUnit(ongoingMonkeyTest);

logger.info(ongoingMonkeyTest.getTitle());
testRunDeviceOrchestrator.addGifFrameAsyncDelay(testRunDevice, agentManagementService.getScreenshotDir(), 2, logger);
if (!testTask.isDisableGifEncoder()) {
testRunDeviceOrchestrator.addGifFrameAsyncDelay(testRunDevice, agentManagementService.getScreenshotDir(), 2, logger);
}
//run monkey test
testRun.addNewTimeTag(unitIndex + ". " + ongoingMonkeyTest.getTitle(),
System.currentTimeMillis() - testRun.getTestStartTimeMillis());
Expand Down
4 changes: 3 additions & 1 deletion agent/src/main/java/com/microsoft/hydralab/agent/runner/monkey/AppiumMonkeyRunner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,9 @@ protected File runAndGetGif(File appiumJarFile, String appiumCommand, TestRunDev
testRun.addNewTimeTag(1 + ". " + ongoingMonkeyTest.getTitle(),
System.currentTimeMillis() - recordingStartTimeMillis);
testRunDeviceOrchestrator.setRunningTestName(testRunDevice, ongoingMonkeyTest.getTitle());
testRunDeviceOrchestrator.addGifFrameAsyncDelay(testRunDevice, agentManagementService.getScreenshotDir(), 5, logger);
if (!testTask.isDisableGifEncoder()) {
testRunDeviceOrchestrator.addGifFrameAsyncDelay(testRunDevice, agentManagementService.getScreenshotDir(), 5, logger);
}
testRun.setTestStartTimeMillis(System.currentTimeMillis());

performanceTestManagementService.testStarted(ongoingMonkeyTest.getTitle());
Expand Down
12 changes: 8 additions & 4 deletions agent/src/main/java/com/microsoft/hydralab/agent/runner/python/PythonRunner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,11 @@ protected void run(TestRunDevice testRunDevice, TestTask testTask, TestRun testR
/* set paths */
String absoluteReportPath = testRun.getResultFolder().getAbsolutePath();
testRun.setTestXmlReportPath(agentManagementService.getTestBaseRelPathInUrl(new File(absoluteReportPath)));
File gifFile = testRunDevice.getGifFile();
if (gifFile.exists() && gifFile.length() > 0) {
testRun.setTestGifPath(agentManagementService.getTestBaseRelPathInUrl(gifFile));
if (!testTask.isDisableGifEncoder()) {
File gifFile = testRunDevice.getGifFile();
if (gifFile.exists() && gifFile.length() > 0) {
testRun.setTestGifPath(agentManagementService.getTestBaseRelPathInUrl(gifFile));
}
}
}

Expand Down Expand Up @@ -146,7 +148,9 @@ public long runPythonTest(TestRunDevice testRunDevice, TestTask testTask, TestRu
testRun.addNewTestUnit(ongoingPythonTest);

logger.info(ongoingPythonTest.getTitle());
testRunDeviceOrchestrator.addGifFrameAsyncDelay(testRunDevice, agentManagementService.getScreenshotDir(), 2, logger);
if (!testTask.isDisableGifEncoder()) {
testRunDeviceOrchestrator.addGifFrameAsyncDelay(testRunDevice, agentManagementService.getScreenshotDir(), 2, logger);
}
//run Python test
testRun.addNewTimeTag(unitIndex + ". " + ongoingPythonTest.getTitle(),
System.currentTimeMillis() - testRun.getTestStartTimeMillis());
Expand Down
12 changes: 8 additions & 4 deletions agent/src/main/java/com/microsoft/hydralab/agent/runner/smart/SmartRunner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,11 @@ protected void run(TestRunDevice testRunDevice, TestTask testTask, TestRun testR
/* set paths */
String absoluteReportPath = testRun.getResultFolder().getAbsolutePath();
testRun.setTestXmlReportPath(agentManagementService.getTestBaseRelPathInUrl(new File(absoluteReportPath)));
File gifFile = testRunDevice.getGifFile();
if (gifFile.exists() && gifFile.length() > 0) {
testRun.setTestGifPath(agentManagementService.getTestBaseRelPathInUrl(gifFile));
if (!testTask.isDisableGifEncoder()) {
File gifFile = testRunDevice.getGifFile();
if (gifFile.exists() && gifFile.length() > 0) {
testRun.setTestGifPath(agentManagementService.getTestBaseRelPathInUrl(gifFile));
}
}

}
Expand Down Expand Up @@ -121,7 +123,9 @@ public void runSmartTestOnce(int i, TestRunDevice testRunDevice, TestTask testTa
testRun.addNewTimeTag(unitIndex + ". " + ongoingSmartTest.getTitle(), System.currentTimeMillis() - testRun.getTestStartTimeMillis());
testRunDeviceOrchestrator.setRunningTestName(testRunDevice, ongoingSmartTest.getTitle());
logger.info(ongoingSmartTest.getTitle());
testRunDeviceOrchestrator.addGifFrameAsyncDelay(testRunDevice, agentManagementService.getScreenshotDir(), 1, logger);
if (!testTask.isDisableGifEncoder()) {
testRunDeviceOrchestrator.addGifFrameAsyncDelay(testRunDevice, agentManagementService.getScreenshotDir(), 1, logger);
}

performanceTestManagementService.testStarted(ongoingSmartTest.getTitle());

Expand Down
1 change: 1 addition & 0 deletions agent/src/main/java/com/microsoft/hydralab/agent/runner/t2c/T2CRunner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@ private void runT2CJsonTestCase(File jsonFile, TestRunDevice testRunDevice, Test

performanceTestManagementService.testStarted(ongoingTest.getTitle());

// TODO do not call this method if testTask.isDisableGifEncoder() is true
testRunDeviceOrchestrator.addGifFrameAsyncDelay(testRunDevice, agentManagementService.getScreenshotDir(), 5, logger);

// Run Test
Expand Down
12 changes: 9 additions & 3 deletions agent/src/main/java/com/microsoft/hydralab/agent/runner/xctest/XCTestRunner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,9 @@ private ArrayList<String> runXctest(TestRunDevice testRunDevice, Logger logger,
if (testRunDevice.getDeviceInfo() == null) {
throw new RuntimeException("No such device: " + testRunDevice.getDeviceInfo());
}
testRunDeviceOrchestrator.addGifFrameAsyncDelay(testRunDevice, agentManagementService.getScreenshotDir(), 0, logger);
if (!testTask.isDisableGifEncoder()) {
testRunDeviceOrchestrator.addGifFrameAsyncDelay(testRunDevice, agentManagementService.getScreenshotDir(), 0, logger);
}
StringBuilder argString = new StringBuilder();
Map<String, String> instrumentationArgs = testTask.getTaskRunArgs();
if (instrumentationArgs != null && !instrumentationArgs.isEmpty()) {
Expand Down Expand Up @@ -138,7 +140,9 @@ private ArrayList<String> runXctest(TestRunDevice testRunDevice, Logger logger,
out.start();
proc.waitFor();
result = out.getResult();
testRunDeviceOrchestrator.addGifFrameAsyncDelay(testRunDevice, agentManagementService.getScreenshotDir(), 0, logger);
if (!testTask.isDisableGifEncoder()) {
testRunDeviceOrchestrator.addGifFrameAsyncDelay(testRunDevice, agentManagementService.getScreenshotDir(), 0, logger);
}
} catch (Exception e) {
throw new RuntimeException("Execute XCTest failed");
}
Expand Down Expand Up @@ -207,7 +211,9 @@ private void finishTest(TestRunDevice testRunDevice, TestTask testTask, TestRun
testRun.onTestEnded();
String absoluteReportPath = testRun.getResultFolder().getAbsolutePath();
testRun.setTestXmlReportPath(agentManagementService.getTestBaseRelPathInUrl(new File(absoluteReportPath)));
testRun.setTestGifPath(agentManagementService.getTestBaseRelPathInUrl(testRunDevice.getGifFile()));
if (!testTask.isDisableGifEncoder()) {
testRun.setTestGifPath(agentManagementService.getTestBaseRelPathInUrl(testRunDevice.getGifFile()));
}
if (!testTask.isDisableGifEncoder()) {
testRunDeviceOrchestrator.stopGitEncoder(testRunDevice, agentManagementService.getScreenshotDir(), testRun.getLogger());
}
Expand Down
Loading