ScalaTest + Play, 6.0.0-RC2
API
Generated with
ScalaTest + Play, 6.0.0-RC2/org.scalatestplus.play/BaseOneServerPerTest

BaseOneServerPerTest

org.scalatestplus.play.BaseOneServerPerTest
trait BaseOneServerPerTest extends TestSuiteMixin, ServerProvider

Trait that provides a new Application and running TestServer instance for each test executed in a ScalaTest Suite.

This TestSuiteMixin trait overrides ScalaTest's withFixture method to create a new Application and TestServer before each test, and ensure they are cleaned up after the test has completed. The Application is available (implicitly) from method app. The TestServer's port number is available as port (and implicitly available as portNumber, wrapped in a PortNumber).

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 an 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.oneserverpertest

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

class ExampleSpec extends PlaySpec with OneServerPerTest {

 // Override newAppForTest or use GuiceOneServerPerTest
 implicit override def newAppForTest(testData: TestData): Application = new GuiceApplicationBuilder()
   .configure(Map("ehcacheplugin" -> "disabled"))
   .router(TestRoutes.router)
   .build()

 "The OneServerPerTest trait" must {
   "provide a FakeApplication" in {
     app.configuration.getOptional[String]("ehcacheplugin") mustBe Some("disabled")
   }
   "make the FakeApplication 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()
   }
 }
}

Attributes

Graph
Supertypes
trait TestSuiteMixin
trait SuiteMixin
class Object
trait Matchable
class Any
Show all
Known subtypes
Self type

Members list

Value members

Concrete methods

def newAppForTest(testData: TestData): Application

Creates new instance of Application with parameters set to their defaults. Override this method if you need an Application created with non-default parameter values.

Creates new instance of Application with parameters set to their defaults. Override this method if you need an Application created with non-default parameter values.

Attributes

protected def newServerForTest(app: Application, testData: TestData): RunningServer
protected def testServerFactory: TestServerFactory
def withFixture(test: <none>): Outcome

Creates new Application and running TestServer instances before executing each test, and ensures they are cleaned up after the test completes. You can access the Application from your tests as app and the TestServer's port number as port.

Creates new Application and running TestServer instances before executing each test, and ensures they are cleaned up after the test completes. You can access the Application from your tests as app and the TestServer's port number as port.

Value parameters

test

the no-arg test function to run with a fixture

Attributes

Returns

the Outcome of the test execution

Inherited methods

def expectedTestCount(filter: Filter): Int

The total number of tests that are expected to run when this Suite's run method is invoked.

The total number of tests that are expected to run when this Suite's run method is invoked.

Value parameters

filter

a Filter with which to filter tests to count based on their tags

Attributes

Inherited from:
SuiteMixin
def nestedSuites: IndexedSeq[Suite]

An immutable IndexedSeq of this SuiteMixin object's nested Suites. If this SuiteMixin contains no nested Suites, this method returns an empty IndexedSeq.

An immutable IndexedSeq of this SuiteMixin object's nested Suites. If this SuiteMixin contains no nested Suites, this method returns an empty IndexedSeq.

Attributes

Inherited from:
SuiteMixin
final def port: Int

The port used by the TestServer.

The port used by the TestServer.

Attributes

Inherited from:
ServerProvider
def rerunner: Option[String]

The fully qualified name of the class that can be used to rerun this suite.

The fully qualified name of the class that can be used to rerun this suite.

Attributes

Inherited from:
SuiteMixin
def run(testName: Option[String], args: Args): Status

Runs this suite of tests.

Runs this suite of tests.

Value parameters

args

the Args for this run

testName

an optional name of one test to execute. If None, all relevant tests should be executed. I.e., None acts like a wildcard that means execute all relevant tests in this Suite.

Attributes

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.

Throws
NullArgumentException

if any passed parameter is null.

Inherited from:
SuiteMixin
protected def runNestedSuites(args: Args): Status

Runs zero to many of this suite's nested suites.

Runs zero to many of this suite's nested suites.

Value parameters

args

the Args for this run

Attributes

Returns

a Status object that indicates when all nested suites started by this method have completed, and whether or not a failure occurred.

Throws
NullArgumentException

if args is null.

Inherited from:
SuiteMixin
protected def runTest(testName: String, args: Args): Status

Runs a test.

Runs a test.

Value parameters

args

the Args for this run

testName

the name of one test to execute.

Attributes

Returns

a Status object that indicates when the test started by this method has completed, and whether or not it failed .

Throws
NullArgumentException

if any of testName or args is null.

Inherited from:
SuiteMixin
protected def runTests(testName: Option[String], args: Args): Status

Runs zero to many of this suite's tests.

Runs zero to many of this suite's tests.

Value parameters

args

the Args for this run

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.

Attributes

Returns

a Status object that indicates when all tests started by this method have completed, and whether or not a failure occurred.

Throws
NullArgumentException

if either testName or args is null.

Inherited from:
SuiteMixin
def suiteId: String

A string ID for this Suite that is intended to be unique among all suites reported during a run.

A string ID for this Suite that is intended to be unique among all suites reported during a run.

The suite ID is intended to be unique, because ScalaTest does not enforce that it is unique. If it is not unique, then you may not be able to uniquely identify a particular test of a particular suite. This ability is used, for example, to dynamically tag tests as having failed in the previous run when rerunning only failed tests.

Attributes

Returns

this Suite object's ID.

Inherited from:
SuiteMixin
def suiteName: String

A user-friendly suite name for this Suite.

A user-friendly suite name for this Suite.

This trait's implementation of this method returns the simple name of this object's class. This trait's implementation of runNestedSuites calls this method to obtain a name for Reports to pass to the suiteStarting, suiteCompleted, and suiteAborted methods of the Reporter.

Attributes

Returns

this Suite object's suite name.

Inherited from:
SuiteMixin
def tags: Map[String, Set[String]]

A Map whose keys are String names of tagged tests and whose associated values are the Set of tag names for the test. If a test has no associated tags, its name does not appear as a key in the returned Map. If this Suite contains no tests with tags, this method returns an empty Map.

A Map whose keys are String names of tagged tests and whose associated values are the Set of tag names for the test. If a test has no associated tags, its name does not appear as a key in the returned Map. If this Suite contains no tests with tags, this method returns an empty Map.

Subclasses may override this method to define and/or discover tags in a custom manner, but overriding method implementations should never return an empty Set as a value. If a test has no tags, its name should not appear as a key in the returned Map.

Attributes

Inherited from:
SuiteMixin
def testDataFor(testName: String, theConfigMap: ConfigMap): TestData

Provides a TestData instance for the passed test name, given the passed config map.

Provides a TestData instance for the passed test name, given the passed config map.

This method is used to obtain a TestData instance to pass to withFixture(NoArgTest) and withFixture(OneArgTest) and the beforeEach and afterEach methods of trait BeforeAndAfterEach.

Value parameters

testName

the name of the test for which to return a TestData instance

theConfigMap

the config map to include in the returned TestData

Attributes

Returns

a TestData instance for the specified test, which includes the specified config map

Inherited from:
SuiteMixin
def testNames: Set[String]

A Set of test names. If this Suite contains no tests, this method returns an empty Set.

A Set of test names. If this Suite contains no tests, this method returns an empty Set.

Although subclass and subtrait implementations of this method may return a Set whose iterator produces String test names in a well-defined order, the contract of this method does not required a defined order. Subclasses are free to implement this method and return test names in either a defined or undefined order.

Attributes

Inherited from:
SuiteMixin

Deprecated and Inherited fields

val styleName: String

The styleName lifecycle method has been deprecated and will be removed in a future version of ScalaTest.

The styleName lifecycle method has been deprecated and will be removed in a future version of ScalaTest.

This method was used to support the chosen styles feature, which was deactivated in 3.1.0. The internal modularization of ScalaTest in 3.2.0 will replace chosen styles as the tool to encourage consistency across a project. We do not plan a replacement for styleName.

Attributes

Deprecated
true
Inherited from:
SuiteMixin

Implicits

Implicits

final implicit 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.

Attributes

final implicit def runningServer: RunningServer

Inherited implicits

implicit def portNumber: PortNumber

Implicit PortNumber instance that wraps port. The value returned from portNumber.value will be same as the value of port.

Implicit PortNumber instance that wraps port. The value returned from portNumber.value will be same as the value of port.

Attributes

Returns

the configured port number, wrapped in a PortNumber

Inherited from:
ServerProvider
Generated with