如何扩展 ZIO 测试的测试环境
How to extend the TestEnvironment of a ZIO Test
我想测试以下功能:
def curl(host: String, attempt: Int = 200): ZIO[Loggings with Clock, Throwable, Unit]
如果环境只使用标准的 ZIO 环境,比如 Console with Clock
,测试将开箱即用:
testM("curl on valid URL") {
(for {
r <- composer.curl("https://google.com")
} yield
assert(r, isUnit))
}
测试环境将由zio-test
提供。
所以问题是,如何使用我的 Loggings
模块扩展 TestEnvironment?
这是我想出来的:
testM("curl on valid URL") {
(for {
r <- composer.curl("https://google.com")
} yield
assert(r, isUnit))
.provideSome[TestEnvironment](env => new Loggings.ConsoleLogger
with TestClock {
override val clock: TestClock.Service[Any] = env.clock
override val scheduler: TestClock.Service[Any] = env.scheduler
override val console: TestLogger.Service[Any] = MyLogger()
})
}
使用 TestEnvironment
和 provideSome
设置我的环境。
请注意,此答案适用于 RC17,在 RC18 中会发生重大变化。你是对的,就像在其他组合环境的情况下一样,我们需要实现一个函数来从我们拥有的模块构建我们的整体环境。 Spec 内置了多个组合器,例如 provideManaged
来执行此操作,因此您无需在测试本身中执行此操作。所有这些都有 "normal" 变体,它们将为套件中的每个测试提供单独的环境副本,以及 "shared" 变体,当它是一种资源时,将为整个套件创建一个环境副本创建像 Kafka 服务一样昂贵。
您可以在下面查看使用 provideSomeManaged
提供将测试环境扩展到测试的环境的示例。
在 RC18 中,将有许多其他与 ZIO 上的变体等效的变体,以及层的新概念,使为 ZIO 应用程序构建组合环境变得更加容易。
import zio._
import zio.clock._
import zio.test._
import zio.test.environment._
import ExampleSpecUtil._
object ExampleSpec
extends DefaultRunnableSpec(
suite("ExampleSpec")(
testM("My Test") {
for {
time <- clock.nanoTime
_ <- Logging.logLine(
s"The TestClock says the current time is $time"
)
} yield assertCompletes
}
).provideSomeManaged(testClockWithLogging)
)
object ExampleSpecUtil {
trait Logging {
def logging: Logging.Service
}
object Logging {
trait Service {
def logLine(line: String): UIO[Unit]
}
object Live extends Logging {
val logging: Logging.Service =
new Logging.Service {
def logLine(line: String): UIO[Unit] =
UIO(println(line))
}
}
def logLine(line: String): URIO[Logging, Unit] =
URIO.accessM(_.logging.logLine(line))
}
val testClockWithLogging
: ZManaged[TestEnvironment, Nothing, TestClock with Logging] =
ZIO
.access[TestEnvironment] { testEnvironment =>
new TestClock with Logging {
val clock = testEnvironment.clock
val logging = Logging.Live.logging
val scheduler = testEnvironment.scheduler
}
}
.toManaged_
}
我想测试以下功能:
def curl(host: String, attempt: Int = 200): ZIO[Loggings with Clock, Throwable, Unit]
如果环境只使用标准的 ZIO 环境,比如 Console with Clock
,测试将开箱即用:
testM("curl on valid URL") {
(for {
r <- composer.curl("https://google.com")
} yield
assert(r, isUnit))
}
测试环境将由zio-test
提供。
所以问题是,如何使用我的 Loggings
模块扩展 TestEnvironment?
这是我想出来的:
testM("curl on valid URL") {
(for {
r <- composer.curl("https://google.com")
} yield
assert(r, isUnit))
.provideSome[TestEnvironment](env => new Loggings.ConsoleLogger
with TestClock {
override val clock: TestClock.Service[Any] = env.clock
override val scheduler: TestClock.Service[Any] = env.scheduler
override val console: TestLogger.Service[Any] = MyLogger()
})
}
使用 TestEnvironment
和 provideSome
设置我的环境。
请注意,此答案适用于 RC17,在 RC18 中会发生重大变化。你是对的,就像在其他组合环境的情况下一样,我们需要实现一个函数来从我们拥有的模块构建我们的整体环境。 Spec 内置了多个组合器,例如 provideManaged
来执行此操作,因此您无需在测试本身中执行此操作。所有这些都有 "normal" 变体,它们将为套件中的每个测试提供单独的环境副本,以及 "shared" 变体,当它是一种资源时,将为整个套件创建一个环境副本创建像 Kafka 服务一样昂贵。
您可以在下面查看使用 provideSomeManaged
提供将测试环境扩展到测试的环境的示例。
在 RC18 中,将有许多其他与 ZIO 上的变体等效的变体,以及层的新概念,使为 ZIO 应用程序构建组合环境变得更加容易。
import zio._
import zio.clock._
import zio.test._
import zio.test.environment._
import ExampleSpecUtil._
object ExampleSpec
extends DefaultRunnableSpec(
suite("ExampleSpec")(
testM("My Test") {
for {
time <- clock.nanoTime
_ <- Logging.logLine(
s"The TestClock says the current time is $time"
)
} yield assertCompletes
}
).provideSomeManaged(testClockWithLogging)
)
object ExampleSpecUtil {
trait Logging {
def logging: Logging.Service
}
object Logging {
trait Service {
def logLine(line: String): UIO[Unit]
}
object Live extends Logging {
val logging: Logging.Service =
new Logging.Service {
def logLine(line: String): UIO[Unit] =
UIO(println(line))
}
}
def logLine(line: String): URIO[Logging, Unit] =
URIO.accessM(_.logging.logLine(line))
}
val testClockWithLogging
: ZManaged[TestEnvironment, Nothing, TestClock with Logging] =
ZIO
.access[TestEnvironment] { testEnvironment =>
new TestClock with Logging {
val clock = testEnvironment.clock
val logging = Logging.Live.logging
val scheduler = testEnvironment.scheduler
}
}
.toManaged_
}