Merge pull request #179 from mockito/issue/175

Add syntax for `doNothing`

Author: ultrasecreth

README.md

@@ -323,6 +323,8 @@ doAnswer(_ => "mocked!").when(aMock).bar                        <=> "mocked!" wi
 doAnswer(_.getArgument[Int](0) * 10).when(aMock).bar(any)       <=> ((i: Int) => i * 10) willBe answered by aMock.bar(*)
 doCallRealMethod.when(aMock).bar                                <=> theRealMethod willBe called by aMock.bar
 doThrow(new IllegalArgumentException).when(aMock).bar           <=> new IllegalArgumentException willBe thrown by aMock.bar
+
+doNothing().when(aMock).bar                                     <=> aMock.bar.doesNothing()
 
 verifyZeroInteractions(aMock)                                   <=> aMock wasNever called
 verify(aMock).bar                                               <=> aMock.bar was called

core/src/main/scala-2.11/org/mockito/matchers/EqMatchers_VersionSpecific.scala

@@ -1,7 +1,6 @@
 package org.mockito.matchers
 
 trait EqMatchers_VersionSpecific {
-
   /**
    * Creates a matcher that delegates on {{org.scalactic.Equality}} so you can always customise how the values are compared
    * Also works with value classes
@@ -14,5 +13,4 @@ trait EqMatchers_VersionSpecific {
    */
   @deprecated("Use 'eqTo' instead", since = "1.0.2")
   def eqToVal[T](value: T): T = macro MacroMatchers_211.eqToValMatcher[T]
-
 }

core/src/main/scala-2.12/org/mockito/matchers/EqMatchers_VersionSpecific.scala

@@ -5,7 +5,6 @@ import org.mockito.{ ArgumentMatchers => JavaMatchers }
 import org.scalactic.{ Equality, Prettifier }
 
 trait EqMatchers_VersionSpecific {
-
   /**
    * Creates a matcher that delegates on {{org.scalactic.Equality}} so you can always customise how the values are compared
    * Also works with value classes

core/src/main/scala/org/mockito/IdiomaticMockitoBase.scala

@@ -112,6 +112,10 @@ trait IdiomaticMockitoBase extends MockitoEnhancer with ScalacticSerialisableHac
 
     //noinspection AccessorLikeMethodIsUnit
     def isLenient(): Unit = macro WhenMacro.isLenient[T]
+
+    def shouldDoNothing(): Unit = macro DoSomethingMacro.doesNothing
+    def mustDoNothing(): Unit = macro DoSomethingMacro.doesNothing
+    def doesNothing(): Unit = macro DoSomethingMacro.doesNothing
   }
 
   implicit class VerifyingOps[T](stubbing: T) {

macro/src/main/scala-2.11/org.mockito.matchers/MacroMatchers_211.scala

@@ -7,7 +7,6 @@ import org.scalactic.{ Equality, Prettifier }
 import scala.reflect.macros.blackbox
 
 object MacroMatchers_211 {
-
   def eqTo[T: Equality: ValueClassExtractor](value: T)(implicit $pt: Prettifier): T = {
     JavaMatchers.argThat(new EqTo[T](value))
     value

macro/src/main/scala/org/mockito/DoSomethingMacro.scala

@@ -5,6 +5,23 @@ import org.mockito.Utils._
 import scala.reflect.macros.blackbox
 
 object DoSomethingMacro {
+  def doesNothing(c: blackbox.Context)(): c.Tree = {
+    import c.universe._
+
+    val r = c.macroApplication match {
+      case q"$_.StubbingOps[$_]($invocation).shouldDoNothing()" =>
+        transformInvocation(c)(invocation, q"_root_.org.mockito.MockitoSugar.doNothing")
+      case q"$_.StubbingOps[$_]($invocation).mustDoNothing()" =>
+        transformInvocation(c)(invocation, q"_root_.org.mockito.MockitoSugar.doNothing")
+      case q"$_.StubbingOps[$_]($invocation).doesNothing()" =>
+        transformInvocation(c)(invocation, q"_root_.org.mockito.MockitoSugar.doNothing")
+
+      case o => throw new Exception(s"Couldn't recognize '${show(o)}'")
+    }
+    if (c.settings.contains("mockito-print-when")) println(show(r))
+    r
+  }
+
   def returnedBy[T: c.WeakTypeTag, S](c: blackbox.Context)(stubbing: c.Expr[T])($ev: c.Expr[S]): c.Expr[S] = {
     import c.universe._
 

scalatest/src/test/scala-2.11/user/org/mockito/MockitoSugarTest_211.scala

@@ -4,7 +4,6 @@ import org.mockito.{ ArgumentMatchersSugar, MockitoSugar }
 import org.scalatest.{ Matchers, WordSpec }
 
 class MockitoSugarTest_211 extends WordSpec with MockitoSugar with Matchers with ArgumentMatchersSugar {
-
   trait Baz {
     def traitMethod(defaultArg: Int = 30, anotherDefault: String = "hola"): Int = ???
   }

scalatest/src/test/scala-2.11/user/org/mockito/stubbing/ReturnsEmptyValuesTest.scala

@@ -12,7 +12,6 @@ import scala.concurrent.Future
 import scala.util.{ Success, Try }
 
 class ReturnsEmptyValuesTest extends WordSpec with Matchers with IdiomaticMockito with TryValues with OptionValues with ScalaFutures {
-
   class KnownTypes {
     def returnsOption: Option[String]           = Some("not mocked!")
     def returnsList: List[String]               = List("not mocked!")

scalatest/src/test/scala-2.12/user/org/mockito/IdiomaticMockitoTest_212.scala

@@ -9,15 +9,13 @@ import scala.concurrent.ExecutionContext.Implicits.global
 import scala.concurrent.Future
 
 class IdiomaticMockitoTest_212 extends WordSpec with Matchers with IdiomaticMockito with ArgumentMatchersSugar with ScalaFutures {
-
   class Foo {
     def valueClass(n: Int, v: ValueClass): String = ???
 
     def valueCaseClass(n: Int, v: ValueCaseClassInt): String = ???
   }
 
   "value class matchers" should {
-
     "eqTo macro works with new syntax" in {
       val aMock = mock[Foo]
 

scalatest/src/test/scala-2.12/user/org/mockito/MockitoSugarTest_212.scala

@@ -10,7 +10,6 @@ import scala.concurrent.Future
 
 //noinspection RedundantDefaultArgument
 class MockitoSugarTest_212 extends WordSpec with MockitoSugar with Matchers with ArgumentMatchersSugar with TableDrivenPropertyChecks with ScalaFutures {
-
   val scenarios = Table(
     ("testDouble", "foo", "baz"),
     ("mock", () => mock[Foo], () => mock[Baz]),
@@ -19,7 +18,6 @@ class MockitoSugarTest_212 extends WordSpec with MockitoSugar with Matchers with
 
   forAll(scenarios) { (testDouble, foo, baz) =>
     testDouble should {
-
       "work with default arguments in traits" in {
         val testDouble = baz()
 

scalatest/src/test/scala-2.12/user/org/mockito/scalatest/AsyncIdiomaticMockitoTest_212.scala

@@ -6,7 +6,6 @@ import org.scalatest.{ AsyncWordSpec, Matchers }
 import scala.concurrent.Future
 
 class AsyncIdiomaticMockitoTest_212 extends AsyncWordSpec with Matchers with AsyncIdiomaticMockito {
-
   "AsyncMockito" should {
     "work with specialised methods" in {
       val mockFunction = mock[() => Int]

scalatest/src/test/scala-2.12/user/org/mockito/stubbing/ReturnsEmptyValuesTest.scala

@@ -12,7 +12,6 @@ import scala.concurrent.Future
 import scala.util.{ Success, Try }
 
 class ReturnsEmptyValuesTest extends WordSpec with Matchers with IdiomaticMockito with TryValues with OptionValues with ScalaFutures {
-
   class KnownTypes {
     def returnsOption: Option[String]           = Some("not mocked!")
     def returnsList: List[String]               = List("not mocked!")

scalatest/src/test/scala/user/org/mockito/IdiomaticMockitoTest.scala

@@ -908,6 +908,14 @@ class IdiomaticMockitoTest extends AnyWordSpec with Matchers with IdiomaticMocki
   }
 
   "mock" should {
+    "stub a no op call" in {
+      val org = mock[Org]
+
+      org.unit().doesNothing()
+
+      org.unit() shouldBe ()
+    }
+
     "stub a real call" in {
       val org: Org = mock[Org].bar shouldCall realMethod
       org.bar shouldBe "not mocked"

scalatest/src/test/scala/user/org/mockito/MockitoScalaSessionTest.scala

@@ -42,6 +42,8 @@ class MockitoScalaSessionTest extends AnyWordSpec with IdiomaticMockito with Mat
     def userClassFinal: BarFinal = new BarFinal
 
     def finalFinalEqualsAndHashcode: FinalEqualsAndHashcode = ???
+
+    def unit(): Unit = ()
   }
 
   class Bar {
@@ -108,6 +110,14 @@ class MockitoScalaSessionTest extends AnyWordSpec with IdiomaticMockito with Mat
             aFoo.bar(*) returns "mocked"
           }
         }
+
+        an[UnnecessaryStubbingException] should be thrownBy {
+          MockitoScalaSession().run {
+            val aFoo = foo()
+
+            aFoo.unit().doesNothing()
+          }
+        }
       }
 
       "check incorrect stubs" in {
@@ -139,15 +149,21 @@ class MockitoScalaSessionTest extends AnyWordSpec with IdiomaticMockito with Mat
       }
 
       "check unexpected invocations" in {
-        val thrown = the[UnexpectedInvocationException] thrownBy {
+        (the[UnexpectedInvocationException] thrownBy {
           MockitoScalaSession().run {
             val aFoo = foo()
 
             aFoo.bar("pepe")
           }
-        }
+        }).getMessage should startWith("Unexpected invocations found")
 
-        thrown.getMessage should startWith("Unexpected invocations found")
+        (the[UnexpectedInvocationException] thrownBy {
+          MockitoScalaSession().run {
+            val aFoo = foo()
+
+            aFoo.unit()
+          }
+        }).getMessage should startWith("Unexpected invocations found")
       }
 
       "not check unexpected invocations if the call was verified" in {

scalatest/src/test/scala/user/org/mockito/TestModel.scala

@@ -113,6 +113,8 @@ class Org {
   def option(a: String, b: Int): Option[String] = None
 
   def printTaggedValue(value: TaggedValue[String]): String = "not mocked"
+
+  def unit(): Unit = ???
 }
 
 case class Baz2(param1: Int, param2: String)

version.properties

@@ -1,4 +1,4 @@
 #Version of the produced binaries. This file is intended to be checked-in.
 #It will be automatically bumped by release automation.
-version=1.9.1
+version=1.10.0
 previousVersion=1.9.0