Skip to content

Commit

Permalink
Deprecate internal forAllShrink
Browse files Browse the repository at this point in the history 
Shrinking failed tests will be deprecated when an explicit
generator is given to forAll.

Going forward, there should be another way for users to
shrink failing tests.  Naming it forAllShrink is the obvious
candidate.  This old version of forAllShrink taking a should
be made private, and should also be updated to take an
explicit Shrink[T] rather than an explicit T => Stream[T].
  • Loading branch information
@ashawley
ashawley committed Feb 21, 2019
1 parent e6acf65 commit d16e8ba
Show file tree
Hide file tree
Showing 2 changed files with 114 additions and 5 deletions.
15 changes: 11 additions & 4 deletions src/main/scala/org/scalacheck/Prop.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,6 @@ object Prop {

import Gen.{fail, Parameters}
import Arbitrary.{arbitrary}
import Shrink.{shrink}

// Types

Expand Down Expand Up @@ -748,9 +747,17 @@ object Prop {

/** Universal quantifier for an explicit generator. Shrinks failed arguments
* with the given shrink function */
@deprecated("Use forAllShrink with implicit Shrink[T]", "1.15.0")
def forAllShrink[T, P](g: Gen[T],
shrink: T => Stream[T])(f: T => P
)(implicit pv: P => Prop, pp: T => Pretty
): Prop = forAllShrink(g, Shrink(shrink))(f)

/** Universal quantifier for an explicit generator. Shrinks failed arguments
* with the explicit `Shrink`. */
private def forAllShrink[T, P](g: Gen[T],
s: Shrink[T])(f: T => P
)(implicit pv: P => Prop, pp: T => Pretty
): Prop = Prop { prms0 =>

val (prms, seed) = startSeed(prms0)
Expand All @@ -775,7 +782,7 @@ object Prop {
}

def shrinker(x: T, r: Result, shrinks: Int, orig: T): Result = {
val xs = shrink(x).filter(gr.sieve)
val xs = s.shrink(x).filter(gr.sieve)
val res = r.addArg(Arg(labels,x,shrinks,orig,pp(x),pp(orig)))
if(xs.isEmpty) res else getFirstFailure(xs) match {
case Right((x2,r2)) => res
Expand Down Expand Up @@ -812,7 +819,7 @@ object Prop {
p: P => Prop,
s1: Shrink[T1],
pp1: T1 => Pretty
): Prop = forAllShrink[T1,P](g1, shrink[T1])(f)
): Prop = forAllShrink[T1,P](g1, s1)(f)

/** Universal quantifier for two explicit generators. Shrinks failed arguments
* with the default shrink function for the type */
Expand Down Expand Up @@ -910,7 +917,7 @@ object Prop {
f: A1 => P)(implicit
p: P => Prop,
a1: Arbitrary[A1], s1: Shrink[A1], pp1: A1 => Pretty
): Prop = forAllShrink(arbitrary[A1],shrink[A1])(f andThen p)
): Prop = forAllShrink(arbitrary[A1],s1)(f andThen p)

/** Converts a function into a universally quantified property */
def forAll[A1,A2,P] (
Expand Down
104 changes: 103 additions & 1 deletion src/test/scala/org/scalacheck/PropSpecification.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ package org.scalacheck
import Prop.{
forAll, falsified, undecided, exception, passed, proved, all,
atLeastOne, sizedProp, someFailing, noneFailing, Undecided, False, True,
Exception, Proof, throws, BooleanOperators, secure, delay, lzy
Exception, Proof, throws, BooleanOperators, secure, delay, lzy,
forAllShrink, forAllNoShrink
}
import Gen.{ const, fail, oneOf, listOf, Parameters }

Expand Down Expand Up @@ -129,6 +130,107 @@ object PropSpecification extends Properties("Prop") {
falsified(prms).status == False
}

// FIXME: This method was deprecated in 1.15.0, and will be removed.
property("forAllShrink(Gen, T=>Shrink[T])") = {
val anyVal: Gen[AnyVal] = Arbitrary.arbitrary[AnyVal]
val shrinkAnyVal: Shrink[AnyVal] = Shrink {
case v: Unit => Shrink.shrink[Unit](v)
case v: Boolean => Shrink.shrink[Boolean](v)
case v: Char => Shrink.shrink[Char](v)
case v: Byte => Shrink.shrink[Byte](v)
case v: Short => Shrink.shrink[Short](v)
case v: Int => Shrink.shrink[Int](v)
case v: Long => Shrink.shrink[Long](v)
case v: Float => Shrink.shrink[Float](v)
case v: Double => Shrink.shrink[Double](v)
}
forAllShrink(anyVal, shrinkAnyVal.shrink(_)) { _ =>
passed
}
}

property("forAll(Arbitrary)") = {
forAll { (_: AnyVal, _: AnyVal, _: AnyVal, _: AnyVal, _: AnyVal, _: AnyVal, _: AnyVal, _: AnyVal) =>
forAll { (_: AnyVal, _: AnyVal, _: AnyVal, _: AnyVal, _: AnyVal, _: AnyVal, _: AnyVal) =>
forAll { (_: AnyVal, _: AnyVal, _: AnyVal, _: AnyVal, _: AnyVal, _: AnyVal) =>
forAll { (_: AnyVal, _: AnyVal, _: AnyVal, _: AnyVal, _: AnyVal) =>
forAll { (_: AnyVal, _: AnyVal, _: AnyVal, _: AnyVal) =>
forAll { (_: AnyVal, _: AnyVal, _: AnyVal) =>
forAll { (_: AnyVal, _: AnyVal) =>
forAll { (_: AnyVal) =>
passed
}
}
}
}
}
}
}
}
}

property("forAllNoShrink(Arbitrary)") = {
forAllNoShrink { (_: AnyVal, _: AnyVal, _: AnyVal, _: AnyVal, _: AnyVal, _: AnyVal, _: AnyVal, _: AnyVal) =>
forAllNoShrink { (_: AnyVal, _: AnyVal, _: AnyVal, _: AnyVal, _: AnyVal, _: AnyVal, _: AnyVal) =>
forAllNoShrink { (_: AnyVal, _: AnyVal, _: AnyVal, _: AnyVal, _: AnyVal, _: AnyVal) =>
forAllNoShrink { (_: AnyVal, _: AnyVal, _: AnyVal, _: AnyVal, _: AnyVal) =>
forAllNoShrink { (_: AnyVal, _: AnyVal, _: AnyVal, _: AnyVal) =>
forAllNoShrink { (_: AnyVal, _: AnyVal, _: AnyVal) =>
forAllNoShrink { (_: AnyVal, _: AnyVal) =>
forAllNoShrink { (_: AnyVal) =>
passed
}
}
}
}
}
}
}
}
}

property("forAll(Gen)") = {
val anyVal: Gen[AnyVal] = Arbitrary.arbitrary[AnyVal]
forAll(anyVal, anyVal, anyVal, anyVal, anyVal, anyVal, anyVal, anyVal) { (_, _, _, _, _, _, _, _) =>
forAll(anyVal, anyVal, anyVal, anyVal, anyVal, anyVal, anyVal) { (_, _, _, _, _, _, _) =>
forAll(anyVal, anyVal, anyVal, anyVal, anyVal, anyVal) { (_, _, _, _, _, _) =>
forAll(anyVal, anyVal, anyVal, anyVal, anyVal) { (_, _, _, _, _) =>
forAll(anyVal, anyVal, anyVal, anyVal) { (_, _, _, _) =>
forAll(anyVal, anyVal, anyVal) { (_, _, _) =>
forAll(anyVal, anyVal) { (_, _) =>
forAll(anyVal) { (_) =>
passed
}
}
}
}
}
}
}
}
}

property("forAllNoShrink(Gen)") = {
val anyVal: Gen[AnyVal] = Arbitrary.arbitrary[AnyVal]
forAllNoShrink(anyVal, anyVal, anyVal, anyVal, anyVal, anyVal, anyVal, anyVal) { (_, _, _, _, _, _, _, _) =>
forAllNoShrink(anyVal, anyVal, anyVal, anyVal, anyVal, anyVal, anyVal) { (_, _, _, _, _, _, _) =>
forAllNoShrink(anyVal, anyVal, anyVal, anyVal, anyVal, anyVal) { (_, _, _, _, _, _) =>
forAllNoShrink(anyVal, anyVal, anyVal, anyVal, anyVal) { (_, _, _, _, _) =>
forAllNoShrink(anyVal, anyVal, anyVal, anyVal) { (_, _, _, _) =>
forAllNoShrink(anyVal, anyVal, anyVal) { (_, _, _) =>
forAllNoShrink(anyVal, anyVal) { (_, _) =>
forAllNoShrink(anyVal) { (_) =>
passed
}
}
}
}
}
}
}
}
}

property("proved") = forAll((prms: Parameters) => proved(prms).status == Proof)

property("passed") = forAll((prms: Parameters) => passed(prms).status == True)
Expand Down

0 comments on commit d16e8ba

Please # to comment.