Full page screenshot support in Chrome

core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/resolution/ResolutionModifier.java

@@ -23,6 +23,7 @@
 import java.util.Map;
 import org.apache.commons.lang3.math.NumberUtils;
 import org.openqa.selenium.Dimension;
+import org.openqa.selenium.JavascriptExecutor;
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.WebDriver.Window;
 import org.slf4j.Logger;
@@ -34,23 +35,24 @@ public class ResolutionModifier implements CollectorJob {
 
   private static final Logger LOG = LoggerFactory.getLogger(ResolutionModifier.class);
 
-  private static final String PARAM_MAXIMIZE = "maximize";
-
   private static final String WIDTH_PARAM = "width";
 
   private static final String HEIGHT_PARAM = "height";
 
-  private static final int MAX_SIZE = 100000;
+  private static final String JAVASCRIPT_GET_BODY_HEIGHT = "return document.body.scrollHeight";
+
+  private static final int MAX_SIZE = 15000;
+
+  private static final int INITIAL_HEIGHT = 300;
+
+  private static final int HEIGHT_NOT_DEFINED = 0;
 
   private final WebDriver webDriver;
 
   private int width;
 
   private int height;
 
-  @Deprecated
-  private boolean maximize;
-
   public ResolutionModifier(WebDriver webDriver) {
     this.webDriver = webDriver;
   }
@@ -64,33 +66,32 @@ public CollectorStepResult collect() throws ProcessingException {
 
   @Override
   public void setParameters(Map<String, String> params) throws ParametersException {
-    String paramValue = params.get(PARAM_MAXIMIZE);
-    maximize = Boolean.valueOf(paramValue);
-
-    if (params.containsKey(WIDTH_PARAM) && params.containsKey(HEIGHT_PARAM)) {
+    if (params.containsKey(WIDTH_PARAM)) {
       width = NumberUtils.toInt(params.get(WIDTH_PARAM));
       ParametersValidator.checkRange(width, 1, MAX_SIZE, "Width should be greater than 0");
-
-      height = NumberUtils.toInt(params.get(HEIGHT_PARAM));
-      ParametersValidator.checkRange(height, 1, MAX_SIZE, "Height should be greater than 0");
-
-      ParametersValidator.checkParameter(!maximize,
-          "You cannot maximize the window and specify the dimension");
-    } else if (params.containsKey(WIDTH_PARAM) || params.containsKey(HEIGHT_PARAM)) {
-      throw new ParametersException("You have to specify both width and height");
+      if (params.containsKey(HEIGHT_PARAM)) {
+        height = NumberUtils.toInt(params.get(HEIGHT_PARAM));
+        ParametersValidator
+            .checkRange(height, 1, MAX_SIZE, "Height should be greater than 0 and smaller than " + MAX_SIZE);
+      }
+    } else {
+      throw new ParametersException("You have to specify width, height parameter is optional");
     }
   }
 
   private void setResolution(WebDriver webDriver) {
     Window window = webDriver.manage().window();
-    if (maximize) {
-      window.maximize();
-      LOG.error("Trying to maximise window to  {}x{}!", window.getSize().getWidth(),
-          window.getSize().getHeight());
-    } else {
-      LOG.info("Setting resolution to  {}x{}  ", width, height);
-      window.setSize(new Dimension(width, height));
+    if (height == HEIGHT_NOT_DEFINED) {
+      window.setSize(new Dimension(width, INITIAL_HEIGHT));
+      JavascriptExecutor js = (JavascriptExecutor) webDriver;
+      height = Integer
+          .parseInt(js.executeScript(JAVASCRIPT_GET_BODY_HEIGHT).toString());
+      if (height > MAX_SIZE) {
+        LOG.warn("Height is over browser limit, changing height to {}", MAX_SIZE);
+        height = MAX_SIZE;
+      }
     }
+    LOG.info("Setting resolution to  {}x{}  ", width, height);
+    window.setSize(new Dimension(width, height));
   }
-
 }

core/jobs/src/test/java/com/cognifide/aet/job/common/modifiers/resolution/ResolutionModifierTest.java

@@ -29,20 +29,22 @@
 import org.mockito.InjectMocks;
 import org.mockito.Mock;
 import org.mockito.runners.MockitoJUnitRunner;
+import org.openqa.selenium.Capabilities;
 import org.openqa.selenium.Dimension;
 import org.openqa.selenium.WebDriver;
+import org.openqa.selenium.remote.RemoteWebDriver;
 
 @RunWith(MockitoJUnitRunner.class)
 public class ResolutionModifierTest {
 
-  private static final String PARAM_MAXIMIZE = "maximize";
-
   private static final String WIDTH_PARAM = "width";
 
   private static final String HEIGHT_PARAM = "height";
 
   private static final String NOT_A_NUMBER = "NaN";
 
+  private static final String JAVASCRIPT_GET_BODY_HEIGHT = "return document.body.scrollHeight";
+
   private static final int WINDOW_WIDTH = 1024;
 
   private static final int WINDOW_HEIGHT = 768;
@@ -51,8 +53,13 @@ public class ResolutionModifierTest {
 
   private static final int CUSTOM_HEIGHT = 600;
 
+  private static final int BROWSER_HEIGHT_LIMIT = 15000;
+
+  @Mock
+  private RemoteWebDriver webDriver;
+
   @Mock
-  private WebDriver webDriver;
+  private Capabilities capabilities;
 
   @Mock
   private Map<String, String> params;
@@ -72,6 +79,7 @@ public class ResolutionModifierTest {
   @Before
   public void setUp() {
     when(webDriver.manage()).thenReturn(options);
+    when(webDriver.getCapabilities()).thenReturn(capabilities);
     when(options.window()).thenReturn(window);
     when(window.getSize()).thenReturn(windowDimension);
     when(windowDimension.getWidth()).thenReturn(WINDOW_WIDTH);
@@ -110,28 +118,6 @@ public void setParametersTest_height0() throws ParametersException {
     tested.setParameters(params);
   }
 
-  @Test(expected = ParametersException.class)
-  public void setParametersTest_maximizeWithWindowSize() throws ParametersException {
-    when(params.get(PARAM_MAXIMIZE)).thenReturn("true");
-    when(params.containsKey(HEIGHT_PARAM)).thenReturn(true);
-    when(params.get(HEIGHT_PARAM)).thenReturn("100");
-
-    tested.setParameters(params);
-  }
-
-  @Test
-  public void collectTest_maximize() throws ParametersException, ProcessingException {
-    when(params.get(PARAM_MAXIMIZE)).thenReturn("true");
-
-    tested.setParameters(params);
-    tested.collect();
-
-    verify(window, times(1)).maximize();
-    verify(windowDimension, times(1)).getWidth();
-    verify(windowDimension, times(1)).getHeight();
-    verify(window, never()).setSize(new Dimension(WINDOW_WIDTH, WINDOW_HEIGHT));
-  }
-
   @Test
   public void collectTest_setWidthHeight() throws ParametersException, ProcessingException {
     when(params.containsKey(HEIGHT_PARAM)).thenReturn(true);
@@ -142,25 +128,49 @@ public void collectTest_setWidthHeight() throws ParametersException, ProcessingE
     tested.setParameters(params);
     tested.collect();
 
-    verify(window, never()).maximize();
     verify(windowDimension, never()).getWidth();
     verify(windowDimension, never()).getHeight();
     verify(window, times(1)).setSize(new Dimension(CUSTOM_WIDTH, CUSTOM_HEIGHT));
   }
 
   @Test(expected = ParametersException.class)
-  public void collectTest_setOnlyHeight() throws ParametersException, ProcessingException {
+  public void collectTest_setOnlyHeight() throws ParametersException {
     when(params.containsKey(HEIGHT_PARAM)).thenReturn(true);
     when(params.get(HEIGHT_PARAM)).thenReturn("" + CUSTOM_HEIGHT);
-
     tested.setParameters(params);
   }
 
-  @Test(expected = ParametersException.class)
-  public void collectTest_setOnlyWidth() throws ParametersException, ProcessingException {
+  private void setUp_setOnlyWidth(){
     when(params.containsKey(WIDTH_PARAM)).thenReturn(true);
+    when(params.containsKey(HEIGHT_PARAM)).thenReturn(false);
     when(params.get(WIDTH_PARAM)).thenReturn("" + CUSTOM_WIDTH);
+  }
+
+  @Test
+  public void collectTest_setOnlyWidth() throws ParametersException, ProcessingException {
+    setUp_setOnlyWidth();
+    when(webDriver.executeScript(JAVASCRIPT_GET_BODY_HEIGHT))
+        .thenReturn(CUSTOM_HEIGHT);
 
     tested.setParameters(params);
+    tested.collect();
+
+    verify(windowDimension, never()).getWidth();
+    verify(windowDimension, never()).getHeight();
+    verify(window, times(1)).setSize(new Dimension(CUSTOM_WIDTH, CUSTOM_HEIGHT));
+  }
+
+  @Test
+  public void collectTest_setOnlyWidth_reachedBrowserHeightLimit() throws ParametersException, ProcessingException {
+    setUp_setOnlyWidth();
+    when(webDriver.executeScript(JAVASCRIPT_GET_BODY_HEIGHT))
+        .thenReturn(BROWSER_HEIGHT_LIMIT + 5000L);
+
+    tested.setParameters(params);
+    tested.collect();
+
+    verify(windowDimension, never()).getWidth();
+    verify(windowDimension, never()).getHeight();
+    verify(window, times(1)).setSize(new Dimension(CUSTOM_WIDTH, BROWSER_HEIGHT_LIMIT));
   }
 }

core/worker/src/main/java/com/cognifide/aet/worker/drivers/chrome/ChromeWebDriverFactory.java

@@ -136,6 +136,9 @@ private DesiredCapabilities setupCapabilities() {
 
     ChromeOptions options = new ChromeOptions();
     options.addArguments("--disable-plugins");
+    options.addArguments("--headless");
+    options.addArguments("--hide-scrollbars");
+    options.setAcceptInsecureCerts(true);
 
     capabilities.setCapability(ChromeOptions.CAPABILITY, options);
 

documentation/src/main/wiki/HideModifier.md

@@ -6,7 +6,8 @@ Module name: **hide**
 
 | ! Important information |
 |:----------------------- |
-| In order to use this modifier it must be declared after the open module in the definition of the test suite XML. |
+| *In order to use this modifier it must be declared after the open module in the definition of the test suite XML.
+*In order to use this modifier with Resolution Modifier it must be declared before the Resolution Modifier because the Hide modifier might affect the total height of the page (when used without `leaveBlankSpace="true"`. |
 
 ##### Parameters
 

documentation/src/main/wiki/ResolutionModifier.md

@@ -1,23 +1,22 @@
 #### Resolution Modifier
 
-Resolution Modifier is responsible for changing browser screen size. Affects [[Screen Collector | ScreenCollector]] results.  
+Resolution Modifier is responsible for changing browser screen size. Affects [[Screen Collector | ScreenCollector]] results.
 
 | ! Note |
 |:------ |
-| Please note that final resoulution of screenshots may be different when scrollbar is dispayed. <br/><br/> Default  width of Firefox's Scrollbar is equal to 33px.  (so when you want to grab viewport of size 1024, then set width parameter to 1057px) |
+| Firefox: Please note that final resoulution of screenshots may be different when scrollbar is dispayed. <br/><br/> Default  width of Firefox's Scrollbar is equal to 33px.  (so when you want to grab viewport of size 1024, then set width parameter to 1057px) |
 
 Module name: **resolution**
 
 ##### Parameters
 
 | Parameter | Value | Description | Mandatory |
 | --------- | ----- | ----------- | --------- |
-| `width` | int (1 to 100000) | Window width | no |
-| `height` | int (1 to 100000) | Window height | no |
+| `width` | int (1 to 15000) | Window width | yes |
+| `height` | int (1 to 15000) | Window height | no |
 
-| ! Important information |
-|:----------------------- |
-| You cannot maximize the window and specify the dimension at the same time. If you specify height param you have to also specify width param and vice versa. |
+| Note |
+| When height is not specified then it's computed by JavaScript. <br/> If the resolution is specified without height parameter it should be specified after [`open`](https://github.com/Cognifide/aet/wiki/Open). |
 
 ##### Example Usage
 

integration-tests/sample-site/src/main/resources/page_template/template.html

@@ -267,24 +267,6 @@ <h1 id="forms">Forms</h1>
 										</div>
 									</div>
 								</div>
-								<div class="form-group">
-									<label for="select" class="col-lg-2 control-label">Selects</label>
-									<div class="col-lg-10">
-										<select class="form-control" id="select">
-											<option>1</option>
-											<option>2</option>
-											<option>3</option>
-											<option>4</option>
-											<option>5</option>
-										</select> <br /> <select multiple="" class="form-control">
-											<option>1</option>
-											<option>2</option>
-											<option>3</option>
-											<option>4</option>
-											<option>5</option>
-										</select>
-									</div>
-								</div>
 								<div class="form-group">
 									<div class="col-lg-10 col-lg-offset-2">
 										<button class="btn btn-default">Cancel</button>

integration-tests/sample-site/src/main/webapp/includes/bodyContent.jsp

@@ -250,24 +250,6 @@
 										</div>
 									</div>
 								</div>
-								<div class="form-group">
-									<label for="select" class="col-lg-2 control-label">Selects</label>
-									<div class="col-lg-10">
-										<select class="form-control" id="select">
-											<option>1</option>
-											<option>2</option>
-											<option>3</option>
-											<option>4</option>
-											<option>5</option>
-										</select> <br /> <select multiple="" class="form-control">
-											<option>1</option>
-											<option>2</option>
-											<option>3</option>
-											<option>4</option>
-											<option>5</option>
-										</select>
-									</div>
-								</div>
 								<div class="form-group">
 									<div class="col-lg-10 col-lg-offset-2">
 										<button class="btn btn-default">Cancel</button>

integration-tests/sample-site/src/main/webapp/sanity/comparators/cookie/failed.jsp

@@ -23,8 +23,8 @@
     Cookie dynamicCookieValue = new Cookie("DynamicSampleCookieName",dt.format(date));
     Cookie dynamicCookieName = new Cookie(dt.format(date),"staticCookieValue");
     dynamicCookieValue.setMaxAge(60*60*24);
-    // expire cookie after 1 second in order to have it cleared for next run
-    dynamicCookieName.setMaxAge(10);
+    // expire cookie after 60 second in order to have it cleared for next run
+    dynamicCookieName.setMaxAge(60);
     response.addCookie( dynamicCookieValue );
     response.addCookie( dynamicCookieName );
 %>

integration-tests/sample-site/src/main/webapp/sanity/comparators/layout/height_detection.jsp

@@ -0,0 +1,29 @@
+<%--
+
+    AET
+
+    Copyright (C) 2013 Cognifide Limited
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+         http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+--%>
+<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>
+<%@ include file="/includes/header.jsp" %>
+<%
+String timestamp = Long.toString(System.currentTimeMillis());
+%>
+<%@ include file="/includes/bodyContent.jsp" %>
+<div class="space">
+    <%@ include file="dynamic_content.jsp" %>
+</div>
+<%@ include file="/includes/footer.jsp" %>

integration-tests/test-suite/partials-templates/executejavascript.xml

@@ -24,6 +24,7 @@
 	<test name="S-comparator-Layout-Executejavascript-cmd-hide">
 		<collect>
 			<open />
+			<resolution width="1500" />
 			<sleep duration="3000" />
 			<executejavascript cmd="document.getElementById('demo1').style.display='none'" />
 			<executejavascript cmd="document.getElementById('demo2').style.display='none'" />
@@ -39,6 +40,7 @@
 	<test name="S-comparator-Layout-Executejavascript-cmd-background">
 		<collect>
 			<open />
+			<resolution width="1500" />
 			<sleep duration="3000" />
 			<executejavascript cmd="document.body.style.background = 'green';" />
 			<screen />
@@ -53,6 +55,7 @@
 	<test name="S-comparator-Layout-Executejavascript-snippetUrl-background">
 		<collect>
 			<open />
+			<resolution width="1500" />
 			<sleep duration="3000" />
 			<executejavascript snippetUrl="${snippet.url.domain}snippets/change-bg-snippet.js" />
 			<screen />
@@ -67,6 +70,7 @@
 	<test name="S-comparator-Layout-Executejavascript-snippetUrl-basicAuth-background">
 		<collect>
 			<open />
+			<resolution width="1500" />
 			<sleep duration="3000" />
 			<executejavascript snippetUrl="${snippet.url.domain}secured/change-bg-snippet.js" basicAuthUsername="user" basicAuthPassword="password" />
 			<screen />