OneServerPerTest

Trait that provides a new Application and running TestServer instance for each test executed in a ScalaTest Suite.

This SuiteMixin trait overrides ScalaTest's withFixture method to create a new Application and TestServer before each test, and ensure they are cleaned up after the test has completed. The Application is available (implicitly) from method app. The TestServer's port number is available as port (and implicitly available as portNumber, wrapped in a PortNumber).

By default, this trait creates a new FakeApplication for each test using default parameter values, which is returned by the newAppForTest method defined in this trait. If your tests need an Application with non-default parameters, override newAppForTest to return it.

Here's an example that demonstrates some of the services provided by this trait:

package org.scalatestplus.play.examples.oneserverpertest

import play.api.test._
import org.scalatest._
import org.scalatestplus.play._
import play.api.{Play, Application}
import play.api.inject.guice._
import play.api.routing._

class ExampleSpec extends PlaySpec with OneServerPerTest {

  // Override newAppForTest if you need a FakeApplication with other than non-default parameters.
  implicit override def newAppForTest(testData: TestData): Application = new GuiceApplicationBuilder()
    .configure(Map("ehcacheplugin" -> "disabled"))
    .router(Router.from(TestRoute))
    .build()

  "The OneServerPerTest trait" must {
    "provide a FakeApplication" in {
      app.configuration.getString("ehcacheplugin") mustBe Some("disabled")
    }
    "make the FakeApplication available implicitly" in {
      def getConfig(key: String)(implicit app: Application) = app.configuration.getString(key)
      getConfig("ehcacheplugin") mustBe Some("disabled")
    }
    "start the FakeApplication" in {
      Play.maybeApplication mustBe Some(app)
    }
    "provide the port number" in {
      port mustBe Helpers.testServerPort
    }
    "provide an actual running server" in {
      import Helpers._
      import java.net._
      val url = new URL("http://localhost:" + port + "/boum")
      val con = url.openConnection().asInstanceOf[HttpURLConnection]
      try con.getResponseCode mustBe 404
      finally con.disconnect()
    }
  }
}

Self Type: OneServerPerTest with Suite
Source: OneServerPerTest.scala

Linear Supertypes

ServerProvider, SuiteMixin, AnyRef, Any

Abstract Value Members

abstract def expectedTestCount(filter: Filter): Int

Definition Classes
SuiteMixin
abstract def nestedSuites: IndexedSeq[Suite]

Definition Classes
SuiteMixin
abstract def rerunner: Option[String]

Definition Classes
SuiteMixin
abstract def run(testName: Option[String], args: Args): Status

Definition Classes
SuiteMixin
abstract def runNestedSuites(args: Args): Status

Attributes
protected
Definition Classes
SuiteMixin
abstract def runTest(testName: String, args: Args): Status

Attributes
protected
Definition Classes
SuiteMixin
abstract def runTests(testName: Option[String], args: Args): Status

Attributes
protected
Definition Classes
SuiteMixin
abstract val styleName: String

Definition Classes
SuiteMixin
abstract def suiteId: String

Definition Classes
SuiteMixin
abstract def suiteName: String

Definition Classes
SuiteMixin
abstract def tags: Map[String, Set[String]]

Definition Classes
SuiteMixin
abstract def testDataFor(testName: String, theConfigMap: ConfigMap): TestData

Definition Classes
SuiteMixin
abstract def testNames: Set[String]

Definition Classes
SuiteMixin

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
implicit final def app: Application

Implicit method that returns the FakeApplication instance for the current test.
Implicit method that returns the FakeApplication instance for the current test.

Definition Classes
OneServerPerTest → ServerProvider
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def newAppForTest(testData: TestData): Application

Creates new instance of Application with parameters set to their defaults.
Creates new instance of Application with parameters set to their defaults. Override this method if you need an Application created with non-default parameter values.
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
lazy val port: Int

The port used by the TestServer.
The port used by the TestServer. By default this will be set to the result returned from Helpers.testServerPort. You can override this to provide a different port number.

Definition Classes
OneServerPerTest → ServerProvider
implicit final lazy val portNumber: PortNumber

Implicit PortNumber instance that wraps port.
Implicit PortNumber instance that wraps port. The value returned from portNumber.value will be same as the value of port.
returns
the configured port number, wrapped in a PortNumber

Definition Classes
ServerProvider
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def withFixture(test: (OneServerPerTest.this)#NoArgTest): Outcome

Creates new Application and running TestServer instances before executing each test, and ensures they are cleaned up after the test completes.
Creates new Application and running TestServer instances before executing each test, and ensures they are cleaned up after the test completes. You can access the Application from your tests as app and the TestServer's port number as port.
test
the no-arg test function to run with a fixture
returns
the Outcome of the test execution

Definition Classes
OneServerPerTest → SuiteMixin

Related Doc: package play

trait OneServerPerTest extends SuiteMixin with ServerProvider

Abstract Value Members

abstract def expectedTestCount(filter: Filter): Int

abstract def nestedSuites: IndexedSeq[Suite]

abstract def rerunner: Option[String]

abstract def run(testName: Option[String], args: Args): Status

abstract def runNestedSuites(args: Args): Status

abstract def runTest(testName: String, args: Args): Status

abstract def runTests(testName: Option[String], args: Args): Status

abstract val styleName: String

abstract def suiteId: String

abstract def suiteName: String

abstract def tags: Map[String, Set[String]]

abstract def testDataFor(testName: String, theConfigMap: ConfigMap): TestData

abstract def testNames: Set[String]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

implicit final def app: Application

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

def newAppForTest(testData: TestData): Application

final def notify(): Unit

final def notifyAll(): Unit

lazy val port: Int

implicit final lazy val portNumber: PortNumber

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withFixture(test: (OneServerPerTest.this)#NoArgTest): Outcome

Inherited from ServerProvider

Inherited from SuiteMixin

Inherited from AnyRef

Inherited from Any

Ungrouped