Description
Beanmother helps to create your various and complex objects super easily with fixtures for testing. It encourages developers to write more tests.
Beanmother is a implementation of ObjectMother pattern and also fixture replacement tool. You do not need to write extra code like factories or builders for creating test objects. Beanmother helps to create fresh and randomized bean objects for every single test. You can use your beans as it is.
Fixtures can be written in YAML format that is very easy to read and write. It is expressive and extensible. You can use the scripts provided by Beanmother to create multiple types of random data and global sequentail numbers.
Java 7 and above are supported.
beanmother alternatives and similar libraries
Based on the "Testing" category.
Alternatively, view beanmother alternatives based on common mentions on social networks and blogs.
-
Karate
Karate is the only open-source tool to combine API test-automation, mocks, performance-testing and even UI automation into a single, unified framework. -
TestContainers
Provides throwaway instances of common databases, Selenium web browsers, or anything else that can run in a Docker container. -
PowerMock
Enables mocking of static methods, constructors, final classes and methods, private methods and removal of static initializers. -
PIT
Fast mutation-testing framework for evaluating fault-detection abilities of existing JUnit or TestNG test-suites. -
GreenMail
In-memory email server for integration testing. Supports SMTP, POP3 and IMAP including SSL. -
Mutability Detector
Reports on whether instances of a given class are immutable. -
Arquillian
Integration and functional testing platform for Java EE containers. -
Scott Test Reporter
Detailed failure reports and hassle free assertions for Java tests - Power Asserts for Java -
J8Spec
J8Spec is a library that allows tests written in Java to follow the BDD style introduced by RSpec and Jasmine.
Get performance insights in less than 4 minutes
* Code Quality Rankings and insights are calculated and provided by Lumnify.
They vary from L1 to L5 with "L5" being the highest. Visit our partner's website for more details.
Do you think we are missing an alternative of beanmother or a related project?
README
Beanmother
[beanmother](logo.png)
Beanmother helps to create various objects, simple and complex, super easily with fixtures for testing. It encourages developers to write more tests.
Beanmother is an implementation of ObjectMother pattern and also fixture replacement tool. You do not need to write extra code(like factories or builders) for creating test objects. Beanmother helps to create fresh and randomized bean objects for every type of test. You can use a bean as is!.
Java 7 and above are supported.
Example
Create fixture .yml
file in test/resources/fixtures
as a convention.
# test/resources/fixtures/publishing.yml
book: &book
title: ${faker.book.title}
language: en
publishedAt: ${faker.date.between('2000-01-01', '2010-01-01')}
author:
id: ${sequence.number}
name: Ernest Hemingway
introduction: ${faker.lorem.paragraph}
birth: July 21, 1899
gender: MALE
works:
- <<: *book
- <<: *book
- <<: *book
YAML format is very easy to read and write. It is expressive and extensible as well. You can use scripts provided by Beanmother to create multiple types of random data and global sequential numbers.
ObjectMother objectMother = ObjectMother.getInstance();
@Test
public void testSingleObject() {
Book book = objectMother.bear("book", Book.class);
Author author = objectMother.bear("author", Author.class);
}
@Test
public void testMultipleObjects() {
List<Author> authors = objectMother.bear("author", Author.class, 10);
}
And just create!
But if for some reason, you need load the fixtures from another directory inside the classpath
objectMother.addFixtureLocation("another_dir") // test/resources/another_dir
And if the directory it's outside classpath
objectMother.addFixtureLocation("filesystem:///absolute/path/to/fixture/dir") // /absolute/path/to/fixture/dir
Usage
Installation
- Apache Maven
<dependency>
<groupId>io.beanmother</groupId>
<artifactId>beanmother-core</artifactId>
<version>0.9.0</version>
<scope>test</scope>
</dependency>
- Gradle
testCompile 'io.beanmother:beanmother-core:0.9.0'
Extensions
beanmother-java8-converter - For java8 time and optional data type
beanmother-joda-time-converter - For Joda-time data type
beanmother-guava-converter - For Google Guava optional data type
beanmother-builder-converter - For builder pattern initializer
Fixture Script
The scripts provided by Beanmother are kind of fake property value generators.
author:
title: ${faker.book.title}
Currently, FakerScriptRunner
and SeqenceScriptRunner
are registered as a default.
FakerScriptRunner
works withfaker
namespace. The script runner is implemented by java-faker. You can find a usage of java-faker in this document. If a method has no arguments, parentheses can be ignored. For example,
beer:
hop: ${faker.beer.hop}
malt: ${faker.beer.malt}
created_at: ${faker.date.between('1990-01-01', '2000-01-01')}
SequenceScriptRunner
works with thesequence
namespace. The script generates sequential numbers globally. For example,
person:
id: ${sequence.number}
Arguments constructor bean
If a bean does not have a no-argument contructor, just add _construct
key. For example,
price:
_construct:
- 3
- USD
PostProcessor
If you need a common configuration for specific beans, you can use PostProcessor.
Customization
ObjectMother
class is a default implementation of AbstractBeanMother
class. For customization, simply extend AbstractBeanMother
. I highly recommend building it as a singleton instance.
public class MyObjectMother extends AbstractBeanMother {
private static MyObjectMother myObjectMother = new MyObjectMother();
private MyObjectMother() {
super();
}
// Override for adding your default fixture directory paths.
@Override
public String[] defaultFixturePaths() {
return new String[]{ 'test-models', 'fixtures' };
}
// Override for adding your custom Converter.
@Override
protected void configureConverterFactory(ConverterFactory converterFactory) {
converterFactory.register(new MyConverter());
}
// Override for adding your custom ScriptRunner.
@Override
protected void configureScriptHandler(ScriptHandler scriptHandler) {
scriptHandler.register(new MyScriptRunner);
}
// Override for adding your custom PostProcessor.
@Override
protected void configurePostProcessorFactory(PostProcessorFactory postProcessorFactory) {
postProcessorFactory.register(new MyPostProcessor);
}
}
Register PostProcessors
A PostProcessor can handle your bean after mapper.
public class AuthorPostProcessor extends PostProcessor<Author> {
@Override
public void process(Author bean, FixtureMap fixtureMap) {
for(Book book : bean.getWorks()) {
book.setAuthor(bean);
}
}
}
And, pass the instance as an argument when you create an instance.
Author author = ObjectMother.bear("author", Author.class, new AuthorPostProcessor());
or, register the PostProcessor to your custom BeanMother for using it globally.
@Override
protected void configurePostProcessorFactory(PostProcessorFactory postProcessorFactory) {
postProcessorFactory.register(new AuthorPostProcessor());
}
Everytime you create an instance of Author, AuthorPostProcessor
will run before returning an instance of Author.
Customize default fixture path.
Just register the path in ObjectMother. It will scan all files under the path.
ObjectMother.addFixtureLocation("mocks");
Or, override #defaultFixturePaths
in your custom BeanMother.
@Override
public String[] defaultFixturePaths() {
// Add your fixture directory or file paths under `resources`.
return new String[]{ 'test-models', 'fixtures' };
}
Customize converter
You can write your own converter if you want to.
public class MyIntegerToStringConverter extends AbstractGenericConverter<Integer, String> {
@Override
public String convert(Integer source) {
return String.valueOf(source + 1);
}
}
And, register the converter in your custom BeanMother.
@Override
protected void configureConverterFactory(ConverterFactory converterFactory) {
converterFactory.register(new MyIntegerToStringConverter());
}
Customize ScriptRunner
You can write your own ScriptRunner.
public class MyScriptRunner implements ScriptRunner {
@Override
public Object run(ScriptFragment scriptFragment) {
// Do something
return any;
}
@Override
public boolean canHandle(ScriptFragment scriptFragment) {
return scriptFragment.getMethodName.equal("myname");
}
}
And, register the ScriptRunner in your custom BeanMother.
@Override
protected void configureScriptHandler(ScriptHandler scriptHandler) {
scriptHandler.register(new MyScriptRunner());
}
Tests
$ mvn test
Contributions
Any kind of contributions are very welcome! Coding style guideline is not prepared yet. Although I use Intellij IDE default style, follow common sense and please use four-space indentation.
*Note that all licence references and agreements mentioned in the beanmother README section above
are relevant to that project's source code only.