forked from cypress-io/cypress
/
index.ts
477 lines (415 loc) · 12.3 KB
/
index.ts
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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
/// <reference types="cypress" />
import Vue from 'vue'
import {
createLocalVue,
mount as testUtilsMount,
VueTestUtilsConfigOptions,
Wrapper,
} from '@vue/test-utils'
import {
getContainerEl,
setupHooks,
checkForRemovedStyleOptions,
} from '@cypress/mount-utils'
const defaultOptions: (keyof MountOptions)[] = [
'vue',
'extensions',
]
const DEFAULT_COMP_NAME = 'unknown'
const registerGlobalComponents = (Vue, options) => {
const globalComponents = Cypress._.get(options, 'extensions.components')
if (Cypress._.isPlainObject(globalComponents)) {
Cypress._.forEach(globalComponents, (component, id) => {
Vue.component(id, component)
})
}
}
const installFilters = (Vue, options) => {
const filters: VueFilters | undefined = Cypress._.get(
options,
'extensions.filters',
)
if (Cypress._.isPlainObject(filters)) {
Object.keys(filters).forEach((name) => {
Vue.filter(name, filters[name])
})
}
}
const installPlugins = (Vue, options, props) => {
const plugins: VuePlugins =
Cypress._.get(props, 'plugins') ||
Cypress._.get(options, 'extensions.use') ||
Cypress._.get(options, 'extensions.plugins') ||
[]
// @ts-ignore
plugins.forEach((p) => {
Array.isArray(p) ? Vue.use(...p) : Vue.use(p)
})
}
const installMixins = (Vue, options) => {
const mixins =
Cypress._.get(options, 'extensions.mixin') ||
Cypress._.get(options, 'extensions.mixins')
if (Cypress._.isArray(mixins)) {
mixins.forEach((mixin) => {
Vue.mixin(mixin)
})
}
}
const registerGlobalDirectives = (Vue, options) => {
const directives =
Cypress._.get(options, 'extensions.directives')
if (Cypress._.isPlainObject(directives)) {
Object.keys(directives).forEach((name) => {
Vue.directive(name, directives[name])
})
}
}
const hasStore = ({ store }: { store: any }) => Boolean(store && store._vm)
const forEachValue = <T>(obj: Record<string, T>, fn: (value: T, key: string) => void) => {
return Object.keys(obj).forEach((key) => fn(obj[key], key))
}
const resetStoreVM = (Vue, { store }) => {
// bind store public getters
store.getters = {}
const wrappedGetters = store._wrappedGetters as Record<string, (store: any) => void>
const computed = {}
forEachValue(wrappedGetters, (fn, key) => {
// use computed to leverage its lazy-caching mechanism
computed[key] = () => fn(store)
Object.defineProperty(store.getters, key, {
get: () => store._vm[key],
enumerable: true, // for local getters
})
})
store._watcherVM = new Vue()
store._vm = new Vue({
data: {
$$state: store._vm._data.$$state,
},
computed,
})
return store
}
/**
* Type for component passed to "mount"
*
* @interface VueComponent
* @example
* import Hello from './Hello.vue'
* ^^^^^ this type
* mount(Hello)
*/
type VueComponent = Vue.ComponentOptions<any> | Vue.VueConstructor
/**
* Options to pass to the component when creating it, like
* props.
*
* @interface ComponentOptions
*/
type ComponentOptions = Record<string, unknown>
// local placeholder types
type VueLocalComponents = Record<string, VueComponent>
type VueFilters = {
[key: string]: (value: string) => string
}
type VueDirectives = {
[key: string]: Function | Object
}
type VueMixin = unknown
type VueMixins = VueMixin | VueMixin[]
type VuePluginOptions = unknown
type VuePlugin = unknown | [unknown, VuePluginOptions]
/**
* A single Vue plugin or a list of plugins to register
*/
type VuePlugins = VuePlugin[]
/**
* Additional Vue services to register while mounting the component, like
* local components, plugins, etc.
*
* @interface MountOptionsExtensions
* @see https://github.com/cypress-io/cypress/tree/develop/npm/vue#examples
*/
interface MountOptionsExtensions {
/**
* Extra local components
*
* @memberof MountOptionsExtensions
* @see https://github.com/cypress-io/cypress/tree/develop/npm/vue#examples
* @example
* import Hello from './Hello.vue'
* // imagine Hello needs AppComponent
* // that it uses in its template like <app-component ... />
* // during testing we can replace it with a mock component
* const appComponent = ...
* const components = {
* 'app-component': appComponent
* },
* mount(Hello, { extensions: { components }})
*/
components?: VueLocalComponents
/**
* Optional Vue filters to install while mounting the component
*
* @memberof MountOptionsExtensions
* @see https://github.com/cypress-io/cypress/tree/develop/npm/vue#examples
* @example
* const filters = {
* reverse: (s) => s.split('').reverse().join(''),
* }
* mount(Hello, { extensions: { filters }})
*/
filters?: VueFilters
/**
* Optional Vue mixin(s) to install when mounting the component
*
* @memberof MountOptionsExtensions
* @alias mixins
* @see https://github.com/cypress-io/cypress/tree/develop/npm/vue#examples
*/
mixin?: VueMixins
/**
* Optional Vue mixin(s) to install when mounting the component
*
* @memberof MountOptionsExtensions
* @alias mixin
* @see https://github.com/cypress-io/cypress/tree/develop/npm/vue#examples
*/
mixins?: VueMixins
/**
* A single plugin or multiple plugins.
*
* @see https://github.com/cypress-io/cypress/tree/develop/npm/vue#examples
* @alias plugins
* @memberof MountOptionsExtensions
*/
use?: VuePlugins
/**
* A single plugin or multiple plugins.
*
* @see https://github.com/cypress-io/cypress/tree/develop/npm/vue#examples
* @alias use
* @memberof MountOptionsExtensions
*/
plugins?: VuePlugins
/**
* Optional Vue directives to install while mounting the component
*
* @memberof MountOptionsExtensions
* @see https://github.com/cypress-io/cypress/tree/develop/npm/vue#examples
* @example
* const directives = {
* custom: {
* name: 'custom',
* bind (el, binding) {
* el.dataset['custom'] = binding.value
* },
* unbind (el) {
* el.removeAttribute('data-custom')
* },
* },
* }
* mount(Hello, { extensions: { directives }})
*/
directives?: VueDirectives
}
/**
* Options controlling how the component is going to be mounted,
* including global Vue plugins and extensions.
*
* @interface MountOptions
*/
interface MountOptions {
/**
* Vue instance to use.
*
* @deprecated
* @memberof MountOptions
*/
vue: unknown
/**
* Extra Vue plugins, mixins, local components to register while
* mounting this component
*
* @memberof MountOptions
* @see https://github.com/cypress-io/cypress/tree/develop/npm/vue#examples
*/
extensions: MountOptionsExtensions
}
/**
* Utility type for union of options passed to "mount(..., options)"
*/
type MountOptionsArgument = Partial<ComponentOptions & MountOptions & VueTestUtilsConfigOptions>
// when we mount a Vue component, we add it to the global Cypress object
// so here we extend the global Cypress namespace and its Cypress interface
declare global {
// eslint-disable-next-line no-redeclare
namespace Cypress {
interface Cypress {
/**
* Mounted Vue instance is available under Cypress.vue
* @memberof Cypress
* @example
* mount(Greeting)
* .then(() => {
* Cypress.vue.message = 'Hello There'
* })
* // new message is displayed
* cy.contains('Hello There').should('be.visible')
*/
vue: Vue
vueWrapper: Wrapper<Vue>
}
}
}
const cleanup = () => {
Cypress.vueWrapper?.destroy()
}
/**
* Direct Vue errors to the top error handler
* where they will fail Cypress test
* @see https://vuejs.org/v2/api/#errorHandler
* @see https://github.com/cypress-io/cypress/issues/7910
*/
function failTestOnVueError (err, vm, info) {
// Vue 2 try catches the error-handler so push the error to be caught outside
// of the handler.
setTimeout(() => {
throw err
})
}
/**
* Extract the component name from the object passed to mount
* @param componentOptions the compoennt passed to mount
* @returns name of the component
*/
function getComponentDisplayName (componentOptions: any): string {
if (componentOptions.name) {
return componentOptions.name
}
if (componentOptions.__file) {
const filepathSplit = componentOptions.__file.split('/')
const fileName = filepathSplit[filepathSplit.length - 1] ?? DEFAULT_COMP_NAME
// remove the extension .js, .ts or .vue from the filename to get the name of the component
const baseFileName = fileName.replace(/\.(js|ts|vue)?$/, '')
// if the filename is index, then we can use the direct parent foldername, else use the name itself
return (baseFileName === 'index' ? filepathSplit[filepathSplit.length - 2] : baseFileName)
}
return DEFAULT_COMP_NAME
}
/**
* Mounts a Vue component inside Cypress browser.
* @param {VueComponent} component imported from Vue file
* @param {MountOptionsArgument} optionsOrProps used to pass options to component being mounted
* @returns {Cypress.Chainable<{wrapper: Wrapper<T>, component: T}
* @example
* import { mount } from '@cypress/vue'
* import { Stepper } from './Stepper.vue'
*
* it('mounts', () => {
* cy.mount(Stepper)
* cy.get('[data-cy=increment]').click()
* cy.get('[data-cy=counter]').should('have.text', '1')
* })
* @see {@link https://on.cypress.io/mounting-vue} for more details.
*
*/
export const mount = (
component: VueComponent,
optionsOrProps: MountOptionsArgument = {},
): Cypress.Chainable<{
wrapper: Wrapper<Vue, Element>
component: Wrapper<Vue, Element>['vm']
}> => {
checkForRemovedStyleOptions(optionsOrProps)
// Remove last mounted component if cy.mount is called more than once in a test
cleanup()
const options: Partial<MountOptions> = Cypress._.pick(
optionsOrProps,
defaultOptions,
)
const props: Partial<ComponentOptions> = Cypress._.omit(
optionsOrProps,
defaultOptions,
)
const componentName = getComponentDisplayName(component)
const message = `<${componentName} ... />`
return cy
.window({
log: false,
})
.then((win) => {
const localVue = createLocalVue()
// @ts-ignore
win.Vue = localVue
localVue.config.errorHandler = failTestOnVueError
// set global Vue instance:
// 1. convenience for debugging in DevTools
// 2. some libraries might check for this global
// appIframe.contentWindow.Vue = localVue
// refresh inner Vue instance of Vuex store
// @ts-ignore
if (hasStore(component)) {
// @ts-ignore
component.store = resetStoreVM(localVue, component)
}
// @ts-ignore
const document: Document = cy.state('document')
let el = getContainerEl()
const componentNode = document.createElement('div')
el.append(componentNode)
// setup Vue instance
installFilters(localVue, options)
installMixins(localVue, options)
installPlugins(localVue, options, props)
registerGlobalDirectives(localVue, options)
registerGlobalComponents(localVue, options)
props.attachTo = componentNode
const wrapper = localVue.extend(component as any)
const VTUWrapper = testUtilsMount(wrapper, { localVue, ...props })
Cypress.vue = VTUWrapper.vm
Cypress.vueWrapper = VTUWrapper
return {
wrapper: VTUWrapper,
component: VTUWrapper.vm,
}
})
.then(() => {
if (optionsOrProps.log !== false) {
return Vue.nextTick(() => {
Cypress.log({
name: 'mount',
message: [message],
})
})
}
})
}
/**
* Helper function for mounting a component quickly in test hooks.
* @example
* import {mountCallback} from '@cypress/vue2'
* beforeEach(mountVue(component, options))
*
* Removed as of Cypress 11.0.0.
* @see https://on.cypress.io/migration-11-0-0-component-testing-updates
*/
export const mountCallback = (
component: VueComponent,
options?: MountOptionsArgument,
) => {
return () => {
// @ts-expect-error - undocumented API
Cypress.utils.throwErrByPath('mount.mount_callback')
}
}
// Side effects from "import { mount } from '@cypress/<my-framework>'" are annoying, we should avoid doing this
// by creating an explicit function/import that the user can register in their 'component.js' support file,
// such as:
// import 'cypress/<my-framework>/support'
// or
// import { registerCT } from 'cypress/<my-framework>'
// registerCT()
// Note: This would be a breaking change
setupHooks(cleanup)