test: add helper method for overriding env variables

[victor-yanev]

Description:

Related issue(s):

Fixes #

Notes for reviewer:

Checklist

• Documented (Code comments, README, etc.)
• Tested (unit, integration, etc.)

[github-actions]

Acceptance Tests

0 tests   0 ✔️  0s ⏱️
0 suites  0 💤
0 files    0 ❌

Results for commit 7e74328.

♻️ This comment has been updated with latest results.

[sonarcloud]

Quality Gate failed

Failed conditions
9.1% Duplication on New Code (required ≤ 3%)

See analysis details on SonarCloud

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 19.98%. Comparing base (4d727db) to head (7e74328).

❗ There is a different number of reports uploaded between BASE (4d727db) and HEAD (7e74328). Click for more details.

HEAD has 3 uploads less than BASE

Flag	BASE (4d727db)	HEAD (7e74328)
server	1	0
ws-server	1	0
	1	0

Additional details and impacted files

@@             Coverage Diff             @@
##             main    #3022       +/-   ##
===========================================
- Coverage   88.37%   19.98%   -68.40%     
===========================================
  Files          61       41       -20     
  Lines        4053     3068      -985     
  Branches      815      621      -194     
===========================================
- Hits         3582      613     -2969     
- Misses        430     2446     +2016     
+ Partials       41        9       -32     

Flag	Coverage Δ
relay	19.98% <ø> (-70.17%)	⬇️
server	?
ws-server	?

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
.../lib/services/ethService/ethFilterService/index.ts	16.25% <ø> (-68.75%)	⬇️

... and 55 files with indirect coverage changes

[acuarica]

I believe mocha allows the user to have multiple before and after. Maybe we could use a smaller wrapper that only invokes before and after to set only 1 env variable. I guess this way might be more composable. What do you think?

[victor-yanev]

That's true and the tests() method that is passed can also include before, beforeEach, afterEach, and after in addition to it and describe declarations, I don't see a problem with there being other before and after called inside.

I am not sure what you mean, could you maybe give some examples?

[acuarica]

I was thinking something like this (and for each env var you want to modify you need to call this method in the test)

Suggested change

	/**
	* Overrides an environment variable in the provided {@link NodeJS.Dict} object.
	*
	* @param {NodeJS.Dict<string>} object - The object containing the environment variables.
	* @param {string} key - The key of the environment variable to override.
	* @param {string | undefined} value - The value to set the environment variable to.
	*/
	export const overrideEnv = (object: NodeJS.Dict<string>, key: string, value: string | undefined) => {
	if (value === undefined) {
	delete object[key];
	} else {
	object[key] = value;
	}
	};
	/**
	* Overrides environment variables for the duration of the provided tests.
	*
	* @param {NodeJS.Dict<string>} envs - An object containing key-value pairs of environment variables to set.
	* @param {Function} tests - A function containing the tests to run with the overridden environment variables.
	*/
	export const withOverriddenEnvs = (envs: NodeJS.Dict<string>, tests: () => void) => {
	const overriddenEnvs = Object.entries(envs)
	.map(([key, value]) => `${key}=${value}`)
	.join(', ');
	describe(`given ${overriddenEnvs} are set`, () => {
	let envsToReset: NodeJS.Dict<string> = {};
	before(() => {
	for (const key in envs) {
	envsToReset[key] = process.env[key];
	overrideEnv(process.env, key, envs[key]);
	}
	});
	tests();
	after(() => {
	for (const key in envsToReset) {
	overrideEnv(process.env, key, envsToReset[key]);
	}
	});
	});
	};
	export const overriddeEnv = (key: string, value: string | undefined) => {
	let prevValue: string | undefined;
	before(() => {
	prevValue = process.env[key];
	process.env[key] = value;
	});
	after(() => {
	if (prevValue === undefined) {
	delete process.env[key];
	} else {
	process.env[key] = prevValue;
	}
	});
	};