> A common test utils used within the different `wix-ui` packages
> A common test utils used within the different wix-ui packages
The following helper functions can be used within the different wix-ui packages:
Returns true if a certain class exists on an element.
``javascript
import {isClassExists} from '@wix/wix-ui-test-utils/react-helpers';
const element = document.createElement('div');
element.classList.add('big');
isClassExists(element, 'big'); // true
isClassExists(element, 'small'); // false
`
Returns a promise that resolves after a given timeout.
`javascript
import {sleep} from '@wix/wix-ui-test-utils/react-helpers';
sleep(5000)
.then(() => console.log('Hello world'));
async function foo() {
await sleep(5000);
console.log('Hello world');
}
`
A HOC that makes underlying component "controlled". The "controlled" element will be
initiated with an initial value, invoke an onChange callback and will bind the passed
prop functions.
`javascript
import {mount} from 'enzyme';
import {makeControlled} from '@wix/wix-ui-test-utils/react-helpers';
const UncontrolledInput = props => (
);
const ControlledInput = makeControlled(UncontrolledInput);
const component = mount(
/>
);
// ...
`
Accepts a component driver. Returns a new driver factory. An explanation of drivers can be viewd
here.
`javascript
import React from 'react';
import {createDriverFactory} from '@wix/wix-ui-test-utils/driver-factory';
import {buttonDriverFactory} from './Button.driver';
import Button from './';
const createDriver = createDriverFactory(buttonDriverFactory);
describe('Button', () => {
it('should exist', () => {
const driver = createDriver();
expect(driver.exists()).toBe(true);
});
});
`
#### testkitFactoryCreator
Accepts a component driver. Returns a testkit factory.
`javascript
import {testkitFactoryCreator} from '@wix/wix-ui-test-utils/vanilla';
import datePickerDriverFactory './driver';
const driverFactory = testkitFactoryCreator(datePickerDriverFactory);
const driver = driverFactory({
// ...
});
driver.click();
driver.exists();
// ...
`
#### isTestkitExists
This function should be used inside the component tests in order to to perform a sanity check for the exposed testkit.
It accepts a React Element and a testkit factory. Returns true if the driver
works as expected.
`javascript
import {testkitFactoryCreator, isTestkitExists} from '@wix/wix-ui-test-utils/vanilla';
import datePickerDriverFactory './driver';
const driverFactory = testkitFactoryCreator(datePickerDriverFactory);
isTestkitExists(
driverFactory
); // true
`
#### enzymeTestkitFactoryCreator
Accepts a component driver. Returns a testkit factory based on enzyme.
`javascript
import {enzymeTestkitFactoryCreator} from '@wix/wix-ui-test-utils/enzyme';
import datePickerDriverFactory './driver';
const driverFactory = enzymeTestkitFactoryCreator(datePickerDriverFactory);
const driver = driverFactory({
// ...
});
driver.click();
driver.exists();
// ...
`
#### isEnzymeTestkitExists
This function should be used inside the component tests in order to to perform a sanity check for the exposed testkit.
It accepts a React Element and a testkit factory. Returns true if the driver
works as expected.
`javascript
import {enzymeTestkitFactoryCreator, isEnzymeTestkitExists} from '@wix/wix-ui-test-utils/enzyme';
import datePickerDriverFactory './driver';
import {mount} from 'enzyme';
const driverFactory = enzymeTestkitFactoryCreator(datePickerDriverFactory);
isEnzymeTestkitExists(
driverFactory,
mount
); // true
``