t

org.scalatestplus.play

ConfiguredServer

trait ConfiguredServer extends TestSuiteMixin 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 GuiceOneServerPerSuite 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 GuiceOneAppPerSuite'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 GuiceOneServerPerSuite {

  // Override fakeApplication() if you need a Application with other than non-default parameters.
  def fakeApplication(): Application =
    new GuiceApplicationBuilder().configure("ehcacheplugin" -> "disabled").build()

  "The OneServerPerSuite 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")
    }
    "provide an http endpoint" in {
      runningServer.endpoints.httpEndpoint must not be empty
    }
    "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 TestSuite
Source
ConfiguredServer.scala
Linear Supertypes
ServerProvider, TestSuiteMixin, SuiteMixin, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConfiguredServer
  2. ServerProvider
  3. TestSuiteMixin
  4. SuiteMixin
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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 runNestedSuites(args: Args): Status
    Attributes
    protected
    Definition Classes
    SuiteMixin
  5. abstract def runTest(testName: String, args: Args): Status
    Attributes
    protected
    Definition Classes
    SuiteMixin
  6. abstract def runTests(testName: Option[String], args: Args): Status
    Attributes
    protected
    Definition Classes
    SuiteMixin
  7. abstract val styleName: String
    Definition Classes
    SuiteMixin
  8. abstract def suiteId: String
    Definition Classes
    SuiteMixin
  9. abstract def suiteName: String
    Definition Classes
    SuiteMixin
  10. abstract def tags: Map[String, Set[String]]
    Definition Classes
    SuiteMixin
  11. abstract def testDataFor(testName: String, theConfigMap: ConfigMap): TestData
    Definition Classes
    SuiteMixin
  12. abstract def testNames: Set[String]
    Definition Classes
    SuiteMixin
  13. abstract def withFixture(test: (ConfiguredServer.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 final def app: Application

    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
    ConfiguredServer → ServerProvider
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. final def configuredPort: Int

    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

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

    The port used by the TestServer.

    The port used by the TestServer.

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

    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

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

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

Inherited from ServerProvider

Inherited from TestSuiteMixin

Inherited from SuiteMixin

Inherited from AnyRef

Inherited from Any

Ungrouped