-
Notifications
You must be signed in to change notification settings - Fork 3.1k
/
sessions.spec.js
318 lines (259 loc) · 10.8 KB
/
sessions.spec.js
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
const baseUrl = Cypress.config('baseUrl')
before(() => {
// sessions has logic built in to persists sessions on UI refresh
Cypress.session.clearAllSavedSessions()
})
const expectCurrentSessionData = async (obj) => {
return Cypress.session.getCurrentSessionData()
.then((result) => {
cy.log(result)
expect(result.cookies.map((v) => v.name)).members(obj.cookies || [])
expect(result.localStorage).deep.members(obj.localStorage || [])
expect(result.sessionStorage).deep.members(obj.sessionStorage || [])
})
}
describe('cy.session', { retries: 0 }, () => {
describe('args', () => {
it('accepts string as id', () => {
cy.session('session-id', () => {})
cy.session({ name: 'session-id', zkey: 'val' }, () => {})
})
it('accepts array as id', () => {
cy.session('session-id', () => {})
})
it('accepts object as id', () => {
cy.session('session-id', () => {})
})
// redundant?
it('accepts options as third argument', () => {
const setup = cy.stub().as('setupSession')
const validate = cy.stub().as('validateSession')
cy.session('session-id', setup, { validate })
cy.then(() => {
expect(setup).to.be.calledOnce
expect(validate).to.be.calledOnce
})
})
})
describe('errors', () => {
let lastLog = null
let logs = []
beforeEach(() => {
cy.on('log:added', (attrs, log) => {
if (attrs.name === 'session') {
lastLog = log
logs.push(log)
}
})
return null
})
it('throws error when experimentalSessionAndOrigin not enabled', { experimentalSessionAndOrigin: false, experimentalSessionSupport: false }, (done) => {
cy.on('fail', (err) => {
expect(lastLog.get('error')).to.eq(err)
expect(lastLog.get('state')).to.eq('failed')
expect(err.message).to.eq('`cy.session()` requires enabling the `experimentalSessionAndOrigin` flag.')
expect(err.docsUrl).to.eq('https://on.cypress.io/session')
done()
})
cy.session('sessions-not-enabled')
})
it('throws error when experimentalSessionSupport is enabled through test config', { experimentalSessionAndOrigin: false, experimentalSessionSupport: true }, (done) => {
cy.on('fail', (err) => {
expect(lastLog.get('error')).to.eq(err)
expect(lastLog.get('state')).to.eq('failed')
expect(err.message).to.eq('\`cy.session()\` requires enabling the \`experimentalSessionAndOrigin\` flag. The \`experimentalSessionSupport\` flag was enabled but was removed in Cypress version 9.6.0.')
expect(err.docsUrl).to.eq('https://on.cypress.io/session')
done()
})
cy.session('sessions-not-enabled')
})
it('throws error when experimentalSessionSupport is enabled through Cypress.config', { experimentalSessionAndOrigin: false }, (done) => {
Cypress.config('experimentalSessionSupport', true)
cy.on('fail', (err) => {
Cypress.config('experimentalSessionSupport', false)
expect(lastLog.get('error')).to.eq(err)
expect(lastLog.get('state')).to.eq('failed')
expect(err.message).to.eq('\`cy.session()\` requires enabling the \`experimentalSessionAndOrigin\` flag. The \`experimentalSessionSupport\` flag was enabled but was removed in Cypress version 9.6.0.')
expect(err.docsUrl).to.eq('https://on.cypress.io/session')
done()
})
cy.session('sessions-not-enabled')
})
it('throws when sessionId argument was not provided', function (done) {
cy.on('fail', (err) => {
expect(lastLog.get('error')).to.eq(err)
expect(lastLog.get('state')).to.eq('failed')
expect(err.message).to.eq('`cy.session()` was passed an invalid argument. The first argument `id` must be an string or serializable object.')
expect(err.docsUrl).to.eq('https://on.cypress.io/session')
done()
})
cy.session()
})
it('throws when sessionId argument is not an object', function (done) {
cy.on('fail', (err) => {
expect(lastLog.get('error')).to.eq(err)
expect(lastLog.get('state')).to.eq('failed')
expect(err.message).to.eq('`cy.session()` was passed an invalid argument. The first argument `id` must be an string or serializable object.')
expect(err.docsUrl).to.eq('https://on.cypress.io/session')
done()
})
cy.session(1)
})
it('throws when options argument is provided and is not an object', function (done) {
cy.on('fail', (err) => {
expect(lastLog.get('error')).to.eq(err)
expect(lastLog.get('state')).to.eq('failed')
expect(err.message).to.eq('`cy.session()` was passed an invalid argument. The optional third argument `options` must be an object.')
expect(err.docsUrl).to.eq('https://on.cypress.io/session')
done()
})
cy.session('some-session', () => {}, 'invalid_arg')
})
it('throws when options argument has an invalid option', function (done) {
cy.on('fail', (err) => {
expect(lastLog.get('error')).to.eq(err)
expect(lastLog.get('state')).to.eq('failed')
expect(err.message).to.eq('`cy.session()` was passed an invalid option: **invalid_key**\nAvailable options are: `validate`')
expect(err.docsUrl).to.eq('https://on.cypress.io/session')
done()
})
cy.session('some-session', () => {}, { invalid_key: 2 })
})
it('throws when options argument has an option with an invalid type', function (done) {
cy.on('fail', (err) => {
expect(lastLog.get('error')).to.eq(err)
expect(lastLog.get('state')).to.eq('failed')
expect(err.message).to.eq('`cy.session()` was passed an invalid option value. **validate** must be of type **function** but was **number**.')
expect(err.docsUrl).to.eq('https://on.cypress.io/session')
done()
})
cy.session('some-session', () => {}, { validate: 2 })
})
it('throws when setup function is not provided and existing session is not found', function (done) {
cy.on('fail', (err) => {
expect(lastLog.get('error')).to.eq(err)
expect(lastLog.get('state')).to.eq('failed')
expect(err.message).to.eq('No session is defined with the name\n **some-session**\nIn order to use `cy.session()`, provide a `setup` as the second argument:\n\n`cy.session(id, setup)`')
expect(err.docsUrl).to.eq('https://on.cypress.io/session')
done()
})
cy.session('some-session')
})
it('throws when multiple session calls with same sessionId but different options', function (done) {
cy.on('fail', async (err) => {
expect(lastLog.get('error')).to.eq(err)
expect(lastLog.get('state')).to.eq('failed')
expect(err.message).to.eq('You may not call `cy.session()` with a previously used name and different options. If you want to specify different options, please use a unique name other than **duplicate-session**.')
expect(err.docsUrl).to.eq('https://on.cypress.io/session')
await expectCurrentSessionData({
localStorage: [{ origin: baseUrl, value: { one: 'value' } }],
})
done()
})
cy.session('duplicate-session', () => {
// function content
window.localStorage.one = 'value'
})
cy.session('duplicate-session', () => {
// different function content
window.localStorage.two = 'value'
})
})
describe('options.validate failures', () => {
const errorHookMessage = 'This error occurred in a session validate hook after initializing the session. Because validation failed immediately after session setup we failed the test.'
it('throws when options.validate has a failing Cypress command', (done) => {
cy.on('fail', (err) => {
expect(err.message).contain('Expected to find element: `#does_not_exist`')
expect(err.message).contain(errorHookMessage)
expect(err.codeFrame).exist
done()
})
cy.session(['mock-session', 'command'], () => {
cy.log('setup')
}, {
validate () {
cy.get('#does_not_exist', { timeout: 20 })
},
})
})
it('throws when options.validate throws an error', (done) => {
cy.on('fail', (err) => {
expect(err.message).contain('validate error')
expect(err.message).contain(errorHookMessage)
expect(err.codeFrame).exist
done()
})
cy.session(['mock-session', 'throws'], () => {
cy.log('setup')
}, {
validate () {
throw new Error('validate error')
},
})
})
it('throws when options.validate rejects', (done) => {
cy.on('fail', (err) => {
expect(err.message).contain('validate error')
expect(err.message).contain(errorHookMessage)
expect(err.codeFrame).exist
done()
})
cy.session(['mock-session', 'rejects'], () => {
cy.log('setup')
}, {
validate () {
return Promise.reject(new Error('validate error'))
},
})
})
it('throws when options.validate returns false', (done) => {
cy.on('fail', (err) => {
expect(err.message).to.contain('Your `cy.session` **validate** callback returned false.')
expect(err.message).contain(errorHookMessage)
expect(err.codeFrame).exist
done()
})
cy.session(['mock-session', 'return false'], () => {
cy.log('setup')
}, {
validate () {
return false
},
})
})
it('throws when options.validate resolves false', (done) => {
cy.on('fail', (err) => {
expect(err.message).to.contain('Your `cy.session` **validate** callback resolved false.')
expect(err.message).contain(errorHookMessage)
expect(err.codeFrame).exist
done()
})
cy.session(['mock-session', 'resolves false'], () => {
cy.log('setup')
}, {
validate () {
return Promise.resolve(false)
},
})
})
// TODO: emilyrohrbough - 4/3/2022 - figure out what the below comment means
// TODO: cy.validate that will fail, hook into event, soft-reload inside and test everything is halted
// Look at other tests for cancellation
// make error collapsible by default
it('throws when options.validate returns Chainer<false>', (done) => {
cy.on('fail', (err) => {
expect(err.message).to.contain('Your `cy.session` **validate** callback resolved false.')
expect(err.message).contain(errorHookMessage)
done()
})
cy.session(['mock-session', 'Chainer<false>'], () => {
cy.log('setup')
}, {
validate () {
return cy.wrap(false)
},
})
})
})
})
})