doobie.weaver.Checker.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of doobie-weaver_2.13 Show documentation
Weaver support for doobie.
The newest version!
// Copyright (c) 2013-2020 Rob Norris and Contributors
// This software is licensed under the MIT License (MIT).
// For more information see LICENSE or https://opensource.org/licenses/MIT

package doobie.weaver

import weaver.*
import weaver.Expectations.Helpers.*
import doobie.util.testing.*
import doobie.syntax.connectionio.*
import cats.effect.kernel.Sync
import cats.syntax.all.*
import doobie.util.Colors
import doobie.*
import org.tpolecat.typename.*

/** Module with a mix-in trait for specifications that enables checking of doobie `Query` and `Update` values.
  *
  * {{{
  * object ExampleSuite extends IOSuite with IOChecker {
  *
  *   override type Res = Transactor[IO]
  *   override def sharedResource: Resource[IO, Res] =
  *     // The transactor to use for the tests.
  *     Resource.pure(Transactor.fromDriverManager[IO](...))
  *
  *   // Now just mention the queries. Arguments are not used.
  *   test("findByNameAndAge") { implicit transactor => check(MyDaoModule.findByNameAndAge(null, 0)) }
  *   test("allWoozles") { implicit transactor => check(MyDaoModule.allWoozles) }
  *
  * }
  * }}}
  */
trait Checker[M[_]] {
  def check[A: Analyzable](a: A)(implicit M: Sync[M], pos: SourceLocation, transactor: Transactor[M]): M[Expectations] =
    checkImpl(Analyzable.unpack(a))

  def checkOutput[A: TypeName](q: Query0[A])(implicit
      M: Sync[M],
      pos: SourceLocation,
      transactor: Transactor[M]
  ): M[Expectations] =
    checkImpl(AnalysisArgs(
      s"Query0[${typeName[A]}]",
      q.pos,
      q.sql,
      q.outputAnalysis
    ))

  def checkOutput[A: TypeName, B: TypeName](q: Query[A, B])(implicit
      M: Sync[M],
      pos: SourceLocation,
      transactor: Transactor[M]
  ): M[Expectations] =
    checkImpl(AnalysisArgs(
      s"Query[${typeName[A]}, ${typeName[B]}]",
      q.pos,
      q.sql,
      q.outputAnalysis
    ))

  private def checkImpl(args: AnalysisArgs)(implicit M: Sync[M], pos: SourceLocation, transactor: Transactor[M]) = {
    analyze(args).transact(transactor).map { report =>
      if (!report.succeeded)
        failure(formatReport(args, report, Colors.Ansi)
          .padLeft("  ")
          .toString)
      else success
    }
  }
}