/**
    * This file Copyright (c) 2017 Magnolia International
    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
    *
    *
    * This file is dual-licensed under both the Magnolia
    * Network Agreement and the GNU General Public License.
    * You may elect to use one or the other of these licenses.
    *
   * This file is distributed in the hope that it will be
   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
   * implied warranty of MERCHANTABILITY or FITNESS FOR A
   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
   * Redistribution, except as permitted by whichever of the GPL
   * or MNA you select, is prohibited.
   *
   * 1. For the GPL license (GPL), you can redistribute and/or
   * modify this file under the terms of the GNU General
   * Public License, Version 3, as published by the Free Software
   * Foundation.  You should have received a copy of the GNU
   * General Public License, Version 3 along with this program;
   * if not, write to the Free Software Foundation, Inc., 51
   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   *
   * 2. For the Magnolia Network Agreement (MNA), this file
   * and the accompanying materials are made available under the
   * terms of the MNA which accompanies this distribution, and
   * is available at http://www.magnolia-cms.com/mna.html
   *
   * Any modifications to this file must keep this entire header
   * intact.
   *
   */
  package info.magnolia.integrationtests.docker;
  
  import org.junit.runner.Description;
  import org.testcontainers.containers.BindMode;
  import org.testcontainers.containers.GenericContainer;
  import org.testcontainers.containers.SeleniumUtils;
  import org.testcontainers.containers.traits.LinkableContainer;
  import org.testcontainers.containers.wait.LogMessageWaitStrategy;
  
  /**
   * Forked from {@link org.testcontainers.containers.BrowserWebDriverContainer similar TestContainers' class}.
   * Does not provide a web driver itself, but rather starts a Selenium node and attaches it to a configured hub.
   */
  public class SeleniumGridNodeContainer extends GenericContainer<SeleniumGridNodeContainer> implements LinkableContainer {
  
      private static final String CHROME_IMAGE = "selenium/node-chrome%s:%s";
      private static final String FIREFOX_IMAGE = "selenium/node-firefox%s:%s";
  
      private static final int VNC_PORT = 5900;
  
      private boolean debug = false;
  
      private String targetBrowser;
  
      public SeleniumGridNodeContainer() {
          this.waitStrategy = new LogMessageWaitStrategy().withRegEx(".*node is registered.*\n");
      }
  
      @Override
      protected Integer getLivenessCheckPort() {
          return getMappedPort(VNC_PORT);
      }
  
      public SeleniumGridNodeContainer withDebugMode(boolean isDebugModeOn) {
          this.debug = isDebugModeOn;
          return this;
      }
  
      public SeleniumGridNodeContainer withTargetBrowser(String targetBrowser) {
          this.targetBrowser = targetBrowser;
          return this;
      }
  
      public SeleniumGridNodeContainer withSeleniumHubHost(String seleniumHubHost) {
          return withEnv("HUB_PORT_4444_TCP_ADDR", seleniumHubHost);
      }
  
      public SeleniumGridNodeContainer withSeleniumHubPort(int seleniumHubPort) {
          return withEnv("HUB_PORT_4444_TCP_PORT", String.valueOf(seleniumHubPort));
      }
  
      public SeleniumGridNodeContainer withUploadDirectory(String uploadDirectory) {
          return withFileSystemBind(uploadDirectory, "/var/upload", BindMode.READ_ONLY);
      }
  
      public SeleniumGridNodeContainer withTestNetwork(String testNetwork) {
          return withCreateContainerCmdModifier(cmd -> cmd.withNetworkMode(testNetwork));
      }
  
      @Override
      protected void configure() {
  
          String timeZone = System.getProperty("user.timezone");
  
          if (timeZone == null || timeZone.isEmpty()) {
              timeZone = "Etc/UTC";
         }
 
         addFileSystemBind("/dev/shm", "/dev/shm", BindMode.READ_WRITE);
         setDockerImageName(getImageForSelectedBrowser());
         
         addExposedPorts(VNC_PORT);
         addEnv("TZ", timeZone);
         addEnv("no_proxy", "localhost");
         setCommand("/opt/bin/entry_point.sh");
 
         addEnv("SCREEN_DEPTH", "24");
         addEnv("SCREEN_WIDTH", "1280");
         addEnv("SCREEN_HEIGHT", "1024");
 
         /*
          * Some unreliability of the selenium browser containers has been observed, so allow multiple attempts to start.
          */
         setStartupAttempts(3);
     }
 
     public String getImageForSelectedBrowser() {
 
         final String seleniumVersion = SeleniumUtils.determineClasspathSeleniumVersion();
         final String debugSuffix = debug ? "-debug" : "";
 
         switch (targetBrowser) {
         case "chrome":
             return String.format(CHROME_IMAGE, debugSuffix, seleniumVersion);
         case "firefox":
             return String.format(FIREFOX_IMAGE, debugSuffix, seleniumVersion);
         default:
             throw new UnsupportedOperationException(String.format("Browser name must be 'chrome' or 'firefox'; provided '%s' is not supported", targetBrowser));
         }
     }
 
     @Override
     protected void finished(Description description) {
         this.stop();
     }
 }