Fetching latest commit…
Cannot retrieve the latest commit at this time.

Random Beans
Because life is too short to generate random Java™ beans by hand..

MIT license Coverage Status Build Status Maven Central Javadocs Gitter

Latest news

  • 19/06/2017: Version 3.7.0 is released. Checkout what's new in the change log.
  • 05/03/2017: Version 3.6.0 is out with new features and bug fixes. See all details in the change log.

What is Random Beans ?

Random Beans is a library that generates random Java beans. Let's say you have a class Person and you want to generate a random instance of it, here we go:

Person person = random(Person.class);

The static method EnhancedRandom.random is able to generate random instances of a given type.

Let's see another example. If you want to generate a random stream of 10 persons, you can use the following snippet:

Stream<Person> persons = randomStreamOf(10, Person.class);

This second static method of the EnhancedRandom API generates a stream of random instances of a given type.

What is this EnhancedRandom API?

The java.util.Random API provides 7 methods to generate random data: nextInt(), nextLong(), nextDouble(), nextFloat(), nextBytes(), nextBoolean() and nextGaussian(). What if you need to generate a random String? Or say a random instance of your domain object? Random Beans provides the EnhancedRandom API that extends (enhances) java.util.Random with a method called nextObject(Class type). This method is able to generate a random instance of any arbitrary Java bean:

EnhancedRandom enhancedRandom = EnhancedRandomBuilder.aNewEnhancedRandom();
Person person = enhancedRandom.nextObject(Person.class);

The EnhancedRandomBuilder is the main entry point to configure EnhancedRandom instances. It allows you to set all parameters to control how random data is generated:

EnhancedRandom random = EnhancedRandomBuilder.aNewEnhancedRandomBuilder()
   .timeRange(nine, five)
   .dateRange(today, tomorrow)
   .stringLengthRange(5, 50)
   .collectionSizeRange(1, 10)

For more details about these parameters, please refer to the configuration parameters section.

In most cases, default options are enough and you can use a static import of the EnhancedRandom.random(Class object) as seen previously.

Random beans allows you to control how to generate random data through the Randomizer interface and makes it easy to exclude some fields from the object graph using the fluent FieldDefinition API:

EnhancedRandom enhancedRandom = EnhancedRandomBuilder.aNewEnhancedRandomBuilder()
   .randomize(String.class, (Randomizer<String>) () -> "foo")

Person person = enhancedRandom.nextObject(Person.class);

Why Random Beans ?

Populating a Java object with random data can look easy at first glance, unless your domain model involves many related classes. In the previous example, let's suppose the Person type is defined as follows:

Without Random Beans, you would write the following code in order to create an instance of the Person class:

Street street = new Street(12, (byte) 1, "Oxford street");
Address address = new Address(street, "123456", "London", "United Kingdom");
Person person = new Person("Foo", "Bar", "", Gender.MALE, address);

And if these classes do not provide constructors with parameters (may be some legacy beans you don't have the control over), you would write:

Street street = new Street();
street.setType((byte) 1);
street.setName("Oxford street");

Address address = new Address();
address.setCountry("United Kingdom");

Person person = new Person();

With Random Beans, generating a random Person object is done with random(Person.class). The library will recursively populate all the object graph. That's a big difference!

How can this be useful ?

Sometimes, the test fixture does not really matter to the test logic. For example, if we want to test the result of a new sorting algorithm, we can generate random input data and assert the output is sorted, regardless of the data itself:

public void testSortAlgorithm() {

   // Given
   int[] ints = aNewEnhancedRandom().nextObject(int[].class);

   // When
   int[] sortedInts = myAwesomeSortAlgo.sort(ints);

   // Then
   assertThat(sortedInts).isSorted(); // fake assertion


Another example is testing the persistence of a domain object, we can generate a random domain object, persist it and assert the database contains the same values:

public void testPersistPerson() throws Exception {
   // Given
   Person person = random(Person.class);

   // When

   // Then
   assertThat("person_table").column("name").value().isEqualTo(person.getName()); // assretj db

There are many other uses cases where random beans can be useful, you can find a non exhaustive list in the wiki.



You are welcome to contribute to the project with pull requests on GitHub.

If you believe you found a bug, please use the issue tracker.

If you have any question, suggestion, or feedback, do not hesitate to use the Gitter channel of the project.

Core team and contributors

Core team

Awesome contributors

Thank you all for your contributions!