All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.mockito.WhenMacro.scala Maven / Gradle / Ivy

The newest version!
package org.mockito

import org.mockito.Utils._
import org.mockito.internal.MacroDebug.debugResult
import org.mockito.internal.ValueClassWrapper
import org.mockito.stubbing.{ ScalaFirstStubbing, ScalaOngoingStubbing }

import scala.reflect.ClassTag
import scala.reflect.macros.blackbox

object WhenMacro {
  private def transformInvocation(c: blackbox.Context)(invocation: c.Tree): c.Tree = {
    import c.universe._

    val pf: PartialFunction[c.Tree, c.Tree] = {
      case q"$obj.$method[..$targs](...$args)" =>
        val newArgs = args.map(a => transformArgs(c)(a))
        q"$obj.$method[..$targs](...$newArgs)"
      case q"$obj.$method[..$targs]" => invocation
    }

    if (pf.isDefinedAt(invocation))
      pf(invocation)
    else if (pf.isDefinedAt(invocation.children.last)) {
      val vals = invocation.children.dropRight(1)
      val valsByName = vals.collect { case line @ q"$_ val $name:$_ = $value" =>
        name.toString -> (value.asInstanceOf[c.Tree], line)
      }.toMap

      val inlinedArgsCall = invocation.children.last match {
        case q"$obj.$method[..$targs](...$args)" =>
          val newArgs = args.map { a =>
            transformArgs(c)(a).map {
              case p if show(p).startsWith("x$") => transformArg(c)(valsByName(p.toString)._1)
              case other                         => other
            }
          }
          q"$obj.$method[..$targs](...$newArgs)"
      }

      val call = show(inlinedArgsCall)
      val usedVals = valsByName.collect {
        case (name, (_, line)) if call.contains(name) => line
      }

      q"..$usedVals; $inlinedArgsCall"
    } else throw new Exception(s"Couldn't recognize invocation ${show(invocation)}")
  }

  private val ShouldReturnOptions            = Set("shouldReturn", "mustReturn", "returns")
  private val FunctionalShouldReturnOptions  = ShouldReturnOptions.map(_ + "F")
  private val FunctionalShouldReturnOptions2 = ShouldReturnOptions.map(_ + "FG")
  def shouldReturn[T: c.WeakTypeTag](c: blackbox.Context): c.Tree = {
    import c.universe._

    val r = c.macroApplication match {
      case q"$_.StubbingOps[$t]($invocation).$m" if ShouldReturnOptions.contains(m.toString) =>
        q"new _root_.org.mockito.IdiomaticMockitoBase.ReturnActions(_root_.org.mockito.Mockito.when[$t](${transformInvocation(c)(invocation)}))"

      case q"$_.$cls[..$_]($invocation).$m" if cls.toString.startsWith("StubbingOps") && FunctionalShouldReturnOptions.contains(m.toString) =>
        q"new _root_.org.mockito.${packageName(c)(cls)}.${className(c)(cls, "IdiomaticMockito")}.ReturnActions(_root_.org.mockito.Mockito.when(${transformInvocation(c)(invocation)}))"

      case q"$_.$cls[..$_]($invocation).$m" if cls.toString.startsWith("StubbingOps2") && FunctionalShouldReturnOptions2.contains(m.toString) =>
        q"new _root_.org.mockito.${packageName(c)(cls)}.${className(c)(cls, "IdiomaticMockito")}.ReturnActions2(_root_.org.mockito.Mockito.when(${transformInvocation(c)(invocation)}))"

      case o => throw new Exception(s"Couldn't recognize ${show(o)}")
    }
    debugResult(c)("mockito-print-when")(r)
    r
  }

  def isLenient[T: c.WeakTypeTag](c: blackbox.Context)(): c.Expr[Unit] = {
    import c.universe._

    val r = c.Expr[Unit] {
      c.macroApplication match {
        case q"$_.StubbingOps[$t]($invocation).isLenient()" =>
          q"new _root_.org.mockito.stubbing.ScalaFirstStubbing(_root_.org.mockito.Mockito.when[$t](${transformInvocation(c)(invocation)})).isLenient()"

        case o => throw new Exception(s"Couldn't recognize ${show(o)}")
      }
    }
    debugResult(c)("mockito-print-lenient")(r.tree)
    r
  }

  object RealMethod {
    def willBe(called: Called.type): Called.type = called
  }

  val ShouldCallOptions = Set("shouldCall", "mustCall", "calls")
  def shouldCallRealMethod[T: c.WeakTypeTag](c: blackbox.Context)(crm: c.Expr[RealMethod.type]): c.Expr[ScalaOngoingStubbing[T]] = {
    import c.universe._

    val r = c.Expr[ScalaOngoingStubbing[T]] {
      c.macroApplication match {
        case q"$_.StubbingOps[$t]($invocation).$m($_.realMethod)" if ShouldCallOptions.contains(m.toString) =>
          q"new _root_.org.mockito.stubbing.ScalaOngoingStubbing(_root_.org.mockito.Mockito.when[$t](${transformInvocation(c)(invocation)}).thenCallRealMethod())"

        case o => throw new Exception(s"Couldn't recognize ${show(o)}")
      }
    }
    debugResult(c)("mockito-print-when")(r.tree)
    r
  }

  private val ShouldThrowOptions           = Set("shouldThrow", "mustThrow", "throws")
  private val FunctionalShouldFailOptions  = Set("shouldFailWith", "mustFailWith", "failsWith", "raises")
  private val FunctionalShouldFailOptions2 = Set("shouldFailWithG", "mustFailWithG", "failsWithG", "raisesG")
  def shouldThrow[T: c.WeakTypeTag](c: blackbox.Context): c.Tree = {
    import c.universe._

    val r = c.macroApplication match {
      case q"$_.StubbingOps[$t]($invocation).$m" if ShouldThrowOptions.contains(m.toString) =>
        q"new _root_.org.mockito.IdiomaticMockitoBase.ThrowActions(_root_.org.mockito.Mockito.when[$t](${transformInvocation(c)(invocation)}))"

      case q"$_.$cls[..$_]($invocation).$m" if cls.toString.startsWith("StubbingOps") && FunctionalShouldFailOptions.contains(m.toString) =>
        q"new _root_.org.mockito.${packageName(c)(cls)}.${className(c)(cls, "IdiomaticMockito")}.ThrowActions(_root_.org.mockito.Mockito.when(${transformInvocation(c)(invocation)}))"

      case q"$_.$cls[..$_]($invocation).$m" if cls.toString.startsWith("StubbingOps2") && FunctionalShouldFailOptions2.contains(m.toString) =>
        q"new _root_.org.mockito.${packageName(c)(cls)}.${className(c)(cls, "IdiomaticMockito")}.ThrowActions2(_root_.org.mockito.Mockito.when(${transformInvocation(c)(invocation)}))"

      case o => throw new Exception(s"Couldn't recognize ${show(o)}")
    }
    debugResult(c)("mockito-print-when")(r)
    r
  }

  class AnswerActions[T](os: ScalaFirstStubbing[T]) {
    def apply(f: => T): ScalaOngoingStubbing[T] = os thenAnswer f

    def apply[P0: ValueClassWrapper](f: P0 => T)(implicit classTag: ClassTag[P0] = defaultClassTag[P0]): ScalaOngoingStubbing[T] =
      os thenAnswer f

    def apply[P0: ValueClassWrapper, P1: ValueClassWrapper](f: (P0, P1) => T): ScalaOngoingStubbing[T] =
      os thenAnswer f

    def apply[P0: ValueClassWrapper, P1: ValueClassWrapper, P2: ValueClassWrapper](f: (P0, P1, P2) => T): ScalaOngoingStubbing[T] =
      os thenAnswer f

    def apply[P0: ValueClassWrapper, P1: ValueClassWrapper, P2: ValueClassWrapper, P3: ValueClassWrapper](f: (P0, P1, P2, P3) => T): ScalaOngoingStubbing[T] =
      os thenAnswer f

    def apply[P0: ValueClassWrapper, P1: ValueClassWrapper, P2: ValueClassWrapper, P3: ValueClassWrapper, P4: ValueClassWrapper](
        f: (P0, P1, P2, P3, P4) => T
    ): ScalaOngoingStubbing[T] =
      os thenAnswer f

    def apply[P0: ValueClassWrapper, P1: ValueClassWrapper, P2: ValueClassWrapper, P3: ValueClassWrapper, P4: ValueClassWrapper, P5: ValueClassWrapper](
        f: (P0, P1, P2, P3, P4, P5) => T
    ): ScalaOngoingStubbing[T] =
      os thenAnswer f

    def apply[P0: ValueClassWrapper, P1: ValueClassWrapper, P2: ValueClassWrapper, P3: ValueClassWrapper, P4: ValueClassWrapper, P5: ValueClassWrapper, P6: ValueClassWrapper](
        f: (P0, P1, P2, P3, P4, P5, P6) => T
    ): ScalaOngoingStubbing[T] =
      os thenAnswer f

    def apply[
        P0: ValueClassWrapper,
        P1: ValueClassWrapper,
        P2: ValueClassWrapper,
        P3: ValueClassWrapper,
        P4: ValueClassWrapper,
        P5: ValueClassWrapper,
        P6: ValueClassWrapper,
        P7: ValueClassWrapper
    ](f: (P0, P1, P2, P3, P4, P5, P6, P7) => T): ScalaOngoingStubbing[T] =
      os thenAnswer f

    def apply[
        P0: ValueClassWrapper,
        P1: ValueClassWrapper,
        P2: ValueClassWrapper,
        P3: ValueClassWrapper,
        P4: ValueClassWrapper,
        P5: ValueClassWrapper,
        P6: ValueClassWrapper,
        P7: ValueClassWrapper,
        P8: ValueClassWrapper
    ](f: (P0, P1, P2, P3, P4, P5, P6, P7, P8) => T): ScalaOngoingStubbing[T] =
      os thenAnswer f

    def apply[
        P0: ValueClassWrapper,
        P1: ValueClassWrapper,
        P2: ValueClassWrapper,
        P3: ValueClassWrapper,
        P4: ValueClassWrapper,
        P5: ValueClassWrapper,
        P6: ValueClassWrapper,
        P7: ValueClassWrapper,
        P8: ValueClassWrapper,
        P9: ValueClassWrapper
    ](f: (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9) => T): ScalaOngoingStubbing[T] =
      os thenAnswer f

    def apply[
        P0: ValueClassWrapper,
        P1: ValueClassWrapper,
        P2: ValueClassWrapper,
        P3: ValueClassWrapper,
        P4: ValueClassWrapper,
        P5: ValueClassWrapper,
        P6: ValueClassWrapper,
        P7: ValueClassWrapper,
        P8: ValueClassWrapper,
        P9: ValueClassWrapper,
        P10: ValueClassWrapper
    ](f: (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10) => T): ScalaOngoingStubbing[T] =
      os thenAnswer f

    def apply[
        P0: ValueClassWrapper,
        P1: ValueClassWrapper,
        P2: ValueClassWrapper,
        P3: ValueClassWrapper,
        P4: ValueClassWrapper,
        P5: ValueClassWrapper,
        P6: ValueClassWrapper,
        P7: ValueClassWrapper,
        P8: ValueClassWrapper,
        P9: ValueClassWrapper,
        P10: ValueClassWrapper,
        P11: ValueClassWrapper
    ](f: (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11) => T): ScalaOngoingStubbing[T] =
      os thenAnswer f

    def apply[
        P0: ValueClassWrapper,
        P1: ValueClassWrapper,
        P2: ValueClassWrapper,
        P3: ValueClassWrapper,
        P4: ValueClassWrapper,
        P5: ValueClassWrapper,
        P6: ValueClassWrapper,
        P7: ValueClassWrapper,
        P8: ValueClassWrapper,
        P9: ValueClassWrapper,
        P10: ValueClassWrapper,
        P11: ValueClassWrapper,
        P12: ValueClassWrapper
    ](f: (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12) => T): ScalaOngoingStubbing[T] =
      os thenAnswer f

    def apply[
        P0: ValueClassWrapper,
        P1: ValueClassWrapper,
        P2: ValueClassWrapper,
        P3: ValueClassWrapper,
        P4: ValueClassWrapper,
        P5: ValueClassWrapper,
        P6: ValueClassWrapper,
        P7: ValueClassWrapper,
        P8: ValueClassWrapper,
        P9: ValueClassWrapper,
        P10: ValueClassWrapper,
        P11: ValueClassWrapper,
        P12: ValueClassWrapper,
        P13: ValueClassWrapper
    ](f: (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13) => T): ScalaOngoingStubbing[T] =
      os thenAnswer f

    def apply[
        P0: ValueClassWrapper,
        P1: ValueClassWrapper,
        P2: ValueClassWrapper,
        P3: ValueClassWrapper,
        P4: ValueClassWrapper,
        P5: ValueClassWrapper,
        P6: ValueClassWrapper,
        P7: ValueClassWrapper,
        P8: ValueClassWrapper,
        P9: ValueClassWrapper,
        P10: ValueClassWrapper,
        P11: ValueClassWrapper,
        P12: ValueClassWrapper,
        P13: ValueClassWrapper,
        P14: ValueClassWrapper
    ](f: (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14) => T): ScalaOngoingStubbing[T] =
      os thenAnswer f

    def apply[
        P0: ValueClassWrapper,
        P1: ValueClassWrapper,
        P2: ValueClassWrapper,
        P3: ValueClassWrapper,
        P4: ValueClassWrapper,
        P5: ValueClassWrapper,
        P6: ValueClassWrapper,
        P7: ValueClassWrapper,
        P8: ValueClassWrapper,
        P9: ValueClassWrapper,
        P10: ValueClassWrapper,
        P11: ValueClassWrapper,
        P12: ValueClassWrapper,
        P13: ValueClassWrapper,
        P14: ValueClassWrapper,
        P15: ValueClassWrapper
    ](f: (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15) => T): ScalaOngoingStubbing[T] =
      os thenAnswer f

    def apply[
        P0: ValueClassWrapper,
        P1: ValueClassWrapper,
        P2: ValueClassWrapper,
        P3: ValueClassWrapper,
        P4: ValueClassWrapper,
        P5: ValueClassWrapper,
        P6: ValueClassWrapper,
        P7: ValueClassWrapper,
        P8: ValueClassWrapper,
        P9: ValueClassWrapper,
        P10: ValueClassWrapper,
        P11: ValueClassWrapper,
        P12: ValueClassWrapper,
        P13: ValueClassWrapper,
        P14: ValueClassWrapper,
        P15: ValueClassWrapper,
        P16: ValueClassWrapper
    ](f: (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16) => T): ScalaOngoingStubbing[T] =
      os thenAnswer f

    def apply[
        P0: ValueClassWrapper,
        P1: ValueClassWrapper,
        P2: ValueClassWrapper,
        P3: ValueClassWrapper,
        P4: ValueClassWrapper,
        P5: ValueClassWrapper,
        P6: ValueClassWrapper,
        P7: ValueClassWrapper,
        P8: ValueClassWrapper,
        P9: ValueClassWrapper,
        P10: ValueClassWrapper,
        P11: ValueClassWrapper,
        P12: ValueClassWrapper,
        P13: ValueClassWrapper,
        P14: ValueClassWrapper,
        P15: ValueClassWrapper,
        P16: ValueClassWrapper,
        P17: ValueClassWrapper
    ](f: (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17) => T): ScalaOngoingStubbing[T] =
      os thenAnswer f

    def apply[
        P0: ValueClassWrapper,
        P1: ValueClassWrapper,
        P2: ValueClassWrapper,
        P3: ValueClassWrapper,
        P4: ValueClassWrapper,
        P5: ValueClassWrapper,
        P6: ValueClassWrapper,
        P7: ValueClassWrapper,
        P8: ValueClassWrapper,
        P9: ValueClassWrapper,
        P10: ValueClassWrapper,
        P11: ValueClassWrapper,
        P12: ValueClassWrapper,
        P13: ValueClassWrapper,
        P14: ValueClassWrapper,
        P15: ValueClassWrapper,
        P16: ValueClassWrapper,
        P17: ValueClassWrapper,
        P18: ValueClassWrapper
    ](f: (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17, P18) => T): ScalaOngoingStubbing[T] =
      os thenAnswer f

    def apply[
        P0: ValueClassWrapper,
        P1: ValueClassWrapper,
        P2: ValueClassWrapper,
        P3: ValueClassWrapper,
        P4: ValueClassWrapper,
        P5: ValueClassWrapper,
        P6: ValueClassWrapper,
        P7: ValueClassWrapper,
        P8: ValueClassWrapper,
        P9: ValueClassWrapper,
        P10: ValueClassWrapper,
        P11: ValueClassWrapper,
        P12: ValueClassWrapper,
        P13: ValueClassWrapper,
        P14: ValueClassWrapper,
        P15: ValueClassWrapper,
        P16: ValueClassWrapper,
        P17: ValueClassWrapper,
        P18: ValueClassWrapper,
        P19: ValueClassWrapper
    ](f: (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17, P18, P19) => T): ScalaOngoingStubbing[T] =
      os thenAnswer f

    def apply[
        P0: ValueClassWrapper,
        P1: ValueClassWrapper,
        P2: ValueClassWrapper,
        P3: ValueClassWrapper,
        P4: ValueClassWrapper,
        P5: ValueClassWrapper,
        P6: ValueClassWrapper,
        P7: ValueClassWrapper,
        P8: ValueClassWrapper,
        P9: ValueClassWrapper,
        P10: ValueClassWrapper,
        P11: ValueClassWrapper,
        P12: ValueClassWrapper,
        P13: ValueClassWrapper,
        P14: ValueClassWrapper,
        P15: ValueClassWrapper,
        P16: ValueClassWrapper,
        P17: ValueClassWrapper,
        P18: ValueClassWrapper,
        P19: ValueClassWrapper,
        P20: ValueClassWrapper
    ](f: (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17, P18, P19, P20) => T): ScalaOngoingStubbing[T] =
      os thenAnswer f

    def apply[
        P0: ValueClassWrapper,
        P1: ValueClassWrapper,
        P2: ValueClassWrapper,
        P3: ValueClassWrapper,
        P4: ValueClassWrapper,
        P5: ValueClassWrapper,
        P6: ValueClassWrapper,
        P7: ValueClassWrapper,
        P8: ValueClassWrapper,
        P9: ValueClassWrapper,
        P10: ValueClassWrapper,
        P11: ValueClassWrapper,
        P12: ValueClassWrapper,
        P13: ValueClassWrapper,
        P14: ValueClassWrapper,
        P15: ValueClassWrapper,
        P16: ValueClassWrapper,
        P17: ValueClassWrapper,
        P18: ValueClassWrapper,
        P19: ValueClassWrapper,
        P20: ValueClassWrapper,
        P21: ValueClassWrapper
    ](f: (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17, P18, P19, P20, P21) => T): ScalaOngoingStubbing[T] =
      os thenAnswer f

//      (2 to 22).foreach { fn =>
//        val args = 0 until fn
//        print(s"""
//                 |def apply[${args.map(a => s"P$a: ValueClassWrapper").mkString(",")}](f: (${args.map(a => s"P$a").mkString(",")}) => T): ScalaOngoingStubbing[T] =
//                 |    os thenAnswer f
//                 |""".stripMargin)
//      }
  }

  private val ShouldAnswerOptions            = Set("shouldAnswer", "mustAnswer", "answers")
  private val FunctionalShouldAnswerOptions  = ShouldAnswerOptions.map(_ + "F")
  private val FunctionalShouldAnswerOptions2 = ShouldAnswerOptions.map(_ + "FG")
  def shouldAnswer[T: c.WeakTypeTag](c: blackbox.Context): c.Tree = {
    import c.universe._

    val r = c.macroApplication match {
      case q"$_.StubbingOps[$t]($invocation).$m" if ShouldAnswerOptions.contains(m.toString) =>
        q"new _root_.org.mockito.WhenMacro.AnswerActions(_root_.org.mockito.Mockito.when[$t](${transformInvocation(c)(invocation)}))"

      case q"$_.$cls[..$_]($invocation).$m" if cls.toString.startsWith("StubbingOps") && FunctionalShouldAnswerOptions.contains(m.toString) =>
        q"new _root_.org.mockito.${packageName(c)(cls)}.${className(c)(cls, "IdiomaticMockito")}.AnswerActions(_root_.org.mockito.Mockito.when(${transformInvocation(c)(invocation)}))"

      case q"$_.$cls[..$_]($invocation).$m" if cls.toString.startsWith("StubbingOps2") && FunctionalShouldAnswerOptions2.contains(m.toString) =>
        q"new _root_.org.mockito.${packageName(c)(cls)}.${className(c)(cls, "IdiomaticMockito")}.AnswerActions2(_root_.org.mockito.Mockito.when(${transformInvocation(c)(invocation)}))"

      case o => throw new Exception(s"Couldn't recognize ${show(o)}")
    }
    debugResult(c)("mockito-print-when")(r)
    r
  }

  class AnswerPFActions[T](os: ScalaFirstStubbing[T]) {
    def apply(pf: PartialFunction[Any, T]): ScalaOngoingStubbing[T] = os thenAnswer pf
  }

  private val ShouldAnswerPFOptions = Set("shouldAnswerPF", "mustAnswerPF", "answersPF")
  def shouldAnswerPF[T: c.WeakTypeTag](c: blackbox.Context): c.Tree = {
    import c.universe._

    val r = c.macroApplication match {
      case q"$_.StubbingOps[$t]($invocation).$m" if ShouldAnswerPFOptions.contains(m.toString) =>
        q"new _root_.org.mockito.WhenMacro.AnswerPFActions(_root_.org.mockito.Mockito.when[$t](${transformInvocation(c)(invocation)}))"

      case o => throw new Exception(s"Couldn't recognize ${show(o)}")
    }
    debugResult(c)("mockito-print-when")(r)
    r
  }
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy