overleaf/services/web/test/smoke/src/SmokeTests.js
Jakob Ackermann 5e773ce950 Merge pull request #4101 from overleaf/ae-settings-module
Migrate from `settings-sharelatex` to `@overleaf/settings`

GitOrigin-RevId: 9a298ba26382180c1351683c5fddc9004418c1e6
2021-07-08 02:08:28 +00:00

95 lines
2.2 KiB
JavaScript

const fs = require('fs')
const Path = require('path')
const Settings = require('@overleaf/settings')
const { getCsrfTokenForFactory } = require('./support/Csrf')
const { SmokeTestFailure } = require('./support/Errors')
const {
requestFactory,
assertHasStatusCode,
} = require('./support/requestHelper')
const { processWithTimeout } = require('./support/timeoutHelper')
const STEP_TIMEOUT = Settings.smokeTest.stepTimeout
const PATH_STEPS = Path.join(__dirname, './steps')
const STEPS = fs
.readdirSync(PATH_STEPS)
.sort()
.map(name => {
const step = require(Path.join(PATH_STEPS, name))
step.name = Path.basename(name, '.js')
return step
})
async function runSmokeTests({ isAborted, stats }) {
let lastStep = stats.start
function completeStep(key) {
const step = Date.now()
stats.steps.push({ [key]: step - lastStep })
lastStep = step
}
const request = requestFactory({ timeout: STEP_TIMEOUT })
const getCsrfTokenFor = getCsrfTokenForFactory({ request })
const ctx = {
assertHasStatusCode,
getCsrfTokenFor,
processWithTimeout,
request,
stats,
timeout: STEP_TIMEOUT,
}
const cleanupSteps = []
async function runAndTrack(id, fn) {
let result
try {
result = await fn(ctx)
} catch (e) {
throw new SmokeTestFailure(`${id} failed`, {}, e)
} finally {
completeStep(id)
}
Object.assign(ctx, result)
}
completeStep('init')
let err
try {
for (const step of STEPS) {
if (isAborted()) break
const { name, run, cleanup } = step
if (cleanup) cleanupSteps.unshift({ name, cleanup })
await runAndTrack(`run.${name}`, run)
}
} catch (e) {
err = e
}
const cleanupErrors = []
for (const step of cleanupSteps) {
const { name, cleanup } = step
try {
await runAndTrack(`cleanup.${name}`, cleanup)
} catch (e) {
// keep going with cleanup
cleanupErrors.push(e)
}
}
if (err) throw err
if (cleanupErrors.length) {
if (cleanupErrors.length === 1) throw cleanupErrors[0]
throw new SmokeTestFailure('multiple cleanup steps failed', {
stats,
cleanupErrors,
})
}
}
module.exports = { runSmokeTests, SmokeTestFailure }