Disclaimer: This is not an official Google product.
Acai makes it easy to write functional tests of your application with JUnit4 and Guice.
Acai makes it simple to:
- Inject the helper classes you need into tests
- Start any services needed by your tests
- Run between-test cleanup of these services
- Start up multiple services for testing in the right order
Acai is designed for large functional tests of your application. For example it can help with writing tests which start your backend and frontend server in a self-contained mode with their dependencies faked out and then validates some key user scenarios with Webdriver to give you confidence your complete system works correctly. It can also be useful for tests which validate the integration of a small set of components. Note however that for smaller unit-tests we generally recommend you create the class under test manually rather than using Acai.
The simplest test using Acai doesn't register any TestingService bindings at all, it just uses Acai to inject a test with a module:
@RunWith(JUnit4.class)
public class SimpleTest {
@Rule public Acai acai = new Acai(MyTestModule.class);
@Inject private MyClass foo;
@Test
public void checkSomethingWorks() {
// Use the injected value of foo here
}
private static class MyTestModule extends AbstractModule {
@Override protected void configure() {
bind(MyClass.class).to(MyClassImpl.class);
}
}
}
The real power of Acai comes when your production server is configured with Guice and you create an alternate test module which configures your server with heavyweight dependencies like databases replaced with local in-memory implementations. You could then start this server once for all tests in the suite (to avoid waiting for it to start between each test) and wipe the database between tests (to cheaply isolate test-cases from one-another).
The following example shows how this pattern would be used in tests:
@RunWith(JUnit4.class)
public class ExampleFunctionalTest {
@Rule public Acai acai = new Acai(MyTestModule.class);
@Inject private MyServerClient serverClient;
@Test
public void checkSomethingWorks() {
// Call the running server and test some behaviour here.
// Any state will be cleared by MyFakeDatabaseWiper after each
// test case.
}
private static class MyTestModule extends AbstractModule {
@Override protected void configure() {
// Normal Guice modules which configure your
// server with in-memory versions of backends.
install(MyServerModule());
install(MyFakeDatabaseModule());
install(new TestingServiceModule() {
@Override protected void configureTestingServices() {
bindTestingService(MyServerRunner.class);
bindTestingService(MyFakeDatabaseWiper.class);
}
});
}
}
private static class MyServerRunner implements TestingService {
@Inject private MyServer myServer;
@BeforeSuite public void startServer() {
myServer.start().awaitStarted();
}
}
private static class MyFakeDatabaseWiper implements TestingService {
@Inject private MyFakeDatabse myFakeDatabase;
@AfterTest public void wipeDatabase() {
myFakeDatabase.wipe();
}
}
}
Note that when a module is passed to Acai in a rule any @BeforeSuite methods are only executed once per suite even if the same module is used in multiple Acai rules in multiple different test classes within that suite. This allows tests of the server to be structured into test classes according to the functionality being tested.
If the services you need to start for tests must be started in a specific order
you can express this using the @DependsOn
annotation.
For example:
@RunWith(JUnit4.class)
public class ExampleFrontendWebdriverTest {
@Rule public Acai acai = new Acai(MyTestModule.class);
@Inject private SomeFrontendFeaturePageObject featurePage;
@Test
public void checkSomethingWorks() {
// Test the frontend client using the webdriver page
// object here.
}
private static class MyTestModule extends AbstractModule {
@Override protected void configure() {
// Normal Guice modules which configure your
// server with in-memory versions of servers and
// a test module configuring a webdriver client.
install(MyServerModule());
install(MyFakeDatabaseModule());
install(WebDriverModule());
install(new TestingServiceModule() {
@Override protected void configureTestingServices() {
bindTestingService(MyServerRunner.class);
bindTestingService(MyBackendRunner.class);
}
});
}
}
@DependsOn(MyBackendRunner.class)
private static class MyFrontendRunner implements TestingService {
@Inject private MyFrontendServer myFrontendServer;
@BeforeSuite public void startServer() {
myFrontendServer.start().awaitStarted();
}
}
private static class MyBackendRunner implements TestingService {
@Inject private MyBackendServer myBackendServer;
@BeforeSuite public void startServer() {
myBackendServer.start().awaitStarted();
}
}
}
In the above example MyFrontendRunner
is annotated
@DependsOn(MyBackendRunner.class)
which will cause Acai to start the
backend server before starting the frontend.
As shown in the above examples Acai has a very small API surface.
Firstly, and most importantly, there is the Acai
rule class itself
which is used as a JUnit4 @Rule
and is passed a module class to be used to
configure the test.
The module class passed to the Acai
constructor may optionally use
TestingServiceModule
to bind one or more TestingService
implementations.
The TestingService
interface is purely a marker to allow Acai to know
which classes provide testing services. To actually do anything implementations
of this interface should add zero argument methods annotated with one of
@BeforeSuite
, @BeforeTest
or @AfterTest
. These methods will be run before
the suite, before each test or after each test respectively. You may add as
many methods annotated with these annotations as you wish to a
TestingService
; Acai will find and run them all when appropriate.
Finally a TestingService
implementation can be annotated @DependsOn
to
signal its @BeforeSuite
and @BeforeTest
methods need to be run after
those of another TestingService
. This provides a simple declarative mechanism
to order service startup in tests.
Refer to the examples above to see the API in action.