Remove vaadin-uitest-common dependency from server tests (#8551)

Uses custom reference and error files in test project.

test/servlet-containers/generic/pom.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
     <parent>
         <groupId>com.vaadin</groupId>
@@ -13,6 +13,7 @@
     <packaging>war</packaging>
     <properties>
         <osgi.bundle.version>8.0.0</osgi.bundle.version>
+        <jetty.skip>true</jetty.skip>
     </properties>
 
     <dependencies>
@@ -41,8 +42,7 @@
         </dependency>
         <dependency>
             <groupId>com.vaadin</groupId>
-            <artifactId>vaadin-uitest-common</artifactId>
-            <version>${project.version}</version>
+            <artifactId>vaadin-testbench-api</artifactId>
             <scope>test</scope>
         </dependency>
     </dependencies>
@@ -51,13 +51,15 @@
     <build>
 
         <plugins>
-            <!--TODO run this on different servers-->
+            <!--TODO run this on different servers -->
             <plugin>
                 <groupId>org.eclipse.jetty</groupId>
                 <artifactId>jetty-maven-plugin</artifactId>
                 <version>${jetty.version}</version>
                 <configuration>
-                    <skip>true</skip>
+                    <webApp>
+                        <contextPath>/demo</contextPath>
+                    </webApp>
                 </configuration>
             </plugin>
             <plugin>
@@ -72,14 +74,22 @@
                     <skip>true</skip>
                 </configuration>
             </plugin>
+            <plugin>
+                <artifactId>maven-failsafe-plugin</artifactId>
+                <!-- Currently tested using an Ant script. -->
+                <configuration>
+                    <skip>true</skip>
+                </configuration>
+            </plugin>
             <plugin>
                 <artifactId>maven-war-plugin</artifactId>
                 <configuration>
                     <archive>
                         <manifestFile>${project.build.outputDirectory}/META-INF/MANIFEST.MF</manifestFile>
                     </archive>
                 </configuration>
-                <!-- This execution builds an additional .war file with JBoss 6 specific descriptor -->
+                <!-- This execution builds an additional .war file with JBoss 
+                    6 specific descriptor -->
                 <executions>
                     <execution>
                         <id>jboss6-war</id>

test/servlet-containers/generic/src/test/java/com/vaadin/tests/integration/AbstractIntegrationTest.java

@@ -1,37 +1,91 @@
-/*
- * Copyright 2000-2016 Vaadin Ltd.
- *
- * 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.
- */
 package com.vaadin.tests.integration;
 
-import com.vaadin.testbench.By;
+import java.awt.image.BufferedImage;
+import java.io.File;
+import java.io.IOException;
+import java.util.List;
+import java.util.logging.Logger;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+import javax.imageio.ImageIO;
+
+import org.junit.After;
+import org.junit.runner.RunWith;
+import org.openqa.selenium.remote.DesiredCapabilities;
+import org.openqa.selenium.support.ui.ExpectedCondition;
+import org.openqa.selenium.support.ui.WebDriverWait;
+
+import com.vaadin.testbench.annotations.BrowserConfiguration;
+import com.vaadin.testbench.annotations.BrowserFactory;
+import com.vaadin.testbench.annotations.RunOnHub;
 import com.vaadin.testbench.elements.UIElement;
+import com.vaadin.testbench.parallel.Browser;
+import com.vaadin.testbench.parallel.BrowserUtil;
+import com.vaadin.testbench.parallel.ParallelRunner;
+import com.vaadin.testbench.parallel.ParallelTest;
 import com.vaadin.testbench.parallel.TestNameSuffix;
-import com.vaadin.tests.tb3.SingleBrowserTestPhantomJS2;
-
-/**
- * Base class for integration tests. Integration tests use the
- * {@literal deployment.url} parameter to determine the base deployment url
- * (http://hostname:123)
- *
- * @author Vaadin Ltd
- */
+import com.vaadin.testbench.screenshot.ImageFileUtil;
+
+@RunOnHub("tb3-hub.intra.itmill.com")
+@RunWith(ParallelRunner.class)
+@BrowserFactory(CustomBrowserFactory.class)
 @TestNameSuffix(property = "server-name")
-public abstract class AbstractIntegrationTest
-        extends SingleBrowserTestPhantomJS2 {
+public abstract class AbstractIntegrationTest extends ParallelTest {
+
+    /**
+     * Height of the screenshots we want to capture
+     */
+    private static final int SCREENSHOT_HEIGHT = 850;
+
+    /**
+     * Width of the screenshots we want to capture
+     */
+    private static final int SCREENSHOT_WIDTH = 1500;
+
+    private boolean screenshotErrors;
+
+    @BrowserConfiguration
+    public final List<DesiredCapabilities> getBrowsersToTest() {
+        return getBrowsers().map(BrowserUtil.getBrowserFactory()::create)
+                .collect(Collectors.toList());
+    }
+
+    protected Stream<Browser> getBrowsers() {
+        return Stream.of(Browser.PHANTOMJS);
+    }
+
     @Override
-    protected String getBaseURL() {
+    public void setup() throws Exception {
+        super.setup();
+
+        testBench().resizeViewPortTo(SCREENSHOT_WIDTH, SCREENSHOT_HEIGHT);
+
+        openTestURL();
+    }
+
+    private void openTestURL() {
+        String url = getDeploymentURL() + getContextPath() + getTestPath() + "?"
+                + getParameters().collect(Collectors.joining("&"));
+        driver.get(url);
+
+        if (!isElementPresent(UIElement.class)) {
+            waitUntil(e -> isElementPresent(UIElement.class), 10);
+        }
+    }
+
+    protected Stream<String> getParameters() {
+        return Stream.of("restartApplication");
+    }
+
+    /**
+     * Returns a path where the test UI is found.
+     *
+     * @return path for test
+     */
+    protected abstract String getTestPath();
+
+    private String getDeploymentURL() {
         String deploymentUrl = System.getProperty("deployment.url");
         if (deploymentUrl == null || deploymentUrl.equals("")) {
             throw new RuntimeException(
@@ -40,17 +94,48 @@ protected String getBaseURL() {
         return deploymentUrl;
     }
 
-    @Override
-    protected void openTestURL() {
-        super.openTestURL();
-
-        waitForApplication();
+    protected void compareScreen(String identifier) throws IOException {
+        String refFileName = identifier + "-"
+                + getDesiredCapabilities().getBrowserName().toLowerCase()
+                + ".png";
+        String errorFileName = identifier + "-"
+                + getDesiredCapabilities().getBrowserName().toLowerCase() + "-"
+                + System.getProperty("server-name") + ".png";
+        File referenceFile = ImageFileUtil
+                .getReferenceScreenshotFile(refFileName);
+        try {
+            BufferedImage reference = ImageIO.read(referenceFile);
+            if (testBench().compareScreen(reference, errorFileName)) {
+                return;
+            }
+        } catch (IOException e) {
+            Logger.getLogger(getClass().getName()).warning(
+                    "Missing screenshot reference: " + referenceFile.getPath());
+        }
+        screenshotErrors = true;
     }
 
-    protected void waitForApplication() {
-        if (!isElementPresent(UIElement.class)) {
-            // Wait for UI element.
-            waitForElementPresent(By.vaadin("//com.vaadin.ui.UI"));
+    @After
+    public void teardown() {
+        if (screenshotErrors) {
+            throw new RuntimeException("Screenshots failed.");
         }
     }
+
+    /**
+     * Waits the given number of seconds for the given condition to become true.
+     * Use e.g. as
+     * {@link #waitUntil(ExpectedConditions.textToBePresentInElement(by, text))}
+     *
+     * @param condition
+     *            the condition to wait for to become true
+     */
+    protected <T> void waitUntil(ExpectedCondition<T> condition,
+            long timeoutInSeconds) {
+        new WebDriverWait(driver, timeoutInSeconds).until(condition);
+    }
+
+    protected String getContextPath() {
+        return "/demo";
+    }
 }

test/servlet-containers/generic/src/test/java/com/vaadin/tests/integration/AbstractServletIntegrationTest.java

@@ -1,81 +1,21 @@
-/*
- * Copyright 2000-2016 Vaadin Ltd.
- *
- * 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.
- */
 package com.vaadin.tests.integration;
 
-import java.io.IOException;
-import java.util.ArrayList;
-import java.util.Collection;
-import java.util.Collections;
-
 import org.junit.Test;
-import org.junit.runner.RunWith;
-import org.junit.runners.Parameterized.Parameters;
 
 import com.vaadin.testbench.elements.TableElement;
-import com.vaadin.tests.tb3.ParameterizedTB3Runner;
 
-/**
- * Base class for servlet integration tests. Automatically prepends "/demo" to
- * the deployment path
- *
- * @author Vaadin Ltd
- */
-@RunWith(ParameterizedTB3Runner.class)
 public abstract class AbstractServletIntegrationTest
         extends AbstractIntegrationTest {
 
-    private String contextPath = "/demo";
-
     @Test
-    public void runTest() throws IOException, AssertionError {
-        openTestURL();
+    public void runTest() throws Exception {
         // make sure no fading progress indicator from table update is lingering
-        sleep(2000);
+        Thread.sleep(2000);
         compareScreen("initial");
         $(TableElement.class).first().getCell(0, 1).click();
         // without this, table fetch might have a fading progress indicator
-        sleep(2000);
+        Thread.sleep(2000);
         compareScreen("finland");
     }
 
-    @Override
-    protected String getDeploymentPath(Class<?> uiClass) {
-        return contextPath + super.getDeploymentPath(uiClass);
-    }
-
-    public void setContextPath(String contextPath) {
-        this.contextPath = contextPath;
-    }
-
-    @Parameters
-    public static Collection<String> getContextPaths() {
-        if (getServerName().equals("wildfly9-nginx")) {
-            ArrayList<String> paths = new ArrayList<>();
-            paths.add("/buffering/demo");
-            paths.add("/nonbuffering/demo");
-            paths.add("/buffering-timeout/demo");
-            paths.add("/nonbuffering-timeout/demo");
-            return paths;
-        } else {
-            return Collections.emptyList();
-        }
-    }
-
-    protected static String getServerName() {
-        return System.getProperty("server-name");
-    }
-
 }

test/servlet-containers/generic/src/test/java/com/vaadin/tests/integration/CustomBrowserFactory.java

@@ -0,0 +1,21 @@
+package com.vaadin.tests.integration;
+
+import org.openqa.selenium.remote.DesiredCapabilities;
+
+import com.vaadin.testbench.parallel.Browser;
+import com.vaadin.testbench.parallel.BrowserUtil;
+import com.vaadin.testbench.parallel.DefaultBrowserFactory;
+
+public class CustomBrowserFactory extends DefaultBrowserFactory {
+
+    @Override
+    public DesiredCapabilities create(Browser browser) {
+        DesiredCapabilities capabilities = super.create(browser);
+        if (BrowserUtil.isPhantomJS(capabilities)) {
+            capabilities.setVersion("2");
+            capabilities.setCapability("phantomjs.binary.path",
+                    "/usr/bin/phantomjs2");
+        }
+        return capabilities;
+    }
+}

test/servlet-containers/generic/src/test/java/com/vaadin/tests/integration/ServletIntegrationWebsocketUITest.java → test/servlet-containers/generic/src/test/java/com/vaadin/tests/integration/ServletIntegrationDefaultPushIT.java

@@ -15,7 +15,12 @@
  */
 package com.vaadin.tests.integration;
 
-public class ServletIntegrationWebsocketUITest
+public class ServletIntegrationDefaultPushIT
         extends AbstractServletIntegrationTest {
     // Uses the test method declared in the super class
+
+    @Override
+    protected String getTestPath() {
+        return "/run/ServletIntegrationDefaultPushUI";
+    }
 }

test/servlet-containers/generic/src/test/java/com/vaadin/tests/integration/ServletIntegrationUITest.java → test/servlet-containers/generic/src/test/java/com/vaadin/tests/integration/ServletIntegrationIT.java

@@ -15,6 +15,11 @@
  */
 package com.vaadin.tests.integration;
 
-public class ServletIntegrationUITest extends AbstractServletIntegrationTest {
+public class ServletIntegrationIT extends AbstractServletIntegrationTest {
     // Uses the test method declared in the super class
+
+    @Override
+    protected String getTestPath() {
+        return "/run/ServletIntegrationUI";
+    }
 }