com.wix.accord.scalatest

ResultMatchers

trait ResultMatchers extends AnyRef

Extends a test suite with a set of matchers over validation com.wix.accord.Results.

Self Type
ResultMatchers with Suite
Linear Supertypes
AnyRef, Any
Known Subclasses
CombinatorTestSpec
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ResultMatchers
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. case class GroupViolationMatcher(value: Any = null, constraint: String = null, legacyDescription: String = null, path: Path = null, violations: Set[(ResultMatchers.this)#ViolationMatcher] = null) extends (ResultMatchers.this)#ViolationMatcher with Product with Serializable

    A matcher over com.wix.accord.GroupViolations.

    A matcher over com.wix.accord.GroupViolations. To generate a violation rule "pattern", call the constructor with the required predicates, for example:

    val firstNameNotEmpty = RuleViolationMatcher( path = Path( Generic( "firstName" ) ), constraint = "must not be empty" ) val lastNameNotEmpty = RuleViolationMatcher( path = Path( Generic( "lastName" ) ), constraint = "must not be empty" ) val orPredicateFailed = GroupViolationMatcher( constraint = "doesn't meet any of the requirements", violations = firstNameNotEmpty :: lastNameNotEmpty :: Nil ) val validationResult: Result = ... validationResult must failWith( orPredicateFailed )

    value

    A predicate specifying the object under validation.

    constraint

    A predicate specifying the constraint being violated.

    legacyDescription

    Retained for backwards compatibility; matches against the rendered description of the object being validated. See com.wix.accord.Descriptions.render for details of how descriptions are rendered into strings.

    path

    A predicate specifying the path of the object being validated.

    violations

    The set of violations that comprise the group being validated.

    See also

    com.wix.accord.GroupViolation

  2. case class ResultMatcher(expectedViolations: Set[(ResultMatchers.this)#ViolationMatcher]) extends Matcher[Result] with Product with Serializable

    A matcher over validation com.wix.accord.Results.

    A matcher over validation com.wix.accord.Results. Takes a set of expected violations and return a suitable match result in case of failure.

    expectedViolations

    The set of expected violations for this matcher.

  3. case class RuleViolationMatcher(value: Any = null, constraint: String = null, legacyDescription: String = null, path: Path = null) extends (ResultMatchers.this)#ViolationMatcher with Product with Serializable

    A matcher over com.wix.accord.RuleViolations.

    A matcher over com.wix.accord.RuleViolations. To generate a violation rule "pattern", call the constructor with the required predicates, for example:

    val firstNameNotEmpty = RuleViolationMatcher( description = Path( Generic( "firstName" ) ), constraint = "must not be empty" ) val validationResult: Result = ... validationResult must failWith( firstNameNotEmpty )

    value

    A predicate specifying the object under validation.

    constraint

    A predicate specifying the constraint being violated.

    legacyDescription

    Retained for backwards compatibility; matches against the rendered description of the object being validated. See com.wix.accord.Descriptions.render for details of how descriptions are rendered into strings.

    path

    A predicate specifying the path to the object being validated.

    See also

    com.wix.accord.RuleViolation

  4. sealed trait ViolationMatcher extends Matcher[Violation]

    Abstracts over validators for the various violation type.

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. val aFailure: BeMatcher[Result]

    Enables syntax like someResult should be( aFailure )

  5. val aSuccess: BeMatcher[Result]

    Enables syntax like someResult should be( aSuccess )

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  10. def failWith(expectedViolations: (ResultMatchers.this)#ViolationMatcher*): Matcher[Result]

    A convenience method for matching failures.

    A convenience method for matching failures. Enables syntax like:

    val result: Result = ... result should failWith( Path( Generic( "firstName" ) ) -> "must not be empty", Path( Generic( "lastName" ) ) -> "must not be empty" )

    expectedViolations

    The set of expected violations.

    returns

    A matcher over validation com.wix.accord.Results.

  11. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  12. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  13. def group[T](path: Path, constraint: String, expectedViolations: T*)(implicit ev: (T) ⇒ (ResultMatchers.this)#RuleViolationMatcher): (ResultMatchers.this)#GroupViolationMatcher

    A convenience method for matching violation groups.

    A convenience method for matching violation groups. Enables syntax like:

    val result: Result = ... result should failWith( group( Path( Generic( "teacher" ) ), "is invalid", // The group context Path( Generic( "firstName ) ) -> "must not be empty" ) ) // The rule violations

    path

    A predicate specifying the path to the object being validated.

    constraint

    A textual description of the constraint being violated (for example, "must not be empty").

    expectedViolations

    The set of expected violations that comprise the group.

    returns

    A matcher over com.wix.accord.GroupViolations.

  14. def group(path: Path, constraint: String, expectedViolations: (Path, String)*): (ResultMatchers.this)#GroupViolationMatcher

    A convenience method for matching violation groups.

    A convenience method for matching violation groups. Enables syntax like:

    val result: Result = ... result should failWith( group( Path( Generic( "teacher" ) ), "is invalid", // The group context Path( Generic( "firstName ) ) -> "must not be empty" ) ) // The rule violations

    path

    A predicate specifying the path to the object being validated.

    constraint

    A textual description of the constraint being violated (for example, "must not be empty").

    expectedViolations

    The set of expected violations that comprise the group.

    returns

    A matcher over com.wix.accord.GroupViolations.

  15. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  16. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  17. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  18. final def notify(): Unit

    Definition Classes
    AnyRef

  19. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  20. implicit def path2RuleViolationMatcher(path: Path): (ResultMatchers.this)#RuleViolationMatcher

    A convenience implicit to simplify test code.

    A convenience implicit to simplify test code. Enables syntax like:

    val rule: RuleViolationMatcher = Path( Generic( "firstName" ) ) // ... which is equivalent to val rule = RuleViolationMatcher( path = Path( Generic( "firstName" ) ) )

  21. implicit def pathAndConstraintTuple2RuleMatcher(v: (Path, String)): (ResultMatchers.this)#RuleViolationMatcher

    A convenience implicit to simplify test code.

    A convenience implicit to simplify test code. Enables syntax like:

    val rule: RuleViolationMatcher = Path( Generic( "firstName" ) ) -> "must not be empty" // ... which is equivalent to val rule = RuleViolationMatcher( path = Path( Generic( "firstName" ) ), constraint = "must not be empty" )

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

    Definition Classes
    AnyRef

  23. def toString(): String

    Definition Classes
    AnyRef → Any

  24. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  26. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. implicit def description2RuleViolationMatcher(desc: Description): (ResultMatchers.this)#RuleViolationMatcher

    A convenience implicit to simplify test code.

    A convenience implicit to simplify test code. Enables syntax like:

    val rule: RuleViolationMatcher = Generic( "firstName" ) // ... which is equivalent to val rule = RuleViolationMatcher( path = Path( Generic( "firstName" ) ) )

    Annotations
    @deprecated
    Deprecated

    (Since version 0.7)

  2. implicit def descriptionAndConstraintTuple2RuleMatcher(v: (Description, String)): (ResultMatchers.this)#RuleViolationMatcher

    A convenience implicit to simplify test code.

    A convenience implicit to simplify test code. Enables syntax like:

    val rule: RuleViolationMatcher = Generic( "firstName" ) -> "must not be empty" // ... which is equivalent to val rule = RuleViolationMatcher( path = Path( Generic( "firstName" ) ), constraint = "must not be empty" )

    Annotations
    @deprecated
    Deprecated

    (Since version 0.7)

  3. def group[T](legacyDescription: String, constraint: String, expectedViolations: T*)(implicit ev: (T) ⇒ (ResultMatchers.this)#RuleViolationMatcher): (ResultMatchers.this)#GroupViolationMatcher

    A convenience method for matching violation groups.

    A convenience method for matching violation groups. Enables syntax like:

    val result: Result = ... result should failWith( group( "teacher", "is invalid", // The group context "firstName" -> "must not be empty" ) ) // The rule violations

    legacyDescription

    Retained for backwards compatibility; matches against the rendered description of the object being validated. See com.wix.accord.Descriptions.render for details of how descriptions are rendered into strings.

    constraint

    A textual description of the constraint being violated (for example, "must not be empty").

    expectedViolations

    The set of expected violations that comprise the group.

    returns

    A matcher over com.wix.accord.GroupViolations.

    Annotations
    @deprecated
    Deprecated

    (Since version 0.6) Intended for backwards compatibility. It is recommended to match against paths instead.

  4. def group(legacyDescription: String, constraint: String, expectedViolations: (String, String)*): (ResultMatchers.this)#GroupViolationMatcher

    A convenience method for matching violation groups.

    A convenience method for matching violation groups. Enables syntax like:

    val result: Result = ... result should failWith( group( "teacher", "is invalid", // The group context "firstName" -> "must not be empty" ) ) // The rule violations

    legacyDescription

    Retained for backwards compatibility; matches against the rendered description of the object being validated. See com.wix.accord.Descriptions.render for details of how descriptions are rendered into strings.

    constraint

    A textual description of the constraint being violated (for example, "must not be empty").

    expectedViolations

    The set of expected violations that comprise the group.

    returns

    A matcher over com.wix.accord.GroupViolations.

    Annotations
    @deprecated
    Deprecated

    (Since version 0.6) Intended for backwards compatibility. It is recommended to match against paths instead.

  5. implicit def stringTuple2RuleMatcher(v: (String, String)): (ResultMatchers.this)#RuleViolationMatcher

    A convenience implicit to simplify test code.

    A convenience implicit to simplify test code. Enables syntax like:

    val rule: RuleViolationMatcher = "firstName" -> "must not be empty" // ... which is equivalent to val rule = RuleViolationMatcher( legacyDescription = "firstName", constraint = "must not be empty" )

    Annotations
    @deprecated
    Deprecated

    (Since version 0.6)

Inherited from AnyRef

Inherited from Any

Ungrouped