RestMatchers

Adds ScalaTest support to the RestTest Dsl.

The should keyword is added to Api.RequestBuilder and Api.Response expressions, the RequestBuilder is executed first and should applied to the Response.

The have keyword supports Extractors.ExtractorLikes. See ExtractorToHavePropertyMatcher for more details.

Example

using (_ url "http://api.rest.org/person") { implicit rb =>
  GET should have (statusCode(Status.OK), jsonBodyAsList[Person] === EmptyList)

  val (status, id) = POST body personJson returning (statusCode, headerText("X-Person-Id"))
  status should be(Status.Created)

  val foo = GET / id should have (statusCode(Status.OK), jsonBodyAs[Person] === Jason)

  GET should have (statusCode === Status.OK, jsonBodyAsList[Person] === Seq(Jason))

  DELETE / id should have (statusCode === Status.OK)

  GET / id should have (statusCode === Status.NotFound)

  GET should have (statusCode(Status.OK), jsonBodyAsList[Person] === EmptyList)
}

Linear Supertypes

AnyRef, Any

Known Subclasses

RestMatchers

Type Members

implicit class ExtractorToHavePropertyMatcher[T] extends AnyRef

Implicitly add operations to Extractors.Extractor that create HavePropertyMatchers.
Implicitly add operations to Extractors.Extractor that create HavePropertyMatchers.
This adds support for reusing Extractors in should have(...) expressions, for example
```
response should have(statusCode(Status.OK))
```
implicit class OptionExtractorToHavePropertyMatcher extends HavePropertyMatcher[Dsl.Response, String]

Implicitly convert an Extractors.Extractor that returns any type of Option into a HavePropertyMatcher.
Implicitly convert an Extractors.Extractor that returns any type of Option into a HavePropertyMatcher.
This adds support for reusing Extractor[Option[_]]s in should have(...) expressions, for example
```
response should have(header("header2"))
response should have(body)
```

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
implicit def extractorToShouldWrapper[T](extractor: Dsl.ExtractorLike[T])(implicit response: Dsl.Response): scalatest.Matchers.AnyShouldWrapper[T]
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
implicit def methodToShouldWrapper(method: Dsl.Method)(implicit builder: Dsl.RequestBuilder, client: Dsl.HttpClient): scalatest.Matchers.AnyShouldWrapper[Dsl.Response]
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
implicit def requestBuilderToShouldWrapper(builder: Dsl.RequestBuilder)(implicit client: Dsl.HttpClient): scalatest.Matchers.AnyShouldWrapper[Dsl.Response]

Implicitly execute a Api.RequestBuilder and convert the Api.Response into a AnyRefShouldWrapper
Implicitly execute a Api.RequestBuilder and convert the Api.Response into a AnyRefShouldWrapper
This adds support for ScalaTest's ShouldMatchers to RequestBuilder
implicit def responseToShouldWrapper(response: Dsl.Response): scalatest.Matchers.AnyShouldWrapper[Dsl.Response]

Implicitly convert a Api.Response into a AnyRefShouldWrapper
Implicitly convert a Api.Response into a AnyRefShouldWrapper
This adds support for ScalaTest's ShouldMatchers to Response
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object RestMatchers | package resttest

trait RestMatchers extends AnyRef

Example

Type Members

implicit class ExtractorToHavePropertyMatcher[T] extends AnyRef

implicit class OptionExtractorToHavePropertyMatcher extends HavePropertyMatcher[Dsl.Response, String]

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

implicit def extractorToShouldWrapper[T](extractor: Dsl.ExtractorLike[T])(implicit response: Dsl.Response): scalatest.Matchers.AnyShouldWrapper[T]

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

implicit def methodToShouldWrapper(method: Dsl.Method)(implicit builder: Dsl.RequestBuilder, client: Dsl.HttpClient): scalatest.Matchers.AnyShouldWrapper[Dsl.Response]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

implicit def requestBuilderToShouldWrapper(builder: Dsl.RequestBuilder)(implicit client: Dsl.HttpClient): scalatest.Matchers.AnyShouldWrapper[Dsl.Response]

implicit def responseToShouldWrapper(response: Dsl.Response): scalatest.Matchers.AnyShouldWrapper[Dsl.Response]

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

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped