package scala.collection.parallel
import org.scalacheck._
import org.scalacheck.Gen
import org.scalacheck.Gen._
import org.scalacheck.Prop._
import org.scalacheck.Properties
import scala.collection._
import scala.collection.parallel._
abstract class ParallelIterableCheck[T](collName: String) extends Properties(collName) with Operators[T] {
type CollType <: ParIterable[T]
def values: Seq[Gen[T]]
def ofSize(vals: Seq[Gen[T]], sz: Int): Iterable[T]
def fromTraversable(t: Traversable[T]): CollType
def isCheckingViews: Boolean
def hasStrictOrder: Boolean
def instances(vals: Seq[Gen[T]]): Gen[Iterable[T]] = oneOf(
sized(
sz =>
ofSize(vals, sz)
),
for (sz <- choose(1000, 2000)) yield ofSize(vals, sz),
for (sz <- choose(4000, 4001)) yield ofSize(vals, sz),
for (sz <- choose(10000, 10001)) yield ofSize(vals, sz)
)
// used to check if constructed collection is valid
def checkDataStructureInvariants(orig: Traversable[T], cf: AnyRef) = {
// can be overriden in subclasses
true
}
def printDataStructureDebugInfo(cf: AnyRef) {
// can be overridden in subclasses
}
val rnd = new scala.util.Random
def sample(gen: Gen[T]): T = {
var s = gen.sample
while (s == None) s = gen.sample
s.get
}
def sampleValue: T = sample(values(rnd.nextInt(values.length)))
def collectionPairs = for (inst <- instances(values)) yield (inst, fromTraversable(inst))
def collectionPairsWithLengths = for (inst <- instances(values); s <- choose(0, inst.size))
yield (inst, fromTraversable(inst), s)
def collectionPairsWith2Indices = for (
inst <- instances(values);
f <- choose(0, inst.size);
s <- choose(0, inst.size))
yield (inst, fromTraversable(inst), f, s)
def collectionTriplets = for (inst <- instances(values);
updStart <- choose(0, inst.size); howMany <- choose(0, inst.size)) yield {
val modif = inst.toSeq.patch(updStart, inst.toSeq, howMany)
(inst, fromTraversable(inst), modif)
}
def areEqual(t1: GenTraversable[T], t2: GenTraversable[T]) = if (hasStrictOrder) {
t1 == t2 && t2 == t1
} else (t1, t2) match { // it is slightly delicate what `equal` means if the order is not strict
case (m1: GenMap[_, _], m2: GenMap[_, _]) => m1 == m2 && m2 == m1
case (i1: GenIterable[_], i2: GenIterable[_]) =>
val i1s = i1.toSet
val i2s = i2.toSet
i1s == i2s && i2s == i1s
case _ => t1 == t2 && t2 == t1
}
def printDebugInfo(coll: ParIterableLike[_, _, _]) {
println("Collection debug info: ")
coll.printDebugBuffer
println("Task debug info: ")
println(coll.tasksupport.debugMessages.mkString("\n"))
}
def printComparison(t: Traversable[_], coll: ParIterable[_], tf: Traversable[_], cf: ParIterable[_], ind: Int) {
printDebugInfo(coll)
println("Operator: " + ind)
println("sz: " + t.size)
println(t)
println
println("sz: " + coll.size)
println(coll)
println("transformed to:")
println
println("size: " + tf.size)
println(tf)
println
println("size: " + cf.size)
println(cf)
println
println("tf == cf - " + (tf == cf))
println("cf == tf - " + (cf == tf))
}
property("reductions must be equal for assoc. operators") = forAll(collectionPairs) { case (t, coll) =>
if (t.size != 0) {
val results = for ((op, ind) <- reduceOperators.zipWithIndex) yield {
val tr = t.reduceLeft(op)
val cr = coll.reduce(op)
if (tr != cr) {
println("from: " + t)
println("and: " + coll)
println("reducing with " + ind)
println(tr)
println(cr)
}
("op index: " + ind) |: tr == cr
}
results.reduceLeft(_ && _)
} else "has size 0" |: true
}
property("counts must be equal") = forAll(collectionPairs) { case (t, coll) =>
val results = for ((pred, ind) <- countPredicates.zipWithIndex) yield {
val tc = t.count(pred)
val cc = coll.count(pred)
if (tc != cc) {
println("from: " + t + " - size: " + t.size)
println("and: " + coll + " - size: " + coll.toList.size)
println(tc)
println(cc)
printDebugInfo(coll)
}
("op index: " + ind) |: tc == cc
}
results.reduceLeft(_ && _)
}
property("forall must be equal") = forAll(collectionPairs) { case (t, coll) =>
val results = for ((pred, ind) <- forallPredicates.zipWithIndex)
yield ("op index: " + ind) |: t.forall(pred) == coll.forall(pred)
results.reduceLeft(_ && _)
}
property("exists must be equal") = forAll(collectionPairs) { case (t, coll) =>
val results = for ((pred, ind) <- existsPredicates.zipWithIndex)
yield ("op index: " + ind) |: t.exists(pred) == coll.exists(pred)
results.reduceLeft(_ && _)
}
property("both must find or not find an element") = forAll(collectionPairs) { case (t, coll) =>
val results = for ((pred, ind) <- findPredicates.zipWithIndex) yield {
val ft = t.find(pred)
val fcoll = coll.find(pred)
("op index: " + ind) |: ((ft == None && fcoll == None) || (ft != None && fcoll != None))
}
results.reduceLeft(_ && _)
}
property("mappings must be equal") = forAll(collectionPairs) { case (t, coll) =>
val results = for ((f, ind) <- mapFunctions.zipWithIndex) yield {
val ms = t.map(f)
val mp = coll.map(f)
val invs = checkDataStructureInvariants(ms, mp)
if (!areEqual(ms, mp) || !invs) {
println(t)
println(coll)
println("mapped to: ")
println(ms)
println(mp)
println("sizes: ")
println(ms.size)
println(mp.size)
println("valid: " + invs)
}
("op index: " + ind) |: (areEqual(ms, mp) && invs)
}
results.reduceLeft(_ && _)
}
property("collects must be equal") = forAll(collectionPairs) { case (t, coll) =>
val results = for ((f, ind) <- partialMapFunctions.zipWithIndex) yield {
val ps = t.collect(f)
val pp = coll.collect(f)
if (!areEqual(ps, pp)) {
println(t)
println(coll)
println("collected to: ")
println(ps)
println(pp)
}
("op index: " + ind) |: areEqual(ps, pp)
}
results.reduceLeft(_ && _)
}
property("flatMaps must be equal") = forAll(collectionPairs) { case (t, coll) =>
(for ((f, ind) <- flatMapFunctions.zipWithIndex)
yield ("op index: " + ind) |: areEqual(t.flatMap(f), coll.flatMap(f))).reduceLeft(_ && _)
}
property("filters must be equal") = forAll(collectionPairs) { case (t, coll) =>
(for ((p, ind) <- filterPredicates.zipWithIndex) yield {
val tf = t.filter(p)
val cf = coll.filter(p)
val invs = checkDataStructureInvariants(tf, cf)
if (tf != cf || cf != tf || !invs) {
printDebugInfo(coll)
println("Operator: " + ind)
println("sz: " + t.size)
println(t)
println
println("sz: " + coll.size)
println(coll)
println
println("filtered to:")
println
println(cf)
println
println(tf)
println
println("tf == cf - " + (tf == cf))
println("cf == tf - " + (cf == tf))
printDataStructureDebugInfo(cf)
println("valid: " + invs)
}
("op index: " + ind) |: tf == cf && cf == tf && invs
}).reduceLeft(_ && _)
}
property("filterNots must be equal") = forAll(collectionPairs) { case (t, coll) =>
(for ((p, ind) <- filterNotPredicates.zipWithIndex) yield {
val tf = t.filterNot(p)
val cf = coll.filterNot(p)
if (tf != cf || cf != tf) printComparison(t, coll, tf, cf, ind)
("op index: " + ind) |: tf == cf && cf == tf
}).reduceLeft(_ && _)
}
if (!isCheckingViews) property("partitions must be equal") = forAll(collectionPairs) { case (t, coll) =>
(for ((p, ind) <- partitionPredicates.zipWithIndex) yield {
val tpart = t.partition(p)
val cpart = coll.partition(p)
if (tpart != cpart) {
println("from: " + t)
println("and: " + coll)
println(cpart)
println(tpart)
}
("op index: " + ind) |: tpart == cpart
}).reduceLeft(_ && _)
}
if (hasStrictOrder) property("takes must be equal") = forAll(collectionPairsWithLengths) { case (t, coll, n) =>
("take " + n + " elements") |: t.take(n) == coll.take(n)
}
if (hasStrictOrder) property("drops must be equal") = forAll(collectionPairsWithLengths) { case (t, coll, n) =>
("drop " + n + " elements") |: t.drop(n) == coll.drop(n)
}
if (hasStrictOrder) property("slices must be equal") = forAll(collectionPairsWith2Indices)
{ case (t, coll, fr, slicelength) =>
val from = if (fr < 0) 0 else fr
val until = if (from + slicelength > t.size) t.size else from + slicelength
val tsl = t.slice(from, until)
val collsl = coll.slice(from, until)
if (tsl != collsl) {
println("---------------------- " + from + ", " + until)
println("from: " + t)
println("and: " + coll)
println(tsl)
println(collsl)
println("as list: " + collsl.toList)
println(collsl.iterator.hasNext)
println(collsl.iterator.next)
println(collsl.iterator.hasNext)
println(collsl.iterator.next)
println(collsl.iterator.hasNext)
println(collsl.iterator.next)
println(collsl.iterator.hasNext)
}
("slice from " + from + " until " + until) |: tsl == collsl
}
if (hasStrictOrder) property("splits must be equal") = forAll(collectionPairsWithLengths) { case (t, coll, n) =>
val tspl = t.splitAt(n)
val cspl = coll.splitAt(n)
if (tspl != cspl) {
println("at: " + n)
println("from: " + t)
println("and: " + coll)
println(tspl)
println(cspl)
}
("splitAt " + n) |: tspl == cspl
}
if (hasStrictOrder) property("takeWhiles must be equal") = forAll(collectionPairs) { case (t, coll) =>
(for ((pred, ind) <- takeWhilePredicates.zipWithIndex) yield {
val tt = t.takeWhile(pred)
val ct = coll.takeWhile(pred)
if (tt != ct) {
println("from: " + t)
println("and: " + coll)
println("taking while...")
println(tt)
println(ct)
}
("operator " + ind) |: tt == ct
}).reduceLeft(_ && _)
}
if (hasStrictOrder) property("spans must be equal") = forAll(collectionPairs) { case (t, coll) =>
(for ((pred, ind) <- spanPredicates.zipWithIndex) yield {
val tsp = t.span(pred)
val csp = coll.span(pred)
if (tsp != csp) {
println("from: " + t)
println("and: " + coll)
println("span with predicate " + ind)
println(tsp)
println(csp)
println("---------------------------------")
println(coll.span(pred))
println("---------------------------------")
}
("operator " + ind) |: tsp == csp
}).reduceLeft(_ && _)
}
if (hasStrictOrder) property("dropWhiles must be equal") = forAll(collectionPairs) { case (t, coll) =>
(for ((pred, ind) <- dropWhilePredicates.zipWithIndex) yield {
("operator " + ind) |: t.dropWhile(pred) == coll.dropWhile(pred)
}).reduceLeft(_ && _)
}
property("folds must be equal for assoc. operators") = forAll(collectionPairs) { case (t, coll) =>
(for (((first, op), ind) <- foldArguments.zipWithIndex) yield {
val tres = t.foldLeft(first)(op)
val cres = coll.fold(first)(op)
if (cres != tres) {
println("from: " + t)
println("and: " + coll)
println("folds are: ")
println(tres)
println(cres)
}
("operator " + ind) |: tres == cres
}).reduceLeft(_ && _)
}
property("++s must be equal") = forAll(collectionTriplets) { case (t, coll, colltoadd) =>
val toadd = colltoadd
val tr = t ++ toadd.iterator
val cr = coll ++ toadd.iterator
if (!areEqual(tr, cr)) {
println("from: " + t)
println("and: " + coll.iterator.toList)
println("adding: " + toadd)
println(tr.toList)
println(cr.iterator.toList)
}
("adding " |: areEqual(tr, cr)) &&
(for ((trav, ind) <- (addAllTraversables).zipWithIndex) yield {
val tadded = t ++ trav
val cadded = coll ++ collection.parallel.mutable.ParArray(trav.toSeq: _*)
if (!areEqual(tadded, cadded)) {
println("----------------------")
println("from: " + t)
println("and: " + coll)
println("adding: " + trav)
println(tadded)
println(cadded)
}
("traversable " + ind) |: areEqual(tadded, cadded)
}).reduceLeft(_ && _)
}
if (hasStrictOrder) property("copies to array must be equal") = forAll(collectionPairs) { case (t, coll) =>
val tarr = newArray(t.size)
val collarr = newArray(coll.size)
t.copyToArray(tarr, 0, t.size)
coll.copyToArray(collarr, 0, coll.size)
if (tarr.toSeq != collarr.toSeq) {
println("from: " + t)
println("and: " + coll)
println(tarr.toSeq)
println(collarr.toSeq)
}
tarr.toSeq == collarr.toSeq
}
if (hasStrictOrder) property("scans must be equal") = forAll(collectionPairs) {
case (t, coll) =>
(for (((first, op), ind) <- foldArguments.zipWithIndex) yield {
val tscan = t.scanLeft(first)(op)
val cscan = coll.scan(first)(op)
if (tscan != cscan || cscan != tscan) {
println("from: " + t)
println("and: " + coll)
println("scans are: ")
println(tscan)
println(cscan)
}
("operator " + ind) |: tscan == cscan && cscan == tscan
}).reduceLeft(_ && _)
}
property("groupBy must be equal") = forAll(collectionPairs) {
case (t, coll) =>
(for ((f, ind) <- groupByFunctions.zipWithIndex) yield {
val tgroup = t.groupBy(f)
val cgroup = coll.groupBy(f)
if (tgroup != cgroup || cgroup != tgroup) {
println("from: " + t)
println("and: " + coll)
println("groups are: ")
println(tgroup)
println(cgroup)
}
("operator " + ind) |: tgroup == cgroup && cgroup == tgroup
}).reduceLeft(_ && _)
}
}