Rainfall

Rainfall is an extensible java 1.8+ framework to implement custom DSL based stress and performance tests in your application.

The goal is to provide all best practices of performance testing within a library so you do not need to reimplement them.

It provides several features:

• Pure java API. No fancy language, you can embed your tests within your applciation sourcecode without additional tweaks.
• Stress testing. This is useful to know how your application is behaving under pressure.
• Load testing. This will test your application under a defined load, and will assert if your SLA is met.
• Aimed at allowing performance regression testing in your continuous integration environment. You can embed your regression performance tests in your application test suite, so they run for every build, and if the performance expectations are not met, this will fail the tests.
• Customizable : You can do web applications testing, but also database, APIs, virtually anything.
• Coordinated omission free, thanks to the HdrHistogram library.
• Nice reporting, with eye candy graphs thanks to plotly.js and d3.js.

It has a customisable fluent interface that lets you implement your own DSL when writing tests scenarios, and define your own tests actions and metrics. Rainfall is open to extensions, three of which are currently in progress,

• Rainfall web is a Yet Another Web Application performance testing library
• Rainfall JCache is a library to test the performance of JSR107 caches solutions
• Rainfall Ehcache is a library to test the performance of Ehcache 2 and 3
• Rainfall Redis
• Rainfall Cassandra

Performance testing primer

If you want to learn more about performance testing, what problematics exist and how Rainfall tackle with them, you can look here: What is performance testing?

Components

Rainfall-core is the core library containing the key elements of the framework. When writing your framework implementation, you must include this library as a dependency.

Rainfall-web is the Web Application performance testing implementation.

Rainfall-jcache is the JSR107 caches performance testing implementation.

Rainfall-ehcache is the Ehcache 2.x/3.x performance testing implementation.

Rainfall-cassandra for Cassandra

Rainfall-redis for Redis

How does it look like?

Beware, Rainfall-core is only the core library, in order to write tests, you need to use an existing implementation (e.g. Rainfall-jcache) or write an implementation yourself

Performance tests are written in java, we will cover a simple example using Rainfall-web:

This tests the performance of calling the Google search page. The scenario is a serie of three consecutive queries that will search for a text string. It will simulate 5 concurrent users doing nothing for 5 seconds then doing the operations of the scenario.

    HttpConfig httpConf = HttpConfig.httpConfig()
        .baseURL("https://www.google.com");

    Scenario scenario = Scenario.scenario("Google search")
        .exec(WebOperations.http("Search Crocro").get("/?").queryParam("q", "Crocro"))
        .exec(WebOperations.http("Search Java").get("/?#q=Java").queryParam("q", "Java"));

    Runner.setUp(scenario)
        .executed(once(5, users), nothingFor(5, seconds), once(5, users))
        .config(httpConf)
        .start();

Quick start

This module is Rainfall-core. It contains the base classes that you will extend in order to write your own performance framework.

io.rainfall.Configuration Your test will define a configuration (e.g. doing http calls to the twitter search page).

io.rainfall.Execution Your test will define a scenario, made of a serie of executions (e.g. do nothing, do an operation once)

io.rainfall.Operation Each execution of the test does some specific Operation (e.g. do the http call with some parameter)

A certain number of those classes are already implemented and available for your tests. See details on the wiki

Build the project

Rainfall is supported on Java 8 and higher

  mvn clean install

Use it in your project

  <dependencies>
    <dependency>
      <groupId>io.rainfall</groupId>
      <artifactId>rainfall-core</artifactId>
      <version>LATEST</version>
    </dependency>
  </dependencies>

Writing your own performance framework

You need to create a new project, similarly to one of the existing implementations (Rainfall-jcache, Rainfall-ehcache, Rainfall-web). See wiki page.

Thanks to the following companies for their support to FOSS:

Sonatype for Nexus

and of course Github for hosting this project.