Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add testing instructions #115

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -334,6 +334,32 @@ export default class AdComponent extends React.Component {
}
```

### Testing

One way to test that events are being tracked is to pass a mocked `tracking` object into your component. Here is an example using Jest and Enzyme:

```js
import ComponentToTest from './ComponentToTest';
import { shallow } from 'enzyme';

const trackEvent = jest.fn();

shallow(
<ComponentToTest
tracking={{
trackEvent
}}
/>
);

test('tracking is called with arguments', () => {
expect(trackEvent).toHaveBeenCalledWith({
event: 'pageDataReady',
page: 'FooPage'
});
});
```

### Tracking Data

Note that there are no restrictions on the objects that are passed in to the decorator.
Expand Down