Stop calls to addGifFrameAsyncDelay to prevent collection of screenshots (#688)

<!-- Please provide brief information about the PR, what it contains &
its purpose, new behaviours after the change. And let us know here if
you need any help: https://github.com/microsoft/HydraLab/issues/new -->

## Description
This Pull request makes use of `disableGifEncoder ` to avoid calls to
`addGifFrameAsyncDelay` to completely prevent any capture of
Screenshots. It disables the collection of screenshots during the test
runs when `disableGifEncoder ` is set to true.

### Linked GitHub issue ID: #  

## Pull Request Checklist
<!-- Put an x in the boxes that apply. This is simply a reminder of what
we are going to look for before merging your code. -->

- [ ] Tests for the changes have been added (for bug fixes / features)
- [x] Code compiles correctly with all tests are passed.
- [x] I've read the [contributing
guide](https://github.com/microsoft/HydraLab/blob/main/CONTRIBUTING.md#making-changes-to-the-code)
and followed the recommended practices.
- [ ] [Wikis](https://github.com/microsoft/HydraLab/wiki) or
[README](https://github.com/microsoft/HydraLab/blob/main/README.md) have
been reviewed and added / updated if needed (for bug fixes / features)

### Does this introduce a breaking change?
*If this introduces a breaking change for Hydra Lab users, please
describe the impact and migration path.*

- [ ] Yes
- [x] No

## How you tested it
*Please make sure the change is tested, you can test it by adding UTs,
do local test and share the screenshots, etc.*


Please check the type of change your PR introduces:
- [ ] Bugfix
- [x] Feature
- [ ] Technical design
- [ ] Build related changes
- [ ] Refactoring (no functional changes, no api changes)
- [ ] Code style update (formatting, renaming) or Documentation content
changes
- [ ] Other (please describe): 

### Feature UI screenshots or Technical design diagrams
*If this is a relatively large or complex change, kick it off by drawing
the tech design with PlantUML and explaining why you chose the solution
you did and what alternatives you considered, etc...*

---------

Co-authored-by: Ujjwal Srivastava <ujsrivastava@Mac.lan>

Author: ASPS002

agent/src/main/java/com/microsoft/hydralab/agent/runner/TestRunner.java

@@ -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()) {

agent/src/main/java/com/microsoft/hydralab/agent/runner/appium/AppiumListener.java

@@ -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());
     }
 

agent/src/main/java/com/microsoft/hydralab/agent/runner/appium/AppiumRunner.java

@@ -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");
@@ -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();

agent/src/main/java/com/microsoft/hydralab/agent/runner/appium/Junit5Listener.java

@@ -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());
     }

agent/src/main/java/com/microsoft/hydralab/agent/runner/espresso/EspressoRunner.java

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

agent/src/main/java/com/microsoft/hydralab/agent/runner/espresso/EspressoTestInfoProcessorListener.java

@@ -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());
     }

agent/src/main/java/com/microsoft/hydralab/agent/runner/maestro/MaestroListener.java

@@ -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) {
@@ -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);
     }
 

agent/src/main/java/com/microsoft/hydralab/agent/runner/maestro/MaestroRunner.java

@@ -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);

agent/src/main/java/com/microsoft/hydralab/agent/runner/monkey/AdbMonkeyRunner.java

@@ -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));
+            }
         }
 
     }
@@ -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());

agent/src/main/java/com/microsoft/hydralab/agent/runner/monkey/AppiumMonkeyRunner.java

@@ -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());