https://github.com/react-native-windows/cavy-extension
extend the functionality of cavy
https://github.com/react-native-windows/cavy-extension
Last synced: 11 months ago
JSON representation
extend the functionality of cavy
- Host: GitHub
- URL: https://github.com/react-native-windows/cavy-extension
- Owner: react-native-windows
- Created: 2019-06-05T04:13:21.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-07-20T18:32:01.000Z (over 4 years ago)
- Last Synced: 2025-02-23T21:01:38.684Z (11 months ago)
- Language: TypeScript
- Size: 543 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
**cavy-extension**
[](https://badge.fury.io/js/cavy-extension)
**[Cavy](https://github.com/pixielabs/cavy)** is a cross-platform integration test framework for React Native.
**Cavy-extension** is a test page focused cavy extension, and it's ideally for component testing. `SimpleTestApp` setups a two page navigation(mainpage and subpage), and helps you maintains the navigation between them. You only need to focus on the test page area. (yellow part below)
It's main functionality:
+ It simplied the steps in component testing and enable user only need to be focused only on authoring test spec and test pages.
+ User only need to provides a testpage, a key which associate swith the testpage. And toTestPage would help to navigate directly to the test page.
+ Allow user to extend the functionality of TestScope and provides IntelliSense when authoring spec.
**Usage**
Check out the [sample app](https://github.com/react-native-windows/cavy-extension/tree/master/sample-app) for a full example of how you may want to integrate cavy-extension into your native testing setup.
***Pre steps***
+ Installation
To get started using Cavy with native reporting, install using yarn:
`yarn add cavy cavy-extension --dev`
or npm:
`npm i --save-dev cavy cavy-extension`
+ create [TestPages](https://github.com/react-native-windows/cavy-extension/blob/master/sample-app/Demo/src/TestApp/TestPages.ts) and replace the app with SimpleTestApp, then hook up them together in a [testapp](https://github.com/react-native-windows/cavy-extension/blob/master/sample-app/Demo/src/TestApp/TestApp.tsx)
```javascript
```
+ convert your project to typescript. It's optionally
***Steps to authoring test case***
1. Write a simple UI test page.
```javascript
export const ExampleTestPage1 = () => {
const generateTestHook = useCavy();
const [text, setText] = useState('');
return setText(text)} value={text}
ref={generateTestHook('Example1.TextInput')} />;
};
```
2. Aggregate the testpages with keys. For example: Example1
```javascript
export const TestPages: Array = [
{
key: 'Example1',
title: 'TestExample by import {ExampleTestPage1}',
page: ExampleTestPage1
},
{
key: 'Example2',
title: 'TestExample by import ExampleTestPage',
page: ExaExampleTestPage2
},
```
3. Write the spec. **toTestPage('Example1')** helps to navigate to test page.
```javascript
await spec2.toTestPage('Example1');
```
***Functionality of this extension***
- Provides a simple testapp, test main page, back button on subpage. and **toTestPage** to help the navigation.
1. Test main page
2. Test sub page
- Add your own functionality to spec and inject it to spec. like **Spec2**
```javascript
function ExampleSpec (spec: TestScope, spec2: SpecHelper) {
spec.describe('Example 1', function () {
spec.it('Test Example 1', async function () {
await spec2.toTestPage('Example1');
...
});
});
```
Or
```javascript
export default function (spec: TestScope) {
let spec2: SpecHelper = new SpecHelper(spec);
spec.describe('Sample Module', function () {
spec.it('SampleModule', async function () {
await spec2.toTestPage('SampleModule');
...
});
});
```
- A typescript project
IntelliSense for spec or spec2 in IDE.
***Test Example***
