-
Notifications
You must be signed in to change notification settings - Fork 511
/
MonadCancelTests.scala
166 lines (153 loc) · 5.35 KB
/
MonadCancelTests.scala
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
/*
* Copyright 2020-2023 Typelevel
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package cats.effect
package laws
import cats.Eq
import cats.effect.kernel.{CancelScope, MonadCancel}
import cats.laws.discipline._
import cats.laws.discipline.SemigroupalTests.Isomorphisms
import org.scalacheck._
import org.scalacheck.Prop.forAll
import org.scalacheck.util.Pretty
import org.typelevel.discipline.Laws
trait MonadCancelTests[F[_], E] extends MonadErrorTests[F, E] {
val laws: MonadCancelLaws[F, E]
@deprecated("revised several constraints", since = "3.2.0")
protected def monadCancel[A: Arbitrary: Eq, B: Arbitrary: Eq, C: Arbitrary: Eq](
implicit ArbFA: Arbitrary[F[A]],
ArbFB: Arbitrary[F[B]],
ArbFC: Arbitrary[F[C]],
ArbFU: Arbitrary[F[Unit]],
ArbFAtoB: Arbitrary[F[A => B]],
ArbFBtoC: Arbitrary[F[B => C]],
ArbE: Arbitrary[E],
CogenA: Cogen[A],
CogenB: Cogen[B],
CogenC: Cogen[C],
CogenE: Cogen[E],
EqFA: Eq[F[A]],
EqFB: Eq[F[B]],
EqFC: Eq[F[C]],
EqFU: Eq[F[Unit]],
EqE: Eq[E],
EqFEitherEU: Eq[F[Either[E, Unit]]],
EqFEitherEA: Eq[F[Either[E, A]]],
EqFABC: Eq[F[(A, B, C)]],
EqFInt: Eq[F[Int]],
iso: Isomorphisms[F],
faPP: F[A] => Pretty,
fuPP: F[Unit] => Pretty,
ePP: E => Pretty): RuleSet =
monadCancel[A, B, C](
implicitly[Arbitrary[A]],
implicitly[Eq[A]],
implicitly[Arbitrary[B]],
implicitly[Eq[B]],
implicitly[Arbitrary[C]],
implicitly[Eq[C]],
ArbFA,
ArbFB,
ArbFC,
ArbFU,
ArbFAtoB,
ArbFBtoC,
ArbE,
CogenA,
CogenB,
CogenC,
CogenE,
EqFA,
EqFB,
EqFC,
EqFU,
EqE,
EqFEitherEU,
EqFEitherEA,
EqFABC,
EqFInt,
iso
)
def monadCancel[A: Arbitrary: Eq, B: Arbitrary: Eq, C: Arbitrary: Eq](
implicit ArbFA: Arbitrary[F[A]],
ArbFB: Arbitrary[F[B]],
ArbFC: Arbitrary[F[C]],
ArbFU: Arbitrary[F[Unit]],
ArbFAtoB: Arbitrary[F[A => B]],
ArbFBtoC: Arbitrary[F[B => C]],
ArbE: Arbitrary[E],
CogenA: Cogen[A],
CogenB: Cogen[B],
CogenC: Cogen[C],
CogenE: Cogen[E],
EqFA: Eq[F[A]],
EqFB: Eq[F[B]],
EqFC: Eq[F[C]],
EqFU: Eq[F[Unit]],
EqE: Eq[E],
EqFEitherEU: Eq[F[Either[E, Unit]]],
EqFEitherEA: Eq[F[Either[E, A]]],
EqFABC: Eq[F[(A, B, C)]],
EqFInt: Eq[F[Int]],
iso: Isomorphisms[F]): RuleSet = {
new RuleSet {
val name = "monadCancel"
val bases: Seq[(String, Laws#RuleSet)] = Nil
val parents = Seq(monadError[A, B, C])
val props = {
val common: Seq[(String, Prop)] = Seq(
"guarantee is guaranteeCase" -> forAll(laws.guaranteeIsGuaranteeCase[A] _),
"uncancelable poll is identity" -> forAll(laws.uncancelablePollIsIdentity[A] _),
"uncancelable ignored poll eliminates nesting" -> forAll(
laws.uncancelableIgnoredPollEliminatesNesting[A] _),
"uncancelable poll inverse nest is uncancelable" -> forAll(
laws.uncancelablePollInverseNestIsUncancelable[A] _),
"uncancelable eliminates onCancel" -> forAll(
laws.uncancelableEliminatesOnCancel[A] _),
"onCancel associates over uncancelable boundary" -> forAll(
laws.onCancelAssociatesOverUncancelableBoundary[A] _),
"onCancel implies uncancelable" -> forAll(laws.onCancelImpliesUncancelable[A] _),
"forceR discards pure" -> forAll(laws.forceRDiscardsPure[A, B] _),
"forceR discards error" -> forAll(laws.forceRDiscardsError[A] _),
"forceR canceled short-circuits" -> forAll(laws.forceRCanceledShortCircuits[A] _),
"forceR associativity" -> forAll(laws.forceRAssociativity[A, B, C] _),
"uncancelable finalizers" -> forAll(laws.uncancelableFinalizers[A] _)
)
val suffix: Seq[(String, Prop)] = laws.F.rootCancelScope match {
case CancelScope.Cancelable =>
Seq(
"canceled sequences onCancel in order" -> forAll(
laws.canceledSequencesOnCancelInOrder _),
"uncancelable canceled associates right over flatMap attempt" -> forAll(
laws.uncancelableCanceledAssociatesRightOverFlatMapAttempt[A] _),
"canceled associates left over flatMap" -> forAll(
laws.canceledAssociatesLeftOverFlatMap[A] _)
)
case CancelScope.Uncancelable =>
Seq(
"uncancelable identity" -> forAll(laws.uncancelableIdentity[A] _),
"canceled is unit" -> laws.canceledUnitIdentity)
}
common ++ suffix
}
}
}
}
object MonadCancelTests {
def apply[F[_], E](implicit F0: MonadCancel[F, E]): MonadCancelTests[F, E] =
new MonadCancelTests[F, E] {
val laws = MonadCancelLaws[F, E]
}
}