http4s-stir-testkit
API
Generated with
http4s-stir-testkit/pl.iterators.stir.testkit/ScalatestRouteTest

ScalatestRouteTest

pl.iterators.stir.testkit.ScalatestRouteTest
trait ScalatestRouteTest extends RouteTest, Scalatest, ScalatestUtils

Attributes

Source
ScalatestUtils.scala
Graph
Supertypes
trait Scalatest
trait BeforeAndAfterAll
trait SuiteMixin
trait RouteTest
class Object
trait Matchable
class Any
Show all
Self type
Suite

Members list

Type members

Inherited classlikes

class RequestBuilder(val method: Method)

Attributes

Inherited from:
RequestBuilding
Source
RequestBuilding.scala
Supertypes
class Object
trait Matchable
class Any
class RouteTestResult()

A receptacle for the response or rejections created by a route.

A receptacle for the response or rejections created by a route.

Attributes

Inherited from:
RouteTestResultComponent
Source
RouteTestResultComponent.scala
Supertypes
class Object
trait Matchable
class Any
abstract class TildeArrow[A, B]

Attributes

Inherited from:
RouteTest
Source
RouteTest.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object TildeArrow

Attributes

Inherited from:
RouteTest
Source
RouteTest.scala
Supertypes
class Object
trait Matchable
class Any
abstract class TildeBangArrow[A, B]

Attributes

Inherited from:
RouteTest
Source
RouteTest.scala
Supertypes
class Object
trait Matchable
class Any
object TildeBangArrow

Attributes

Inherited from:
RouteTest
Source
RouteTest.scala
Supertypes
class Object
trait Matchable
class Any
implicit class WithTransformation2(request: Request[IO])

Attributes

Inherited from:
RouteTest
Source
RouteTest.scala
Supertypes
class Object
trait Matchable
class Any

Inherited types

type RequestTransformer = Request[IO] => Request[IO]

Attributes

Inherited from:
RequestBuilding
Source
RequestBuilding.scala

Value members

Inherited methods

def addCredentials(credentials: Credentials): RequestTransformer

Attributes

Inherited from:
RequestBuilding
Source
RequestBuilding.scala
def addHeader(headerName: String, headerValue: String): RequestTransformer

Attributes

Inherited from:
RequestBuilding
Source
RequestBuilding.scala
def addHeader(header: ToRaw): RequestTransformer

Attributes

Inherited from:
RequestBuilding
Source
RequestBuilding.scala
def addHeaders(first: ToRaw, more: ToRaw*): RequestTransformer

Attributes

Inherited from:
RequestBuilding
Source
RequestBuilding.scala
protected def afterAll(): Unit

Defines a method to be run after all of this suite's tests and nested suites have been run.

Defines a method to be run after all of this suite's tests and nested suites have been run.

This trait's implementation of run invokes this afterAll() method. This trait's implementation of this method does nothing.

Attributes

Inherited from:
Scalatest
Source
TestFrameworkInterface.scala
protected def beforeAll(): Unit

Defines a method to be run before any of this suite's tests or nested suites are run.

Defines a method to be run before any of this suite's tests or nested suites are run.

This trait's implementation of run invokes this beforeAll() method. This trait's implementation of this method does nothing.

Attributes

Inherited from:
BeforeAndAfterAll
Source
BeforeAndAfterAll.scala
def charset: Charset

Attributes

Inherited from:
RouteTest
Source
RouteTest.scala
def charsetOption: Option[Charset]

Attributes

Inherited from:
RouteTest
Source
RouteTest.scala
def check[T](body: => T): RouteTestResult => T

Attributes

Inherited from:
RouteTest
Source
RouteTest.scala
def cleanUp(): Unit

Attributes

Inherited from:
RouteTest
Source
RouteTest.scala
def contentType: Content-Type

Attributes

Inherited from:
RouteTest
Source
RouteTest.scala
def entityAs[T](implicit um: EntityDecoder[IO, T], cls: ClassTag[T]): T

Attributes

Inherited from:
RouteTest
Source
RouteTest.scala
def evaluateTo[T](value: T)(implicit runtime: IORuntime): Matcher[IO[T]]

Attributes

Inherited from:
ScalatestUtils
Source
ScalatestUtils.scala
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
Source
SuiteMixin.scala
def failTest(msg: String): Nothing

Attributes

Inherited from:
Scalatest
Source
TestFrameworkInterface.scala
def handled: Boolean

Attributes

Inherited from:
RouteTest
Source
RouteTest.scala
def haveFailedWith(t: Throwable)(implicit runtime: IORuntime): Matcher[IO[_]]

Attributes

Inherited from:
ScalatestUtils
Source
ScalatestUtils.scala
def header(name: String): Option[Raw]

Attributes

Inherited from:
RouteTest
Source
RouteTest.scala
def header[T](implicit ev: Select[T], cls: ClassTag[T]): Option[F[T]]

Attributes

Inherited from:
RouteTest
Source
RouteTest.scala
def headers: Headers

Attributes

Inherited from:
RouteTest
Source
RouteTest.scala
def mapHeaders(f: Headers => Headers): RequestTransformer

Attributes

Inherited from:
RequestBuilding
Source
RequestBuilding.scala
def marshal[T](t: T)(implicit m: ToResponseMarshaller[T], runtime: IORuntime): EntityBody[IO]

Attributes

Inherited from:
MarshallingTestUtils
Source
MarshallingTestUtils.scala
def marshalToResponse[T](t: T)(implicit m: ToResponseMarshaller[T], runtime: IORuntime): Response[IO]

Attributes

Inherited from:
MarshallingTestUtils
Source
MarshallingTestUtils.scala
def mediaType: MediaType

Attributes

Inherited from:
RouteTest
Source
RouteTest.scala
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
Source
SuiteMixin.scala
def rejection: Rejection

Attributes

Inherited from:
RouteTest
Source
RouteTest.scala
def rejections: Seq[Rejection]

Attributes

Inherited from:
RouteTest
Source
RouteTest.scala
def removeHeader[T](implicit h: Header[T, _]): RequestTransformer

Attributes

Inherited from:
RequestBuilding
Source
RequestBuilding.scala
def removeHeader(headerName: String): RequestTransformer

Attributes

Inherited from:
RequestBuilding
Source
RequestBuilding.scala
def removeHeaders(names: String*): RequestTransformer

Attributes

Inherited from:
RequestBuilding
Source
RequestBuilding.scala
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
Source
SuiteMixin.scala
def response: Response[IO]

Attributes

Inherited from:
RouteTest
Source
RouteTest.scala
def responseAs[T](implicit um: EntityDecoder[IO, T], cls: ClassTag[T]): T

Attributes

Inherited from:
RouteTest
Source
RouteTest.scala
def responseEntity: EntityBody[IO]

Attributes

Inherited from:
RouteTest
Source
RouteTest.scala
def run(testName: Option[String], args: Args): Status

Execute a suite surrounded by calls to beforeAll and afterAll.

Execute a suite surrounded by calls to beforeAll and afterAll.

This trait's implementation of this method ("this method") invokes beforeAll(ConfigMap) before executing any tests or nested suites and afterAll(ConfigMap) after executing all tests and nested suites. It runs the suite by invoking super.run, passing along the parameters passed to it.

If any invocation of beforeAll completes abruptly with an exception, this method will complete abruptly with the same exception. If any call to super.run completes abruptly with an exception, this method will complete abruptly with the same exception, however, before doing so, it will invoke afterAll. If afterAll also completes abruptly with an exception, this method will nevertheless complete abruptly with the exception previously thrown by super.run. If super.run returns normally, but afterAll completes abruptly with an exception, this method will complete abruptly with the same exception.

This method does not invoke either beforeAll or afterAll if runTestsInNewInstance is true so that any side effects only happen once per test if OneInstancePerTest is being used. In addition, if no tests are expected, then beforeAll and afterAll will be invoked only if the invokeBeforeAllAndAfterAllEvenIfNoTestsAreExpected flag is true. By default, this flag is false, so that if all tests are excluded (such as if the entire suite class has been marked with @Ignore), then side effects would happen only if at least one test will ultimately be executed in this suite or its nested suites.

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 the test started by this method has completed, and whether or not it failed .

Inherited from:
BeforeAndAfterAll
Source
BeforeAndAfterAll.scala
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
Source
SuiteMixin.scala
def runRoute: RouteTestResult => RouteTestResult

A dummy that can be used as ~> runRoute to run the route but without blocking for the result. The result of the pipeline is the result that can later be checked with check. See the "separate running route from checking" example from ScalatestRouteTestSpec.scala.

A dummy that can be used as ~> runRoute to run the route but without blocking for the result. The result of the pipeline is the result that can later be checked with check. See the "separate running route from checking" example from ScalatestRouteTestSpec.scala.

Attributes

Inherited from:
RouteTest
Source
RouteTest.scala
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
Source
SuiteMixin.scala
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
Source
SuiteMixin.scala
def status: Status

Attributes

Inherited from:
RouteTest
Source
RouteTest.scala
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
Source
SuiteMixin.scala
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
Source
SuiteMixin.scala
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
Source
SuiteMixin.scala
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
Source
SuiteMixin.scala
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
Source
SuiteMixin.scala
def unmarshal[T](request: Request[IO])(implicit um: EntityDecoder[IO, T], runtime: IORuntime): Try[T]

Attributes

Inherited from:
MarshallingTestUtils
Source
MarshallingTestUtils.scala
def unmarshalTo[T](value: Try[T])(implicit um: EntityDecoder[IO, T], runtime: IORuntime): Matcher[Request[IO]]

Attributes

Inherited from:
ScalatestUtils
Source
ScalatestUtils.scala
def unmarshalToValue[T](value: T)(implicit um: EntityDecoder[IO, T], runtime: IORuntime): Matcher[Request[IO]]

Attributes

Inherited from:
ScalatestUtils
Source
ScalatestUtils.scala
def unmarshalValue[T](request: Request[IO])(implicit um: EntityDecoder[IO, T], runtime: IORuntime): T

Attributes

Inherited from:
MarshallingTestUtils
Source
MarshallingTestUtils.scala

Inherited fields

val Delete: RequestBuilder

Attributes

Inherited from:
RequestBuilding
Source
RequestBuilding.scala
val Get: RequestBuilder

Attributes

Inherited from:
RequestBuilding
Source
RequestBuilding.scala
val Head: RequestBuilder

Attributes

Inherited from:
RequestBuilding
Source
RequestBuilding.scala
val Options: RequestBuilder

Attributes

Inherited from:
RequestBuilding
Source
RequestBuilding.scala
val Patch: RequestBuilder

Attributes

Inherited from:
RequestBuilding
Source
RequestBuilding.scala
val Post: RequestBuilder

Attributes

Inherited from:
RequestBuilding
Source
RequestBuilding.scala
val Put: RequestBuilder

Attributes

Inherited from:
RequestBuilding
Source
RequestBuilding.scala
val invokeBeforeAllAndAfterAllEvenIfNoTestsAreExpected: Boolean

Flag to indicate whether to invoke beforeAll and afterAll even when there are no tests expected.

Flag to indicate whether to invoke beforeAll and afterAll even when there are no tests expected.

The default value is false, which means beforeAll and afterAll will not be invoked if there are no tests expected. Whether tests are expected is determined by invoking expectedTestCount passing in the passed filter. Because this count does not include tests excluded based on tags, such as ignored tests, this prevents any side effects in beforeAll or afterAll if no tests will ultimately be executed anyway. If you always want to see the side effects even if no tests are expected, override this val and set it to true.

Attributes

Inherited from:
BeforeAndAfterAll
Source
BeforeAndAfterAll.scala
override val testExceptionHandler: ExceptionHandler

Attributes

Inherited from:
Scalatest
Source
TestFrameworkInterface.scala

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
Source
SuiteMixin.scala

Implicits

Inherited implicits

final implicit def WithTransformation2(request: Request[IO]): WithTransformation2

Attributes

Inherited from:
RouteTest
Source
RouteTest.scala
implicit def header2AddHeader(header: ToRaw): RequestTransformer

Attributes

Inherited from:
RequestBuilding
Source
RequestBuilding.scala
implicit def runtime: IORuntime

Attributes

Inherited from:
RouteTest
Source
RouteTest.scala
Generated with