The Candybean project started while acknowledging that many engineers have developed their own automation frameworks from scratch, and because automation is often designed to support software testing, these frameworks have very similar structure and functionality. That said, some frameworks have better features than others. Candybean's goal is to gather these best-in-class features, approach automation abstractly, and provide a baseline test-specific automation framework. In doing so, we aim to establish an open-source, collaborative project that can become an industry standard on which to iterate further.

For an explicit listing of Candybean goals and features, see the Features section below.

There are two audiences this documentation is meant to support: users and contributors (developers).
Both audiences can learn more about how to use the project by reading further, but project contributors can additionally benefit from visiting the Developers documentation.

See our wiki, FAQ or Quickstart sections for quick high-level information and installation.


Some project features planned for Candybean:


Candybean is a collection of components that fosters test automation. Below is a list of those components:


Writing automated tests with Candybean is as quick as these handful of steps:

Installation prerequisites

Once Maven is installed, it will detect and automatically install further Candybean prerequisites.

If not already familiar, review the basics of Maven to better understand dependency management and execution:


Candybean's git repo includes a git submodule at '/config' referencing SugarCRM's private repo. Out of the box, Candybean will look for its configuration file in this directory, which should either be explicitly defined or overridden via command line or system variable.

The following key-value keys should be defined in a configuration file used to instantiate Candybean. By default, Candybean will look for a candybean.config file located in the 'config' directory, but a path can also be specified from the command line or a system variable 'candybean_config'.

# specifies the type of automation interface
automation.interface = chrome # chrome | firefox | ie | opera | android | ios  

# browser specific profiles and driver paths
browser.firefox.binary = {\
    "linux": "/path/to/firefox/binary/in/linux", \
    "mac": "/path/to/firefox/binary/on/mac", \
    "windows": "c:/path/to/firefox/binary/in/windows"}
browser.firefox.profile = default = {\
    "linux": "/path/to/chrome/driver/in/linux", \
    "mac": "/path/to/chrome/driver/on/mac", \
    "windows": "/path/to/chrome/driver/in/windows"} = /path/to/chromedriver/log = /path/to/ie/driver = /page/load/in/seconds
perf.implicit.wait.seconds = /passive/wait/in/seconds

# logger configuration
handlers = java.util.logging.FileHandler, java.util.logging.ConsoleHandler

# file logging
java.util.logging.FileHandler.limit = 50000
java.util.logging.FileHandler.count = 1
java.util.logging.FileHandler.formatter = java.util.logging.SimpleFormatter
java.util.logging.FileHandler.level = INFO

# logging format
java.util.logging.SimpleFormatter.format = [%1$tm-%1$td-%1$tY %1$tk:%1$tM:%1$tS:%1$tL] %2$s %4$s: %5$s %6$s %n

# Monte Media Library Recorder Settings

Optionally, a candybean configuration file can be generated using the built-in configuration server. To start the server, simply run "mvn -Pconfigure compile", and you may access the web-based configuration interface at http://localhost:8080/cfg

When using the configuration server, candybean will look for a config file to load default values in to the configuration form.

Writing tests

Here's an example Java-JUnit test that uses the candybean AutomationInterfaceBuilder and begins testing through the interface.

The second Java-JUnit test has been enabled for recording, using the @Record annotation, a feature of Candybean that will make a video recording of the test execution. This feature can be configured in the Candybean configuration file.

The VTag annotation on the second JUnit test showcases the ability to tag certain tests to be run only on specific platforms.

When attempting to run tests in parallel, it is important that WebDriverInterface is not instantiated as a static variable, and it is not safe to instantiate WebDriverInterface in the @BeforeClass annotated method, if one is included.

import com.sugarcrm.candybean;
import org.junit.AfterClass;
import org.junit.Test;
import com.sugarcrm.candybean.test.AbstractTest;

public class CandybeanTest {

    private WebDriverInterface iface;

    //The Candybean logger automatically handles the creation of log files specific to test classes
    private Logger logger = Logger.getLogger(Candybean.class.getSimpleName());

    public void setUp() throws CandybeanException {
        Candybean candybean = Candybean.getInstance();
        AutomationInterfaceBuilder builder = candybean.getAIB(WebDriverControlSystemTest.class);
        iface =;

    public void tearDown() throws CandybeanException {

    public void backwardForwardRefreshTest() throws Exception {"Bringing up for an apartment search!");
        assertEquals("", cb.getURL());
        ... do other things
        ... perform other assertions
        ... perform other logging
        ... use other candybean features        

    @Record(duration = Duration.FINAL_FAILED)
    @VTag(tags={"mac", "windows", "linux"}, tagLogicClass="com.sugarcrm.candybean.runner.VTagUnitTest", tagLogicMethod="processTags")
    public void recordingTest() throws Exception {
        String amazonUrl = "";
        assertEquals(amazonUrl, iface.getURL());    
        ... do other things
        ... perform other assertions
        ... perform other logging
        ... use other candybean features            


To run tests in parallel, simply set the value of 'parallel.enabled' to true in the candybean configuration file. The number of threads used for parallel testing can be specified by setting the key 'parallel.threads' in the configuration file.

Refer to Candybean's API Documentation for further feature usage.

Executing your tests

Generally speaking, tests can be/are executed using the Maven Surefire Plugin. So if your tests make use of the Maven standard directory layout and your tests are configured for either JUnit or TestNG, the following command should trigger test execution:

> mvn clean test -Dcbconfig=./candybean.config

Note, though Candybean has default configuration settings, any practical use of the Candybean project will at least require some custom Candybean configuration, thus specifying the location of your Candybean configuration file is required.

Other things you can do:

Specify a testcase and/or test for execution:

> mvn clean test -Dcbconfig=./candybean.config -Dtest=MyTestCase#MyTest

Specify a configured maven profile with surefire plugin inclusion/exclusion for execution:

> mvn clean test -Dcbconfig=./candybean.config -Pintegration

(TestNG) Specify suite XML files from CLI:

> mvn clean test -Dcbconfig=./candybean.config -DsuiteFile=test1.xml,test2.xml

Things we like

This is a list of additional tools and things we like for automation, testing, etc.

We like this stuff: