org.scalatestplus.play.MixedFixtures.scala Maven / Gradle / Ivy
The newest version!
/*
* Copyright 2001-2014 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 play.api.test._
import org.scalatest._
import fixture._
import selenium.WebBrowser
import org.openqa.selenium.WebDriver
import org.openqa.selenium.firefox.FirefoxDriver
import org.openqa.selenium.firefox.FirefoxProfile
import org.openqa.selenium.htmlunit.HtmlUnitDriver
import org.openqa.selenium.safari.SafariDriver
import org.openqa.selenium.chrome.ChromeDriver
import org.openqa.selenium.ie.InternetExplorerDriver
import BrowserFactory.UnavailableDriver
import org.openqa.selenium.safari.SafariDriver
/**
* Trait that helps you provide different fixtures to different tests: a `FakeApplication`, a `TestServer`, or one
* of the Selenium `WebDrivers`s.
*
* Trait `MixedFixtures` can be mixed into any `fixture.Suite`. For convenience it is
* mixed into [[org.scalatestplus.play.MixedPlaySpec MixedPlaySpec]]. In a `fixture.Suite`, tests can
* take a no-arg function. `MixedFixtures` provides several no-arg function classes (classes extending `Function0`) that
* can be used to provide different fixtures for different tests.
*
* If a test needs a `FakeApplication`, use the `App` function, like this:
*
*
* "provide a FakeApplication" in new App(fakeApp("ehcacheplugin" -> "disabled")) {
* app.configuration.getString("ehcacheplugin") mustBe Some("disabled")
* }
*
*
* If a test needs a `FakeApplication` and running `TestServer`, use the `Server` function, like this:
*
*
* "send 404 on a bad request" in new Server {
* import java.net._
* val url = new URL("http://localhost:" + port + "/boom")
* val con = url.openConnection().asInstanceOf[HttpURLConnection]
* try con.getResponseCode mustBe 404
* finally con.disconnect()
* }
*
*
* If a test needs a `FakeApplication`, running `TestServer`, and Selenium driver, use
* one of functions `Chrome`, `Firefox`, `HtmlUnit`, `InternetExplorer`, or `Safari`.
* If the chosen Selenium driver is unavailable on the host platform, the test will
* be automatically canceled. Here's an example that uses the `Safari` function:
*
*
* "provide a web driver" in new Safari(fakeApp()) {
* go to ("http://localhost:" + port + "/testing")
* pageTitle mustBe "Test Page"
* click on find(name("b")).value
* eventually { pageTitle mustBe "scalatest" }
* }
*
*
* Here's a complete example:
*
*
* package org.scalatestplus.play.examples.mixedfixtures
*
* import play.api.test._
* import org.scalatest._
* import org.scalatestplus.play._
* import play.api.{Play, Application}
*
* class ExampleSpec extends MixedPlaySpec {
*
* // Some helper methods
* def fakeApp[A](elems: (String, String)*) = FakeApplication(additionalConfiguration = Map(elems:_*),
* withRoutes = {
* case ("GET", "/testing") =>
* Action(
* Results.Ok(
* "<html>" +
* "<head><title>Test Page</title></head>" +
* "<body>" +
* "<input type='button' name='b' value='Click Me' onclick='document.title=\"scalatest\"' />" +
* "</body>" +
* "</html>"
* ).as("text/html")
* )
* }
* )
* def getConfig(key: String)(implicit app: Application) = app.configuration.getString(key)
*
* // If a test just needs a FakeApplication, use "new App":
* "The App function" must {
* "provide a FakeApplication" in new App(fakeApp("ehcacheplugin" -> "disabled")) {
* app.configuration.getString("ehcacheplugin") mustBe Some("disabled")
* }
* "make the FakeApplication available implicitly" in new App(fakeApp("ehcacheplugin" -> "disabled")) {
* getConfig("ehcacheplugin") mustBe Some("disabled")
* }
* "start the FakeApplication" in new App(fakeApp("ehcacheplugin" -> "disabled")) {
* Play.maybeApplication mustBe Some(app)
* }
* }
*
* // If a test needs a FakeApplication and running TestServer, use "new Server":
* "The Server function" must {
* "provide a FakeApplication" in new Server(fakeApp("ehcacheplugin" -> "disabled")) {
* app.configuration.getString("ehcacheplugin") mustBe Some("disabled")
* }
* "make the FakeApplication available implicitly" in new Server(fakeApp("ehcacheplugin" -> "disabled")) {
* getConfig("ehcacheplugin") mustBe Some("disabled")
* }
* "start the FakeApplication" in new Server(fakeApp("ehcacheplugin" -> "disabled")) {
* Play.maybeApplication mustBe Some(app)
* }
* import Helpers._
* "send 404 on a bad request" in new Server {
* import java.net._
* val url = new URL("http://localhost:" + port + "/boom")
* val con = url.openConnection().asInstanceOf[HttpURLConnection]
* try con.getResponseCode mustBe 404
* finally con.disconnect()
* }
* }
*
* // If a test needs a FakeApplication, running TestServer, and Selenium
* // HtmlUnit driver use "new HtmlUnit":
* "The HtmlUnit function" must {
* "provide a FakeApplication" in new HtmlUnit(fakeApp("ehcacheplugin" -> "disabled")) {
* app.configuration.getString("ehcacheplugin") mustBe Some("disabled")
* }
* "make the FakeApplication available implicitly" in new HtmlUnit(fakeApp("ehcacheplugin" -> "disabled")) {
* getConfig("ehcacheplugin") mustBe Some("disabled")
* }
* "start the FakeApplication" in new HtmlUnit(fakeApp("ehcacheplugin" -> "disabled")) {
* Play.maybeApplication mustBe Some(app)
* }
* import Helpers._
* "send 404 on a bad request" in new HtmlUnit {
* import java.net._
* val url = new URL("http://localhost:" + port + "/boom")
* val con = url.openConnection().asInstanceOf[HttpURLConnection]
* try con.getResponseCode mustBe 404
* finally con.disconnect()
* }
* "provide a web driver" in new HtmlUnit(fakeApp()) {
* go to ("http://localhost:" + port + "/testing")
* pageTitle mustBe "Test Page"
* click on find(name("b")).value
* eventually { pageTitle mustBe "scalatest" }
* }
* }
*
* // If a test needs a FakeApplication, running TestServer, and Selenium
* // Firefox driver use "new Firefox":
* "The Firefox function" must {
* "provide a FakeApplication" in new Firefox(fakeApp("ehcacheplugin" -> "disabled")) {
* app.configuration.getString("ehcacheplugin") mustBe Some("disabled")
* }
* "make the FakeApplication available implicitly" in new Firefox(fakeApp("ehcacheplugin" -> "disabled")) {
* getConfig("ehcacheplugin") mustBe Some("disabled")
* }
* "start the FakeApplication" in new Firefox(fakeApp("ehcacheplugin" -> "disabled")) {
* Play.maybeApplication mustBe Some(app)
* }
* import Helpers._
* "send 404 on a bad request" in new Firefox {
* import java.net._
* val url = new URL("http://localhost:" + port + "/boom")
* val con = url.openConnection().asInstanceOf[HttpURLConnection]
* try con.getResponseCode mustBe 404
* finally con.disconnect()
* }
* "provide a web driver" in new Firefox(fakeApp()) {
* go to ("http://localhost:" + port + "/testing")
* pageTitle mustBe "Test Page"
* click on find(name("b")).value
* eventually { pageTitle mustBe "scalatest" }
* }
* }
*
* // If a test needs a FakeApplication, running TestServer, and Selenium
* // Safari driver use "new Safari":
* "The Safari function" must {
* "provide a FakeApplication" in new Safari(fakeApp("ehcacheplugin" -> "disabled")) {
* app.configuration.getString("ehcacheplugin") mustBe Some("disabled")
* }
* "make the FakeApplication available implicitly" in new Safari(fakeApp("ehcacheplugin" -> "disabled")) {
* getConfig("ehcacheplugin") mustBe Some("disabled")
* }
* "start the FakeApplication" in new Safari(fakeApp("ehcacheplugin" -> "disabled")) {
* Play.maybeApplication mustBe Some(app)
* }
* import Helpers._
* "send 404 on a bad request" in new Safari {
* import java.net._
* val url = new URL("http://localhost:" + port + "/boom")
* val con = url.openConnection().asInstanceOf[HttpURLConnection]
* try con.getResponseCode mustBe 404
* finally con.disconnect()
* }
* "provide a web driver" in new Safari(fakeApp()) {
* go to ("http://localhost:" + port + "/testing")
* pageTitle mustBe "Test Page"
* click on find(name("b")).value
* eventually { pageTitle mustBe "scalatest" }
* }
* }
*
* // If a test needs a FakeApplication, running TestServer, and Selenium
* // Chrome driver use "new Chrome":
* "The Chrome function" must {
* "provide a FakeApplication" in new Chrome(fakeApp("ehcacheplugin" -> "disabled")) {
* app.configuration.getString("ehcacheplugin") mustBe Some("disabled")
* }
* "make the FakeApplication available implicitly" in new Chrome(fakeApp("ehcacheplugin" -> "disabled")) {
* getConfig("ehcacheplugin") mustBe Some("disabled")
* }
* "start the FakeApplication" in new Chrome(fakeApp("ehcacheplugin" -> "disabled")) {
* Play.maybeApplication mustBe Some(app)
* }
* import Helpers._
* "send 404 on a bad request" in new Chrome {
* import java.net._
* val url = new URL("http://localhost:" + port + "/boom")
* val con = url.openConnection().asInstanceOf[HttpURLConnection]
* try con.getResponseCode mustBe 404
* finally con.disconnect()
* }
* "provide a web driver" in new Chrome(fakeApp()) {
* go to ("http://localhost:" + port + "/testing")
* pageTitle mustBe "Test Page"
* click on find(name("b")).value
* eventually { pageTitle mustBe "scalatest" }
* }
* }
*
* // If a test needs a FakeApplication, running TestServer, and Selenium
* // InternetExplorer driver use "new InternetExplorer":
* "The InternetExplorer function" must {
* "provide a FakeApplication" in new InternetExplorer(fakeApp("ehcacheplugin" -> "disabled")) {
* app.configuration.getString("ehcacheplugin") mustBe Some("disabled")
* }
* "make the FakeApplication available implicitly" in new InternetExplorer(fakeApp("ehcacheplugin" -> "disabled")) {
* getConfig("ehcacheplugin") mustBe Some("disabled")
* }
* "start the FakeApplication" in new InternetExplorer(fakeApp("ehcacheplugin" -> "disabled")) {
* Play.maybeApplication mustBe Some(app)
* }
* import Helpers._
* "send 404 on a bad request" in new InternetExplorer {
* import java.net._
* val url = new URL("http://localhost:" + port + "/boom")
* val con = url.openConnection().asInstanceOf[HttpURLConnection]
* try con.getResponseCode mustBe 404
* finally con.disconnect()
* }
* "provide a web driver" in new InternetExplorer(fakeApp()) {
* go to ("http://localhost:" + port + "/testing")
* pageTitle mustBe "Test Page"
* click on find(name("b")).value
* eventually { pageTitle mustBe "scalatest" }
* }
* }
*
* // If a test does not need any special fixtures, just
* // write "in { () => ..."
* "Any old thing" must {
* "be doable without much boilerplate" in { () =>
* 1 + 1 mustEqual 2
* }
* }
* }
*
*/
trait MixedFixtures extends SuiteMixin with UnitFixture { this: fixture.Suite =>
/**
* `NoArg` subclass that provides a `FakeApplication` fixture.
*/
abstract class App(val app: FakeApplication = FakeApplication()) extends NoArg {
/**
* Makes the passed-in `FakeApplication` implicit.
*/
implicit def implicitApp: FakeApplication = app
/**
* Runs the passed in `FakeApplication` before executing the test body, ensuring it is closed after the test body completes.
*/
override def apply() {
def callSuper = super.apply() // this is needed for Scala 2.10 to work
Helpers.running(app)(callSuper)
}
}
/**
* `NoArg` subclass that provides a fixture composed of a `FakeApplication` and running `TestServer`.
*/
abstract class Server(val app: FakeApplication = FakeApplication(), val port: Int = Helpers.testServerPort) extends NoArg {
/**
* Makes the passed in `FakeApplication` implicit.
*/
implicit def implicitApp: FakeApplication = app
/**
* Implicit `PortNumber` instance that wraps `port`. The value returned from `portNumber.value`
* will be same as the value of `port`.
*/
implicit lazy val portNumber: PortNumber = PortNumber(port)
/**
* Runs a `TestServer` using the passed-in `FakeApplication` and port before executing the
* test body, ensuring both are stopped after the test body completes.
*/
override def apply() {
def callSuper = super.apply() // this is needed for Scala 2.10 to work
Helpers.running(TestServer(port, app))(callSuper)
}
}
/**
* `NoArg` subclass that provides a fixture composed of a `FakeApplication`, running `TestServer`, and
* Selenium `HtmlUnitDriver`.
*/
abstract class HtmlUnit(val app: FakeApplication = FakeApplication(), val port: Int = Helpers.testServerPort) extends WebBrowser with NoArg with HtmlUnitFactory {
/**
* A lazy implicit instance of `HtmlUnitDriver`. It will hold `UnavailableDriver` if `HtmlUnitDriver`
* is not available in the running machine.
*/
implicit lazy val webDriver: WebDriver = createWebDriver()
/**
* Makes the passed in `FakeApplication` implicit.
*/
implicit def implicitApp: FakeApplication = app
/**
* Implicit `PortNumber` instance that wraps `port`. The value returned from `portNumber.value`
* will be same as the value of `port`.
*/
implicit lazy val portNumber: PortNumber = PortNumber(port)
/**
* Runs a `TestServer` using the passed-in `FakeApplication` and port before executing the
* test body, which can use the `HtmlUnitDriver` provided by `webDriver`, ensuring all
* are are stopped after the test body completes.
*/
override def apply() {
webDriver match {
case UnavailableDriver(ex, errorMessage) =>
ex match {
case Some(e) => cancel(errorMessage, e)
case None => cancel(errorMessage)
}
case _ =>
def callSuper = super.apply() // this is needed for Scala 2.10 to work
try Helpers.running(TestServer(port, app))(callSuper)
finally webDriver.close()
}
}
}
/**
* `NoArg` subclass that provides a fixture composed of a `FakeApplication`, running `TestServer`, and
* Selenium `FirefoxDriver`.
*/
abstract class Firefox(val app: FakeApplication = FakeApplication(), val port: Int = Helpers.testServerPort) extends WebBrowser with NoArg with FirefoxFactory {
/**
* A lazy implicit instance of `FirefoxDriver`, it will hold `UnavailableDriver` if `FirefoxDriver`
* is not available in the running machine.
*/
implicit lazy val webDriver: WebDriver = createWebDriver()
/**
* Makes the passed in `FakeApplication` implicit.
*/
implicit def implicitApp: FakeApplication = app
/**
* Implicit `PortNumber` instance that wraps `port`. The value returned from `portNumber.value`
* will be same as the value of `port`.
*/
implicit lazy val portNumber: PortNumber = PortNumber(port)
/**
* Runs a `TestServer` using the passed-in `FakeApplication` and port before executing the
* test body, which can use the `FirefoxDriver` provided by `webDriver`, ensuring all
* are are stopped after the test body completes.
*/
override def apply() {
webDriver match {
case UnavailableDriver(ex, errorMessage) =>
ex match {
case Some(e) => cancel(errorMessage, e)
case None => cancel(errorMessage)
}
case _ =>
def callSuper = super.apply() // this is needed for Scala 2.10 to work
try Helpers.running(TestServer(port, app))(callSuper)
finally webDriver.close()
}
}
}
/**
* `NoArg` subclass that provides a fixture composed of a `FakeApplication`, running `TestServer`, and
* Selenium `SafariDriver`.
*/
abstract class Safari(val app: FakeApplication = FakeApplication(), val port: Int = Helpers.testServerPort) extends WebBrowser with NoArg with SafariFactory {
/**
* A lazy implicit instance of `SafariDriver`, it will hold `UnavailableDriver` if `SafariDriver`
* is not available in the running machine.
*/
implicit lazy val webDriver: WebDriver = createWebDriver()
/**
* Makes the passed in `FakeApplication` implicit.
*/
implicit def implicitApp: FakeApplication = app
/**
* Implicit `PortNumber` instance that wraps `port`. The value returned from `portNumber.value`
* will be same as the value of `port`.
*/
implicit lazy val portNumber: PortNumber = PortNumber(port)
/**
* Runs a `TestServer` using the passed-in `FakeApplication` and port before executing the
* test body, which can use the `SafariDriver` provided by `webDriver`, ensuring all
* are are stopped after the test body completes.
*/
override def apply() {
webDriver match {
case UnavailableDriver(ex, errorMessage) =>
ex match {
case Some(e) => cancel(errorMessage, e)
case None => cancel(errorMessage)
}
case _ =>
def callSuper = super.apply() // this is needed for Scala 2.10 to work
try Helpers.running(TestServer(port, app))(callSuper)
finally webDriver.quit()
}
}
}
/**
* `NoArg` subclass that provides a fixture composed of a `FakeApplication`, running `TestServer`, and
* Selenium `ChromeDriver`.
*/
abstract class Chrome(val app: FakeApplication = FakeApplication(), val port: Int = Helpers.testServerPort) extends WebBrowser with NoArg with ChromeFactory {
/**
* A lazy implicit instance of `ChromeDriver`, it will hold `UnavailableDriver` if `ChromeDriver`
* is not available in the running machine.
*/
implicit lazy val webDriver: WebDriver = createWebDriver()
/**
* Makes the passed in `FakeApplication` implicit.
*/
implicit def implicitApp: FakeApplication = app
/**
* Implicit `PortNumber` instance that wraps `port`. The value returned from `portNumber.value`
* will be same as the value of `port`.
*/
implicit lazy val portNumber: PortNumber = PortNumber(port)
/**
* Runs a `TestServer` using the passed-in `FakeApplication` and port before executing the
* test body, which can use the `ChromeDriver` provided by `webDriver`, ensuring all
* are are stopped after the test body completes.
*/
override def apply() {
webDriver match {
case UnavailableDriver(ex, errorMessage) =>
val msg = Resources("cantCreateChromeDriver")
ex match {
case Some(e) => cancel(errorMessage, e)
case None => cancel(errorMessage)
}
case _ =>
def callSuper = super.apply() // this is needed for Scala 2.10 to work
try Helpers.running(TestServer(port, app))(callSuper)
finally webDriver.quit()
}
}
}
/**
* `NoArg` subclass that provides a fixture composed of a `FakeApplication`, running `TestServer`, and
* Selenium `InternetExplorerDriver`.
*/
abstract class InternetExplorer(val app: FakeApplication = FakeApplication(), val port: Int = Helpers.testServerPort) extends WebBrowser with NoArg with InternetExplorerFactory {
/**
* A lazy implicit instance of `InternetExplorerDriver`, it will hold `UnavailableDriver` if `InternetExplorerDriver`
* is not available in the running machine.
*/
implicit lazy val webDriver: WebDriver = createWebDriver()
/**
* Makes the passed in `FakeApplication` implicit.
*/
implicit def implicitApp: FakeApplication = app
/**
* Implicit `PortNumber` instance that wraps `port`. The value returned from `portNumber.value`
* will be same as the value of `port`.
*/
implicit lazy val portNumber: PortNumber = PortNumber(port)
/**
* Runs a `TestServer` using the passed-in `FakeApplication` and port before executing the
* test body, which can use the `InternetExplorerDriver` provided by `webDriver`, ensuring all
* are are stopped after the test body completes.
*/
override def apply() {
webDriver match {
case UnavailableDriver(ex, errorMessage) =>
val msg = Resources("cantCreateInternetExplorerDriver")
ex match {
case Some(e) => cancel(errorMessage, e)
case None => cancel(errorMessage)
}
case _ =>
def callSuper = super.apply() // this is needed for Scala 2.10 to work
try Helpers.running(TestServer(port, app))(callSuper)
finally webDriver.close()
}
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy