Trait

org.scalatestplus.play

OneServerPerTest

Related Doc: package play

Permalink

trait OneServerPerTest extends SuiteMixin with ServerProvider

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
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. OneServerPerTest
  2. ServerProvider
  3. SuiteMixin
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def expectedTestCount(filter: Filter): Int

    Permalink
    Definition Classes
    SuiteMixin
  2. abstract def nestedSuites: IndexedSeq[Suite]

    Permalink
    Definition Classes
    SuiteMixin
  3. abstract def rerunner: Option[String]

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    SuiteMixin
  8. abstract val styleName: String

    Permalink
    Definition Classes
    SuiteMixin
  9. abstract def suiteId: String

    Permalink
    Definition Classes
    SuiteMixin
  10. abstract def suiteName: String

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

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

    Permalink
    Definition Classes
    SuiteMixin
  13. abstract def testNames: Set[String]

    Permalink
    Definition Classes
    SuiteMixin

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. implicit final def app: Application

    Permalink

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

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

    Definition Classes
    OneServerPerTestServerProvider
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

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

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int

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

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

    Permalink
    Definition Classes
    AnyRef
  14. def newAppForTest(testData: TestData): Application

    Permalink

    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.

  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. lazy val port: Int

    Permalink

    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
    OneServerPerTestServerProvider
  18. implicit final lazy val portNumber: PortNumber

    Permalink

    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
  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  20. def toString(): String

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

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

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

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

    Permalink

    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

Inherited from ServerProvider

Inherited from SuiteMixin

Inherited from AnyRef

Inherited from Any

Ungrouped