Screenshot file suffix as parameter in library init (#236)

* add keyword to modify screenshot file suffix

* screenshot file suffix as library import argument

* update changelog to new screenshot file suffix keyword

* run of robotidy

Author: GeoGegl

CHANGELOG.md

@@ -7,6 +7,12 @@ This document follows the conventions laid out in [Keep a CHANGELOG][].
 
 ## [Unreleased][]
 
+### Added
+
+- [#234] (https://github.com/GDATASoftwareAG/robotframework-flaui/pull/234) New keyword to set screenshot file suffix
+  - Set Screenshot File Suffix  <SUFFIX>
+- [] () Include screenshot_suffix as parameter in library init.
+
 ## [Release][4.0.0] [4.0.0][3.7.0-4.0.0] - 2025-04-26
 
 ### Updated

atests/Screenshot.robot

@@ -135,4 +135,5 @@ Reset Screenshot Environment To Default
     Set Screenshot Log Mode    File
     Take Screenshots On Failure    ${True}
     Set Screenshot Directory
+    Set Screenshot File Suffix
     Run Keyword And Ignore Error    Stop Application    ${pid}

atests/ScreenshotFileSuffix.robot

@@ -0,0 +1,46 @@
+*** Settings ***
+Documentation       Test suite for screenshot keywords.
+...                 XPath not found error handling for all keywords must be implemented under ErrorHandling.robot
+...
+
+Library             Process
+Library             String
+Library             OperatingSystem
+Library             StringFormat
+Library             FlaUILibrary    uia=${UIA}    screenshot_on_failure=True    screenshot_suffix=png
+Resource            util/Common.resource
+Resource            util/Error.resource
+Resource            util/XPath.resource
+
+
+*** Variables ***
+${SCREENSHOT_FOLDER}    screenshots/default
+
+
+*** Test Cases ***
+Take Screenshot Of Window As Png From Library Import
+    [Setup]    Start Application
+    ${PID}    Attach Application By Name    ${TEST_APP}
+    Set Screenshot Directory    ${SCREENSHOT_FOLDER}
+    ${FILENAME}    Get Expected Filename    ${TEST_NAME}    png
+    File Should Not Exist    ${OUTPUT DIR}/${SCREENSHOT_FOLDER}/${FILENAME}
+    Take Screenshot    ${MAIN_WINDOW}
+    File Should Exist    ${OUTPUT DIR}/${SCREENSHOT_FOLDER}/${FILENAME}
+    [Teardown]    Run Keyword And Ignore Error    Stop Application    ${PID}
+
+
+*** Keywords ***
+Get Expected Filename
+    [Arguments]    ${TEST_FILENAME}    ${SUFFIX}=jpg
+    ${FILENAME}    Convert To Lowercase    ${TEST_FILENAME}
+    ${HOSTNAME}    Convert To Lowercase    %{COMPUTERNAME}
+
+    Should Be Lowercase    ${FILENAME}
+
+    ${FILENAME}    Replace String    ${FILENAME}    ${space}    _
+    ${FILENAME}    Catenate    SEPARATOR=_    ${HOSTNAME}    ${FILENAME}
+    ${FILENAME}    Catenate    SEPARATOR=_    test    ${FILENAME}
+    ${FILENAME}    Catenate    SEPARATOR=_    ${FILENAME}    [0-9]*
+    ${FILENAME}    Catenate    SEPARATOR=.    ${FILENAME}    ${SUFFIX}
+
+    RETURN    ${FILENAME}

src/FlaUILibrary/__init__.py

@@ -107,7 +107,8 @@ def __init__(self,
                  screenshot_on_failure='True',
                  screenshot_dir=None,
                  timeout=1000,
-                 screenshot_mode='FILE'):
+                 screenshot_mode='FILE',
+                 screenshot_suffix='jpg'):
         """
         FlaUiLibrary can be imported by following optional arguments:
 
@@ -116,6 +117,7 @@ def __init__(self,
         ``screenshot_dir`` is the directory where screenshots are saved.
         ``timeout`` maximum amount of waiting time in ms for an element find action. Default value is 1000ms.
         ``screenshot_mode`` screenshot mode how to persist screenshots as FILE or BASE64
+        ``screenshot_suffix`` screenshot file type and suffix for screenshots saved as FILE
 
         If the given directory does not already exist, it will be created when the first screenshot is taken.
         If the argument is not given, the default location for screenshots is the output directory of the Robot run,
@@ -148,7 +150,8 @@ def __init__(self,
             FlaUILibrary.KeywordModules.SCREENSHOT: ScreenshotKeywords(self.container,
                                                                        screenshot_dir,
                                                                        screenshot_on_failure == 'True',
-                                                                       screenshot_mode),
+                                                                       screenshot_mode,
+                                                                       screenshot_suffix),
             FlaUILibrary.KeywordModules.TEXTBOX: TextBoxKeywords(self.container),
             FlaUILibrary.KeywordModules.WINDOW: WindowKeywords(self.container),
             FlaUILibrary.KeywordModules.RADIOBUTTON: RadioButtonKeywords(self.container),

src/FlaUILibrary/keywords/screenshot.py

@@ -12,18 +12,21 @@ def __init__(self,
                  container: AutomationInterfaceContainer,
                  directory: str,
                  is_enabled: bool,
-                 mode: str):
+                 mode: str,
+                 suffix: str):
         """Creates screenshot keywords module to handle image capturing.
 
         ``container`` User automation container to handle element interaction
         ``directory`` Screenshot directory to set.
         ``is_enabled`` Flag to identify if feature is active or not.
         ``mode`` Mode how to persists screenshots.
+        ``suffix`` File type and suffix for writing.
         """
         self._container = container
         self.set_screenshot_directory(directory)
         self.take_screenshots_on_failure(is_enabled)
         self.set_screenshot_log_mode(mode)
+        self.set_screenshot_file_suffix(suffix)
 
     @keyword
     def get_screenshot_log_mode(self):