cavy/CHANGELOG.md

An integration test framework for React Native.

# 4.0.2

- Open up react and react-native peer dependency versions. Thanks
  [alexburkowskypolysign](https://github.com/alexburkowskypolysign) for
  this.
- Remove sample app from codebase (was ignored by npm anyway, so doesn't
  affect package.
- Update CircleCI workflow.

# 4.0.1

- Fix bug in `generateTestHook`, preserving the functionality of users' own
  refs created using `useRef` and `createRef`. Thanks to
  [MrLoh](https://github.com/MrLoh) for the fix.

# 4.0.0

**BREAKING** This release includes updates to the default Cavy reporter to
support new cavy-cli features. These changes are backwards compatible within
Cavy itself, and require no changes to your code. However, if you're using
cavy-cli you'll need to upgrade to version cavy-cli 2.0 to continue to run
your tests.

The updated default reporter now:

- Opens a websocket connection to cavy-cli when your app boots. cavy-cli waits
  for a configurable length of time to receive this connection and exits with an
  error code if no connection is made.
- Sends in-progress results to cavy-cli, so that you can see a log of each test
  as they pass/fail in realtime.

This release also:
- Adds a deprecation warning if an old-style reporter is used i.e. a reporter
  that is a function taking one argument (the test report object).

# 3.4.1

- Remove tester app from package.

# 3.4.0

- Add ability to tag and filter tests, allowing you to run a subset of tests per
  test run.

# 3.3.0

- Add `fullResults` to Cavy's test report object, containing more details about
  the test suite and individual test cases e.g. timings and test describe block
  labels. Cavy can now support outputting JUnit compatible test reports via
  [cavy-cli](https://github.com/pixielabs/cavy-cli).

# 3.2.1

- Fix bug in `containsText` helper function, whereby you couldn't test for a
  <Text> component containing a number. Thank you
  [Zooheck](https://github.com/Zooheck)!

# 3.2.0

- New `focus` spec helper function. Thanks [Austin](https://github.com/austinpgraham)!

# 3.1.0

- Extend `wrap` functionality so that it can also be used turn native components
  like `Text` into testable components.
- New `containsText` spec helper function.
- Use [hoist-non-react-statics](https://github.com/mridgway/hoist-non-react-statics)
  in `hook` HOC.
- Add a `displayName` to the `hook` HOC for ease of debugging.
- Upgrade React Native in the sample app to 0.59.9.

# 3.0.0

- **BREAKING** Fixed issue whereby props were being flattened on `wrap`-ped
  function components. This is a breaking change for those users manually
  fetching a component and accessing a flattened prop as a workaround. All props
  are now accessible through the `props` key as expected. Thanks to
  [FLGMwt](https://github.com/FLGMwt) for your help!

# 2.2.1

- Fix regression introduced in 2.2.0.

# 2.2.0

- Add support for passing refs created via `React.createRef` to `generateTestHook`.

# 2.1.1

- Fix confusing messaging when Cavy fails to connect to
[cavy-cli](https://github.com/pixielabs/cavy-cli).

# 2.1.0

- Deprecate the `sendReport` prop. By default Cavy checks to see whether
  cavy-cli is running and sends the test report if a response is received.
- Add the ability to use a custom `reporter` when running Cavy tests. If
  supplied, Cavy will send the test report to the custom reporter rather than
  cavy-cli.

# 2.0.0

- Add a `beforeEach` function that can be used on a per-spec basis. Thanks to
[PatrickBRT](https://github.com/PatrickBRT) whose work inspired our approach!
- **BREAKING** Clear AsyncStorage and re-render the app before each test runs.
- Cavy no longer resets your app at the end of the test suite.

# 1.1.0

- Un-deprecate `wrap` (was deprecated in 0.6.0) and rewrite it using React
  Hooks. `wrap` is now the accepted way to test function components, replacing
  our previous recommendation to use Recompose's `toClass` (which has been
  deprecated in favour of React Hooks). 🎉

# 1.0.0

- **BREAKING** Drop official support for React Native < 0.59 and React < 16.8.0.
- Update `<Tester>` to use the newer Context API introduced in React 16.3.
- Added a custom [React Hook](https://reactjs.org/docs/hooks-intro.html) called
  `useCavy()` which can be used to access `generateTestHook` from your
  functional components.

This version brings Cavy in line with how people use React nowadays (moving
towards using functional components). However React Hooks were added in React
Native 0.59 and React 16.8.0, so you will need to upgrade your application to
continue to use Cavy from version 1.0.0 onwards. You can continue to use
0.6.2 in the meantime.

If you don't use `useCavy()` Cavy 1.0.0 should work with React Native >= 0.57.5
which was [the earliest version that supported the new Context API](https://github.com/facebook/react-native/issues/21975)
however this is not officially supported.

# 0.6.2

- Fix for when `clearAsyncStorage` option is used but there are no entries in
AsyncStorage. Thanks [haikyuu](https://github.com/haikyuu)!

# 0.6.1

- Update `babel-presets-env` and `.babelrc`.  Thanks
  [eriben](https://github.com/eriben).

# 0.6.0

- Remove `console.warn` when overwriting a component.
- Add deprecation message when calling `wrap`.

# 0.5.0

- Support [cavy-cli](https://github.com/pixielabs/cavy-cli).

cavy-cli is the next step in Cavy's development. With it, we can start to
support Continuous Integration, conditionally running tests, and a bunch of
other cool stuff. Thanks to [Tyler Pate](https://github.com/TGPSKI) whose
suggestions inspired our approach.

# 0.4.1

- Stop using deprecated `PropTypes` and `createClass`. Thanks
  [Mohammed Abu-alsaad](https://github.com/mo-solnet)!
- Fix for when using a wrapped component in a shallow render environment.
  Thanks [Kye Bracey](https://github.com/Kynosaur)!
- Updated documentation for Create React Native App / Expo.

# 0.4.0

- Add optional `startDelay` property to `<Tester>` which delays the test suite
  from beginning once the component is mounted.
- Added a start and end console log line.

With thanks to [Tyler Pate](https://github.com/TGPSKI) for both of these
features!

# 0.3.1

- Tweak to the test failure message.

# 0.3.0

- Added the ability to automatically clear the app's entire AsyncStorage
  between test cases. By default, behaviour is unchanged (it does not clear
  it).

# 0.2.0

- Added a `notExists` component assertion.

# 0.1.0

- Added a pause function.
- Configurable wait time when finding components.

# 0.0.2

- Bug fix to ensure that default props are set for wrapped components.

# 0.0.1

- Initial release.