Automatically screenshot taken when a test fails

Author: Matécsa Dániel

points.yml

@@ -19,11 +19,9 @@ student:
 # This has no effect on your grade.
 # ----------------------------------------------------------
 ai_usage:
-  used: false
-  tools: ""           # e.g. "Claude, GitHub Copilot"
-  description: ""     # e.g. "Used Claude to generate initial Page Object 
-                       #  classes, then modified them manually. Used Copilot 
-                       #  for autocomplete while writing test methods."
+  used: true
+  tools: "GitHub Copilot, Gemini"           # e.g. "Claude, GitHub Copilot"
+  description: "Copilot was used for autocomplete when writing test methods. Gemini was used to help implement advanced tasks."     
 
 # ----------------------------------------------------------
 # Quality requirements (gatekeepers)
@@ -192,7 +190,7 @@ advanced:
     link: "https://www.selenium.dev/selenium/docs/api/java/org/openqa/selenium/JavascriptExecutor.html"
 
   screenshot_on_failure:     # 6 pts | once
-    done: false
+    done: true
     description: "Automatically take a screenshot when a test fails (e.g. using a TestNG ITestListener)"
     link: "https://www.browserstack.com/guide/take-screenshots-in-selenium"
 

tests/mytests/src/test/java/tests/ScreenshotTest.java

@@ -0,0 +1,35 @@
+package tests;
+
+import java.net.MalformedURLException;
+
+import org.testng.annotations.*;
+import org.testng.*;
+
+import pages.*;
+
+public class ScreenshotTest extends TestBase {
+
+    @BeforeMethod
+    public void Setup() throws MalformedURLException
+    {
+        before();
+    }
+
+    @Test
+    public void screenshotTest() {
+        LoginPage loginPage = null;
+        
+        loginPage = login(loginPage);
+        
+        MainPage mainPage = loginPage.clickLogin();
+
+        Assert.assertTrue(mainPage.getBodyText().contains("This text will surely not be found on the page!"));
+
+    }
+
+    @AfterMethod
+    public void close() {
+        after();
+    }
+
+}

tests/mytests/src/test/java/tests/TestBase.java

@@ -5,13 +5,16 @@
 import org.openqa.selenium.*;
 import org.openqa.selenium.chrome.*;
 import org.openqa.selenium.remote.RemoteWebDriver;
+import org.testng.annotations.Listeners;
+
 import java.net.URL;
 import java.util.Map;
 import java.net.MalformedURLException;
 
 import pages.LoginPage;
 import utils.ConfigReader;
 
+@Listeners(utils.TestListener.class)
 public class TestBase {
 
     protected WebDriver driver;
@@ -50,4 +53,7 @@ protected LoginPage login(LoginPage loginPage) {
         return loginPage;
     }
 
+    public WebDriver getDriver() {
+        return this.driver;
+    }
 }

tests/mytests/src/test/java/utils/TestListener.java

@@ -0,0 +1,40 @@
+package utils;
+
+import org.openqa.selenium.OutputType;
+import org.openqa.selenium.TakesScreenshot;
+import org.openqa.selenium.WebDriver;
+import org.testng.ITestResult;
+import org.testng.TestListenerAdapter;
+
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.StandardCopyOption;
+
+import tests.TestBase;
+
+public class TestListener extends TestListenerAdapter {
+    @Override
+    public void onTestFailure(ITestResult tr) {
+        String methodName = tr.getMethod().getMethodName();
+        String fileWithPath = methodName + "_error.png";
+
+        Object testClass = tr.getInstance();
+        WebDriver driver = ((TestBase) testClass).getDriver();
+
+        if (driver != null) {
+            try {
+                TakesScreenshot scrShot = ((TakesScreenshot) driver);
+                File SrcFile = scrShot.getScreenshotAs(OutputType.FILE);
+                File DestFile = new File(fileWithPath);
+                
+                Files.copy(SrcFile.toPath(), DestFile.toPath(), StandardCopyOption.REPLACE_EXISTING);
+                System.out.println("Screenshot saved to: " + DestFile.getAbsolutePath());
+                
+            } catch (IOException e) {
+                System.out.println("Error: screenshot could not be saved.");
+                e.printStackTrace();
+            }
+        }
+    }
+}