Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 | import sinon from 'sinon'; import { parse } from 'path'; import React from 'react'; import PropTypes from 'prop-types'; import { mount, shallow } from 'enzyme'; import assert from 'assert'; import _ from 'lodash'; import glob from 'glob'; import * as lucid from '../index'; // Common tests for all our components export function common( Component, { getDefaultProps = _.constant({}), exemptFunctionProps = [], exemptChildComponents = [], selectRoot = _.identity, noExport = false, } = {} ) { function generateDefaultProps(props = {}) { return _.assign({}, getDefaultProps(), props); } describe('[common]', () => { if (!Component) { throw new Error('An undefined component was passed to generic tests.'); } if (Component._isLucidHybridComponent) { throw new Error( `You're trying to run generic tests on a hybrid component which is bad and won't work and will make you cry. Check your spec files for ${ Component.displayName } and import the raw component instead of the hybrid version.` ); } it('should have a `displayName` defined', () => { assert(Component.displayName); }); it('should pass through styles to the root element', () => { const style = { backgroundColor: '#f0f', }; const wrapper = shallow( <Component {...generateDefaultProps()} style={style} />, { disableLifecycleMethods: true } ); const rootWrapper = selectRoot(wrapper).first(); const rootStyle = rootWrapper.prop('style'); assert( _.every(style, (val, key) => val === rootStyle[key]), 'root style must contain passed styles' ); }); it('should pass through `className`', () => { const expectedClass = 'rAnDoM'; const wrapper = shallow( <Component {...generateDefaultProps()} className={expectedClass} />, { disableLifecycleMethods: true } ); const rootWrapper = selectRoot(wrapper).first(); const classNames = rootWrapper.prop('className').split(' '); assert( _.includes(classNames, expectedClass), `'${classNames}' should include '${expectedClass}'` ); }); it('should have an application scoped base class', () => { const expectedClass = 'lucid-' + Component.displayName; const wrapper = shallow(<Component {...generateDefaultProps()} />, { disableLifecycleMethods: true, }); const rootWrapper = selectRoot(wrapper).first(); const classNames = rootWrapper.prop('className').split(' '); assert( _.includes(classNames, expectedClass), `'${classNames}' should include '${Component.displayName}'` ); }); it('should have only application scoped classes', () => { const wrapper = shallow(<Component {...generateDefaultProps()} />, { disableLifecycleMethods: true, }); const rootWrapper = selectRoot(wrapper).first(); const parentClasses = rootWrapper.prop('className').split(' '); const childrenClasses = rootWrapper.children().reduce((acc, node) => { if (!node.prop('className')) { return acc; } return acc.concat(node.prop('className').split(' ')); }, []); const allClasses = parentClasses.concat(childrenClasses); _.forEach(allClasses, className => { assert( _.includes(className, `lucid-${Component.displayName}`), `${className} must be scoped` ); }); }); describe('function propTypes', () => { const funcProps = _.pickBy( Component.propTypes, propType => propType === PropTypes.func ); _.forEach(funcProps, (propType, propName) => { it(`${propName} should only use onX convention for function proptypes`, () => { assert( _.startsWith(propName, 'on') || _.includes(exemptFunctionProps, propName), `${propName} must follow onX convention` ); }); }); }); describe('child components', () => { // Child components are all function types which start with a capital letter const childComponents = _.pickBy(Component, (value, key) => { return /^[A-Z]/.test(key) && _.isFunction(value); }); describe('propNames in propTypes', () => { _.flow( x => _.map(x, 'propName'), x => _.compact(x), x => _.flatMap(x, _.castArray), x => _.reject(x, propName => _.includes(exemptChildComponents, propName) ), x => _.forEach(x, propName => { it(`should include ${propName} in propTypes`, () => { assert( Component.propTypes[propName], `must include ${propName} in propTypes` ); }); }) )(childComponents); }); }); describe('example testing', () => { const fileNames = glob.sync( `./src/components/**/${Component.displayName}/examples/*.@(j|t)sx` ); _.each(fileNames, path => { const Example = require('../../' + path).default; const title = parse(path).name; it(`should match snapshot(s) for ${title}`, () => { const shallowExample = shallow(<Example />, { disableLifecycleMethods: true, }); // If the root of the example is an instance of the Component under test, snapshot it. // Otherwise, look under the root for instances of the Component and snapshot those. if (shallowExample.is(Component.displayName)) { expect( shallow(<Component {...shallowExample.props()} />, { disableLifecycleMethods: true, }) ).toMatchSnapshot(); } else { shallowExample.find(Component.displayName).forEach(example => { expect( shallow(<Component {...example.props()} />, { disableLifecycleMethods: true, }) ).toMatchSnapshot(); }); } }); }); }); // Only run this test if it's a public component if (!Component._isPrivate && !noExport) { it('should be available as an exported module from index.ts', () => { assert(lucid[Component.displayName]); }); } }); } // Common tests for all our icon components export function icons(Component) { describe('[icon]', () => { it('should add the correct class for isClickable', () => { const wrapper = mount(<Component isClickable={true} />); const targetClassName = 'lucid-Icon-is-clickable'; assert( wrapper.find('svg').hasClass(targetClassName), `Missing '${targetClassName}' class` ); }); }); } // Common tests for all control components export function controls( Component, { callbackName, controlSelector, eventType, additionalProps = {} } ) { // Use DOM tests here since some of our controls use dom events under the hood describe('[control]', () => { it('should callback with `event` and `props`', () => { const expectedSpecialProp = 32; const props = { specialProp: expectedSpecialProp, [callbackName]: sinon.spy(), ...additionalProps, }; const wrapper = mount(<Component {...props} />); wrapper .find(controlSelector) .first() .simulate(eventType); // Last argument should be an object with `uniqueId` and `event` const { props: { specialProp }, event, } = _.last(props[callbackName].args[0]); assert(event, 'missing event'); assert.equal( specialProp, expectedSpecialProp, 'incorrect or missing specialProp' ); }); }); } // Common tests for all Functional Components // // These tests are intended to help us make sure our FCs are shaped corrected. // They are necessary because there isn't a perfect way to get the defaultProps // to be factored in correctly yet with React/TypeScript: // https://github.com/DefinitelyTyped/DefinitelyTyped/issues/30695#issuecomment-474780159 export function functionalComponents(FC) { // Use DOM tests here since some of our controls use dom events under the hood describe('[functionalComponent]', () => { it('should have the correct `peek` properties', () => { expect(FC.propName === undefined || typeof FC.propName === 'string').toBe( true ); expect( FC._isPrivate === undefined || typeof FC._isPrivate === 'boolean' ).toBe(true); expect(typeof FC.peek).toBe('object'); expect(typeof FC.peek.description).toBe('string'); expect( FC.peek.extend === undefined || typeof FC.peek.extend === 'string' ).toBe(true); expect( FC.peek.extend === undefined || typeof FC.peek.extend === 'string' ).toBe(true); expect( FC.peek.categories === undefined || Array.isArray(FC.peek.categories) ).toBe(true); expect( FC.peek.madeFrom === undefined || Array.isArray(FC.peek.madeFrom) ).toBe(true); }); }); } const NativeDate = global.Date; const createMockDateClass = (...args) => _.assign( function MockDate() { return new NativeDate(...args); }, { UTC: NativeDate.UTC, parse: NativeDate.parse, now: () => new NativeDate(...args).getTime(), prototype: NativeDate.prototype, } ); export const mockDate = _.assign( (...args) => { global.Date = createMockDateClass(...args); }, { restore() { global.Date = NativeDate; }, } ); |