|
| 1 | +import { expect } from 'chai' |
| 2 | +import pausePlugin from '../../../lib/plugin/pause.js' |
| 3 | +import { setPauseHandler } from '../../../lib/pause.js' |
| 4 | +import { hopeThat, isEffectActive, retryTo, tryTo } from '../../../lib/effects.js' |
| 5 | +import recordStep from '../../../lib/step/record.js' |
| 6 | +import Step from '../../../lib/step.js' |
| 7 | +import event from '../../../lib/event.js' |
| 8 | +import recorder from '../../../lib/recorder.js' |
| 9 | +import store from '../../../lib/store.js' |
| 10 | +import { createTest } from '../../../lib/mocha/test.js' |
| 11 | + |
| 12 | +const trackedEvents = [event.test.before, event.test.started, event.test.failed, event.test.after, event.step.failed] |
| 13 | + |
| 14 | +const failingStep = () => recordStep(new Step({ fail: () => Promise.reject(new Error('Ups')) }, 'fail'), []) |
| 15 | + |
| 16 | +describe('pause plugin on=fail', () => { |
| 17 | + let pauses |
| 18 | + let listenersBefore |
| 19 | + |
| 20 | + beforeEach(() => { |
| 21 | + store.dryRun = false |
| 22 | + pauses = 0 |
| 23 | + setPauseHandler(() => { |
| 24 | + pauses++ |
| 25 | + return Promise.resolve() |
| 26 | + }) |
| 27 | + listenersBefore = Object.fromEntries(trackedEvents.map(name => [name, event.dispatcher.listeners(name)])) |
| 28 | + recorder.reset() |
| 29 | + recorder.start() |
| 30 | + pausePlugin({}) |
| 31 | + }) |
| 32 | + |
| 33 | + afterEach(() => { |
| 34 | + for (const name of trackedEvents) { |
| 35 | + for (const listener of event.dispatcher.listeners(name)) { |
| 36 | + if (!listenersBefore[name].includes(listener)) event.dispatcher.removeListener(name, listener) |
| 37 | + } |
| 38 | + } |
| 39 | + event.dispatcher.emit(event.test.finished, createTest('cleanup')) |
| 40 | + setPauseHandler(null) |
| 41 | + recorder.reset() |
| 42 | + }) |
| 43 | + |
| 44 | + const finishTest = async test => { |
| 45 | + event.dispatcher.emit(event.test.finished, test) |
| 46 | + event.dispatcher.emit(event.test.after, test) |
| 47 | + await recorder.promise() |
| 48 | + } |
| 49 | + |
| 50 | + it('does not pause when a step failure is swallowed by tryTo (#4516)', async () => { |
| 51 | + const test = createTest('tryTo') |
| 52 | + event.dispatcher.emit(event.test.started, test) |
| 53 | + const result = await tryTo(failingStep) |
| 54 | + await recorder.promise() |
| 55 | + expect(result).to.equal(false) |
| 56 | + event.dispatcher.emit(event.test.passed, test) |
| 57 | + await finishTest(test) |
| 58 | + expect(pauses).to.equal(0) |
| 59 | + }) |
| 60 | + |
| 61 | + it('pauses when a hopeThat soft assertion fails', async () => { |
| 62 | + const test = createTest('hopeThat') |
| 63 | + event.dispatcher.emit(event.test.started, test) |
| 64 | + const result = await hopeThat(failingStep) |
| 65 | + await recorder.promise() |
| 66 | + expect(result).to.equal(false) |
| 67 | + event.dispatcher.emit(event.test.passed, test) |
| 68 | + await finishTest(test) |
| 69 | + expect(pauses).to.equal(1) |
| 70 | + }) |
| 71 | + |
| 72 | + it('does not pause when retryTo succeeds after a failed attempt', async () => { |
| 73 | + const test = createTest('retryTo') |
| 74 | + event.dispatcher.emit(event.test.started, test) |
| 75 | + await retryTo(tries => (tries === 1 ? failingStep() : recorder.add(() => 'ok')), 2, 0) |
| 76 | + await recorder.promise() |
| 77 | + event.dispatcher.emit(event.test.passed, test) |
| 78 | + await finishTest(test) |
| 79 | + expect(pauses).to.equal(0) |
| 80 | + }) |
| 81 | + |
| 82 | + it('pauses when retryTo exhausts all attempts', async () => { |
| 83 | + const test = createTest('retryTo exhausted') |
| 84 | + event.dispatcher.emit(event.test.started, test) |
| 85 | + const err = await retryTo(failingStep, 2, 0).catch(e => e) |
| 86 | + expect(err).to.be.instanceOf(Error) |
| 87 | + recorder.reset() |
| 88 | + recorder.start() |
| 89 | + event.dispatcher.emit(event.test.failed, test, err) |
| 90 | + await finishTest(test) |
| 91 | + expect(pauses).to.equal(1) |
| 92 | + expect(isEffectActive()).to.equal(false) |
| 93 | + }) |
| 94 | + |
| 95 | + it('leaves no active effect after nested tryTo', async () => { |
| 96 | + await tryTo(() => tryTo(failingStep)) |
| 97 | + await recorder.promise() |
| 98 | + expect(isEffectActive()).to.equal(false) |
| 99 | + }) |
| 100 | + |
| 101 | + it('pauses when a failed step fails the test', async () => { |
| 102 | + const test = createTest('failing step') |
| 103 | + event.dispatcher.emit(event.test.started, test) |
| 104 | + const err = await failingStep().catch(e => e) |
| 105 | + recorder.reset() |
| 106 | + recorder.start() |
| 107 | + event.dispatcher.emit(event.test.failed, test, err) |
| 108 | + await finishTest(test) |
| 109 | + expect(pauses).to.equal(1) |
| 110 | + }) |
| 111 | + |
| 112 | + it('pauses when a Before hook fails', async () => { |
| 113 | + const test = createTest('before hook') |
| 114 | + event.dispatcher.emit(event.test.before, test) |
| 115 | + const err = await failingStep().catch(e => e) |
| 116 | + recorder.reset() |
| 117 | + recorder.start() |
| 118 | + event.dispatcher.emit(event.test.failed, test, err, 'Before') |
| 119 | + await finishTest(test) |
| 120 | + expect(pauses).to.equal(1) |
| 121 | + }) |
| 122 | + |
| 123 | + it('pauses when an After hook fails a passed test', async () => { |
| 124 | + const test = createTest('after hook') |
| 125 | + event.dispatcher.emit(event.test.started, test) |
| 126 | + event.dispatcher.emit(event.test.passed, test) |
| 127 | + const err = await failingStep().catch(e => e) |
| 128 | + recorder.reset() |
| 129 | + recorder.start() |
| 130 | + event.dispatcher.emit(event.test.failed, test, err, 'After') |
| 131 | + await finishTest(test) |
| 132 | + expect(pauses).to.equal(1) |
| 133 | + }) |
| 134 | + |
| 135 | + it('does not pause when the test fails without a failed step', async () => { |
| 136 | + const test = createTest('plain error') |
| 137 | + event.dispatcher.emit(event.test.started, test) |
| 138 | + event.dispatcher.emit(event.test.failed, test, new Error('Ups')) |
| 139 | + await finishTest(test) |
| 140 | + expect(pauses).to.equal(0) |
| 141 | + }) |
| 142 | + |
| 143 | + it('does not carry a failure over to the next test', async () => { |
| 144 | + const failed = createTest('failed') |
| 145 | + event.dispatcher.emit(event.test.started, failed) |
| 146 | + const err = await failingStep().catch(e => e) |
| 147 | + recorder.reset() |
| 148 | + recorder.start() |
| 149 | + event.dispatcher.emit(event.test.failed, failed, err) |
| 150 | + await finishTest(failed) |
| 151 | + |
| 152 | + const passed = createTest('passed') |
| 153 | + event.dispatcher.emit(event.test.started, passed) |
| 154 | + event.dispatcher.emit(event.test.passed, passed) |
| 155 | + await finishTest(passed) |
| 156 | + expect(pauses).to.equal(1) |
| 157 | + }) |
| 158 | +}) |
0 commit comments