Packages

t

org.scalatestplus.play.guice

GuiceOneAppPerTest

trait GuiceOneAppPerTest extends BaseOneAppPerTest with GuiceFakeApplicationFactory

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 using default parameter values, which is returned by the newAppForTest method defined in this trait. If your tests need a 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.oneapppertest

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

class ExampleSpec extends PlaySpec with GuiceOneAppPerTest {

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

  "The OneAppPerTest trait" must {
    "provide an Application" in {
      app.configuration.getOptional[String]("ehcacheplugin") mustBe Some("disabled")
    }
    "make the Application available implicitly" in {
      def getConfig(key: String)(implicit app: Application) = app.configuration.getOptional[String](key)
      getConfig("ehcacheplugin") mustBe Some("disabled")
    }
  }
}

Self Type
GuiceOneAppPerTest with TestSuite
Source
GuiceOneAppPerTest.scala
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GuiceOneAppPerTest
  2. GuiceFakeApplicationFactory
  3. FakeApplicationFactory
  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 expectedTestCount(filter: Filter): Int
    Definition Classes
    SuiteMixin
  2. abstract def nestedSuites: IndexedSeq[Suite]
    Definition Classes
    SuiteMixin
  3. abstract def rerunner: Option[String]
    Definition Classes
    SuiteMixin
  4. abstract def run(testName: Option[String], args: Args): Status
    Definition Classes
    SuiteMixin
  5. abstract def suiteId: String
    Definition Classes
    SuiteMixin
  6. abstract def suiteName: String
    Definition Classes
    SuiteMixin
  7. abstract def tags: Map[String, Set[String]]
    Definition Classes
    SuiteMixin
  8. abstract def testDataFor(testName: String, theConfigMap: ConfigMap): TestData
    Definition Classes
    SuiteMixin
  9. abstract def testNames: Set[String]
    Definition Classes
    SuiteMixin
  10. abstract val styleName: String
    Definition Classes
    SuiteMixin
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) The styleName lifecycle method has been deprecated and will be removed in a future version of ScalaTest with no replacement.

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 fakeApplication(): Application
  3. 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
  4. def withFixture(test: (GuiceOneAppPerTest.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