{"id":801,"date":"2013-10-23T04:55:18","date_gmt":"2013-10-23T11:55:18","guid":{"rendered":"http:\/\/10kdev.net\/?p=801"},"modified":"2013-10-23T04:58:39","modified_gmt":"2013-10-23T11:58:39","slug":"a-decent-mockito-verify-example","status":"publish","type":"post","link":"http:\/\/10kdev.net\/?p=801","title":{"rendered":"A Decent Mockito.verify Example"},"content":{"rendered":"

I always get confused as to when it would be a good time to use verify. I also see verify thrown into tests for no reason at all, except maybe as a practice to remember the syntax. I had written a Spring validation class and a test, and since Errors is an interface<\/em> and is more easily used in tests as a mock (IMHO) I thought it a good spot to do a verify for the test instead of the usual assertsEquals or whatever.<\/p>\n

The rule is, for an object add, the objectId must be null or else I return a validation error.<\/p>\n

The calling Spring (3.2) controller method:<\/p>\n


\n@ApiOperation(value = “add new object”)<\/span><\/span><\/span><\/span><\/span><\/p>\n

@RequestMapping(method = RequestMethod.PUT<\/em>)<\/span><\/span><\/span><\/span><\/span><\/p>\n

public<\/strong>
\n@ResponseBody<\/span>
\n<\/span><\/span><\/span><\/p>\n

ObjectAdd add(@Valid
\n@RequestBody Object object) {<\/span>
\n<\/span><\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0return\u00a0<\/strong>objectService<\/span>.add(object);<\/span><\/span><\/span><\/span><\/p>\n

}<\/span><\/p>\n

Here’s my validation class. What it does is ensure there wasn’t an ID submitted to my PUT method \u2013 help the UI people out a little I know that get’s confusing. Also, if we make our rest API public this will help and . . it’s just good practice.<\/p>\n

The test we’ll write is on this class, to confirm it is checking for a null ID value. We’ll confirm that the Error object method either get’s called, or doesn’t, depending on if the ID is null or not (remember we are in ADD mode so we do not want an ID).<\/p>\n

@Component(“objectValidator”)<\/span>
\n<\/span><\/span><\/span><\/p>\n

public<\/strong>
\nclass<\/strong> ObjectValidator implements<\/strong> Validator {<\/span>
\n<\/span><\/span><\/span><\/span><\/span><\/p>\n


\n@Value(“${object.Id}”)<\/span><\/span><\/span><\/span><\/span><\/p>\n

private<\/strong> String idName;<\/span>
\n<\/span><\/span><\/span><\/span><\/p>\n


\n@Value(“${object.add.empty.id}”)<\/span><\/span><\/span><\/span><\/span><\/p>\n

private<\/strong> String idError;<\/span>
\n<\/span><\/span><\/span><\/span><\/p>\n


\n@SuppressWarnings(“rawtypes”)<\/span>
\n<\/span><\/span><\/span><\/span><\/p>\n


\n@Override<\/span><\/span><\/p>\n

public<\/strong>
\nboolean<\/strong> supports(Class clazz) {<\/span>
\n<\/span><\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0return<\/strong> Object.class<\/strong>.isAssignableFrom(clazz);<\/span>
\n<\/span><\/span><\/span><\/span><\/p>\n

}<\/span>
\n<\/span><\/p>\n


\n@Override<\/span>
\n<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0public<\/strong>
\nvoid<\/strong> validate(Object target, Errors errors) {<\/span>
\n<\/span><\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0Object object = (Object) target;<\/span>
\n<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0if<\/strong> (null<\/strong> != object.getObjectId()) {<\/span>
\n<\/span><\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 errors.rejectValue(idName, idError);<\/span>
\n<\/span><\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0}<\/span>
\n<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0}<\/span>
\n<\/span><\/p>\n

}<\/span><\/p>\n

Here’s the pojo, Jacksonfied because it comes in via a Controller and @Valid is used on the @Request:<\/p>\n

@JsonTypeInfo(use = JsonTypeInfo.Id.NAME<\/em>, include = JsonTypeInfo.As.WRAPPER_OBJECT<\/em><\/span>)<\/span>
\n<\/span><\/span><\/span><\/span><\/span><\/span><\/span><\/p>\n

@JsonTypeName(“object”)<\/span>
\n<\/span><\/span><\/span><\/p>\n

public<\/strong>
\nclass<\/strong> Object<\/span>
\n<\/span><\/span><\/span><\/p>\n

{<\/span>
\n<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0@JsonProperty<\/span>
\n<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0private<\/strong> Integer objectId;<\/span>
\n<\/span><\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0@JsonProperty<\/span>
\n<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0private<\/strong> String objectText;<\/span>
\n<\/span><\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0@JsonProperty<\/span>
\n<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0private<\/strong> Date createDate;
\n<\/span><\/span><\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0public<\/strong> Object()<\/span>
\n<\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0{<\/span>
\n<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/\/ no-arg<\/span> constructor for Jackson<\/span><\/span>
\n<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0}<\/span>
\n<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0public<\/strong> Integer getObjectId()<\/span>
\n<\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0{<\/span>
\n<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0return\u00a0<\/strong>objectId<\/span>;<\/span><\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0}<\/span>
\n<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0public<\/strong>
\nvoid<\/strong> setObjectId(Integer objectId)<\/span>
\n<\/span><\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0{<\/span>
\n<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0this<\/strong>.objectId = objectId;<\/span>
\n<\/span><\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0}<\/span>
\n<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0public<\/strong> String getObjectText()<\/span>
\n<\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0{<\/span>
\n<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0return<\/strong> objectText;<\/span>
\n<\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0}<\/span>
\n<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0public\u00a0<\/strong>void<\/strong> setObjectText (String objectText)<\/span><\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0{<\/span>
\n<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0this<\/strong>.objectText = objectText;<\/span>
\n<\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0}<\/span>
\n<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0public<\/strong> Date getCreateDate()<\/span>
\n<\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0{<\/span>
\n<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0return\u00a0<\/strong>createDate<\/span>;<\/span><\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0}<\/span>
\n<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0public\u00a0<\/strong>void<\/strong> setCreateDate(Date createDate)<\/span><\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0{<\/span>
\n<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0this<\/strong>.createDate = createDate;<\/span>
\n<\/span><\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0}
\n<\/span><\/p>\n

}<\/span><\/p>\n

And here’s my unit test with verification:<\/p>\n

public<\/strong>
\nclass<\/strong> ObjectValidatorTest {<\/span>
\n<\/span><\/span><\/span><\/p>\n


\n@InjectMocks<\/span><\/span><\/p>\n

private<\/strong> ObjectValidator objectValidator = new<\/strong> ObjectValidator();<\/span><\/span><\/span><\/span><\/span><\/span><\/span><\/p>\n

@Mock<\/span><\/span><\/p>\n

private<\/strong> Errors mockErrors;<\/span>
\n<\/span><\/span><\/span><\/span><\/p>\n


\n@Before<\/span><\/span><\/p>\n

public<\/strong>
\nvoid<\/strong> setUp() throws<\/strong> Exception {<\/span>
\n<\/span><\/span><\/span><\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0MockitoAnnotations.initMocks<\/em>(this<\/strong>);<\/span>
\n<\/span><\/span><\/p>\n

}<\/span>
\n<\/span><\/p>\n


\n@After<\/span><\/span><\/span><\/p>\n

public<\/strong>
\nvoid<\/strong> tearDown() throws<\/strong> Exception {<\/span>
\n<\/span><\/span><\/span><\/span><\/span><\/span><\/p>\n

}<\/span>
\n<\/span><\/p>\n


\n@Test<\/span><\/span><\/p>\n

public<\/strong>
\nvoid<\/strong> testValidate() {<\/span>
\n<\/span><\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0Object object = new<\/strong> Object();<\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0object.setObjectId(null<\/strong>);<\/span>
\n<\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0objectValidator.validate(object, mockErrors);<\/span>
\n<\/span><\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0verify<\/em>(mockErrors, times<\/em>(0)).rejectValue(anyString<\/em>(),anyString<\/em>());<\/span>
\n<\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0<\/span>
\n<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0object.setObjectId(44); <\/span>
\n<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0objectValidator.validate(object, mockErrors);<\/span>
\n<\/span><\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0verify<\/em>(mockErrors, times<\/em>(1)).rejectValue(anyString<\/em>(),anyString<\/em>());<\/span>
\n<\/span><\/span><\/p>\n

}<\/span>
\n<\/span><\/p>\n


\n@Test<\/span><\/span><\/p>\n

public<\/strong>
\nvoid<\/strong> testSupports() {<\/span>
\n<\/span><\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0assertTrue<\/em>(objectValidator.supports(Object.class<\/strong>));<\/span>
\n<\/span><\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0assertFalse<\/em>(objectValidator<\/span>.supports(String.class<\/strong>));<\/span>
\n<\/span><\/span><\/p>\n

}<\/span>
\n<\/span><\/p>\n


\n<\/span><\/p>\n

I think this makes a lot of sense. We aren’t testing Errors itself, just if our validation methods logic calls Errors or ignores it in the correct situations.
\n<\/span><\/p>\n

One thing to force ourselves to really think about when writing mock tests is “what are we really testing.” A lot of times I get errors, forgetting “ah, yeah even that service had to be mocked.” Verification can help us test our class that has a mock component.<\/span><\/p>\n","protected":false},"excerpt":{"rendered":"

I always get confused as to when it would be a good time to use verify. I also see verify thrown into tests for no reason at all, except maybe as a practice to remember the syntax. I had written a Spring validation class and a test, and since Errors is an interface and is […]<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[1],"tags":[],"_links":{"self":[{"href":"http:\/\/10kdev.net\/index.php?rest_route=\/wp\/v2\/posts\/801"}],"collection":[{"href":"http:\/\/10kdev.net\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/10kdev.net\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/10kdev.net\/index.php?rest_route=\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"http:\/\/10kdev.net\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=801"}],"version-history":[{"count":4,"href":"http:\/\/10kdev.net\/index.php?rest_route=\/wp\/v2\/posts\/801\/revisions"}],"predecessor-version":[{"id":805,"href":"http:\/\/10kdev.net\/index.php?rest_route=\/wp\/v2\/posts\/801\/revisions\/805"}],"wp:attachment":[{"href":"http:\/\/10kdev.net\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=801"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/10kdev.net\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=801"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/10kdev.net\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=801"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}