Add clientHints into the README example

Add ScreenshotListener for test failure analysis
Collect failure artifacts in the pipeline

Author: mialeska

README.md

@@ -96,6 +96,10 @@ It is also possible to set mobile emulation capabilities (for chromium-based bro
             "width": 660,
             "height": 1040,
             "pixelRatio": 3.0
+          },
+          "clientHints": {
+            "platform": "Android",
+            "mobile": true
           }
         },
         "unhandledPromptBehavior": "ignore"

azure-pipelines.yml

@@ -61,3 +61,21 @@ jobs:
       mavenAuthenticateFeed: false
       effectivePomSkip: false
       sonarQubeRunAnalysis: false
+
+  - task: CopyFiles@2
+    displayName: 'Copy failure screenshots and test logs'
+    inputs:
+      SourceFolder: '$(Build.SourcesDirectory)/target'
+      Contents: |
+        surefire-reports/failure_screenshots/*.png
+        log/*.log
+      TargetFolder: '$(Build.ArtifactStagingDirectory)'
+    condition: succeededOrFailed()
+
+  - task: PublishBuildArtifacts@1
+    displayName: 'Publish copied artifacts'
+    inputs:
+      PathtoPublish: '$(Build.ArtifactStagingDirectory)'
+      ArtifactName: 'drop'
+      publishLocation: 'Container'
+    condition: succeededOrFailed()

src/test/java/testreport/ScreenshotListener.java

@@ -0,0 +1,37 @@
+package testreport;
+
+import aquality.selenium.browser.AqualityServices;
+import org.apache.logging.log4j.core.util.FileUtils;
+import org.openqa.selenium.OutputType;
+import org.openqa.selenium.TakesScreenshot;
+import org.testng.ITestResult;
+import org.testng.Reporter;
+import org.testng.TestListenerAdapter;
+
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.text.SimpleDateFormat;
+import java.util.Calendar;
+
+public class ScreenshotListener extends TestListenerAdapter {
+    @Override
+    public void onTestFailure(ITestResult result) {
+        Calendar calendar = Calendar.getInstance();
+        SimpleDateFormat formatter = new SimpleDateFormat("dd_MM_yyyy_hh_mm_ss");
+        String dateString = formatter.format(calendar.getTime());
+        String methodName = result.getName();
+        if(!result.isSuccess() && AqualityServices.isBrowserStarted()){
+            File scrFile = ((TakesScreenshot)AqualityServices.getBrowser().getDriver()).getScreenshotAs(OutputType.FILE);
+            try {
+                String reportDirectory = String.format("%s/target/surefire-reports", new File(System.getProperty("user.dir")).getAbsolutePath());
+                File destFile = new File(String.format("%s/failure_screenshots/%s_%s.png", reportDirectory, methodName, dateString));
+                FileUtils.makeParentDirs(destFile);
+                Files.copy(scrFile.toPath(), destFile.toPath());
+                Reporter.log(String.format("<a href='%s'> <img src='%s' height='100' width='100'/> </a>", destFile.getAbsolutePath(), destFile.getAbsolutePath()));
+            } catch (IOException e) {
+                AqualityServices.getLogger().fatal("An IO exception occurred while tried to save a screenshot", e);
+            }
+        }
+    }
+}

src/test/java/tests/BaseTest.java

@@ -6,12 +6,15 @@
 import org.openqa.selenium.Dimension;
 import org.testng.annotations.AfterMethod;
 import org.testng.annotations.BeforeMethod;
+import org.testng.annotations.Listeners;
+import testreport.ScreenshotListener;
 import theinternet.TheInternetPage;
 
 import java.io.IOException;
 
 import static utils.FileUtil.getResourceFileByName;
 
+@Listeners(ScreenshotListener.class)
 public abstract class BaseTest {
     private static final String DEFAULT_URL = TheInternetPage.LOGIN.getAddress();