OneAppPerSuite

Trait that provides a new FakeApplication instance per ScalaTest Suite.

By default, this trait creates a new FakeApplication for the Suite using default parameter values, which is made available via the app field defined in this trait. If your Suite needs a FakeApplication with non-default parameters, override app to create it the way you need it.

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

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

package org.scalatestplus.play.examples.oneapppersuite

import play.api.test._
import org.scalatest._
import org.scalatestplus.play._
import play.api.{Play, Application}

class ExampleSpec extends PlaySpec with OneAppPerSuite {

  // Override app if you need a FakeApplication with other than non-default parameters.
  implicit override lazy val app: FakeApplication =
    FakeApplication(additionalConfiguration = Map("ehcacheplugin" -> "disabled"))

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

If you have many tests that can share the same FakeApplication, 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 OneAppPerSuite and declares the nested Suites. Annotate the nested suites with @DoNotDiscover and have them extend ConfiguredApp. Here's an example:

package org.scalatestplus.play.examples.oneapppersuite

import play.api.test._
import org.scalatest._
import org.scalatestplus.play._
import play.api.{Play, Application}

// This is the "master" suite
class NestedExampleSpec extends Suites(
  new OneSpec,
  new TwoSpec,
  new RedSpec,
  new BlueSpec
) with OneAppPerSuite {
  // Override app if you need a FakeApplication with other than non-default parameters.
  implicit override lazy val app: FakeApplication =
    FakeApplication(additionalConfiguration = Map("ehcacheplugin" -> "disabled"))
}

// These are the nested suites
@DoNotDiscover class OneSpec extends PlaySpec with ConfiguredApp
@DoNotDiscover class TwoSpec extends PlaySpec with ConfiguredApp
@DoNotDiscover class RedSpec extends PlaySpec with ConfiguredApp

@DoNotDiscover
class BlueSpec extends PlaySpec with ConfiguredApp {

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