Add some more tests

Author: kklisura

cdt-java-client/src/test/java/com/github/kklisura/cdt/launch/ChromeLauncherTest.java

@@ -33,18 +33,23 @@
 import static org.powermock.api.easymock.PowerMock.mockStatic;
 import static org.powermock.api.easymock.PowerMock.replay;
 
+import ch.qos.logback.classic.Level;
+import ch.qos.logback.classic.Logger;
+import ch.qos.logback.classic.LoggerContext;
 import com.github.kklisura.cdt.launch.ChromeLauncher.Environment;
 import com.github.kklisura.cdt.launch.ChromeLauncher.ShutdownHookRegistry;
 import com.github.kklisura.cdt.launch.config.ChromeLauncherConfiguration;
 import com.github.kklisura.cdt.launch.exceptions.ChromeProcessTimeoutException;
 import com.github.kklisura.cdt.launch.support.ProcessLauncher;
+import com.github.kklisura.cdt.launch.utils.LogCollector;
 import com.github.kklisura.cdt.services.ChromeService;
 import com.github.kklisura.cdt.services.impl.ChromeServiceImpl;
 import com.github.kklisura.cdt.utils.FilesUtils;
 import java.io.ByteArrayInputStream;
 import java.io.IOException;
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.util.ArrayList;
 import java.util.List;
 import java.util.concurrent.TimeUnit;
 import org.easymock.Capture;
@@ -56,6 +61,7 @@
 import org.powermock.api.easymock.PowerMock;
 import org.powermock.core.classloader.annotations.PrepareForTest;
 import org.powermock.modules.junit4.PowerMockRunner;
+import org.slf4j.LoggerFactory;
 
 /**
  * Chrome launcher test.
@@ -119,6 +125,8 @@ public void testGetChromeBinaryPathThrowsExceptionWhenNoBinaryFound() {
             processLauncher.isExecutable(
                 "C:/Program Files (x86)/Google/Chrome/Application/chrome.exe"))
         .andReturn(false);
+    expect(processLauncher.isExecutable("C:/Program Files/Google/Chrome/Application/chrome.exe"))
+        .andReturn(false);
 
     replayAll();
 
@@ -636,6 +644,102 @@ public void testExitValue() throws IOException {
     verifyAll();
   }
 
+  /**
+   * Registers appender that adds logging events to the argument loggingEvents. This also sets the
+   * level of the logger to DEBUG.
+   *
+   * @param name Name of the logger.
+   * @param loggingEvents Logging events.
+   */
+  private static void registerAppenderOnDebugLogger(
+      String name, Level level, List<String> loggingEvents) {
+    LoggerContext loggerContext = (LoggerContext) LoggerFactory.getILoggerFactory();
+
+    final Logger logger = loggerContext.getLogger(name);
+    logger.setLevel(level);
+    logger.addAppender(new LogCollector(loggingEvents));
+  }
+
+  @Test
+  public void testLaunchWithDebugLogging()
+      throws IOException, ChromeProcessTimeoutException, InterruptedException {
+    List<String> loggingEvents = new ArrayList<>();
+    registerAppenderOnDebugLogger(
+        "com.github.kklisura.cdt.launch.chrome.output", Level.DEBUG, loggingEvents);
+
+    expect(environment.getEnv("CHROME_PATH")).andReturn("/test-binary-path");
+    expect(processLauncher.isExecutable("/test-binary-path")).andReturn(true);
+
+    shutdownHookRegistry.register(anyObject());
+
+    final String trigger =
+        "first-line\r\nsecond-line\r\nDevTools listening on ws://127.0.0.1:9123/\r\nthird-line\r\nforth-line\r\n";
+    expect(process.getInputStream()).andReturn(new ByteArrayInputStream(trigger.getBytes()));
+
+    expect(processLauncher.launch(eq("/test-binary-path"), anyObject())).andReturn(process);
+
+    expect(FilesUtils.randomTempDir("cdt-user-data-dir")).andReturn("temp-user-data-dir");
+
+    replayAll();
+    PowerMock.replay(FilesUtils.class);
+
+    ChromeService launch = launcher.launch();
+
+    verifyAll();
+    PowerMock.verify(FilesUtils.class);
+
+    assertNotNull(launch);
+    assertTrue(launch instanceof ChromeServiceImpl);
+
+    assertEquals(9123, ((ChromeServiceImpl) launch).getPort());
+
+    // Give a thread in waitForDevToolsServer method a bit more chance to collect logging events.
+    Thread.sleep(100);
+
+    assertEquals(5, loggingEvents.size());
+    assertEquals("[DEBUG] first-line", loggingEvents.get(0));
+    assertEquals("[DEBUG] second-line", loggingEvents.get(1));
+    assertEquals("[DEBUG] DevTools listening on ws://127.0.0.1:9123/", loggingEvents.get(2));
+    assertEquals("[DEBUG] third-line", loggingEvents.get(3));
+    assertEquals("[DEBUG] forth-line", loggingEvents.get(4));
+  }
+
+  @Test
+  public void testLaunchWithErrorLoggingDoesNotLogAnything()
+      throws IOException, ChromeProcessTimeoutException {
+    List<String> loggingEvents = new ArrayList<>();
+    registerAppenderOnDebugLogger(
+        "com.github.kklisura.cdt.launch.chrome.output", Level.ERROR, loggingEvents);
+
+    expect(environment.getEnv("CHROME_PATH")).andReturn("/test-binary-path");
+    expect(processLauncher.isExecutable("/test-binary-path")).andReturn(true);
+
+    shutdownHookRegistry.register(anyObject());
+
+    final String trigger =
+        "first-line\r\nsecond-line\r\nDevTools listening on ws://127.0.0.1:9123/\r\nthird-line\r\nforth-line\r\n";
+    expect(process.getInputStream()).andReturn(new ByteArrayInputStream(trigger.getBytes()));
+
+    expect(processLauncher.launch(eq("/test-binary-path"), anyObject())).andReturn(process);
+
+    expect(FilesUtils.randomTempDir("cdt-user-data-dir")).andReturn("temp-user-data-dir");
+
+    replayAll();
+    PowerMock.replay(FilesUtils.class);
+
+    ChromeService launch = launcher.launch();
+
+    verifyAll();
+    PowerMock.verify(FilesUtils.class);
+
+    assertNotNull(launch);
+    assertTrue(launch instanceof ChromeServiceImpl);
+
+    assertEquals(9123, ((ChromeServiceImpl) launch).getPort());
+
+    assertEquals(0, loggingEvents.size());
+  }
+
   private static void assertUserDataDir(List<String> arguments) {
     boolean hasUserDataDir = false;
     for (String argument : arguments) {

cdt-java-client/src/test/java/com/github/kklisura/cdt/launch/utils/LogCollector.java

@@ -0,0 +1,45 @@
+package com.github.kklisura.cdt.launch.utils;
+
+/*-
+ * #%L
+ * cdt-java-client
+ * %%
+ * Copyright (C) 2018 - 2021 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 ch.qos.logback.classic.spi.ILoggingEvent;
+import ch.qos.logback.core.AppenderBase;
+import java.util.List;
+
+/**
+ * An appender that collects the log events to an array.
+ *
+ * @author Kenan Klisura
+ */
+public class LogCollector extends AppenderBase<ILoggingEvent> {
+  private final List<String> loggingEventList;
+
+  public LogCollector(List<String> loggingEventList) {
+    this.name = "loggingEvents-appender";
+    this.loggingEventList = loggingEventList;
+    start();
+  }
+
+  @Override
+  protected void append(ILoggingEvent eventObject) {
+    loggingEventList.add("[" + eventObject.getLevel() + "] " + eventObject.getMessage());
+  }
+}