com.avaje.ebean

Class MockiEbean

java.lang.Object

com.avaje.ebean.MockiEbean

public class MockiEbean
extends Object

This is a test helper class that can be used to swap out the default EbeanServer in the Ebean singleton with a mock implementation.

This enables a developer to write a test using a tool like Mockito to mock the EbeanServer interface and make this the default server of the Ebean singleton.

 EbeanServer mock = ...; // create a mock or test double etc

 MockiEbean.runWithMock(mock, new Runnable() {

   public void run() {
     ...
     // test code in here runs with mock EbeanServer
   }
 });

An example using Mockito to mock the getBeanId() method on EbeanServer.

@Test
public void testWithMockito() {

  EbeanServer defaultServer = Ebean.getServer(null);
  assertTrue("is a real EbeanServer", defaultServer instanceof DefaultServer);

  Long magicBeanId = Long.valueOf(47L);

  EbeanServer mock = Mockito.mock(EbeanServer.class);
  when(mock.getBeanId(null)).thenReturn(magicBeanId);

  MockiEbean mockiEbean = MockiEbean.start(mock);
  try {

    // So using the Ebean singleton returns the mock instance
    EbeanServer server = Ebean.getServer(null);
    Object beanId = server.getBeanId(null);

    assertEquals(magicBeanId, beanId);

  } finally {
    mockiEbean.restoreOriginal();
  }

  EbeanServer restoredServer = Ebean.getServer(null);
  assertTrue("is a real EbeanServer", restoredServer instanceof DefaultServer);
}

Method Summary

Modifier and Type	Method and Description
void	afterRun() Typically only used internally.
void	beforeRun() Typically only used internally.
com.avaje.ebean.EbeanServer	getMock() Return the mock EbeanServer instance that was set as the default EbeanServer.
com.avaje.ebean.EbeanServer	getOriginal() Return the original EbeanServer implementation.
void	restoreOriginal() Restore the original EbeanServer implementation as the default EbeanServer.
<V> V	run(Callable<V> testCallable) Run the test callable restoring the original EbeanServer afterwards.
void	run(Runnable testRunnable) Run the test runnable restoring the original EbeanServer afterwards.
static <V> V	runWithMock(com.avaje.ebean.EbeanServer mock, Callable<V> test) Run the test runnable using the mock EbeanServer and restoring the original EbeanServer afterward.
static void	runWithMock(com.avaje.ebean.EbeanServer mock, Runnable test) Run the test runnable using the mock EbeanServer and restoring the original EbeanServer afterward.
static MockiEbean	start(com.avaje.ebean.EbeanServer mock) Set a mock implementation of EbeanServer as the default server.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

start

public static MockiEbean start(com.avaje.ebean.EbeanServer mock)

Set a mock implementation of EbeanServer as the default server.

Typically the mock instance passed in is created by Mockito or similar tool.

The default EbeanSever is the instance returned by Ebean.getServer(String) when the server name is null.

Parameters:

mock - the mock instance that becomes the default EbeanServer

Returns:

The MockiEbean with a restoreOriginal() method that can be used to restore the original EbeanServer implementation.

runWithMock

public static void runWithMock(com.avaje.ebean.EbeanServer mock,
                               Runnable test)

Run the test runnable using the mock EbeanServer and restoring the original EbeanServer afterward.

Parameters:

mock - the mock instance that becomes the default EbeanServer

test - typically some test code as a runnable

runWithMock

public static <V> V runWithMock(com.avaje.ebean.EbeanServer mock,
                                Callable<V> test)
                         throws Exception

Run the test runnable using the mock EbeanServer and restoring the original EbeanServer afterward.

Parameters:

mock - the mock instance that becomes the default EbeanServer

test - typically some test code as a callable

Throws:

Exception

getOriginal

public com.avaje.ebean.EbeanServer getOriginal()

Return the original EbeanServer implementation.

This is the implementation that is put back as the default EbeanServer when restoreOriginal() is called.

getMock

public com.avaje.ebean.EbeanServer getMock()

Return the mock EbeanServer instance that was set as the default EbeanServer.

run

public void run(Runnable testRunnable)

Run the test runnable restoring the original EbeanServer afterwards.

run

public <V> V run(Callable<V> testCallable)
          throws Exception

Run the test callable restoring the original EbeanServer afterwards.

Throws:

Exception

beforeRun

public void beforeRun()

Typically only used internally. Usually used to set static Finder test doubles.

afterRun

public void afterRun()

Typically only used internally. Usually used to restore static Finder original implementations.

restoreOriginal

public void restoreOriginal()

Restore the original EbeanServer implementation as the default EbeanServer.