Trait

org.scalatestplus.play.components

OneServerPerTestWithComponents

Related Doc: package components

Permalink

trait OneServerPerTestWithComponents extends BaseOneServerPerTest with WithApplicationComponents with FakeApplicationFactory

An extension of BaseOneServerPerTest providing Compile-time DI.

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

This TestSuiteMixin 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 Application for each test according to the components defined in the test.

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

import org.scalatestplus.play.PlaySpec
import org.scalatestplus.play.components.OneServerPerTestWithComponents
import play.api._
import play.api.mvc.Result
import play.api.test.Helpers._
import play.api.test.{FakeRequest, Helpers}

import scala.concurrent.Future

class ExampleComponentsSpec extends PlaySpec with OneServerPerTestWithComponents {

  override def components: BuiltInComponents = new BuiltInComponentsFromContext(context) with NoHttpFiltersComponents {

    import play.api.mvc.Results
    import play.api.routing.Router
    import play.api.routing.sird._

    lazy val router: Router = Router.from({
      case GET(p"/") => defaultActionBuilder {
        Results.Ok("success!")
      }
    })

    override lazy val configuration: Configuration = context.initialConfiguration ++ Configuration("foo" -> "bar", "ehcacheplugin" -> "disabled")
  }

  "The OneServerPerTestWithComponents trait" must {
    "provide an Application" in {
      import play.api.test.Helpers.{GET, route}
      val Some(result): Option[Future[Result]] = route(app, FakeRequest(GET, "/"))
      Helpers.contentAsString(result) must be("success!")
    }
    "override the configuration" in {
      app.configuration.getOptional[String]("foo") mustBe Some("bar")
    }
  }
}

Self Type
OneServerPerTestWithComponents with TestSuite
Source
OneServerPerTestWithComponents.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OneServerPerTestWithComponents
  2. FakeApplicationFactory
  3. WithApplicationComponents
  4. BaseOneServerPerTest
  5. ServerProvider
  6. TestSuiteMixin
  7. SuiteMixin
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def components: BuiltInComponents

    Permalink

    Override this function to instantiate the components - a factory of sorts.

    Override this function to instantiate the components - a factory of sorts.

    returns

    the components to be used by the application

    Definition Classes
    WithApplicationComponents
  2. abstract def expectedTestCount(filter: Filter): Int

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    SuiteMixin
  10. abstract def suiteId: String

    Permalink
    Definition Classes
    SuiteMixin
  11. abstract def suiteName: String

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

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

    Permalink
    Definition Classes
    SuiteMixin
  14. 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 Application instance for the current test.

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

    Definition Classes
    BaseOneServerPerTestServerProvider
  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. lazy val context: Context

    Permalink

    returns

    a context to use to create the application.

    Definition Classes
    WithApplicationComponents
  8. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  10. def fakeApplication(): Application

    Permalink
  11. def finalize(): Unit

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  16. 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.

    Definition Classes
    BaseOneServerPerTest
  17. final def newApplication: Application

    Permalink

    returns

    new application instance and set the components. This must be called for components to be properly set up.

    Definition Classes
    WithApplicationComponents
  18. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  20. 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
    BaseOneServerPerTestServerProvider
  21. 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
  22. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. def withFixture(test: (OneServerPerTestWithComponents.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
    BaseOneServerPerTest → TestSuiteMixin

Inherited from FakeApplicationFactory

Inherited from WithApplicationComponents

Inherited from BaseOneServerPerTest

Inherited from ServerProvider

Inherited from TestSuiteMixin

Inherited from SuiteMixin

Inherited from AnyRef

Inherited from Any

Ungrouped