EasyTest is an actively maintained project. If you have any questions/queries please either log an issue or mail [email protected]
An updated version of EasyTest Core(1.4.0) module is now available in Maven Central Repository
Version 1.4.0 is compatible with JUnit 4.12. All the versions previous to 1.4.0 are compatible with JUnit 4.10
- appendData attribute in DataLoader annotation to optionally specify whether data specified in two different files for the same method be appended or replaced.
- A complete rewrite of the Framework to be faster and easier to work with. Advanced Users can now easily debug the source code as it is modularized and separated out cleanly.
- Intercept annotation. A field level annotation that can be used to intercept calls to methods within the class that is under test.
- PreserveContext Method level annotation tat can be used to specify whther the context of the test should be preserved between test runs. The default value is true.
- Bug fixes
For a more indepth into the new features or for any queries, please contact [email protected]
-
Display annotation is introduced to limit the input key=value pair that is displayed as part of the test method name. Until now, all the test data that is used to run the test method was displayed in the IDE, in the form : testMethodName{paramName=paramVal,paramName=paramVal} Now a user can choose to show only certain fields in the test method name. Look at Display annotation Usage to see how it can be used at class level and Display at method level to see how it can be overridden at method level.
-
Format annotation is introduced for the user to specify the date, datetime and time format to be used to convert date/datetime/time values. Initially EasyTest was parsing the date strings randomly and it was not efficient. The specified date/datetime/time formats are also available to the custom converters. Look at Format annotation usage and Test class where it is applied.
-
New attribute convertEmptyToNull added to the @Param annotation. This attribute specifies whether the empty values (specified using "")in the test data be converted by EasyTest to Null values or not. Default value is false. Example usage here.
-
New Attribute writeData added to the DataLoader annotation. This attribute tells EasyTest whether the test data be written to the file or not. Default value is true. A new System property to specify whether data should be written or not(using boolean true or false) is also added and is named : "easytest.writeData". Example usage here.
-
A new and extremely powerful annotation TestPolicy is now added. This annotation lets the user define a Policy for his test in a separate file and then reuse this policy in multiple tests. This annotation takes a single argument of type class that defines the policy class that this test method should use. The main benefit of TestPolicy is that it gives user an opportunity to reuse a lot of existing annotations and also de-clutters the main test. Here is the javadoc for TestPolicy annotation to see what all annotations it supports.
-
EasyTestSuite class along with ParallelSuite annotation is now available that is an extension of Suite Junit class and provides the user with the ability to run the suite classes in parallel as well as the methods inside the testclasses in parallel. You can see it in action here.
Besides the above major enhancements, there have been few bug fixes as well as code refactoring that went into this major release.
Version 1.2.5 is mostly some bug fixes and code cleaning release. Importantly, from a user's perspective, anyone writing their own custom loaders can now convert the data into specific Object during read time itself, which simplifies their test cases further in the sense that they dont need to write/register specific converters. Although this practice is not encouraged as it may lead to coupled, hard to refactor code, but in certain scenarios it is also useful. One of the clients of EasyTest had this requirement and so it has now been supported.
A new method level annotation Repeat. This annotation can be used to repeat the same test multiple times. This annotation is useful in scenarios where you may quickly want to load test your application. Here is how this annotation can be used.
public class TestRepeat {
@Test
@Repeat(times=20)
public Item findItemTest(@Param(name='itemId')String itemId) {
Item result = testSubject.findItem(itemId)
Assert.notNull(result);
return result;
}
Notice the Repeat annotation at the method level. When EasyTest sees this annotation, it creates "n" different instances of the test method, where "n" is defined by the "times" attribute of the Repeat annotation. In the above case, EasyTest will create 20 unique instances of the above test method.
There is also a System Property test.repeatCount that can be used while running tests from command line. When this property is set, EasyTest simply creates "n" instances of each test defined in the test class, where "n" is defined by the value of the above System Property. System Property takes precedence over Repeat annotation. It means that if both annotation and system property is present, then System Property's value will be used.
Another important addition to EasyTest is a new interface for Converter called ParamAwareConverter This interface introduces a new convert method that is now aware of the Parameter name that it is trying to convert. Users of the original Converter will not be affected and can continue to use it like before. If you are using AbstractConverter class to define your converters then you are in luck. You now get the name parameter for free by calling the getParamName method of the AbstractConverter class. Thanks to Josef Sustacek for his contribution.
Yet another addition to the library is the support for global/default input test data in the XML file. So a user can now specify the repeatable input data globally once, instead of defining the same test data again and again for each test method. Thanks again to Josef Sustacek for his contribution. You can have a look at an example here.
You can always refer the WIKI pages of EasyTest project for a general idea and more indepth detail, or can directly mail me at [email protected] for any questions/clarifications/suggestions.
A new annotation Duration is introduced.
This annotation is introduced to capture the time taken by the method under test and assert it with the user specified maximum time.
Thus a user can now say that the test should fail if the method it is trying to test takes more than "x"milliseconds.
Let's look at an example
public class TestDuration {
@Duration(timeInMillis=20)
ItemService testSubject;
@Test
public Item findItemTest(@Param(name='itemId')String itemId) {
Item result = testSubject.findItem(itemId)
Assert.notNull(result);
return result;
}
In the above case, if the method findItem of class ItemService took more than 20 milli seconds, then the test method will fail specifying that the method took more time than expected.
A second use of this annotation is if a user wants to override the value of timeInMillis attribute of Duration annotation for a specific Test. In such a case, he can specify the Duration annotation at the Test Method level and EasyTest will override the value of timeInMillis only for that test. Lets look at an example :
public class TestDuration {
@Duration(timeInMillis=20)
ItemService testSubject;
@Test
public Item findItemTest(@Param(name='itemId')String itemId) {
Item result = testSubject.findItem(itemId)
Assert.notNull(result);
return result;
@Test
@Duration(timeInMillis=50 , forClass=ItemService.class)
public List<Item> getItemsTest(@Param(name='itemType')String itemType) {
List<Item> result = testSubject.getItems(itemType)
Assert.notNull(result);
return result;
}
In the above case, we are telling EasyTest that method getItems of class ItemService should not take more than 50 milliseconds when run inside the test method with name getItemsTest.
In order to get the complete picture, have a look at the Java docs of Duration annotation.
-
A user can now specify a variable value as part of the DataLoader's filePaths attribute. Thus it is now possible to use DataLoader annotation like this :
@DataLoader(filePaths = {"${my.data.file}" , "${my.second.data.file}"})
Using the above way, a user can specify properties of the above variables "my.data.file" and "my.second.data.file" as System property using -D option of Java System Properties.
-
A new System Property "testDataFiles" to provide a comma separated list of input test data files at runtime. In order to use this option simply specify @DataLoader annotation at the top of your class without any input data. Thus in such a case DataLoader annotation acts as a marker annotation telling the EasyTest system that it has to fetch the value of filePaths attribute from the system property "testDataFiles".
-
NOTE If a user has specified both "testDataFiles" System Property AND a value for "dataFiles" attribute, then the System Property files(specified using testDataFiles System Property) will override the files specified using the "dataFiles" attribute of DataLoader annotation.
Besides regular clean up stuff, one of the important things that changed in 1.2.1 is the way Test methods are now instantiated and their data handled. Until version 1.2, all the test methods were running in a single test class instance, which, normally was not a problem, but caused some concern with JUnit Rules, especially with Rules that depended on a new instance for each test method (ErrorCollector for eg.) With 1.2.1 that has changed and each test method now runs in its own test instance.
You can download the latest version of EasyTest Core from Maven Central Repository
-
Run Your tests in Parallel using @Parallel annotation. Heres an example :
@RunWith(DataDrivenTestRunner.class) @DataLoader(filePaths = { "getItemsData.csv" }) @Parallel(threads=2) public class TestConditionsSupportedByEasyTestRunner { @Test public void testGetItems(@Param(name="inputData") Map<String, String> inputData) { System.out.println("library Id : " + inputData.get("LibraryId") + " and item type : " + inputData.get("itemType") + " and search text array :" + inputData.get("searchText")); } @Test public void testAnotherItem(@Param(name="inputData") Map<String, String> inputData) { // your test condition } }
Note the annotation @Parallel at the class level. This annotation is all you need to run your tests in Parallel.
- The code is a lot cleaner and is known to support all the known features of JUnit.
Download EasyTest simply by including the latest version of easytest-core and easytest-spring modules from Maven in your pom file.
<groupId>org.easetech</groupId>
<artifactId>easytest-core</artifactId>
<version>1.2</version>
And for Spring module simply include :
<groupId>org.easetech</groupId>
<artifactId>easytest-spring</artifactId>
<version>1.1</version>
EasyTest is a framework that lets you write Data Driven Tests using simple and intuitive annotations. But it does not just provide you the ability to write Data Driven Tests. Instead it provides you with the facility to write sleek tests that are maintainable, easy to write and can be generated automatically using easytest-codegen library.
For a more detailed and up to date introduction, look at the wiki page: https://github.com/EaseTech/easytest/wiki/EasyTest-:-An-Introduction
For using EasyTest in your project, look at the WIKI page : https://github.com/EaseTech/easytest/wiki/EasyTest-:-Getting-Started-%7C-Maven-Dependency
Here are some quick links:
The EasyTest Core Module is built as an extension of Junit, and has taken the approach of providing test data to the test classes/methods at the whole new level. to how the test data is provided to the test method by the JUnit Runner.
Before describing the changes proposed in this repository, let us walk through what JUnit provides us for performing Data Driven Testing. JUnit, in its experimental package provides us two options:
-
Parameterized Runner, in which we provide test data to the test method with @Parameters annotation
-
Theories Runner, in which we provide test data to the test method using either @DataPpoint(s) annotations or by using @ParametersSuppliedBy and DataSupplier extension.
Both of the above approach requires the user to write boilerplate code in their test classes. Even though the data now resides outside the test case, it still is coupled with the test class. Finally, the ease of use that JUnit has been synonymous with for so long appears to be missing in the above experimental Runners.
You can find the detailed examples of Parameterized Runner and its limitations here: http://www.kumaranuj.com/2012/08/junits-parameterized-runner-and-data.html
and for Theories runner here : http://www.kumaranuj.com/2012/08/junit-theories-and-data-driven-testing.html
All this and more, inspired me to write a test framework that is simple to use, is flexible in its approach and can be extended by the user in a consistent manner. Finally I wanted to bring back the same ease of use to the testing world, like we had few years ago(annotate methods with @Test and relax).
This code base consists of :
-
A customized JUnit Runner that gives its user ability to provide test data in a consistent and user controlled manner. It is called DataDrivenTestRunner. This Runner works on our favorite annotation @Test from JUnit and also supports passing parameters to the test method. And this is not its only selling point.
-
DataDrivenTestRUNNER gives its users the ability to inspect the testMethod and its associated test data in the IDE. For example, when a user runs the test method with name : getTestData with the following test data:
"libraryId=1 and itemId=2"
"libraryId=2456 and itemId=789"
then, DataDrivenTest, will provide the details of the executing test method in the JUnit supported IDEs like this:
getTestData{libraryId=1 ,itemId=2}
getTestData{libraryId=2456 ,itemId=789}
NOTE: In case the user has simple test methods(without parameters), DataDrivenTest runner supports that implicitly.
- A Data Loading Strategy consisting of interface Loader and classes LoaderFactory and CSVDataLoader and an Enum LoaderType. EasyTest supports four different ways for the user to load Data:
- CSV
- XECEL
- XML
- CUSTOM
CSV, EXCE,XML data loader implementation is already available and the users can use it out of the box. To give an example of the design, CSVDataLoader is an implementation of Loader interface and provides a mechanism to load test data from a CSV file. LoaderFactory is a Factory class that is responsible for returning the right type of Loader based on the loaderType.
- Param annotation that is an extension of ParametersSuppliedBy annotation and provides a lot of useful features to its user. Some of them include:
-
A mechanism to provide custom Objects to the test method. For eg. if a test method requires a user defined object LibraryId, then the Param annotation can automatically convert the string data(provided in the CSV file) to the LibraryId Object.This is based on Java RegistryEditorsSupport. In case the standard PropertyEditor find mechanism does not apply to your project, you can always register your own custom editors in your test class and the Framework will take care of the rest. For example look in the test package at LibraryId and LibraryIdEditor.
-
Another way to provide custom objects to the test method is by using ConverterManager and AbstractConverter. A user can provide its own implementation of converting a Map (containing the key value pair) to an object that is expected by the test method and the extension framework will take care of the rest. See CASE 4 below
- DataLoader annotation to be used by the user in the test to provide information about the test data like:
-
The list of files from which to load the input test data. This is a OPTIONAL field whose type is a String[]
-
The type of loader to load the files, identified by loaderType.
-
The custom loader that is used by users to provide custom data loaders. It is an OPTIONAL field.
-
DataLoader annotation can be used both at the class level as well as at the method level. In case the annotation is applied at both places, then method level takes precedence over Class level.
Currently the framework supports CSV , XML, Excel and Custom loader Type.
5)DataContext class that contains thread-local variables that stores test data as well as the name of the currently executing test method.
6)Finally, EasyTest also supports DataPoint, DataPoints and ParameterSuppliedBy annotations as well.
CASE 1: Provides input test data in the form of CSV file at the class level, that is used by the test methods.
@RunWith(DataDrivenTestRunner.class)
@DataLoader(filePaths = { "getItemsData.csv" }, loaderType = LoaderType.CSV)
public class TestConditionsSupportedByEasyTestRunner {
/**
* A Simple test that uses data provided by TestData annotation present at the Class level
* @param inputData a generic map of input test data that contains all the required parameters for the test data.
*/
@Test
public void testGetItems(@Param(name="inputData") //@Param annotation is optional and can be omitted when the class name of the parameter is the same as the input parameter name
Map<String, String> inputData) {
System.out.println("library Id : " + inputData.get("LibraryId") + " and item type : "
+ inputData.get("itemType") + " and search text array :" + inputData.get("searchText"));
}
CASE 2: User provides input test data in the form of EXCEL file at the method level only.
@RunWith(DataDrivenTestRunner.class)
public class TestConditionsSupportedByEasyTestRunner {
/**
* A Simple test that uses data provided by TestData annotation present at the Method level
* @param inputData a generic map of input test data that contains all the required parameters for the test data.
*/
@Test
@DataLoader(filePaths = { "getItemsData.xls" }, loaderType = LoaderType.EXCEL)
public void testGetItems(@Param(name="inputData")
Map<String, String> inputData) {
System.out.println("library Id : " + inputData.get("LibraryId") + " and item type : "
+ inputData.get("itemType") + " and search text array :" + inputData.get("searchText"));
}
CASE 3: User provides input test data in the form of XML file at the Class level and as CSV file at method level. In this case method level test data takes priority over class level test data.
@RunWith(DataDrivenTestRunner.class)
@DataLoader(filePaths = { "getItemsData.xml" }, loaderType = LoaderType.XML)
public class TestConditionsSupportedByEasyTestRunner {
/**
* A Simple test that uses data provided by TestData annotation present at the Method level
* @param inputData a generic map of input test data that contains all the required parameters for the test data.
*/
@Test
@DataLoader(filePaths = { "getCustomData.csv" }, loaderType = LoaderType.CSV)
public void testGetItems(@Param(name="items")
List<ItemId> inputData) {
.........
}
CASE 4: User can also use their custom defined Objects as parameters in the test case. In this case LibraryId and ItenmId will be resolved using RegsitryEditorSupport of java:
@RunWith(DataDrivenTestRunner.class)
@DataLoader(filePaths = { "getItemsData.csv" }, loaderType = LoaderType.CSV)
public class TestConditionsSupportedByEasyTestRunner {
@BeforeClass
public static void before(){
//This is optional in case your editors follow Java Editor definition convention
RegistryEditorManager.registerEditor(ItemId.class , ItemIdEditor.class);
}
/**
* A Simple test that uses data provided by TestData annotation present at the Method level
* @param inputData a generic map of input test data that contains all the required parameters for the test data.
*/
@Test
@DataLoader(loader = MyDataLoader.class, loaderType = LoaderType.CUSTOM)
public void testGetItems(
LibraryId id , @Param(name="itemid") ItemId itemId) {
System.out.println("library Id : " + id.getValue() + " and item type : "
+ itemId.getValue());
# Param annotation tells the framework that the parameter's value should be provided by the framework.
It can also take an optional name attribute which gives more control over the data to the user.
}
CASE 5: User can also use their custom defined objects when RegistryEditor support is not enough. The user simply has to either extend AbstractConverter class or implement the Converter interface and register it with the framework using ConverterManager class.
@RunWith(DataDrivenTestRunner.class)
@DataLoader(filePaths = { "getItemsData.csv" }, loaderType = LoaderType.CSV)
public class TestConditionsSupportedByEasyTestRunner {
@BeforeClass
public static void before(){
ConverterManager.registerConverter(ItemConverter.class);
}
@Test
@DataLoader(filePaths = { "getItemsData.csv" })
public void testConverter(@Param(name="item") Item item){
Assert.assertNotNull(item);
System.out.println(item.getDescription() + item.getItemId() + item.getItemType());
}
And the framework supports many more functionalities. To review the functionalities supported, please visit :https://github.com/EaseTech/easytest/wiki
This extension to JUnit focuses on bringing back the simplicity back to JUnit in JUnit way. This extension also focuses mainly on performing Data Driven Testing within your system with ease and at the same time giving Flexibility and Extensibility to the user to use their custom behavior. This extension is meant for people who want to write Test cases once and then reuse them again and again. A single test can act both as a Unit Test and an integration test. Nothing in the test case should or will change. Only the test data and the tesSubject will change. This saves a lot of developers time and in turn of the project.