Merge pull request #115 from telekom/bugfix/window-size

Renamed property tt.display.resolution to tt.window.size.

Author: Mike Reiche

core-interop/src/main/java/eu/tsystems/mms/tic/testframework/constants/TesterraProperties.java

@@ -205,7 +205,9 @@ private TesterraProperties() {
     public static final String FAILURE_CORRIDOR_ALLOWED_FAILED_TESTS_MID = "tt.failure.corridor.allowed.failed.tests.mid";
     public static final String FAILURE_CORRIDOR_ALLOWED_FAILED_TESTS_LOW = "tt.failure.corridor.allowed.failed.tests.low";
 
+    @Deprecated
     public static final String DISPLAY_RESOLUTION = "tt.display.resolution";
+    public static final String WINDOW_SIZE="tt.window.size";
 
     public static final String PAGE_FACTORY_LOOPS = "tt.page.factory.loops";
     public static final String EXECUTION_OMIT_IN_DEVELOPMENT = "tt.execution.omit.indevelopment";

core/src/main/java/eu/tsystems/mms/tic/testframework/internal/Defaults.java

@@ -16,6 +16,7 @@
 :browser_maximize:                              tt.browser.maximize
 :browser_maximize_position:                     tt.browser.maximize.position
 :display_resolution:                            tt.display.resolution
+:window_size:                                   tt.window.size
 :wdm_closewindows_aftertestmethods:             tt.wdm.closewindows.aftertestmethods
 :wdm_closewindows_onfailure:                    tt.wdm.closewindows.onfailure
 :wdm_timeouts_window_switch:                    tt.wdm.timeouts.seconds.window.switch.duration

docs/src/docs/properties/property-attributes.adoc

@@ -31,8 +31,8 @@ This setting overrides the following two properties.
 | {selenium_server_port} | 4444 | The port of the remote Selenium server.
 | {browser_maximize} | false | Try to maximize the browser window.
 | {browser_maximize_position} | self | Screen position for the window to maximize. If you have several screens and want to maximize the window on another screen than your default screen, you can choose between (left, right, top or bottom)
-| {display_resolution} | 1920x1200 | Fall-back resolution, if maximize does not work. +
-For custom window browser size use `driver.manage().window().setSize(new Dimensions(x, y))`
+| {window_size} | 1920x1080 | Default window size for all new sessions (when {browser_maximize} is `false`).
+| {display_resolution} | 1920x1080 | Deprecated by {window_size}
 | {wdm_closewindows_aftertestmethods} | true | If true, after every test method all open browser windows are closed.
 | {wdm_closewindows_onfailure} | true | If true, after failed test methods all open browser windows are closed
 | {wdm_timeouts_window_switch} | 5 | Maximum duration to wait for on a `WebDriverUtils.findWindowAndSwitchTo()` in seconds.

docs/src/docs/properties/webdriver-props.adoc

@@ -31,7 +31,6 @@
 import eu.tsystems.mms.tic.testframework.enums.Position;
 import eu.tsystems.mms.tic.testframework.exceptions.SetupException;
 import eu.tsystems.mms.tic.testframework.exceptions.SystemException;
-import eu.tsystems.mms.tic.testframework.internal.Defaults;
 import eu.tsystems.mms.tic.testframework.internal.Flags;
 import eu.tsystems.mms.tic.testframework.internal.StopWatch;
 import eu.tsystems.mms.tic.testframework.internal.utils.DriverStorage;
@@ -224,10 +223,10 @@ public void setupSession(EventFiringWebDriver eventFiringWebDriver, DesktopWebDr
                 }
             } catch (Throwable t1) {
                 log().error("Could not maximize window", t1);
-                setWindowSizeBasedOnDisplayResolution(window, browser);
+                setWindowSizeBasedOnDisplayResolution(window, request);
             }
         } else {
-            setWindowSizeBasedOnDisplayResolution(window, browser);
+            setWindowSizeBasedOnDisplayResolution(window, request);
         }
 
         if (!Browsers.safari.equalsIgnoreCase(browser)) {
@@ -248,33 +247,28 @@ public void setupSession(EventFiringWebDriver eventFiringWebDriver, DesktopWebDr
         }
     }
 
-    private void setWindowSizeBasedOnDisplayResolution(WebDriver.Window window, String browser) {
-        log().debug("Trying to set window size to: " + Defaults.DISPLAY_RESOLUTION);
-        String[] split = Defaults.DISPLAY_RESOLUTION.split("x");
-        int width = Integer.parseInt(split[0]);
-        int height = Integer.parseInt(split[1]);
+    private void setWindowSize(WebDriver.Window window, Dimension dimension) {
+        window.setPosition(new Point(0, 0));
+        window.setSize(dimension);
+    }
+
+    private void setWindowSizeBasedOnDisplayResolution(WebDriver.Window window, DesktopWebDriverRequest request) {
+        Dimension dimension = request.getWindowSize();
+
         try {
-            window.setSize(new Dimension(width, height));
-        } catch (Throwable t2) {
-            log().error("Could not set window size", t2);
+            setWindowSize(window, dimension);
+        } catch (Throwable t) {
+            log().error("Could not set window size", t);
 
-            if (Browsers.edge.equals(browser)) {
-                log().debug("Edge Browser was requested, trying a second workaround");
+            if (Browsers.edge.equals(request.getBrowser())) {
+                log().debug("Edge Browser was requested, trying workaround");
 
                 Timer timer = new Timer(500, 5000);
                 ThrowablePackedResponse<Object> response = timer.executeSequence(new Timer.Sequence<Object>() {
                     @Override
                     public void run() throws Throwable {
                         setSkipThrowingException(true);
-                        log().debug("Trying setPosition() and setSize()");
-                        try {
-                            window.setPosition(new Point(0, 0));
-                            window.setSize(new Dimension(width, height));
-                            log().debug("Yup, success!");
-                        } catch (Exception e) {
-                            log().warn("Nope. Got error: " + e.getMessage());
-                            throw e;
-                        }
+                        setWindowSize(window, dimension);
                     }
                 });
 

driver-ui-desktop/src/main/java/eu/tsystems/mms/tic/testframework/webdrivermanager/DesktopWebDriverFactory.java

@@ -30,6 +30,9 @@
 import java.net.MalformedURLException;
 import java.net.URL;
 import java.util.Optional;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import org.openqa.selenium.Dimension;
 
 public class DesktopWebDriverRequest extends AbstractWebDriverRequest implements Loggable, Serializable {
 
@@ -73,4 +76,25 @@ public DesktopWebDriverRequest setWebDriverMode(WebDriverMode webDriverMode) {
     public Optional<URL> getServerUrl() {
         return Optional.ofNullable(this.getSeleniumServerUrl());
     }
+
+    public Dimension getWindowSize() {
+        int width = 1920;
+        int height = 1080;
+
+        String windowSizeProperty = PropertyManager.getProperty(TesterraProperties.WINDOW_SIZE, PropertyManager.getProperty(TesterraProperties.DISPLAY_RESOLUTION));
+
+        if (windowSizeProperty != null) {
+            Pattern pattern = Pattern.compile("(\\d+)x(\\d+)");
+            Matcher matcher = pattern.matcher(windowSizeProperty);
+
+            if (matcher.find()) {
+                width = Integer.parseInt(matcher.group(1));
+                height = Integer.parseInt(matcher.group(2));
+            } else {
+                log().error(String.format("Unable to parse property %s=%s, falling back to default", TesterraProperties.WINDOW_SIZE, windowSizeProperty));
+            }
+        }
+
+        return new Dimension(width, height);
+    }
 }

driver-ui-desktop/src/main/java/eu/tsystems/mms/tic/testframework/webdrivermanager/DesktopWebDriverRequest.java

@@ -22,12 +22,16 @@
  package eu.tsystems.mms.tic.testframework.test.layoutcheck;
 
 import eu.tsystems.mms.tic.testframework.AbstractTestSitesTest;
+import eu.tsystems.mms.tic.testframework.common.PropertyManager;
+import eu.tsystems.mms.tic.testframework.constants.TesterraProperties;
 import eu.tsystems.mms.tic.testframework.core.testpage.TestPage;
 import eu.tsystems.mms.tic.testframework.exceptions.TimeoutException;
 import eu.tsystems.mms.tic.testframework.layout.LayoutCheck;
 import eu.tsystems.mms.tic.testframework.pageobjects.GuiElement;
 import eu.tsystems.mms.tic.testframework.pageobjects.Locate;
 import eu.tsystems.mms.tic.testframework.webdrivermanager.WebDriverManager;
+import org.openqa.selenium.Dimension;
+import org.openqa.selenium.WebDriver;
 import org.testng.Assert;
 import org.testng.annotations.Test;
 

integration-tests/src/test/java/eu/tsystems/mms/tic/testframework/test/layoutcheck/LayoutCheckTest.java

@@ -30,6 +30,7 @@
 import eu.tsystems.mms.tic.testframework.webdrivermanager.DesktopWebDriverRequest;
 import eu.tsystems.mms.tic.testframework.webdrivermanager.WebDriverManager;
 import eu.tsystems.mms.tic.testframework.webdrivermanager.WebDriverSessionsManager;
+import org.openqa.selenium.Dimension;
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.chrome.ChromeDriver;
 import org.openqa.selenium.chrome.ChromeOptions;
@@ -167,4 +168,23 @@ public void testT06_clonedWebDriverRequest() {
         clonedCaps.setCapability(capKey, "newValue");
         Assert.assertNotEquals(clonedCaps.getCapability(capKey), baseCaps.getCapability(capKey));
     }
+
+    @Test
+    public void test_WindowSize() {
+        assertNewWebDriverWindowSize(new Dimension(800, 600));
+        PropertyManager.getThreadLocalProperties().setProperty(TesterraProperties.WINDOW_SIZE, "katze");
+        assertNewWebDriverWindowSize(new Dimension(1920, 1080));
+        PropertyManager.getThreadLocalProperties().setProperty(TesterraProperties.WINDOW_SIZE, "1024x768");
+        assertNewWebDriverWindowSize(new Dimension(1024, 768));
+
+        PropertyManager.clearThreadlocalProperties();
+    }
+
+    private void assertNewWebDriverWindowSize(Dimension expected) {
+        WebDriver webDriver = WebDriverManager.getWebDriver();
+        Dimension size = webDriver.manage().window().getSize();
+        Assert.assertEquals(size.getWidth(), expected.getWidth());
+        Assert.assertEquals(size.getHeight(), expected.getHeight());
+        WebDriverManager.shutdown();
+    }
 }

integration-tests/src/test/java/eu/tsystems/mms/tic/testframework/test/webdrivermanager/WebDriverManagerTest.java

@@ -3,7 +3,7 @@ tt.browser=chromeHeadless
 #tt.browser=chrome
 #tt.browser=firefox
 tt.browser.maximize=false
-tt.display.resolution=800x600
+tt.window.size=800x600
 
 tt.element.timeout.seconds=5
 tt.screencaster.active=false