Add "SCREENSHOT_WITH_BACKGROUND" to settings

mdmintz · mdmintz · commit 929aa95cd9ba · 2023-07-18T11:46:27.000-04:00
diff --git a/seleniumbase/config/settings.py b/seleniumbase/config/settings.py
@@ -37,6 +37,13 @@
 # If False, only the downloads from the most recent run will be saved locally.
 ARCHIVE_EXISTING_DOWNLOADS = False
 
+# If True, the last page screenshot will include the <body> and background.
+# If False, the last page screenshot will only include the <body> section.
+# Depending on the screen size, including a background could make the <body>
+# appear very small in the screenshot, which may require manually zooming in
+# on the <body> to see page details if you decide to include the background.
+SCREENSHOT_WITH_BACKGROUND = False
+
 # Default names for files saved during test failures.
 # (These files will get saved to the "latest_logs/" folder.)
 SCREENSHOT_NAME = "screenshot.png"
diff --git a/seleniumbase/core/settings_parser.py b/seleniumbase/core/settings_parser.py
@@ -75,6 +75,8 @@ def set_settings(settings_file):
             settings.ARCHIVE_EXISTING_LOGS = override_settings[key]
         elif key == "ARCHIVE_EXISTING_DOWNLOADS":
             settings.ARCHIVE_EXISTING_DOWNLOADS = override_settings[key]
+        elif key == "SCREENSHOT_WITH_BACKGROUND":
+            settings.SCREENSHOT_WITH_BACKGROUND = override_settings[key]
         elif key == "SCREENSHOT_NAME":
             settings.SCREENSHOT_NAME = override_settings[key]
         elif key == "BASIC_INFO_NAME":
diff --git a/seleniumbase/fixtures/base_case.py b/seleniumbase/fixtures/base_case.py
@@ -14030,7 +14030,17 @@ def __set_last_page_screenshot(self):
                         ignore_test_time_limit=True,
                     )
                 try:
-                    self.__last_page_screenshot = element.screenshot_as_base64
+                    if (
+                        hasattr(settings, "SCREENSHOT_WITH_BACKGROUND")
+                        and settings.SCREENSHOT_WITH_BACKGROUND
+                    ):
+                        self.__last_page_screenshot = (
+                            self.driver.get_screenshot_as_base64()
+                        )
+                    else:
+                        self.__last_page_screenshot = (
+                            element.screenshot_as_base64
+                        )
                 except Exception:
                     try:
                         self.__last_page_screenshot = (
