t

org.scalatestplus.play.components

OneServerPerSuiteWithComponents

trait OneServerPerSuiteWithComponents extends BaseOneServerPerSuite with WithApplicationComponents with FakeApplicationFactory

An extension of BaseOneServerPerSuite providing Compile-time DI.

Trait that provides a new Application and running TestServer instance per ScalaTest Suite.

By default, this trait creates a new Application for the Suite according to the components defined in the test, this is made available via the app field defined in this trait and a new TestServer for the Suite using the port number provided by its port field and the Application provided by its app field. If your Suite needs a different port number, override port.

This TestSuiteMixin trait's overridden run method calls start on the TestServer before executing the Suite via a call to super.run. In addition, it places a reference to the Application provided by app into the ConfigMap under the key org.scalatestplus.play.app and to the port number provided by port under the key org.scalatestplus.play.port. This allows any nested Suites to access the Suite's Application and port number as well, most easily by having the nested Suites mix in the ConfiguredServer trait. On the status returned by super.run, this trait's overridden run method registers a call to stop on the TestServer to be executed when the Status completes, and returns the same Status. This ensure the TestServer will continue to execute until all nested suites have completed, after which the TestServer will be stopped.

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

import org.scalatestplus.play.PlaySpec
import org.scalatestplus.play.components.OneServerPerSuiteWithComponents
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 OneServerPerSuiteWithComponents {

  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 OneServerPerSuiteWithComponents trait" must {
    "provide an Application" in {
      import play.api.test.Helpers.{GET, route}
      val Some(result: Future[Result]) = route(app, FakeRequest(GET, "/"))
      Helpers.contentAsString(result) must be("success!")
    }
    "override the configuration" in {
      app.configuration.getOptional[String]("foo") mustBe Some("bar")
    }
  }
}

If you have many tests that can share the same Application and TestServer, and you don't want to put them all into one test class, you can place them into different Suite classes. These will be your nested suites. Create a master suite that extends OneServerPerSuite and declares the nested Suites. Annotate the nested suites with @DoNotDiscover and have them extend ConfiguredServer. Here's an example:

import org.scalatest.{ DoNotDiscover, Suites, TestSuite }
import org.scalatestplus.play.components._
import org.scalatestplus.play.{ ConfiguredServer, PlaySpec }
import play.api._
import play.api.mvc.Result
import play.api.test.Helpers._
import play.api.test.{ FakeRequest, Helpers }

import scala.concurrent.Future

class NestedExampleSpec extends Suites(
  new OneSpec,
  new TwoSpec,
  new RedSpec,
  new BlueSpec
) with OneServerPerSuiteWithComponents with TestSuite {
  // Override fakeApplication if you need an Application with other than non-default parameters.
  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("ehcacheplugin" -> "disabled")

  }
}

// These are the nested suites
@DoNotDiscover class OneSpec extends PlaySpec with ConfiguredServer {
  "OneSpec" must {
    "make the Application available implicitly" in {
      def getConfig(key: String)(implicit app: Application) = app.configuration.getOptional[String](key)

      getConfig("ehcacheplugin") mustBe Some("disabled")
    }
  }

}

@DoNotDiscover class TwoSpec extends PlaySpec with ConfiguredServer

@DoNotDiscover class RedSpec extends PlaySpec with ConfiguredServer

@DoNotDiscover class BlueSpec extends PlaySpec with ConfiguredServer {

  "The NestedExampleSpeccc" must {
    "provide an Application" in {
      import play.api.test.Helpers.{ GET, route }
      val Some(result: Future[Result]) = route(app, FakeRequest(GET, "/"))
      Helpers.contentAsString(result) must be("success!")
    }
    "provide an actual running server" in {
      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
OneServerPerSuiteWithComponents with TestSuite
Source
OneServerPerSuiteWithComponents.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OneServerPerSuiteWithComponents
  2. FakeApplicationFactory
  3. WithApplicationComponents
  4. BaseOneServerPerSuite
  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

    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
    Definition Classes
    SuiteMixin
  3. abstract def nestedSuites: IndexedSeq[Suite]
    Definition Classes
    SuiteMixin
  4. abstract def rerunner: Option[String]
    Definition Classes
    SuiteMixin
  5. abstract def runNestedSuites(args: Args): Status
    Attributes
    protected
    Definition Classes
    SuiteMixin
  6. abstract def runTest(testName: String, args: Args): Status
    Attributes
    protected
    Definition Classes
    SuiteMixin
  7. abstract def runTests(testName: Option[String], args: Args): Status
    Attributes
    protected
    Definition Classes
    SuiteMixin
  8. abstract val styleName: String
    Definition Classes
    SuiteMixin
  9. abstract def suiteId: String
    Definition Classes
    SuiteMixin
  10. abstract def suiteName: String
    Definition Classes
    SuiteMixin
  11. abstract def tags: Map[String, Set[String]]
    Definition Classes
    SuiteMixin
  12. abstract def testDataFor(testName: String, theConfigMap: ConfigMap): TestData
    Definition Classes
    SuiteMixin
  13. abstract def testNames: Set[String]
    Definition Classes
    SuiteMixin
  14. abstract def withFixture(test: (OneServerPerSuiteWithComponents.this)#NoArgTest): Outcome
    Attributes
    protected
    Definition Classes
    TestSuiteMixin

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. implicit lazy val app: Application

    An implicit instance of Application.

    An implicit instance of Application.

    Definition Classes
    BaseOneServerPerSuiteServerProvider
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. lazy val context: Context

    returns

    a context to use to create the application.

    Definition Classes
    WithApplicationComponents
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def fakeApplication(): Application
  11. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def newApplication: Application

    returns

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

    Definition Classes
    WithApplicationComponents
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def port: Int

    The port used by the TestServer.

    The port used by the TestServer.

    Definition Classes
    ServerProvider
  20. implicit def 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
  21. def run(testName: Option[String], args: Args): Status

    Invokes start on a new TestServer created with the Application provided by app and the port number defined by port, places the Application and port number into the ConfigMap under the keys org.scalatestplus.play.app and org.scalatestplus.play.port, respectively, to make them available to nested suites; calls super.run; and lastly ensures the Application and test server are stopped after all tests and nested suites have completed.

    Invokes start on a new TestServer created with the Application provided by app and the port number defined by port, places the Application and port number into the ConfigMap under the keys org.scalatestplus.play.app and org.scalatestplus.play.port, respectively, to make them available to nested suites; calls super.run; and lastly ensures the Application and test server are stopped after all tests and nested suites have completed.

    testName

    an optional name of one test to run. If None, all relevant tests should be run. I.e., None acts like a wildcard that means run all relevant tests in this Suite.

    args

    the Args for this run

    returns

    a Status object that indicates when all tests and nested suites started by this method have completed, and whether or not a failure occurred.

    Definition Classes
    BaseOneServerPerSuite → SuiteMixin
  22. implicit lazy val runningServer: RunningServer
    Attributes
    protected
    Definition Classes
    BaseOneServerPerSuiteServerProvider
  23. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from FakeApplicationFactory

Inherited from WithApplicationComponents

Inherited from BaseOneServerPerSuite

Inherited from ServerProvider

Inherited from TestSuiteMixin

Inherited from SuiteMixin

Inherited from AnyRef

Inherited from Any

Ungrouped