Packages

t

org.scalatestplus.play.components

OneAppPerTestWithComponents

trait OneAppPerTestWithComponents extends BaseOneAppPerTest with WithApplicationComponents with FakeApplicationFactory with TestSuiteMixin

An extension of BaseOneAppPerTest providing Compile-time DI.

Trait that provides a new Application instance for each test.

This TestSuiteMixin trait's overridden withFixture method creates a new Application before each test and ensures it is cleaned up after the test has completed. You can access the Application from your tests as method app (which is marked implicit).

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.OneAppPerTestWithComponents
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 OneAppPerTestWithComponents {

  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 = Configuration("foo" -> "bar", "ehcacheplugin" -> "disabled").withFallback(context.initialConfiguration)
  }

  "The OneAppPerTestWithComponents 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")
    }
  }
}

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

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 run(testName: Option[String], args: Args): Status
    Definition Classes
    SuiteMixin
  6. abstract val styleName: String
    Definition Classes
    SuiteMixin
  7. abstract def suiteId: String
    Definition Classes
    SuiteMixin
  8. abstract def suiteName: String
    Definition Classes
    SuiteMixin
  9. abstract def tags: Map[String, Set[String]]
    Definition Classes
    SuiteMixin
  10. abstract def testDataFor(testName: String, theConfigMap: ConfigMap): TestData
    Definition Classes
    SuiteMixin
  11. abstract def testNames: Set[String]
    Definition Classes
    SuiteMixin

Concrete Value Members

  1. implicit final def app: Application

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

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

    Definition Classes
    BaseOneAppPerTestAppProvider
  2. def context: Context

    returns

    a context to use to create the application.

    Definition Classes
    WithApplicationComponents
  3. def fakeApplication(): Application
  4. 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 a Application created with non-default parameter values.

    Definition Classes
    BaseOneAppPerTest
  5. 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
  6. def withFixture(test: (OneAppPerTestWithComponents.this)#NoArgTest): Outcome

    Creates a new Application instance before executing each test, and ensure it is cleaned up after the test completes.

    Creates a new Application instance before executing each test, and ensure it is cleaned up after the test completes. You can access the Application from your tests via app.

    test

    the no-arg test function to run with a fixture

    returns

    the Outcome of the test execution

    Definition Classes
    BaseOneAppPerTest → TestSuiteMixin