Skip to content

fix(tests): combat flakiness #830

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DeviaVir merged 2 commits into from
Dec 8, 2025
Merged

fix(tests): combat flakiness #830

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7f4536d
fix(tests): combat flakiness
DeviaVir Dec 8, 2025
a6a6a80
Apply suggestions from code review
DeviaVir Dec 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 33 additions & 24 deletions test/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,16 @@ const _timeout = function (params) {
}
}

const forceRemoveSync = (targetPath) => {
if (typeof fs.rmSync === 'function') {
fs.rmSync(targetPath, { recursive: true, force: true })
return
}
// fs-extra's removeSync always removes recursively and handles non-existent paths gracefully,
// so no options are needed here. This is functionally equivalent to the rmSync call above.
fs.removeSync(targetPath)
}

// It does not completely reproduce the response of the actual API.
const lambdaMockSettings = {
addPermission: {},
Expand Down Expand Up @@ -140,8 +150,8 @@ const _awsRestore = () => {
describe('lib/main', function () {
if (['win32', 'darwin'].includes(process.platform)) {
// It seems that it takes time for file operation in Windows and Mac.
// So set `timeout(120000)` for the whole test.
this.timeout(120000)
// So set timeout(180000) (sec: 180) for the whole test.
this.timeout(180000)
}

let aws = null // mock
Expand Down Expand Up @@ -478,8 +488,8 @@ describe('lib/main', function () {
fs.writeFileSync('fuga', '')
})
after(() => {
['fuga', '__unittest'].forEach((path) => {
fs.removeSync(path)
['fuga', '__unittest'].forEach((targetPath) => {
forceRemoveSync(targetPath)
})
})

Expand Down Expand Up @@ -560,7 +570,7 @@ describe('lib/main', function () {

it('_fileCopy should not include package.json when --prebuiltDirectory is set', () => {
const buildDir = '.build_' + Date.now()
after(() => fs.removeSync(buildDir))
after(() => forceRemoveSync(buildDir))

fs.mkdirSync(buildDir)
fs.writeFileSync(path.join(buildDir, 'testa'), '')
Expand Down Expand Up @@ -594,7 +604,7 @@ describe('lib/main', function () {

describe('when package-lock.json does not exist', () => {
beforeEach(() => {
fs.removeSync(path.join(codeDirectory, 'package-lock.json'))
forceRemoveSync(path.join(codeDirectory, 'package-lock.json'))
})

it('returns false', () => {
Expand Down Expand Up @@ -717,7 +727,7 @@ describe('lib/main', function () {
})

describe('_packageInstall', function () {
_timeout({ this: this, sec: 60 }) // ci should be faster than install
_timeout({ this: this, sec: 180 }) // ci should be faster than install

// npm treats files as packages when installing, and so removes them.
// Test with `devDependencies` packages that are not installed with the `--production` option.
Expand Down Expand Up @@ -754,7 +764,7 @@ describe('lib/main', function () {
fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson))

// Remove package-lock.json because it does not match the package.json to which optionalDependencies was added.
fs.removeSync(path.join(codeDirectory, 'package-lock.json'))
forceRemoveSync(path.join(codeDirectory, 'package-lock.json'))
}

const testOptionalDependenciesIsInstalled = async (packageManager) => {
Expand Down Expand Up @@ -796,7 +806,7 @@ describe('lib/main', function () {

describe('when package-lock.json does not exist', () => {
beforeEach(() => {
return fs.removeSync(path.join(codeDirectory, 'package-lock.json'))
forceRemoveSync(path.join(codeDirectory, 'package-lock.json'))
})

it('should use "npm install"', () => {
Expand Down Expand Up @@ -849,7 +859,7 @@ describe('lib/main', function () {
})

describe('_packageInstall (When codeDirectory contains characters to be escaped)', function () {
_timeout({ this: this, sec: 30 }) // give it time to build the node modules
_timeout({ this: this, sec: 180 }) // give it time to build the node modules

beforeEach(() => {
// Since '\' can not be included in the file or directory name in Windows
Expand All @@ -863,7 +873,7 @@ describe('lib/main', function () {
})

afterEach(() => {
fs.removeSync(codeDirectory)
forceRemoveSync(codeDirectory)
codeDirectory = lambda._codeDirectory()
})

Expand Down Expand Up @@ -952,7 +962,7 @@ describe('lib/main', function () {
})

describe('_zip', function () {
_timeout({ this: this, sec: 60 }) // give it time to zip
_timeout({ this: this, sec: 180 }) // give it time to zip

const beforeTask = async (packageManager) => {
await lambda._cleanDirectory(codeDirectory)
Expand Down Expand Up @@ -1022,7 +1032,7 @@ describe('lib/main', function () {
describe('_archive', () => {
// archive.files's name is a slash delimiter regardless of platform.
it('installs and zips with an index.js file and node_modules/dotenv (It is also a test of `_buildAndArchive`)', function () {
_timeout({ this: this, sec: 30 }) // give it time to zip
_timeout({ this: this, sec: 180 }) // give it time to zip

return lambda._archive({ ...program, sourceDirectory: sourceDirectoryForTest }).then((data) => {
const archive = new Zip(data)
Expand All @@ -1035,9 +1045,9 @@ describe('lib/main', function () {
})

it('packages a prebuilt module without installing (It is also a test of `_archivePrebuilt`)', function () {
_timeout({ this: this, sec: 30 }) // give it time to zip
_timeout({ this: this, sec: 180 }) // give it time to zip
const buildDir = '.build_' + Date.now()
after(() => fs.removeSync(buildDir))
after(() => forceRemoveSync(buildDir))

fs.mkdirSync(buildDir)
fs.mkdirSync(path.join(buildDir, 'd'))
Expand All @@ -1063,11 +1073,11 @@ describe('lib/main', function () {
})

it('cleans the temporary directory before running `_archivePrebuilt`', function () {
_timeout({ this: this, sec: 30 }) // give it time to zip
_timeout({ this: this, sec: 180 }) // give it time to zip
const buildDir = '.build_' + Date.now()
const codeDir = lambda._codeDirectory()
const tmpFile = path.join(codeDir, 'deleteme')
after(() => fs.removeSync(buildDir))
after(() => forceRemoveSync(buildDir))

fs.mkdirSync(codeDir, { recursive: true })
fs.writeFileSync(tmpFile, '...')
Expand All @@ -1085,7 +1095,7 @@ describe('lib/main', function () {
const testZipFile = path.join(os.tmpdir(), 'node-lambda-test.zip')
let bufferExpected = null
before(function () {
_timeout({ this: this, sec: 30 }) // give it time to zip
_timeout({ this: this, sec: 180 }) // give it time to zip

return lambda._zip(program, codeDirectory).then((data) => {
bufferExpected = data
Expand Down Expand Up @@ -1130,7 +1140,7 @@ describe('lib/main', function () {
deployZipfile: filePath,
sourceDirectory: sourceDirectoryForTest
}
_timeout({ this: this, sec: 30 }) // give it time to zip
_timeout({ this: this, sec: 180 }) // give it time to zip
return lambda._archive(_program).then((data) => {
// same test as "installs and zips with an index.js file and node_modules/dotenv"
const archive = new Zip(data)
Expand Down Expand Up @@ -1642,7 +1652,7 @@ describe('lib/main', function () {

describe('Lambda.prototype.deploy()', () => {
it('simple test with mock', function () {
_timeout({ this: this, sec: 30 }) // give it time to zip
_timeout({ this: this, sec: 180 }) // give it time to zip
return lambda.deploy({ ...program, sourceDirectory: sourceDirectoryForTest }).then((result) => {
assert.isUndefined(result)
})
Expand All @@ -1654,10 +1664,9 @@ describe('lib/main', function () {
return lambda._updateTags(
awsLambda,
'arn:aws:lambda:eu-central-1:1234567:function:test',
{ tagKey: 'tagValue' }).then((result) => {
assert.deepEqual(
result, {}
)
{ tagKey: 'tagValue' }
).then((result) => {
assert.deepEqual(result, {})
})
})
})
Expand Down