Trait

org.scalatestplus.play

ConfiguredServer

Related Doc: package play

Permalink

trait ConfiguredServer extends SuiteMixin with ServerProvider

Trait that provides a configured Application and server port number to the suite into which it is mixed.

The purpose of this trait is to allow nested suites of an enclosing suite that extends OneServerPerSuite to make use of the Application and port number provided by OneServerPerSuite. Trait OneServerPerSuite will ensure the Application is placed in the ConfigMap under the key org.scalatestplus.play.app and the port number under the key org.scalatestplus.play.port before nested suites are invoked. This information represents the "configured server" that is passed from the enclosing suite to the nested suites. Trait ConfiguredServer extracts this information from from the ConfigMap and makes the Application available via the app method, the port number available as an Int from the port method, and also the port number wrapped in a PortNumber available as implicit method portNumber (for use with trait WsScalaTestClient).

To prevent discovery of nested suites you can annotate them with @DoNotDiscover. Here's an example, taken from OneAppPerSuite's documentation:

package org.scalatestplus.play.examples.oneserverpersuite

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

class ExampleSpec extends PlaySpec with OneServerPerSuite {

  // Override app if you need a Application with other than non-default parameters.
  implicit override lazy val app: Application =
    new GuiceApplicationBuilder().configure("ehcacheplugin" -> "disabled").build()

  "The OneServerPerSuite trait" must {
    "provide an Application" in {
      app.configuration.getString("ehcacheplugin") mustBe Some("disabled")
    }
    "make the Application available implicitly" in {
      def getConfig(key: String)(implicit app: Application) = app.configuration.getString(key)
      getConfig("ehcacheplugin") mustBe Some("disabled")
    }
    "start the Application" in {
      Play.maybeApplication mustBe Some(app)
    }
    "provide the port number" in {
      port mustBe Helpers.testServerPort
    }
    "provide an actual running server" in {
      import Helpers._
      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
ConfiguredServer with Suite
Source
ConfiguredServer.scala
Linear Supertypes
ServerProvider, SuiteMixin, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ConfiguredServer
  2. ServerProvider
  3. SuiteMixin
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def expectedTestCount(filter: Filter): Int

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

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

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

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

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

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

    Permalink
    Definition Classes
    SuiteMixin
  8. abstract def suiteId: String

    Permalink
    Definition Classes
    SuiteMixin
  9. abstract def suiteName: String

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

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

    Permalink
    Definition Classes
    SuiteMixin
  12. abstract def testNames: Set[String]

    Permalink
    Definition Classes
    SuiteMixin
  13. abstract def withFixture(test: (ConfiguredServer.this)#NoArgTest): Outcome

    Permalink
    Attributes
    protected
    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

    The "configured" Application instance that was passed into run via the ConfigMap.

    The "configured" Application instance that was passed into run via the ConfigMap.

    returns

    the configured Application

    Definition Classes
    ConfiguredServerServerProvider
  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. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  14. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  16. def port: Int

    Permalink

    The "configured" port number, passed into run via the ConfigMap, at which the TestServer is running.

    The "configured" port number, passed into run via the ConfigMap, at which the TestServer is running.

    returns

    the configured port number

    Definition Classes
    ConfiguredServerServerProvider
  17. 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
  18. def run(testName: Option[String], args: Args): Status

    Permalink

    Looks in args.configMap for a key named "org.scalatestplus.play.app" whose value is a Application, and a key named "org.scalatestplus.play.port" whose value is an Int, and if they exist, sets the Application as the value that will be returned from the app method and the Int as the value that will be returned from the port method, then calls super.run.

    Looks in args.configMap for a key named "org.scalatestplus.play.app" whose value is a Application, and a key named "org.scalatestplus.play.port" whose value is an Int, and if they exist, sets the Application as the value that will be returned from the app method and the Int as the value that will be returned from the port method, then calls super.run.

    If no key matches "org.scalatestplus.play.app" in args.configMap, or the associated value is not a Application, or if no key matches "org.scalatestplus.play.port" in args.configMap, or the associated value is not an Int, throws IllegalArgumentException.

    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
    ConfiguredServer → SuiteMixin
    Exceptions thrown

    IllegalArgumentException if the Application and/or port number does not appear in args.configMap under the expected keys

  19. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ServerProvider

Inherited from SuiteMixin

Inherited from AnyRef

Inherited from Any

Ungrouped