AbstractSeleniumTestCase

package org.itracker.selenium;

import com.google.common.base.Function;
import org.apache.commons.io.FileUtils;
import org.apache.log4j.Logger;
import org.itracker.AbstractDependencyInjectionTest;
import org.junit.Before;
import org.openqa.selenium.*;
import org.openqa.selenium.support.ui.FluentWait;
import org.subethamail.wiser.Wiser;

import java.io.File;
import java.util.concurrent.TimeUnit;

import static org.itracker.Assert.*;

/**
 * It is a base class for all Selenium-based test cases.
 * It performs initialization of Selenium client part and
 * retrieves some generally-used parameters like hose application
 * is running at, port, context.
 *
 * @author Andrey Sergievskiy <seas@andreysergievskiy.com>
 */
@SuppressWarnings("WeakerAccess")
public abstract class AbstractSeleniumTestCase
        extends AbstractDependencyInjectionTest {
   protected final static String SE_TIMEOUT = "2000";
   protected static final Wiser wiser;

   protected WebDriver driver;
   protected String applicationHost;
   protected int applicationPort;
   protected String applicationPath;
   protected String applicationURL;
   static final Logger log = Logger.getLogger(AbstractSeleniumTestCase.class);

   static {
      wiser = new Wiser(SeleniumManager.getSMTPPort());
      wiser.start();
      Logger.getLogger(AbstractSeleniumTestCase.class).info("started wiser on " + wiser.getServer().getPort());

      Runtime.getRuntime().addShutdownHook(new Thread(
              new Runnable() {
                 @Override
                 public void run() {

                    try {
                       wiser.stop();
                       Logger.getLogger(getClass()).info("stopped wiser " + wiser);
                    } catch (RuntimeException e) {
                       Logger.getLogger(getClass()).warn("could not stop running wiser: " + wiser);
                       Logger.getLogger(getClass()).debug("exception caught", e);
                    }
                 }
              }
      ));
   }

   @Before
   public void seleniumStart() throws Exception {
      driver = SeleniumManager.getWebDriver();
      assertNotNull("driver", driver);
      driver.manage().timeouts().implicitlyWait(Long.parseLong(SE_TIMEOUT), TimeUnit.MILLISECONDS);
      applicationHost = SeleniumManager.getApplicationHost();
      applicationPort = SeleniumManager.getApplicationPort();
      applicationPath = SeleniumManager.getApplicationPath();
      applicationURL = "http://" + applicationHost + ":" + applicationPort + "/"
              + applicationPath;
   }

   public final WebElement assertElementPresent(By by) {
      if (log.isDebugEnabled()) {
         log.debug("element present by " + by);
      }
      assertTrue(driver.getCurrentUrl() + " " + by + " present", isElementPresent(by));
      return driver.findElement(by);
   }

   public final void assertElementNotPresent(By by) {
      if (log.isDebugEnabled()) {
         log.debug("element not present by " + by);
      }
      assertFalse(driver.getCurrentUrl() + " " + by + " present", isElementPresent(by));
   }

   public final WebElement assertElementTextEquals(String expected, By by) {
      WebElement el = assertElementPresent(by);
      if (log.isDebugEnabled()) {
         log.debug("text equals '" + expected + "' by " + by);
      }
      assertEquals(driver.getCurrentUrl() + " " + by, expected, el.getText());
      return el;
   }

   public final void assertElementCountEquals(int expected, By by) {
      if (log.isDebugEnabled()) {
         log.debug("element count '" + expected + "' by " + by);
      }
      assertEquals(driver.getCurrentUrl() + " " + by + " size", expected, driver.findElements(by).size());
   }

   public final WebElement assertElementPresent(By by, SearchContext searchContext) {
      if (log.isDebugEnabled()) {
         log.debug("element present in " + searchContext + " by " + by);
      }
      assertTrue(driver.getCurrentUrl() + " " + by + " present in " + searchContext, isElementPresent(by, searchContext));
      return searchContext.findElement(by);
   }

   public final void assertElementNotPresent(By by, SearchContext searchContext) {
      if (log.isDebugEnabled()) {
         log.debug("element not present in " + searchContext + " by " + by);
      }
      assertFalse(driver.getCurrentUrl() + " " + by + " present in " + searchContext, isElementPresent(by, searchContext));
   }

   public final WebElement assertElementTextEquals(String expected, By by, SearchContext searchContext) {
      WebElement el = assertElementPresent(by, searchContext);
      if (log.isDebugEnabled()) {
         log.debug("text equals '" + expected + " in " + searchContext + "' by " + by);
      }
      assertEquals(driver.getCurrentUrl() + "  in " + searchContext + " ny " + by, expected, el.getText());
      return el;
   }

   public final void assertElementCountEquals(int expected, By by, SearchContext searchContext) {
      if (log.isDebugEnabled()) {
         log.debug("element count '" + expected + "' in " + searchContext + " by " + by);
      }
      assertEquals(driver.getCurrentUrl() + " " + by + " size in " + searchContext, expected, searchContext.findElements(by).size());
   }


   /**
    * This will initialize a new selenium session for this test scope.
    */
   protected void closeSession() {
      SeleniumManager.closeSession(driver);
   }

   /**
    * Assert being on login page and enter the credentials.
    * <p>Success will be asserted with <code>itracker</code> Cookie present.</p>
    */
   protected final void login(final String username, final String password) {

      log.debug("login called with " + username + ", " + password);

      assertElementPresent(By.name("login")).sendKeys(username);
      assertElementPresent(By.name("password")).sendKeys(password);
      assertElementPresent(By.id("btn-login")).click();
      waitForPageToLoad();
      assertElementPresent(By.name("lookupForm"));

      log.debug("loginUser, logged in " + username + ", cookies: " + driver.manage().getCookies());
   }

   private boolean isElementPresent(By by) {
      return isElementPresent(by, driver);
   }

   private boolean isElementPresent(By by, SearchContext context) {
      try {
         driver.manage().timeouts().implicitlyWait(200, TimeUnit.MILLISECONDS);
         context.findElement(by);
         return true;
      } catch (NoSuchElementException e) {
         if (log.isDebugEnabled())
            log.debug("isElementPresent: not present " + by + "\n in:\n<"
                    + driver.getCurrentUrl() + ">\n"
                    + driver.getPageSource());
         return false;
      } finally {
         driver.manage().timeouts().implicitlyWait(Long.parseLong(SE_TIMEOUT), TimeUnit.MILLISECONDS);
      }

   }

   protected void waitForPageToLoad() {
      waitForPageToLoad(Long.parseLong(SE_TIMEOUT));
   }

   protected void waitForPageToLoad(long timeout) {

      new FluentWait<>(driver)
              .withTimeout(timeout, TimeUnit.MILLISECONDS)
              .pollingEvery(200, TimeUnit.MILLISECONDS)
              .until(new Function<WebDriver, Boolean>() {
                 @Override
                 public Boolean apply(WebDriver webDriver) {
                    try {
                       Object result = ((JavascriptExecutor) driver).executeScript(
                               "return 'complete' == document.readyState;");

                       if (Boolean.TRUE.equals(result)) {
                          return true;
                       }
                    } catch (Exception e) {
                       // Possible page reload. Fine
                    }
                    return false;
                 }
              });
   }

   public static void takeSnapShot(WebDriver webdriver, String fileWithPath) throws Exception {

      if (!(webdriver instanceof TakesScreenshot)) {
         log.info("webdriver is not TakesScreenshot: " + webdriver);
         return;
      }
      //Convert web driver object to TakeScreenshot

      TakesScreenshot scrShot = ((TakesScreenshot) webdriver);

      //Call getScreenshotAs method to create image file

      File SrcFile = scrShot.getScreenshotAs(OutputType.FILE);

      //Move image file to new destination

      File DestFile = new File(fileWithPath);

      //Copy file at destination

      FileUtils.copyFile(SrcFile, DestFile);

   }

}