Add html dump example

Author: kklisura

cdtp-examples/pom.xml

@@ -14,13 +14,39 @@
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <maven.compiler.source>1.8</maven.compiler.source>
     <maven.compiler.target>1.8</maven.compiler.target>
+
+    <logback.version>1.2.3</logback.version>
   </properties>
 
   <dependencies>
+    <dependency>
+      <groupId>ch.qos.logback</groupId>
+      <artifactId>logback-classic</artifactId>
+      <version>${logback.version}</version>
+    </dependency>
+
     <dependency>
       <groupId>com.github.kklisura.cdtp</groupId>
       <artifactId>cdtp-java-client</artifactId>
       <version>1.0-SNAPSHOT</version>
     </dependency>
   </dependencies>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>com.coveo</groupId>
+        <artifactId>fmt-maven-plugin</artifactId>
+        <version>2.1.0</version>
+        <executions>
+          <execution>
+            <goals>
+              <goal>format</goal>
+            </goals>
+            <phase>process-sources</phase>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
+  </build>
 </project>

cdtp-examples/src/main/java/com/github/kklisura/cdpt/examples/DumpHtmlFromPageExample.java

@@ -0,0 +1,57 @@
+package com.github.kklisura.cdpt.examples;
+
+import com.github.kklisura.cdtp.launch.ChromeLauncher;
+import com.github.kklisura.cdtp.protocol.commands.Page;
+import com.github.kklisura.cdtp.protocol.commands.Runtime;
+import com.github.kklisura.cdtp.protocol.types.runtime.Evaluate;
+import com.github.kklisura.cdtp.services.ChromeDevToolsService;
+import com.github.kklisura.cdtp.services.ChromeService;
+import com.github.kklisura.cdtp.services.types.ChromeTab;
+
+/**
+ * The following example dumps the index html from github.com.
+ *
+ * @author Kenan Klisura
+ */
+public class DumpHtmlFromPageExample {
+  public static void main(String[] args) throws InterruptedException {
+    // Create chrome launcher.
+    final ChromeLauncher launcher = new ChromeLauncher();
+
+    // Launch chrome either as headless (true) or regular (false).
+    final ChromeService chromeService = launcher.launch(false);
+
+    // Create empty tab ie about:blank.
+    final ChromeTab tab = chromeService.createTab();
+
+    // Get DevTools service to this tab
+    final ChromeDevToolsService devToolsService = chromeService.createDevToolsService(tab);
+
+    // Get individual commands
+    final Page page = devToolsService.getPage();
+    final Runtime runtime = devToolsService.getRuntime();
+
+    // Wait for on load event
+    page.onLoadEventFired(
+        event -> {
+          // Evaluate javascript
+          Evaluate evaluation = runtime.evaluate("document.documentElement.outerHTML");
+          System.out.println(evaluation.getResult().getValue());
+
+          // Close devtools.
+          devToolsService.close();
+        });
+
+    // Enable page events.
+    page.enable();
+
+    // Navigate to github.com.
+    page.navigate("http://github.com");
+
+    // Wait until devtools is closed.
+    devToolsService.waitUntilClosed();
+
+    // Close tab.
+    chromeService.closeTab(tab);
+  }
+}

cdtp-examples/src/main/java/com/github/kklisura/cdpt/examples/LogRequestsExample.java

@@ -0,0 +1,58 @@
+package com.github.kklisura.cdpt.examples;
+
+import com.github.kklisura.cdtp.launch.ChromeLauncher;
+import com.github.kklisura.cdtp.protocol.commands.Network;
+import com.github.kklisura.cdtp.protocol.commands.Page;
+import com.github.kklisura.cdtp.services.ChromeDevToolsService;
+import com.github.kklisura.cdtp.services.ChromeService;
+import com.github.kklisura.cdtp.services.types.ChromeTab;
+
+/**
+ * Log requests example with DevTools Protocol java client.
+ *
+ * <p>The following example will open chrome, create a tab with about:blank url, subscribe to
+ * requestWillBeSent event and then navigate to github.com.
+ *
+ * @author Kenan Klisura
+ */
+public class LogRequestsExample {
+  public static void main(String[] args) throws InterruptedException {
+    // Create chrome launcher.
+    final ChromeLauncher launcher = new ChromeLauncher();
+
+    // Launch chrome either as headless (true) or regular (false).
+    final ChromeService chromeService = launcher.launch(false);
+
+    // Create empty tab ie about:blank.
+    final ChromeTab tab = chromeService.createTab();
+
+    // Get DevTools service to this tab
+    final ChromeDevToolsService devToolsService = chromeService.createDevToolsService(tab);
+
+    // Get individual commands
+    final Page page = devToolsService.getPage();
+    final Network network = devToolsService.getNetwork();
+
+    // Log requests with onRequestWillBeSent event handler.
+    network.onRequestWillBeSent(
+        event ->
+            System.out.printf(
+                "request: %s %s%s",
+                event.getRequest().getMethod(),
+                event.getRequest().getUrl(),
+                System.lineSeparator()));
+
+    network.onLoadingFinished(
+        event -> {
+          // Close the tab and close the browser when loading finishes.
+          chromeService.closeTab(tab);
+          launcher.close();
+        });
+
+    // Enable network events.
+    network.enable();
+
+    // Navigate to github.com.
+    page.navigate("http://github.com");
+  }
+}

cdtp-examples/src/main/java/com/github/kklisura/cdpt/examples/SimpleNavigateToUrlExample.java

@@ -9,7 +9,7 @@
 /**
  * Simple navigate-to-url example with DevTools Protocol java client.
  *
- * The following example with open chrome, create a tab with about:blank url and then navigate to
+ * <p>The following example will open chrome, create a tab with about:blank url and then navigate to
  * github.com. It will then wait 2seconds and it will navigate to twitter.com. It will again wait
  * for 2seconds and on the end it will close the tab and close the browser.
  *

cdtp-java-client/src/main/java/com/github/kklisura/cdtp/services/ChromeDevToolsService.java

@@ -47,6 +47,16 @@ public interface ChromeDevToolsService extends ChromeDevTools, AutoCloseable {
   /** Closes the dev tools service. */
   void close();
 
+  /**
+   * Returns true if devtools is closed.
+   *
+   * @return True if its closed.
+   */
+  boolean isClosed();
+
+  /** Waits until devtools is closed. */
+  void waitUntilClosed();
+
   /**
    * Adds an event listener on a given event name belonging to some domain.
    *

cdtp-java-client/src/main/java/com/github/kklisura/cdtp/services/ChromeService.java

@@ -20,6 +20,7 @@
  * #L%
  */
 
+import com.github.kklisura.cdtp.services.config.ChromeDevToolsServiceConfiguration;
 import com.github.kklisura.cdtp.services.exceptions.ChromeServiceException;
 import com.github.kklisura.cdtp.services.types.ChromeTab;
 import com.github.kklisura.cdtp.services.types.ChromeVersion;
@@ -84,6 +85,17 @@ public interface ChromeService {
    * Creates a dev tools service to specified tab.
    *
    * @param tab Tab.
+   * @param chromeDevToolsServiceConfiguration Service configuration.
+   * @return Dev tools.
+   */
+  ChromeDevToolsService createDevToolsService(
+      ChromeTab tab, ChromeDevToolsServiceConfiguration chromeDevToolsServiceConfiguration)
+      throws ChromeServiceException;
+
+  /**
+   * Creates a dev tools service to specified tab with default service configuration.
+   *
+   * @param tab Tab.
    * @return Dev tools.
    */
   ChromeDevToolsService createDevToolsService(ChromeTab tab) throws ChromeServiceException;

cdtp-java-client/src/main/java/com/github/kklisura/cdtp/services/config/ChromeDevToolsServiceConfiguration.java

@@ -0,0 +1,82 @@
+package com.github.kklisura.cdtp.services.config;
+
+/*-
+ * #%L
+ * cdpt-java-client
+ * %%
+ * Copyright (C) 2018 Kenan Klisura
+ * %%
+ * 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.
+ * #L%
+ */
+
+import static com.github.kklisura.cdtp.services.utils.ConfigurationUtils.systemProperty;
+
+import com.github.kklisura.cdtp.services.executors.DefaultEventExecutorService;
+import com.github.kklisura.cdtp.services.executors.EventExecutorService;
+
+/**
+ * Chrome DevTools service configuration.
+ *
+ * @author Kenan Klisura
+ */
+public class ChromeDevToolsServiceConfiguration {
+  private static final String READ_TIMEOUT_PROPERTY =
+      "com.github.kklisura.cdtp.services.config.readTimeout";
+
+  private static final long READ_TIMEOUT = systemProperty(READ_TIMEOUT_PROPERTY, 0);
+
+  /** Read timeout in seconds. Default 0. */
+  private long readTimeout = READ_TIMEOUT;
+
+  private EventExecutorService eventExecutorService = new DefaultEventExecutorService();
+
+  /**
+   * Gets read timeout in seconds.
+   *
+   * @return Read timeout in seconds.
+   */
+  public long getReadTimeout() {
+    return readTimeout;
+  }
+
+  /**
+   * Sets read timeout in seconds. 0 for infinite timeout.
+   *
+   * <p>This property can be set by {@link ChromeDevToolsServiceConfiguration#READ_TIMEOUT_PROPERTY}
+   * property.
+   *
+   * @param readTimeout Read timeout in seconds.
+   */
+  public void setReadTimeout(long readTimeout) {
+    this.readTimeout = readTimeout;
+  }
+
+  /**
+   * Gets event executor service.
+   *
+   * @return Event executor service.
+   */
+  public EventExecutorService getEventExecutorService() {
+    return eventExecutorService;
+  }
+
+  /**
+   * Sets event executor service.
+   *
+   * @param eventExecutorService Event executor service.
+   */
+  public void setEventExecutorService(EventExecutorService eventExecutorService) {
+    this.eventExecutorService = eventExecutorService;
+  }
+}

cdtp-java-client/src/main/java/com/github/kklisura/cdtp/services/executors/DefaultEventExecutorService.java

@@ -0,0 +1,43 @@
+package com.github.kklisura.cdtp.services.executors;
+
+/*-
+ * #%L
+ * cdpt-java-client
+ * %%
+ * Copyright (C) 2018 Kenan Klisura
+ * %%
+ * 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.
+ * #L%
+ */
+
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+
+/**
+ * Default event executor service.
+ *
+ * @author Kenan Klisura
+ */
+public class DefaultEventExecutorService implements EventExecutorService {
+  private ExecutorService executorService = Executors.newCachedThreadPool();
+
+  @Override
+  public void execute(Runnable runnable) {
+    executorService.execute(runnable);
+  }
+
+  @Override
+  public void shutdown() {
+    executorService.shutdown();
+  }
+}

cdtp-java-client/src/main/java/com/github/kklisura/cdtp/services/executors/EventExecutorService.java

@@ -0,0 +1,38 @@
+package com.github.kklisura.cdtp.services.executors;
+
+/*-
+ * #%L
+ * cdpt-java-client
+ * %%
+ * Copyright (C) 2018 Kenan Klisura
+ * %%
+ * 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.
+ * #L%
+ */
+
+/**
+ * Event executor service.
+ *
+ * @author Kenan Klisura
+ */
+public interface EventExecutorService {
+  /**
+   * Executes a runnable in separate thread.
+   *
+   * @param runnable Runnable.
+   */
+  void execute(Runnable runnable);
+
+  /** Shutdowns executor service. */
+  void shutdown();
+}