Repository files navigation

Cavy is a cross-platform, integration test framework for React Native, byPixie Labs.

Cavy tests allow you to programmatically interact with deeply nested componentswithin your application. Write your tests in pure JavaScript and run them onboth Android and iOS.

Cavy tests look like this:

exportdefaultfunction(spec){spec.describe('A list of the employees',function(){spec.it('can be filtered by search input',asyncfunction(){awaitspec.exists('EmployeeList.JimCavy');awaitspec.fillIn('SearchBar.TextInput','Amy');awaitspec.press('Button.FilterSubmit');awaitspec.notExists('EmployeeList.JimCavy');awaitspec.exists('EmployeeList.AmyTaylor');});});}

• React Native >= 0.59
• React >= 16.8.0

Get set up with Cavy by following ourinstallation guide.

You might also want tocheck out some articles and watch talks about Cavy tofind out a bit more before you write code.

If you need some inspiration, head over to Cavy'ssample app, follow theinstructions in the README, and see Cavy in action.

Full documentation and guides for Cavy can be found on ourwebsite.

Take a look at our publicPivotal Tracker to see whatwe're currently working on, and what features we plan to add to Cavy next.

When making changes to Cavy, it's useful to have theCavyTester app running indevelopment for regression testing.

Follow the instructions it's own README on how to get the tester app runningagainst a local version of the Cavy library.

Here you'll also find instructions on adding new test cases to ensureyour functionality is fully tested. Please do this :)

Before contributing, please read thecode of conduct.

• Check out the latest master to make sure the feature hasn't been implementedor the bug hasn't been fixed yet.
• Check out the issue tracker to make sure someone already hasn't requested itand/or contributed it.
• Fork the project.
• Start a feature/bugfix branch.
• Commit and push until you are happy with your contribution.
• Remember tosubmit a PR to DefinitelyTypedto update the type definitions if you've changed a function's inputs or outputs.
• Remember to submit a PR to updatethe documentation if you've changedhow something works.
• Please try not to mess with the package.json, version, or history. If youwant to have your own version, or is otherwise necessary, that is fine, butplease isolate to its own commit so we can cherry-pick around it.