PropertiesSection

object PropertiesSection extends Checkers with Matchers with Section

A property is the testable unit in ScalaCheck, and is represented by the org.scalacheck.Prop class. There are several ways to create properties in ScalaCheck, one of them is to use the org.scalacheck.Prop.forAll method like in the example below.

scala> val propConcatLists = forAll { (l1: List[Int], l2: List[Int]) =>
  l1.size + l2.size == (l1 ::: l2).size }

We can use the check method to test it:

scala> propConcatLists.check
+ OK, passed 100 tests.

OK, that seemed alright. Now, we'll define another property.

scala> val propSqrt = forAll { (n: Int) => scala.math.sqrt(n*n) == n }

And check it:

scala> propSqrt.check
! Falsified after 2 passed tests.
> ARG_0: -1
> ARG_0_ORIGINAL: -488187735

Not surprisingly, the property doesn't hold. The argument -1 falsifies it. You can also see that the argument -488187735 falsifies the property. That was the first argument ScalaCheck found, and it was then simplified to -1.

The forAll method creates universally quantified properties directly, but it is also possible to create new properties by combining other properties, or to use any of the specialised methods in the org.scalacheck.Prop object.

Linear Supertypes

Section, Matchers, Explicitly, MatcherWords, ShouldVerb, Tolerance, Assertions, TripleEquals, TripleEqualsSupport, Checkers, ScalaCheckConfiguration, Configuration, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

PropertiesSection
Section
Matchers
Explicitly
MatcherWords
ShouldVerb
Tolerance
Assertions
TripleEquals
TripleEqualsSupport
Checkers
ScalaCheckConfiguration
Configuration
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Type Members

final class AWord extends AnyRef
Definition Classes
Matchers
final class AnWord extends AnyRef
Definition Classes
Matchers
sealed class AnyShouldWrapper[T] extends AnyRef
Definition Classes
Matchers
class CheckingEqualizer[L] extends AnyRef
Definition Classes
TripleEqualsSupport
sealed class Collected extends Serializable
Attributes
protected
Definition Classes
Matchers
class DecidedByEquality[A] extends Equality[A]
Definition Classes
Explicitly
class DecidedWord extends AnyRef
Definition Classes
Explicitly
class DeterminedByEquivalence[T] extends Equivalence[T]
Definition Classes
Explicitly
class DeterminedWord extends AnyRef
Definition Classes
Explicitly
class Equalizer[L] extends AnyRef
Definition Classes
TripleEqualsSupport
final class HavePropertyMatcherGenerator extends AnyRef
Definition Classes
Matchers
final class KeyWord extends AnyRef
Definition Classes
Matchers
case class MaxDiscardedFactor extends PropertyCheckConfigParam with Product with Serializable
Definition Classes
Configuration
case class MinSize extends PropertyCheckConfigParam with Product with Serializable
Definition Classes
Configuration
case class MinSuccessful extends PropertyCheckConfigParam with Product with Serializable
Definition Classes
Configuration
final class PlusOrMinusWrapper[T] extends AnyRef
Definition Classes
Tolerance
sealed abstract class PropertyCheckConfigParam extends Product with Serializable
Definition Classes
Configuration
case class PropertyCheckConfiguration extends Product with Serializable
Definition Classes
Configuration
final class RegexWord extends AnyRef
Definition Classes
Matchers
final class RegexWrapper extends AnyRef
Definition Classes
Matchers
class ResultOfBeWordForAny[T] extends AnyRef
Definition Classes
Matchers
sealed class ResultOfBeWordForCollectedAny[T] extends AnyRef
Definition Classes
Matchers
final class ResultOfBeWordForCollectedArray[T] extends ResultOfBeWordForCollectedAny[Array[T]]
Definition Classes
Matchers
final class ResultOfCollectedAny[T] extends AnyRef
Definition Classes
Matchers
final class ResultOfContainWordForCollectedAny[T] extends AnyRef
Definition Classes
Matchers
final class ResultOfEndWithWordForCollectedString extends AnyRef
Definition Classes
Matchers
final class ResultOfEndWithWordForString extends AnyRef
Definition Classes
Matchers
final class ResultOfFullyMatchWordForCollectedString extends AnyRef
Definition Classes
Matchers
final class ResultOfFullyMatchWordForString extends AnyRef
Definition Classes
Matchers
final class ResultOfHaveWordForCollectedExtent[A] extends AnyRef
Definition Classes
Matchers
final class ResultOfHaveWordForExtent[A] extends AnyRef
Definition Classes
Matchers
final class ResultOfIncludeWordForCollectedString extends AnyRef
Definition Classes
Matchers
final class ResultOfIncludeWordForString extends AnyRef
Definition Classes
Matchers
final class ResultOfNotWordForCollectedAny[T] extends AnyRef
Definition Classes
Matchers
final class ResultOfStartWithWordForCollectedString extends AnyRef
Definition Classes
Matchers
final class ResultOfStartWithWordForString extends AnyRef
Definition Classes
Matchers
case class SizeRange extends PropertyCheckConfigParam with Product with Serializable
Definition Classes
Configuration
final class StringShouldWrapper extends AnyShouldWrapper[String] with org.scalatest.matchers.should.Matchers.StringShouldWrapperForVerb
Definition Classes
Matchers
trait StringShouldWrapperForVerb extends AnyRef
Definition Classes
ShouldVerb
class TheAfterWord extends AnyRef
Definition Classes
Explicitly
final class TheSameInstanceAsPhrase extends AnyRef
Definition Classes
Matchers
final class ValueWord extends AnyRef
Definition Classes
Matchers
case class Workers extends PropertyCheckConfigParam with Product with Serializable
Definition Classes
Configuration

Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
def !==[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]
Definition Classes
TripleEqualsSupport
def !==(right: Null): TripleEqualsInvocation[Null]
Definition Classes
TripleEqualsSupport
def !==[T](right: T): TripleEqualsInvocation[T]
Definition Classes
TripleEqualsSupport
final def ##: Int
Definition Classes
AnyRef → Any
def <[T](right: T)(implicit arg0: Ordering[T]): ResultOfLessThanComparison[T]
Definition Classes
Matchers
def <=[T](right: T)(implicit arg0: Ordering[T]): ResultOfLessThanOrEqualToComparison[T]
Definition Classes
Matchers
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
def ===[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]
Definition Classes
TripleEqualsSupport
def ===(right: Null): TripleEqualsInvocation[Null]
Definition Classes
TripleEqualsSupport
def ===[T](right: T): TripleEqualsInvocation[T]
Definition Classes
TripleEqualsSupport
def >[T](right: T)(implicit arg0: Ordering[T]): ResultOfGreaterThanComparison[T]
Definition Classes
Matchers
def >=[T](right: T)(implicit arg0: Ordering[T]): ResultOfGreaterThanOrEqualToComparison[T]
Definition Classes
Matchers
def a[T](implicit arg0: ClassTag[T]): ResultOfATypeInvocation[T]
Definition Classes
Matchers
val a: AWord
Definition Classes
Matchers
val after: TheAfterWord
Definition Classes
Explicitly
def all(xs: String)(implicit collecting: Collecting[Char, String], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Char]
Definition Classes
Matchers
def all[K, V, JMAP[k, v] <: Map[k, v]](xs: JMAP[K, V])(implicit collecting: Collecting[Entry[K, V], JMAP[K, V]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Entry[K, V]]
Definition Classes
Matchers
def all[K, V, MAP[k, v] <: GenMap[k, v]](xs: MAP[K, V])(implicit collecting: Collecting[(K, V), GenTraversable[(K, V)]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[(K, V)]
Definition Classes
Matchers
def all[E, C[_]](xs: C[E])(implicit collecting: Collecting[E, C[E]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[E]
Definition Classes
Matchers
def allElementsOf[R](elements: GenTraversable[R]): ResultOfAllElementsOfApplication
Definition Classes
Matchers
def allOf(firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit pos: Position): ResultOfAllOfApplication
Definition Classes
Matchers
def an[T](implicit arg0: ClassTag[T]): ResultOfAnTypeInvocation[T]
Definition Classes
Matchers
val an: AnWord
Definition Classes
Matchers
final def asInstanceOf[T0]: T0
Definition Classes
Any
macro def assert(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
Definition Classes
Assertions
macro def assert(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion
Definition Classes
Assertions
macro def assertCompiles(code: String)(implicit pos: Position): Assertion
Definition Classes
Assertions
macro def assertDoesNotCompile(code: String)(implicit pos: Position): Assertion
Definition Classes
Assertions
def assertResult(expected: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
Definition Classes
Assertions
def assertResult(expected: Any, clue: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
Definition Classes
Assertions
def assertThrows[T <: AnyRef](f: => Any)(implicit classTag: ClassTag[T], pos: Position): Assertion
Definition Classes
Assertions
macro def assertTypeError(code: String)(implicit pos: Position): Assertion
Definition Classes
Assertions
macro def assume(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
Definition Classes
Assertions
macro def assume(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion
Definition Classes
Assertions
def atLeast(num: Int, xs: String)(implicit collecting: Collecting[Char, String], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Char]
Definition Classes
Matchers
def atLeast[K, V, JMAP[k, v] <: Map[k, v]](num: Int, xs: JMAP[K, V])(implicit collecting: Collecting[Entry[K, V], JMAP[K, V]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Entry[K, V]]
Definition Classes
Matchers
def atLeast[K, V, MAP[k, v] <: GenMap[k, v]](num: Int, xs: MAP[K, V])(implicit collecting: Collecting[(K, V), GenTraversable[(K, V)]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[(K, V)]
Definition Classes
Matchers
def atLeast[E, C[_]](num: Int, xs: C[E])(implicit collecting: Collecting[E, C[E]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[E]
Definition Classes
Matchers
def atLeastOneElementOf(elements: GenTraversable[Any]): ResultOfAtLeastOneElementOfApplication
Definition Classes
Matchers
def atLeastOneOf(firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit pos: Position): ResultOfAtLeastOneOfApplication
Definition Classes
Matchers
def atMost(num: Int, xs: String)(implicit collecting: Collecting[Char, String], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Char]
Definition Classes
Matchers
def atMost[K, V, JMAP[k, v] <: Map[k, v]](num: Int, xs: JMAP[K, V])(implicit collecting: Collecting[Entry[K, V], JMAP[K, V]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Entry[K, V]]
Definition Classes
Matchers
def atMost[K, V, MAP[k, v] <: GenMap[k, v]](num: Int, xs: MAP[K, V])(implicit collecting: Collecting[(K, V), GenTraversable[(K, V)]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[(K, V)]
Definition Classes
Matchers
def atMost[E, C[_]](num: Int, xs: C[E])(implicit collecting: Collecting[E, C[E]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[E]
Definition Classes
Matchers
def atMostOneElementOf[R](elements: GenTraversable[R]): ResultOfAtMostOneElementOfApplication
Definition Classes
Matchers
def atMostOneOf(firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit pos: Position): ResultOfAtMostOneOfApplication
Definition Classes
Matchers
val be: BeWord
Definition Classes
MatcherWords
def between(from: Int, upTo: Int, xs: String)(implicit collecting: Collecting[Char, String], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Char]
Definition Classes
Matchers
def between[K, V, JMAP[k, v] <: Map[k, v]](from: Int, upTo: Int, xs: JMAP[K, V])(implicit collecting: Collecting[Entry[K, V], JMAP[K, V]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Entry[K, V]]
Definition Classes
Matchers
def between[E, C[_]](from: Int, upTo: Int, xs: C[E])(implicit collecting: Collecting[E, C[E]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[E]
Definition Classes
Matchers
def cancel(cause: Throwable)(implicit pos: Position): Nothing
Definition Classes
Assertions
def cancel(message: String, cause: Throwable)(implicit pos: Position): Nothing
Definition Classes
Assertions
def cancel(message: String)(implicit pos: Position): Nothing
Definition Classes
Assertions
def cancel()(implicit pos: Position): Nothing
Definition Classes
Assertions
def check(p: Prop, configParams: PropertyCheckConfigParam*)(implicit config: PropertyCheckConfiguration, prettifier: Prettifier, pos: Position): Assertion
Definition Classes
Checkers
def check(p: Prop, prms: Parameters)(implicit prettifier: Prettifier, pos: Position): Assertion
Definition Classes
Checkers
def check[A1, A2, A3, A4, A5, A6, P](f: (A1, A2, A3, A4, A5, A6) => P, configParams: PropertyCheckConfigParam*)(implicit config: PropertyCheckConfiguration, p: (P) => Prop, a1: Arbitrary[A1], s1: Shrink[A1], pp1: (A1) => Pretty, a2: Arbitrary[A2], s2: Shrink[A2], pp2: (A2) => Pretty, a3: Arbitrary[A3], s3: Shrink[A3], pp3: (A3) => Pretty, a4: Arbitrary[A4], s4: Shrink[A4], pp4: (A4) => Pretty, a5: Arbitrary[A5], s5: Shrink[A5], pp5: (A5) => Pretty, a6: Arbitrary[A6], s6: Shrink[A6], pp6: (A6) => Pretty, prettifier: Prettifier, pos: Position): Assertion
Definition Classes
Checkers
def check[A1, A2, A3, A4, A5, P](f: (A1, A2, A3, A4, A5) => P, configParams: PropertyCheckConfigParam*)(implicit config: PropertyCheckConfiguration, p: (P) => Prop, a1: Arbitrary[A1], s1: Shrink[A1], pp1: (A1) => Pretty, a2: Arbitrary[A2], s2: Shrink[A2], pp2: (A2) => Pretty, a3: Arbitrary[A3], s3: Shrink[A3], pp3: (A3) => Pretty, a4: Arbitrary[A4], s4: Shrink[A4], pp4: (A4) => Pretty, a5: Arbitrary[A5], s5: Shrink[A5], pp5: (A5) => Pretty, prettifier: Prettifier, pos: Position): Assertion
Definition Classes
Checkers
def check[A1, A2, A3, A4, P](f: (A1, A2, A3, A4) => P, configParams: PropertyCheckConfigParam*)(implicit config: PropertyCheckConfiguration, p: (P) => Prop, a1: Arbitrary[A1], s1: Shrink[A1], pp1: (A1) => Pretty, a2: Arbitrary[A2], s2: Shrink[A2], pp2: (A2) => Pretty, a3: Arbitrary[A3], s3: Shrink[A3], pp3: (A3) => Pretty, a4: Arbitrary[A4], s4: Shrink[A4], pp4: (A4) => Pretty, prettifier: Prettifier, pos: Position): Assertion
Definition Classes
Checkers
def check[A1, A2, A3, P](f: (A1, A2, A3) => P, configParams: PropertyCheckConfigParam*)(implicit config: PropertyCheckConfiguration, p: (P) => Prop, a1: Arbitrary[A1], s1: Shrink[A1], pp1: (A1) => Pretty, a2: Arbitrary[A2], s2: Shrink[A2], pp2: (A2) => Pretty, a3: Arbitrary[A3], s3: Shrink[A3], pp3: (A3) => Pretty, prettifier: Prettifier, pos: Position): Assertion
Definition Classes
Checkers
def check[A1, A2, P](f: (A1, A2) => P, configParams: PropertyCheckConfigParam*)(implicit config: PropertyCheckConfiguration, p: (P) => Prop, a1: Arbitrary[A1], s1: Shrink[A1], pp1: (A1) => Pretty, a2: Arbitrary[A2], s2: Shrink[A2], pp2: (A2) => Pretty, prettifier: Prettifier, pos: Position): Assertion
Definition Classes
Checkers
def check[A1, P](f: (A1) => P, configParams: PropertyCheckConfigParam*)(implicit config: PropertyCheckConfiguration, p: (P) => Prop, a1: Arbitrary[A1], s1: Shrink[A1], pp1: (A1) => Pretty, prettifier: Prettifier, pos: Position): Assertion
Definition Classes
Checkers
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
def combiningProperties(res0: Boolean, res1: Boolean): Assertion
A third way of creating properties, is to combine existing properties into new ones.
Combining Properties
A third way of creating properties, is to combine existing properties into new ones.
```
val p1 = forAll(...)
val p2 = forAll(...)
val p3 = p1 && p2
val p4 = p1 || p2
val p5 = p1 == p2
val p6 = all(p1, p2) // same as p1 && p2
val p7 = atLeastOne(p1, p2) // same as p1 || p2
```
Here, p3 will hold if and only if both p1 and p2 hold, p4 will hold if either p1 or p2 holds, and p5 will hold if p1 holds exactly when p2 holds and vice versa.
val compile: CompileWord
Definition Classes
MatcherWords
def conditionalProperties(res0: Int): Assertion
Sometimes, a specification takes the form of an implication.
Conditional properties
Sometimes, a specification takes the form of an implication. In ScalaCheck, you can use the implication operator ==> to filter the generated values.
If the implication operator is given a condition that is hard or impossible to fulfill, ScalaCheck might not find enough passing test cases to state that the property holds. In the following trivial example, all cases where n is non-zero will be thrown away:
```
scala> import org.scalacheck.Prop.{forAll, propBoolean}
scala> val propTrivial = forAll { n: Int =>
     |  (n == 0) ==> n + 10 == 10
     | }

scala> propTrivial.check
! Gave up after only 4 passed tests. 500 tests were discarded.
```
It is possible to tell ScalaCheck to try harder when it generates test cases, but generally you should try to refactor your property specification instead of generating more test cases, if you get this scenario.
Using implications, we realise that a property might not just pass or fail, it could also be undecided if the implication condition doesn't get fulfilled.
In this example, ScalaCheck will only care for the cases when n is an even number.
val contain: ContainWord
Definition Classes
MatcherWords
def convertEquivalenceToAToBConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: <:<[A, B]): CanEqual[A, B]
Definition Classes
TripleEquals → TripleEqualsSupport
def convertEquivalenceToBToAConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: <:<[B, A]): CanEqual[A, B]
Definition Classes
TripleEquals → TripleEqualsSupport
implicit def convertNumericToPlusOrMinusWrapper[T](pivot: T)(implicit arg0: Numeric[T]): PlusOrMinusWrapper[T]
Definition Classes
Tolerance
implicit def convertSymbolToHavePropertyMatcherGenerator(symbol: Symbol)(implicit prettifier: Prettifier, pos: Position): HavePropertyMatcherGenerator
Definition Classes
Matchers
implicit def convertToAnyShouldWrapper[T](o: T)(implicit pos: Position, prettifier: Prettifier): AnyShouldWrapper[T]
Definition Classes
Matchers
def convertToCheckingEqualizer[T](left: T): CheckingEqualizer[T]
Definition Classes
TripleEquals → TripleEqualsSupport
implicit def convertToEqualizer[T](left: T): Equalizer[T]
Definition Classes
TripleEquals → TripleEqualsSupport
implicit def convertToRegexWrapper(o: Regex): RegexWrapper
Definition Classes
Matchers
implicit def convertToStringShouldWrapper(o: String)(implicit pos: Position, prettifier: Prettifier): StringShouldWrapper
Definition Classes
Matchers
implicit def convertToStringShouldWrapperForVerb(o: String)(implicit position: Position): StringShouldWrapperForVerb
Definition Classes
ShouldVerb
val decided: DecidedWord
Definition Classes
Explicitly
def defaultEquality[A]: Equality[A]
Definition Classes
TripleEqualsSupport
val defined: DefinedWord
Definition Classes
MatcherWords
def definedAt[T](right: T): ResultOfDefinedAt[T]
Definition Classes
Matchers
val determined: DeterminedWord
Definition Classes
Explicitly
val empty: EmptyWord
Definition Classes
MatcherWords
val endWith: EndWithWord
Definition Classes
MatcherWords
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equal(o: Null): Matcher[AnyRef]
Definition Classes
Matchers
def equal[T](spread: Spread[T]): Matcher[T]
Definition Classes
Matchers
def equal(right: Any): MatcherFactory1[Any, Equality]
Definition Classes
MatcherWords
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def every(xs: String)(implicit collecting: Collecting[Char, String], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Char]
Definition Classes
Matchers
def every[K, V, JMAP[k, v] <: Map[k, v]](xs: JMAP[K, V])(implicit collecting: Collecting[Entry[K, V], JMAP[K, V]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Entry[K, V]]
Definition Classes
Matchers
def every[K, V, MAP[k, v] <: Map[k, v]](xs: MAP[K, V])(implicit collecting: Collecting[(K, V), GenTraversable[(K, V)]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[(K, V)]
Definition Classes
Matchers
def every[E, C[_]](xs: C[E])(implicit collecting: Collecting[E, C[E]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[E]
Definition Classes
Matchers
def exactly(num: Int, xs: String)(implicit collecting: Collecting[Char, String], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Char]
Definition Classes
Matchers
def exactly[K, V, JMAP[k, v] <: Map[k, v]](num: Int, xs: JMAP[K, V])(implicit collecting: Collecting[Entry[K, V], JMAP[K, V]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Entry[K, V]]
Definition Classes
Matchers
def exactly[K, V, MAP[k, v] <: GenMap[k, v]](num: Int, xs: MAP[K, V])(implicit collecting: Collecting[(K, V), GenTraversable[(K, V)]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[(K, V)]
Definition Classes
Matchers
def exactly[E, C[_]](num: Int, xs: C[E])(implicit collecting: Collecting[E, C[E]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[E]
Definition Classes
Matchers
val exist: ExistWord
Definition Classes
MatcherWords
def fail(cause: Throwable)(implicit pos: Position): Nothing
Definition Classes
Assertions
def fail(message: String, cause: Throwable)(implicit pos: Position): Nothing
Definition Classes
Assertions
def fail(message: String)(implicit pos: Position): Nothing
Definition Classes
Assertions
def fail()(implicit pos: Position): Nothing
Definition Classes
Assertions
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
val fullyMatch: FullyMatchWord
Definition Classes
MatcherWords
implicit val generatorDrivenConfig: PropertyCheckConfiguration
Definition Classes
Configuration
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def getParameter(configParams: Seq[PropertyCheckConfigParam], config: PropertyCheckConfiguration): Parameter
Definition Classes
Configuration
def groupingProperties(res0: Int, res1: Int, res2: Int): Assertion
Often you want to specify several related properties, perhaps for all methods in a class.
Grouping Properties
Often you want to specify several related properties, perhaps for all methods in a class. ScalaCheck provides a simple way of doing this, through the Properties trait. Look at the following specifications that define some properties for zero.
You can use the check method of the Properties class to check all specified properties, just like for simple Prop instances. In fact, Properties is a subtype of Prop, so you can use it just as if it was a single property.
That single property holds if and only if all of the contained properties hold.
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
val have: HaveWord
Definition Classes
MatcherWords
def inOrder(firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit pos: Position): ResultOfInOrderApplication
Definition Classes
Matchers
def inOrderElementsOf[R](elements: GenTraversable[R]): ResultOfInOrderElementsOfApplication
Definition Classes
Matchers
def inOrderOnly[T](firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit pos: Position): ResultOfInOrderOnlyApplication
Definition Classes
Matchers
val include: IncludeWord
Definition Classes
MatcherWords
def intercept[T <: AnyRef](f: => Any)(implicit classTag: ClassTag[T], pos: Position): T
Definition Classes
Assertions
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
val key: KeyWord
Definition Classes
Matchers
val length: LengthWord
Definition Classes
MatcherWords
def lowPriorityTypeCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], ev: <:<[A, B]): CanEqual[A, B]
Definition Classes
TripleEquals → TripleEqualsSupport
val matchPattern: MatchPatternWord
Definition Classes
MatcherWords
def maxDiscardedFactor(value: PosZDouble): MaxDiscardedFactor
Definition Classes
Configuration
def message(expectedMessage: String): ResultOfMessageWordApplication
Definition Classes
Matchers
def minSize(value: PosZInt): MinSize
Definition Classes
Configuration
def minSuccessful(value: PosInt): MinSuccessful
Definition Classes
Configuration
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def no(xs: String)(implicit collecting: Collecting[Char, String], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Char]
Definition Classes
Matchers
def no[K, V, JMAP[k, v] <: Map[k, v]](xs: JMAP[K, V])(implicit collecting: Collecting[Entry[K, V], JMAP[K, V]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Entry[K, V]]
Definition Classes
Matchers
def no[E, C[_]](xs: C[E])(implicit collecting: Collecting[E, C[E]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[E]
Definition Classes
Matchers
def noElementsOf(elements: GenTraversable[Any]): ResultOfNoElementsOfApplication
Definition Classes
Matchers
def noException(implicit pos: Position): NoExceptionWord
Definition Classes
MatcherWords
def noneOf(firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit pos: Position): ResultOfNoneOfApplication
Definition Classes
Matchers
val not: NotWord
Definition Classes
MatcherWords
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
def of[T](implicit ev: ClassTag[T]): ResultOfOfTypeInvocation[T]
Definition Classes
Matchers
def oneElementOf(elements: GenTraversable[Any]): ResultOfOneElementOfApplication
Definition Classes
Matchers
def oneOf(firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit pos: Position): ResultOfOneOfApplication
Definition Classes
Matchers
def only(xs: Any*)(implicit pos: Position): ResultOfOnlyApplication
Definition Classes
Matchers
def pending: Assertion with PendingStatement
Definition Classes
Assertions
def pendingUntilFixed(f: => Unit)(implicit pos: Position): Assertion with PendingStatement
Definition Classes
Assertions
val readable: ReadableWord
Definition Classes
MatcherWords
val regex: RegexWord
Definition Classes
Matchers
val size: SizeWord
Definition Classes
MatcherWords
def sizeRange(value: PosZInt): SizeRange
Definition Classes
Configuration
val sorted: SortedWord
Definition Classes
MatcherWords
val startWith: StartWithWord
Definition Classes
MatcherWords
final val succeed: Assertion
Definition Classes
Assertions
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def the[T](implicit arg0: ClassTag[T], pos: Position): ResultOfTheTypeInvocation[T]
Definition Classes
Matchers
def theSameElementsAs(xs: GenTraversable[_]): ResultOfTheSameElementsAsApplication
Definition Classes
Matchers
def theSameElementsInOrderAs(xs: GenTraversable[_]): ResultOfTheSameElementsInOrderAsApplication
Definition Classes
Matchers
val theSameInstanceAs: TheSameInstanceAsPhrase
Definition Classes
Matchers
def thrownBy(fun: => Any): ResultOfThrownByApplication
Definition Classes
Matchers
def toString(): String
Definition Classes
AnyRef → Any
val typeCheck: TypeCheckWord
Definition Classes
MatcherWords
def typeCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], ev: <:<[B, A]): CanEqual[A, B]
Definition Classes
TripleEquals → TripleEqualsSupport
implicit def unconstrainedEquality[A, B](implicit equalityOfA: Equality[A]): CanEqual[A, B]
Definition Classes
TripleEquals → TripleEqualsSupport
def universallyQuantifiedPropertiesGen(res0: Boolean): Assertion
When you run check on the properties, ScalaCheck generates random instances of the function parameters and evaluates the results, reporting any failing cases.
When you run check on the properties, ScalaCheck generates random instances of the function parameters and evaluates the results, reporting any failing cases.
You can also give forAll a specific data generator. In the following example smallInteger defines a generator that generates integers between 0 and 100, inclusively.
This way of using the forAll method is good to use when you want to control the data generation by specifying exactly which generator that should be used, and not rely on a default generator for the given type.
def universallyQuantifiedPropertiesString(res0: Boolean): Assertion
As mentioned before, org.scalacheck.Prop.forAll creates universally quantified properties.
Universally quantified properties
As mentioned before, org.scalacheck.Prop.forAll creates universally quantified properties. forAll takes a function as parameter, and creates a property out of it that can be tested with the check method or with Scalatest, like in these examples.
The function passed to forAll should return Boolean or another property, and can take parameters of any types, as long as there exist implicit Arbitrary instances for the types. By default, ScalaCheck has instances for common types like Int, String, List, etc, but it is also possible to define your own Arbitrary instances.
For example:
val value: ValueWord
Definition Classes
Matchers
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
def withClue[T](clue: Any)(fun: => T): T
Definition Classes
Assertions
def workers(value: PosInt): Workers
Definition Classes
Configuration
val writable: WritableWord
Definition Classes
MatcherWords

Deprecated Value Members

def conversionCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], cnv: (B) => A): CanEqual[A, B]
Definition Classes
TripleEquals → TripleEqualsSupport
Annotations
@deprecated
Deprecated
(Since version 3.1.0) The conversionCheckedConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.
def convertEquivalenceToAToBConversionConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: (A) => B): CanEqual[A, B]
Definition Classes
TripleEquals → TripleEqualsSupport
Annotations
@deprecated
Deprecated
(Since version 3.1.0) The convertEquivalenceToAToBConversionConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.
def convertEquivalenceToBToAConversionConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: (B) => A): CanEqual[A, B]
Definition Classes
TripleEquals → TripleEqualsSupport
Annotations
@deprecated
Deprecated
(Since version 3.1.0) The convertEquivalenceToBToAConversionConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.
def lowPriorityConversionCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], cnv: (A) => B): CanEqual[A, B]
Definition Classes
TripleEquals → TripleEqualsSupport
Annotations
@deprecated
Deprecated
(Since version 3.1.0) The lowPriorityConversionCheckedConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

Packages

PropertiesSection

object PropertiesSection extends Checkers with Matchers with Section

Type Members

Value Members

Combining Properties

Conditional properties

Grouping Properties

Universally quantified properties

Deprecated Value Members

Inherited from Section

Inherited from Matchers

Inherited from Explicitly

Inherited from MatcherWords

Inherited from ShouldVerb

Inherited from Tolerance

Inherited from Assertions

Inherited from TripleEquals

Inherited from TripleEqualsSupport

Inherited from Checkers

Inherited from ScalaCheckConfiguration

Inherited from Configuration

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

PropertiesSection

object PropertiesSection extends Checkers with Matchers with Section

Type Members

Value Members

Combining Properties

Conditional properties

Grouping Properties

Universally quantified properties

Deprecated Value Members

Inherited from Section

Inherited from Matchers

Inherited from Explicitly

Inherited from MatcherWords

Inherited from ShouldVerb

Inherited from Tolerance

Inherited from Assertions

Inherited from TripleEquals

Inherited from TripleEqualsSupport

Inherited from Checkers

Inherited from ScalaCheckConfiguration

Inherited from Configuration

Inherited from AnyRef

Inherited from Any

Ungrouped

PropertiesSection