TestConsole

TestConsole provides a testable interface for programs interacting with the console by modeling input and output as reading from and writing to intput and output buffers maintained by TestConsole and backed by a Ref.

All calls to putStr and putStrLn using the TestConsole will write the string to the output buffer and all calls to getStrLn will take a string from the input buffer. No actual printing or reading from the console will occur. TestConsole has several methods to access and manipulate the content of these buffers including feedLines to feed strings to the input buffer that will then be returned by calls to getStrLn, output to get the content of the output buffer from calls to putStr and putStrLn, and clearInput and clearOutput to clear the respective buffers.

Together, these functions make it easy to test programs interacting with the console.

import zio.console._
import zio.test.environment.TestConsole
import zio.ZIO

val sayHello = for {
  name <- getStrLn
  _    <- putStrLn("Hello, " + name + "!")
} yield ()

for {
  _ <- TestConsole.feedLines("John", "Jane", "Sally")
  _ <- ZIO.collectAll(List.fill(3)(sayHello))
  result <- TestConsole.output
} yield result == Vector("Hello, John!\n", "Hello, Jane!\n", "Hello, Sally!\n")