org.mockito.BDDMockito Maven / Gradle / Ivy
/*
* Copyright (c) 2007 Mockito contributors
* This program is made available under the terms of the MIT License.
*/
package org.mockito;
import org.mockito.stubbing.Answer;
import org.mockito.stubbing.OngoingStubbing;
import org.mockito.stubbing.Stubber;
/**
* Behavior Driven Development style of writing tests uses //given //when //then comments as fundamental parts of your test methods.
* This is exactly how we write our tests and we warmly encourage you to do so!
*
* Start learning about BDD here: http://en.wikipedia.org/wiki/Behavior_Driven_Development
*
* The problem is that current stubbing api with canonical role of when word does not integrate nicely with //given //when //then comments.
* It's because stubbing belongs to given component of the test and not to the when component of the test.
* Hence {@link BDDMockito} class introduces an alias so that you stub method calls with {@link BDDMockito#given(Object)} method.
* Now it really nicely integrates with the given component of a BDD style test!
*
* Here is how the test might look like:
*
* import static org.mockito.BDDMockito.*;
*
* Seller seller = mock(Seller.class);
* Shop shop = new Shop(seller);
*
* public void shouldBuyBread() throws Exception {
* //given
* given(seller.askForBread()).willReturn(new Bread());
*
* //when
* Goods goods = shop.buyBread();
*
* //then
* assertThat(goods, containBread());
* }
*
*
* Stubbing voids with throwables:
*
* //given
* willThrow(new RuntimeException("boo")).given(mock).foo();
*
* //when
* Result result = systemUnderTest.perform();
*
* //then
* assertEquals(failure, result);
*
*
* One of the purposes of BDDMockito is also to show how to tailor the mocking syntax to a different programming style.
*/
@SuppressWarnings("unchecked")
public class BDDMockito extends Mockito {
/**
* See original {@link OngoingStubbing}
*/
public static interface BDDMyOngoingStubbing {
/**
* See original {@link OngoingStubbing#thenAnswer(Answer)}
*/
BDDMyOngoingStubbing willAnswer(Answer answer);
/**
* See original {@link OngoingStubbing#thenReturn(Object)}
*/
BDDMyOngoingStubbing willReturn(T value);
/**
* See original {@link OngoingStubbing#thenReturn(Object, Object...)}
*/
BDDMyOngoingStubbing willReturn(T value, T... values);
/**
* See original {@link OngoingStubbing#thenThrow(Throwable...)}
*/
BDDMyOngoingStubbing willThrow(Throwable... throwables);
/**
* See original {@link OngoingStubbing#thenCallRealMethod()}
*/
BDDMyOngoingStubbing willCallRealMethod();
}
public static class BDDOngoingStubbingImpl implements BDDMyOngoingStubbing {
private final OngoingStubbing mockitoOngoingStubbing;
public BDDOngoingStubbingImpl(OngoingStubbing ongoingStubbing) {
this.mockitoOngoingStubbing = ongoingStubbing;
}
/* (non-Javadoc)
* @see org.mockitousage.customization.BDDMockito.BDDMyOngoingStubbing#willAnswer(org.mockito.stubbing.Answer)
*/
public BDDMyOngoingStubbing willAnswer(Answer answer) {
return new BDDOngoingStubbingImpl(mockitoOngoingStubbing.thenAnswer(answer));
}
/* (non-Javadoc)
* @see org.mockitousage.customization.BDDMockito.BDDMyOngoingStubbing#willReturn(java.lang.Object)
*/
public BDDMyOngoingStubbing willReturn(T value) {
return new BDDOngoingStubbingImpl(mockitoOngoingStubbing.thenReturn(value));
}
/* (non-Javadoc)
* @see org.mockitousage.customization.BDDMockito.BDDMyOngoingStubbing#willReturn(java.lang.Object, T[])
*/
public BDDMyOngoingStubbing willReturn(T value, T... values) {
return new BDDOngoingStubbingImpl(mockitoOngoingStubbing.thenReturn(value, values));
}
/* (non-Javadoc)
* @see org.mockitousage.customization.BDDMockito.BDDMyOngoingStubbing#willThrow(java.lang.Throwable[])
*/
public BDDMyOngoingStubbing willThrow(Throwable... throwables) {
return new BDDOngoingStubbingImpl(mockitoOngoingStubbing.thenThrow(throwables));
}
public BDDMyOngoingStubbing willCallRealMethod() {
return new BDDOngoingStubbingImpl(mockitoOngoingStubbing.thenCallRealMethod());
}
}
/**
* see original {@link Mockito#when(Object)}
*/
public static BDDMyOngoingStubbing given(T methodCall) {
return new BDDOngoingStubbingImpl(Mockito.when(methodCall));
}
/**
* See original {@link Stubber}
*/
public static interface BDDStubber {
/**
* See original {@link Stubber#doAnswer(Answer)}
*/
BDDStubber willAnswer(Answer answer);
/**
* See original {@link Stubber#doNothing()}
*/
BDDStubber willNothing();
/**
* See original {@link Stubber#doReturn(Object)}
*/
BDDStubber willReturn(Object toBeReturned);
/**
* See original {@link Stubber#doThrow(Throwable)}
*/
BDDStubber willThrow(Throwable toBeThrown);
/**
* See original {@link Stubber#when(Object)}
*/
T given(T mock);
}
public static class BDDStubberImpl implements BDDStubber {
private final Stubber mockitoStubber;
public BDDStubberImpl(Stubber mockitoStubber) {
this.mockitoStubber = mockitoStubber;
}
/* (non-Javadoc)
* @see org.mockitousage.customization.BDDMockito.BDDStubber#given(java.lang.Object)
*/
public T given(T mock) {
return mockitoStubber.when(mock);
}
/* (non-Javadoc)
* @see org.mockitousage.customization.BDDMockito.BDDStubber#willAnswer(org.mockito.stubbing.Answer)
*/
public BDDStubber willAnswer(Answer answer) {
return new BDDStubberImpl(mockitoStubber.doAnswer(answer));
}
/* (non-Javadoc)
* @see org.mockitousage.customization.BDDMockito.BDDStubber#willNothing()
*/
public BDDStubber willNothing() {
return new BDDStubberImpl(mockitoStubber.doNothing());
}
/* (non-Javadoc)
* @see org.mockitousage.customization.BDDMockito.BDDStubber#willReturn(java.lang.Object)
*/
public BDDStubber willReturn(Object toBeReturned) {
return new BDDStubberImpl(mockitoStubber.doReturn(toBeReturned));
}
/* (non-Javadoc)
* @see org.mockitousage.customization.BDDMockito.BDDStubber#willThrow(java.lang.Throwable)
*/
public BDDStubber willThrow(Throwable toBeThrown) {
return new BDDStubberImpl(mockitoStubber.doThrow(toBeThrown));
}
}
/**
* see original {@link Mockito#doThrow(Throwable)}
*/
public static BDDStubber willThrow(Throwable toBeThrown) {
return new BDDStubberImpl(Mockito.doThrow(toBeThrown));
}
/**
* see original {@link Mockito#doAnswer(Answer)}
*/
public static BDDStubber willAnswer(Answer answer) {
return new BDDStubberImpl(Mockito.doAnswer(answer));
}
/**
* see original {@link Mockito#doNothing()}
*/
public static BDDStubber willDoNothing() {
return new BDDStubberImpl(Mockito.doNothing());
}
/**
* see original {@link Mockito#doReturn(Object)}
*/
public static BDDStubber willReturn(Object toBeReturned) {
return new BDDStubberImpl(Mockito.doReturn(toBeReturned));
}
/**
* see original {@link Mockito#doCallRealMethod()}
*/
public static BDDStubber willCallRealMethod() {
return new BDDStubberImpl(Mockito.doCallRealMethod());
}
}