org.scalatestplus.play.ChromeFactory.scala Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2001-2022 Artima, Inc.
 *
 * 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.
 */

package org.scalatestplus.play

import org.openqa.selenium.WebDriver
import org.openqa.selenium.chrome.ChromeDriver
import org.openqa.selenium.chrome.ChromeDriverService
import org.openqa.selenium.chrome.ChromeOptions
import org.scalatestplus.play.BrowserFactory.UnavailableDriver

/**
 * Factory whose `createWebDriver` method will either return a new Selenium `ChromeDriver`, or
 * [[org.scalatestplus.play.BrowserFactory.UnavailableDriver UnavailableDriver]], if Chrome is not available on the host platform.
 *
 * Traits [[org.scalatestplus.play.OneBrowserPerSuite OneBrowserPerSuite]] and
 * [[org.scalatestplus.play.OneBrowserPerTest OneBrowserPerTest]] extend `BrowserFactory` and therefore require
 * you to fill in the `createWebDriver` method, usually by mixing in one of the `BrowserFactory` subtraits such as
 * `ChromeFactory`.
 */
trait ChromeFactory extends BrowserFactory {

  /**
   * Default [[ChromeOptions]] used to create a [[ChromeDriver]] instance. Override to provide different options.
   */
  lazy val chromeOptions: ChromeOptions = new ChromeOptions()

  /**
   * Default [[ChromeDriverService]] used to create a [[ChromeDriver]] instance. Override to provide different service.
   */
  def chromeDriverService: ChromeDriverService = ChromeDriverService.createDefaultService()

  /**
   * Creates a new instance of a Selenium [[ChromeDriver]], or returns a [[BrowserFactory.UnavailableDriver]] that
   * includes the exception that indicated the driver was not supported on the host platform and an appropriate
   * error message.
   *
   * @return an new instance of a Selenium [[ChromeDriver]], or a [[BrowserFactory.UnavailableDriver]] if it is not
   * available on the host platform.
   *
   * @see [[chromeOptions]] and [[chromeDriverService]].
   */
  def createWebDriver(): WebDriver =
    try {
      new ChromeDriver(chromeDriverService, chromeOptions)
    } catch {
      case ex: Throwable => UnavailableDriver(Some(ex), Resources("cantCreateChromeDriver", ex.getMessage))
    }
}

/**
 * Companion object to trait `ChromeFactory` that mixes in the trait.
 */
object ChromeFactory extends ChromeFactory {

  /**
   * Creates a new instance of a Selenium [[ChromeDriver]], using the specified [[ChromeOptions]],
   * or returns a [[BrowserFactory.UnavailableDriver]] that includes the exception that indicated the driver
   * was not supported on the host platform and an appropriate error message.
   *
   * @return a new instance of a Selenium [[ChromeDriver]], using the specified [[ChromeOptions]],
   *   or a [[BrowserFactory.UnavailableDriver]] if a Chrome driver is not available on the host platform.
   */
  def createDriver(options: ChromeOptions): WebDriver = {
    try {
      new ChromeDriver(options)
    } catch {
      case ex: Throwable => UnavailableDriver(Some(ex), Resources("cantCreateChromeDriver", ex.getMessage))
    }
  }

  /**
   * Creates a new instance of a Selenium [[ChromeDriver]], using the specified [[ChromeDriverService]] and [[ChromeOptions]],
   * or returns a [[BrowserFactory.UnavailableDriver]] that includes the exception that indicated the driver
   * was not supported on the host platform and an appropriate error message.
   *
   * @return a new instance of a Selenium [[ChromeDriver]], using the specified [[ChromeDriverService]] and [[ChromeOptions]],
   *   or a [[BrowserFactory.UnavailableDriver]] if a Chrome driver is not available on the host platform.
   */
  def createWebDriver(service: ChromeDriverService, options: ChromeOptions): WebDriver = {
    try {
      new ChromeDriver(service, options)
    } catch {
      case ex: Throwable => UnavailableDriver(Some(ex), Resources("cantCreateChromeDriver", ex.getMessage))
    }
  }
}