Add ability storing of webdriver console and network logs after failing tests

selenium/che-selenium-core/bin/webdriver.sh

@@ -830,7 +830,7 @@ storeTestReport() {
     if [[ -f ${TMP_SUITE_PATH} ]]; then
         cp ${TMP_SUITE_PATH} target/suite;
     fi
-    zip -qr ${report} target/screenshots target/htmldumps target/workspace-logs target/site target/failsafe-reports target/log target/bin target/suite
+    zip -qr ${report} target/screenshots target/htmldumps target/workspace-logs target/webdriver-logs target/site target/failsafe-reports target/log target/bin target/suite
 
     echo -e "[TEST] Tests results and reports are saved to ${BLUE}${report}${NO_COLOUR}"
     echo "[TEST]"

selenium/che-selenium-core/pom.xml

@@ -90,6 +90,10 @@
             <groupId>org.eclipse.che.core</groupId>
             <artifactId>che-core-commons-annotations</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.eclipse.che.core</groupId>
+            <artifactId>che-core-commons-json</artifactId>
+        </dependency>
         <dependency>
             <groupId>org.eclipse.che.core</groupId>
             <artifactId>che-core-commons-lang</artifactId>

selenium/che-selenium-core/src/main/java/org/eclipse/che/selenium/core/SeleniumWebDriver.java

@@ -255,7 +255,8 @@ private RemoteWebDriver doCreateDriver(URL webDriverUrl) {
     switch (browser) {
       case GOOGLE_CHROME:
         LoggingPreferences loggingPreferences = new LoggingPreferences();
-        loggingPreferences.enable(LogType.BROWSER, Level.SEVERE);
+        loggingPreferences.enable(LogType.PERFORMANCE, Level.ALL);
+        loggingPreferences.enable(LogType.BROWSER, Level.ALL);
 
         ChromeOptions options = new ChromeOptions();
         options.addArguments("--no-sandbox");

selenium/che-selenium-core/src/main/java/org/eclipse/che/selenium/core/inject/SeleniumTestHandler.java

@@ -41,6 +41,7 @@
 import java.util.stream.Stream;
 import javax.annotation.PreDestroy;
 import javax.validation.constraints.NotNull;
+import org.eclipse.che.commons.json.JsonParseException;
 import org.eclipse.che.commons.lang.NameGenerator;
 import org.eclipse.che.selenium.core.SeleniumWebDriver;
 import org.eclipse.che.selenium.core.client.TestGitHubServiceClient;
@@ -50,6 +51,7 @@
 import org.eclipse.che.selenium.core.pageobject.PageObjectsInjector;
 import org.eclipse.che.selenium.core.user.InjectTestUser;
 import org.eclipse.che.selenium.core.user.TestUser;
+import org.eclipse.che.selenium.core.webdriver.log.WebDriverLogsReaderFactory;
 import org.eclipse.che.selenium.core.workspace.InjectTestWorkspace;
 import org.eclipse.che.selenium.core.workspace.TestWorkspace;
 import org.eclipse.che.selenium.core.workspace.TestWorkspaceLogsReader;
@@ -93,6 +95,10 @@ public abstract class SeleniumTestHandler
   @Named("tests.htmldumps_dir")
   private String htmldumpsDir;
 
+  @Inject
+  @Named("tests.webdriverlogs_dir")
+  private String webDriverLogsDir;
+
   @Inject
   @Named("tests.workspacelogs_dir")
   private String workspaceLogsDir;
@@ -128,6 +134,7 @@ public abstract class SeleniumTestHandler
   @Inject private TestGitHubServiceClient gitHubClientService;
   @Inject private TestWorkspaceLogsReader testWorkspaceLogsReader;
   @Inject private SeleniumTestStatistics seleniumTestStatistics;
+  @Inject private WebDriverLogsReaderFactory webDriverLogsReaderFactory;
 
   private final Injector injector;
   private final Map<Long, Object> runningTests = new ConcurrentHashMap<>();
@@ -302,6 +309,7 @@ private void onTestFinish(ITestResult result) {
       captureScreenshot(result);
       captureHtmlSource(result);
       captureTestWorkspaceLogs(result);
+      storeWebDriverLogs(result);
     }
   }
 
@@ -464,6 +472,32 @@ private void captureScreenshotsFromOpenedWindows(
             });
   }
 
+  private void storeWebDriverLogs(ITestResult result) {
+    Set<SeleniumWebDriver> webDrivers = new HashSet<>();
+    Object testInstance = result.getInstance();
+    collectInjectedWebDrivers(testInstance, webDrivers);
+    webDrivers.forEach(webDriver -> storeWebDriverLogs(result, webDriver));
+  }
+
+  private void storeWebDriverLogs(ITestResult result, SeleniumWebDriver webDriver) {
+    String testReference = getTestReference(result);
+
+    try {
+      String filename = NameGenerator.generate(testReference + "_", 4) + ".log";
+      Path webDriverLogsDirectory = Paths.get(webDriverLogsDir, filename);
+      Files.createDirectories(webDriverLogsDirectory.getParent());
+      Files.write(
+          webDriverLogsDirectory,
+          webDriverLogsReaderFactory
+              .create(webDriver)
+              .getAllLogs()
+              .getBytes(Charset.forName("UTF-8")),
+          StandardOpenOption.CREATE);
+    } catch (WebDriverException | IOException | JsonParseException e) {
+      LOG.error(format("Can't store web driver logs related to test %s.", testReference), e);
+    }
+  }
+
   private void dumpHtmlCodeFromTheCurrentPage(ITestResult result, SeleniumWebDriver webDriver) {
     String testReference = getTestReference(result);
     String filename = NameGenerator.generate(testReference + "_", 8) + ".html";

selenium/che-selenium-core/src/main/java/org/eclipse/che/selenium/core/webdriver/log/Log.java

@@ -0,0 +1,156 @@
+/*
+ * Copyright (c) 2012-2018 Red Hat, Inc.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *   Red Hat, Inc. - initial API and implementation
+ */
+package org.eclipse.che.selenium.core.webdriver.log;
+
+import static java.lang.String.format;
+import static org.eclipse.che.selenium.core.webdriver.log.WebDriverLogsReader.LOG_TIME_FORMAT;
+
+import java.text.SimpleDateFormat;
+import java.util.Date;
+
+/**
+ * This class deals with web driver log entry.
+ *
+ * @author Dmytro Nochevnov
+ */
+public class Log {
+  private Message message;
+  private long timestamp;
+
+  public Message getMessage() {
+    return message;
+  }
+
+  public void setMessage(Message message) {
+    this.message = message;
+  }
+
+  boolean isNetworkLog() {
+    return isNetworkRequest()
+        || isNetworkResponse()
+        || isWebsocketCreated()
+        || isWebsocketRequest()
+        || isWebsocketResponse();
+  }
+
+  private boolean isNetworkRequest() {
+    return "Network.requestWillBeSent".equals(getMessage().getMethod());
+  }
+
+  private boolean isNetworkResponse() {
+    return "Network.responseReceived".equals(getMessage().getMethod());
+  }
+
+  private boolean isWebsocketCreated() {
+    return "Network.webSocketCreated".equals(getMessage().getMethod());
+  }
+
+  private boolean isWebsocketRequest() {
+    return "Network.webSocketFrameSent".equals(getMessage().getMethod());
+  }
+
+  private boolean isWebsocketResponse() {
+    return "Network.webSocketFrameReceived".equals(getMessage().getMethod());
+  }
+
+  public String getUrl() {
+    if (hasRequest()) {
+      return getMessage().getParams().getRequest().getUrl();
+
+    } else if (hasResponse()) {
+      return getMessage().getParams().getResponse().getUrl();
+
+    } else if (hasParams() && getMessage().getParams().getUrl() != null) {
+      return getMessage().getParams().getUrl();
+    }
+
+    return "";
+  }
+
+  public String getRequestId() {
+    if (hasParams()) {
+      return getMessage().getParams().getRequestId();
+    }
+
+    return "";
+  }
+
+  public long getTimestamp() {
+    return timestamp;
+  }
+
+  public void setTimestamp(long timestamp) {
+    this.timestamp = timestamp;
+  }
+
+  private String getRequestMethod() {
+    if (hasRequest()) {
+      return getMessage().getParams().getRequest().getMethod();
+    }
+
+    return "";
+  }
+
+  private String getResponseStatus() {
+    if (hasResponse()) {
+      return getMessage().getParams().getResponse().getStatus();
+    }
+
+    return "";
+  }
+
+  private String getPayloadData() {
+    if (hasResponse()) {
+      return getMessage().getParams().getResponse().getPayloadData();
+    }
+
+    return "";
+  }
+
+  private boolean hasRequest() {
+    return hasParams() && getMessage().getParams().getRequest() != null;
+  }
+
+  private boolean hasResponse() {
+    return hasParams() && getMessage().getParams().getResponse() != null;
+  }
+
+  private boolean hasParams() {
+    return getMessage() != null && getMessage().getParams() != null;
+  }
+
+  private String formatTime(long timestamp) {
+    return new SimpleDateFormat(LOG_TIME_FORMAT).format(new Date(timestamp));
+  }
+
+  @Override
+  public String toString() {
+    String prefix = format("%s (id: %s)", formatTime(getTimestamp()), getRequestId());
+
+    if (isNetworkRequest()) {
+      return format("%s [REQUEST]  %s %s\n", prefix, getRequestMethod(), getUrl());
+
+    } else if (isNetworkResponse()) {
+      return format("%s [RESPONSE] %s %s\n", prefix, getResponseStatus(), getUrl());
+
+    } else if (isWebsocketCreated()) {
+      return format("%s [WEBSOCKET_CREATED] %s\n", prefix, getUrl());
+
+    } else if (isWebsocketRequest()) {
+      return format("%s [WEBSOCKET_REQUEST] %s\n", prefix, getPayloadData());
+
+    } else if (isWebsocketResponse()) {
+      return format("%s [WEBSOCKET_RESPONSE] %s\n", prefix, getPayloadData());
+    }
+
+    return super.toString();
+  }
+}

selenium/che-selenium-core/src/main/java/org/eclipse/che/selenium/core/webdriver/log/Message.java

@@ -0,0 +1,26 @@
+/*
+ * Copyright (c) 2012-2018 Red Hat, Inc.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *   Red Hat, Inc. - initial API and implementation
+ */
+package org.eclipse.che.selenium.core.webdriver.log;
+
+/**
+ * This is POJO to extract message from web driver network log entry
+ *
+ * @author Dmytro Nochevnov
+ */
+public interface Message {
+  String getMethod();
+
+  void setMethod(String method);
+
+  Params getParams();
+
+  void setParams(Params params);
+}

selenium/che-selenium-core/src/main/java/org/eclipse/che/selenium/core/webdriver/log/Params.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright (c) 2012-2018 Red Hat, Inc.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *   Red Hat, Inc. - initial API and implementation
+ */
+package org.eclipse.che.selenium.core.webdriver.log;
+
+/**
+ * This is POJO to extract 'params' value from web driver network log entry
+ *
+ * @author Dmytro Nochevnov
+ */
+public interface Params {
+  String getRequestId();
+
+  void setRequestId(String requestId);
+
+  String getUrl();
+
+  void setUrl(String url);
+
+  Request getRequest();
+
+  void setRequest(Request request);
+
+  Response getResponse();
+
+  void setResponse(Response request);
+
+  String getTimestamp();
+
+  void setTimestamp(String timestamp);
+}