cavy-forked-cli

cavy-cli is a command line interface for Cavy, a cross-platform integration test framework for React Native, by Pixie Labs.

This cavy(forked)-cli is a heavily modified fork of the original.

About this fork

This fork is an almost complete rewrite of the cavy cli. It's meant to work around some limitations of the cavy cli in regards to the project I am currently using it in. Maybe some of the ideas outlined in this fork might find it back to the original.

Also the rest of this readme might not match the new implementation.

Note: Installing from NPM means installing the original.

I'm on it :)

Known incompatibilities

Expo is required (which is ok if you have a fresh, recent React Native project)
Requires fork of main project
The cavy command currently does not work. It runs from a server connection as stated under Installation or Usage
The test server doesn't detect properly when an Android device disconnects during refreshing. It does only re-register when the app comes back online

What does it do?

cavy-cli builds, simulates, and tests your React Native app from the command line. When the tests finish the command outputs the results and quits with the relevant exit code (0 for success, 1 for failure) which can be used by continuous integration scripts to determine if the test suite passed or not.

Installation

install locally

$ yarn add git+https://git@github.com/dkaufhold/cavy-forked-cli --dev

# or `npm`:

$ npm i --save-dev git+https://git@github.com/dkaufhold/cavy-forked-cli

Add this script to your package.json

{
    // ...
    "scripts": {
        "cavy": "node ./node_modules/cavy-cli/src/server.js",
    }
    // ...
}

Run test server"

$ npm run cavy

$ yarn run cavy

you can pass an option --filter to apply a string filter to the spec names.

I.e. by running yarn run cavy --filter LoginSpec you can re-run only running the test spec registered as LoginSpec.

You can also supply a comma separated list of filters, which are each applied.
Running yarn run cavy --filter LoginSpec,FeatureSpec,LogoutSpec will run the login spec, a spec about a feature you want to test and then the logout spec.
The order of filters given does not change the order of specs. It will still run in the order that they were registered in.

Basic usage

WIP: see cavy(forked)

Contributing

Before contributing, please read the code of conduct.

You can test your local version of cavy-cli by running npm link within the cavy-cli folder. This will make it so cavy is pointing to the cavy.js script in your local copy of cavy-cli. See the documentation for npm link for more information.

Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
Fork the project.
Start a feature/bugfix branch.
Commit and push until you are happy with your contribution.
Please try not to mess with the package.json, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so we can cherry-pick around it.