Cavy — better test reporting for React Native integration tests

Send Cavy test results to iOS or Android test runners, or write your own report handler.

Cavy is an integration testing framework for React Native. Using Cavy, you can write your application tests in JavaScript (no need for any native code!) and run them in-app or via the command line interface, cavy-cli.

One of the great things about Cavy is that it’s completely platform-agnostic. You can write one set of tests for both Android and iOS, and there are no extra set-up steps for either platform. Easy peasy 🎉

What’s new?

By default, Cavy sends a test report to cavy-cli if it’s running. But what if you want to send the results somewhere else?

You can now supply your own reporter function to Cavy that will be called in place of sending the test report to cavy-cli. The function receives one argument — the Cavy test report — and you pass it into the Tester component at the root of your app:

import React, { Component } from 'react';
import { AppRegistry } from 'react-native';
import App from './app';
import { Tester, TestHookStore } from 'cavy';
import IntegrationSpecs from './specs/IntegrationSpecs';

const testHookStore = new TestHookStore();
const myReporterFunction = (report) => {
  // do something with the report here.
}
class TestableApp extends Component {
  render() {
    return (
      <Tester specs={IntegrationSpecs}
        store={testHookStore}
        reporter={myReporterFunction}>
        <App/>
      </Tester>
    );
  }
}

AppRegistry.registerComponent('App', () => TestableApp);

The report your function will receive has the following structure:

{
  duration: 5.2, // time taken for tests to run (secs)
  errorCount: 1, // number of failing tests
  results: [
    {
      message: "Test suite description: First test description",
      passed: 1 // test passed
    },
    {
      message: "Test suite description: Second test description",
      passed: 0 // test failed
    }
  ]
}

Using Cavy Native Reporter

We’ve used this new custom reporter functionality to develop a native reporter for Cavy that you can use to send your test reports to native Android or iOS test runners.

Cavy Native Reporter fires a Native Module callback when Cavy tests are finished, which you can then wire into a native test runner, such as XCTest for iOS or JUnit for Android.

You might want to consider using Cavy Native Reporter if you already use XCTest or JUnit to test parts of your app or if you have an existing continuous integration pipeline set up for running a native test framework and don’t want to adapt it to run Cavy tests separately.

Check out the README for setup instructions and example code snippets of how you might want to use the reporter in your own native tests (ObjC, Swift or Java).

Big shout out to our friends at Nozbe (and Radek in particular!) for helping us get the native reporter off the ground ❤️.

Here at Pixie Labs, we love giving back to the open-source community and take pride in making the tools we put out there better all the time. If you’re using Cavy in your project, we’d love to hear back from you with any feedback or suggestions.

Let us know how you get on writing your own custom reporters!

.

.

.

Pixie Labs is a leading London-based digital product studio with deep software development expertise in Ruby on Rails, React and React Native. We design and build high-impact apps, platforms and digital tools. Let us help you make your digital product a success.