test: add helper method for overriding env variables #3022

victor-yanev · 2024-09-20T14:02:16Z

Description:

In the current setup, there is no straightforward way to temporarily override environment variables for the duration of a test suite. This can lead to issues where tests inadvertently affect each other due to shared environment settings, making it difficult to isolate and reproduce test failures.

Additionally, in many tests environment variables are overridden without being reverted, propagating this behavior to other tests and making the tests dependent on their order and leading to chain-failures in cases where only one of the tests actually fails.

Changes:

This PR adds new helper methods overrideEnvs and withOverriddenEnvs which provide a mechanism to temporarily set environment variables for the duration of a test or a group of tests.

ℹ️ These methods ensure that the original environment settings are restored after the tests have run, maintaining the integrity of the global environment.

overrideEnvs: Temporarily sets environment variables before a test and restores them afterward.
withOverriddenEnvs: A higher-level function that uses overrideEnvs to set environment variables for a group of tests defined within a callback function.

Related issue(s):

Fixes #3029

Checklist

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

Signed-off-by: Victor Yanev <[email protected]>

github-actions · 2024-09-20T14:08:08Z

Acceptance Tests

  18 files 244 suites 30m 7s ⏱️
601 tests 594 ✔️ 4 💤 3 ❌
695 runs 686 ✔️ 6 💤 3 ❌

Results for commit 358fff3.

♻️ This comment has been updated with latest results.

Signed-off-by: Victor Yanev <[email protected]>

packages/relay/tests/helpers.ts

Signed-off-by: Victor Yanev <[email protected]>

github-actions · 2024-09-25T11:18:40Z

Tests

      3 files   372 suites 18s ⏱️
1 367 tests 1 366 ✔️ 1 💤 0 ❌
1 376 runs 1 375 ✔️ 1 💤 0 ❌

Results for commit 358fff3.

♻️ This comment has been updated with latest results.

Signed-off-by: Victor Yanev <[email protected]>

Nana-EC

LG, final comment is around method naming to make things obvious and avoid wasted troubleshooting time form this improvement

packages/relay/tests/helpers.ts

Signed-off-by: Victor Yanev <[email protected]>

ebadiere

LG, but now there is a merge conflict.

Signed-off-by: Victor Yanev <[email protected]> # Conflicts: # packages/relay/src/lib/services/ethService/ethFilterService/index.ts # packages/relay/tests/lib/clients/localLRUCache.spec.ts # packages/relay/tests/lib/eth/eth_call.spec.ts # packages/relay/tests/lib/eth/eth_estimateGas.spec.ts # packages/relay/tests/lib/eth/eth_feeHistory.spec.ts # packages/relay/tests/lib/eth/eth_gasPrice.spec.ts # packages/relay/tests/lib/eth/eth_getBalance.spec.ts # packages/relay/tests/lib/eth/eth_getBlockByHash.spec.ts # packages/relay/tests/lib/eth/eth_getBlockByNumber.spec.ts # packages/relay/tests/lib/eth/eth_getCode.spec.ts # packages/relay/tests/lib/eth/eth_getLogs.spec.ts # packages/relay/tests/lib/eth/eth_getStorageAt.spec.ts # packages/relay/tests/lib/eth/eth_getTransactionCount.spec.ts # packages/relay/tests/lib/eth/eth_sendRawTransaction.spec.ts # packages/relay/tests/lib/hapiService.spec.ts # packages/relay/tests/lib/hbarLimiter.spec.ts # packages/relay/tests/lib/mirrorNodeClient.spec.ts # packages/relay/tests/lib/precheck.spec.ts # packages/relay/tests/lib/repositories/hbarLimiter/ethAddressHbarSpendingPlanRepository.spec.ts # packages/relay/tests/lib/repositories/hbarLimiter/hbarSpendingPlanRepository.spec.ts # packages/relay/tests/lib/repositories/hbarLimiter/ipAddressHbarSpendingPlanRepository.spec.ts # packages/relay/tests/lib/sdkClient.spec.ts # packages/relay/tests/lib/services/cacheService/cacheService.spec.ts # packages/relay/tests/lib/services/debugService/debug.spec.ts # packages/relay/tests/lib/services/eth/filter.spec.ts # packages/relay/tests/lib/services/metricService/metricService.spec.ts # packages/relay/tests/lib/web3.spec.ts # packages/server/tests/acceptance/cacheService.spec.ts # packages/server/tests/acceptance/hbarLimiter.spec.ts # packages/server/tests/acceptance/rpc_batch3.spec.ts # packages/ws-server/tests/acceptance/subscribeNewHeads.spec.ts # packages/ws-server/tests/unit/utils.spec.ts # packages/ws-server/tests/unit/validations.spec.ts

Signed-off-by: Victor Yanev <[email protected]> # Conflicts: # packages/relay/tests/lib/repositories/hbarLimiter/ethAddressHbarSpendingPlanRepository.spec.ts # packages/relay/tests/lib/repositories/hbarLimiter/hbarSpendingPlanRepository.spec.ts

Signed-off-by: Victor Yanev <[email protected]>

sonarcloud · 2024-10-11T13:50:31Z

Quality Gate failed

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

See analysis details on SonarCloud

github-actions · 2024-10-11T13:53:12Z

🚨 Memory Leak Detected 🚨

A potential memory leak has been detected in the test titled validates enforcement of request id. This may impact the application's performance and stability.

Details

📊 Memory Leak Detection Report 📊

GC Type: MarkSweepCompact
Cost: 24,265.6 ms

Heap Statistics (before vs after executing the test):

Total Heap Size: increased with 1.72 MB
Total Heap Size Executable: no changes
Total Physical Size: decreased with 344.06 KB
Total Available Size: increased with 2.13 MB
Total Global Handles Size: no changes
Used Global Handles Size: decreased with 64.00 bytes
Used Heap Size: decreased with 3.28 MB
Heap Size Limit: no changes
Malloced Memory: no changes
External Memory: no changes
Peak Malloced Memory: no changes

Heap Space Statistics (before vs after executing the test):

Old Space:
- Space Size: increased with 2.10 MB
- Space Used Size: increased with 2.08 MB
- Space Available Size: decreased with 506.37 KB
- Physical Space Size: increased with 2.10 MB
Large Object Space:
- Space Size: increased with 835.58 KB
- Space Used Size: increased with 813.50 KB
- Space Available Size: no changes
- Physical Space Size: increased with 835.58 KB

Recommendations

Please investigate the memory allocations in this test, focusing on objects that are not being properly deallocated.

codecov · 2024-10-11T14:12:44Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.54%. Comparing base (4a69be9) to head (358fff3).
Report is 14 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3022      +/-   ##
==========================================
- Coverage   84.88%   82.54%   -2.34%     
==========================================
  Files          43       61      +18     
  Lines        3216     4063     +847     
  Branches      649      806     +157     
==========================================
+ Hits         2730     3354     +624     
- Misses        283      471     +188     
- Partials      203      238      +35

Flag	Coverage Δ
relay	`84.95% <ø> (+0.06%)`	⬆️
server	`83.43% <ø> (?)`
ws-server	`33.91% <ø> (?)`

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	`79.51% <ø> (ø)`

... and 20 files with indirect coverage changes

* test: add helper method for overriding env variables Signed-off-by: Victor Yanev <[email protected]> * chore: improve readability Signed-off-by: Victor Yanev <[email protected]> * fix: usages Signed-off-by: Victor Yanev <[email protected]> * fix: cacheService.spec.ts Signed-off-by: Victor Yanev <[email protected]> * fix: utils.spec.ts Signed-off-by: Victor Yanev <[email protected]> * fix: relay.spec.ts and sdkClient.spec.ts Signed-off-by: Victor Yanev <[email protected]> * fix: eth_call.spec.ts, eth_estimateGas.spec.ts, ethGetBlockBy.spec.ts Signed-off-by: Victor Yanev <[email protected]> * fix: use helper method to override envs in acceptance test specs Signed-off-by: Victor Yanev <[email protected]> * fix: hapiService.spec.ts and precheck.spec.ts Signed-off-by: Victor Yanev <[email protected]> * fix: sdkClient.spec.ts Signed-off-by: Victor Yanev <[email protected]> * fix: cacheService.spec.ts Signed-off-by: Victor Yanev <[email protected]> * fix: metricService.spec.ts and subscriptionController.spec.ts Signed-off-by: Victor Yanev <[email protected]> * fix: rateLimiter.spec.ts Signed-off-by: Victor Yanev <[email protected]> * fix: failing tests Signed-off-by: Victor Yanev <[email protected]> * chore: revert some changes in rpc_batch3.spec.ts Signed-off-by: Victor Yanev <[email protected]> * fix: subscribe.spec.ts Signed-off-by: Victor Yanev <[email protected]> * chore: add docs with examples to `overrideEnvs` and `withOverriddenEnvs` Signed-off-by: Victor Yanev <[email protected]> * chore: address comments Signed-off-by: Victor Yanev <[email protected]> * fix: build image test Signed-off-by: Victor Yanev <[email protected]> * Merge branch 'main' into add-helper-method-for-overriding-env-variables Signed-off-by: Victor Yanev <[email protected]> * chore: address comments + fix conflicts after merge Signed-off-by: Victor Yanev <[email protected]> * chore: optimize TTL tests in localLRUCache.spec.ts Signed-off-by: Victor Yanev <[email protected]> * fix: failing unit test after merge from main Signed-off-by: Victor Yanev <[email protected]> * chore: optimize imports after merge from main Signed-off-by: Victor Yanev <[email protected]> --------- Signed-off-by: Victor Yanev <[email protected]>

test: add helper method for overriding env variables

08731d1

Signed-off-by: Victor Yanev <[email protected]>

victor-yanev added enhancement New feature or request Technical Debt Issue which resolves technical debt labels Sep 20, 2024

victor-yanev self-assigned this Sep 20, 2024

victor-yanev requested review from AlfredoG87, ebadiere, georgi-l95, Ivo-Yankov, a team and lukelee-sl as code owners September 20, 2024 14:02

chore: improve readability

7e74328

Signed-off-by: Victor Yanev <[email protected]>

acuarica reviewed Sep 20, 2024

View reviewed changes

packages/relay/tests/helpers.ts Outdated Show resolved Hide resolved

acuarica reviewed Sep 20, 2024

View reviewed changes

packages/relay/tests/helpers.ts Outdated Show resolved Hide resolved

fix: usages

c19d59a

Signed-off-by: Victor Yanev <[email protected]>

victor-yanev requested a review from Nana-EC as a code owner September 24, 2024 15:34

victor-yanev added 12 commits September 25, 2024 10:48

fix: cacheService.spec.ts

3ddfb58

Signed-off-by: Victor Yanev <[email protected]>

fix: utils.spec.ts

08dcd68

Signed-off-by: Victor Yanev <[email protected]>

fix: relay.spec.ts and sdkClient.spec.ts

030df8f

Signed-off-by: Victor Yanev <[email protected]>

fix: eth_call.spec.ts, eth_estimateGas.spec.ts, ethGetBlockBy.spec.ts

fbbcec8

Signed-off-by: Victor Yanev <[email protected]>

fix: use helper method to override envs in acceptance test specs

00714c5

Signed-off-by: Victor Yanev <[email protected]>

Merge branch main into 'add-helper-method-for-overriding-env-variables'

4d97b99

Signed-off-by: Victor Yanev <[email protected]>

fix: hapiService.spec.ts and precheck.spec.ts

e771bac

Signed-off-by: Victor Yanev <[email protected]>

fix: sdkClient.spec.ts

f2f25e4

Signed-off-by: Victor Yanev <[email protected]>

fix: cacheService.spec.ts

ad61287

Signed-off-by: Victor Yanev <[email protected]>

fix: metricService.spec.ts and subscriptionController.spec.ts

7b2585c

Signed-off-by: Victor Yanev <[email protected]>

fix: rateLimiter.spec.ts

f8f5034

Signed-off-by: Victor Yanev <[email protected]>

fix: failing tests

5c76ef8

Signed-off-by: Victor Yanev <[email protected]>

chore: revert some changes in rpc_batch3.spec.ts

fbf7eae

Signed-off-by: Victor Yanev <[email protected]>

chore: add docs with examples to overrideEnvs and withOverriddenEnvs

03720d9

Signed-off-by: Victor Yanev <[email protected]>

victor-yanev requested a review from Nana-EC September 26, 2024 08:40

Nana-EC reviewed Sep 26, 2024

View reviewed changes

packages/relay/tests/helpers.ts Outdated Show resolved Hide resolved

victor-yanev added 3 commits September 27, 2024 13:26

chore: address comments

274155c

Signed-off-by: Victor Yanev <[email protected]>

Merge branch 'main' into add-helper-method-for-overriding-env-variables

57c80b8

Signed-off-by: Victor Yanev <[email protected]>

fix: build image test

62cda73

Signed-off-by: Victor Yanev <[email protected]>

victor-yanev requested a review from Nana-EC September 27, 2024 14:40

ebadiere modified the milestones: 0.57.0, 0.58.0 Sep 30, 2024

ebadiere reviewed Oct 4, 2024

View reviewed changes

victor-yanev added 5 commits October 7, 2024 14:06

chore: address comments + fix conflicts after merge

7f9c5e2

Signed-off-by: Victor Yanev <[email protected]>

chore: optimize TTL tests in localLRUCache.spec.ts

a07616d

Signed-off-by: Victor Yanev <[email protected]>

konstantinabl previously approved these changes Oct 10, 2024

View reviewed changes

fix: failing unit test after merge from main

90a1ad4

Signed-off-by: Victor Yanev <[email protected]>

victor-yanev dismissed konstantinabl’s stale review via 90a1ad4 October 11, 2024 13:47

chore: optimize imports after merge from main

358fff3

Signed-off-by: Victor Yanev <[email protected]>

victor-yanev requested review from ebadiere and konstantinabl October 11, 2024 13:51

natanasow approved these changes Oct 11, 2024

View reviewed changes

ebadiere approved these changes Oct 11, 2024

View reviewed changes

konstantinabl approved these changes Oct 11, 2024

View reviewed changes

victor-yanev merged commit 2e2fc07 into main Oct 11, 2024
42 of 43 checks passed

victor-yanev deleted the add-helper-method-for-overriding-env-variables branch October 11, 2024 14:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test: add helper method for overriding env variables #3022

test: add helper method for overriding env variables #3022

victor-yanev commented Sep 20, 2024 •

edited

Loading

github-actions bot commented Sep 20, 2024 •

edited

Loading

github-actions bot commented Sep 25, 2024 •

edited

Loading

Nana-EC left a comment

ebadiere left a comment

sonarcloud bot commented Oct 11, 2024

github-actions bot commented Oct 11, 2024

codecov bot commented Oct 11, 2024

test: add helper method for overriding env variables #3022

test: add helper method for overriding env variables #3022

Conversation

victor-yanev commented Sep 20, 2024 • edited Loading

github-actions bot commented Sep 20, 2024 • edited Loading

Acceptance Tests

github-actions bot commented Sep 25, 2024 • edited Loading

Tests

Nana-EC left a comment

Choose a reason for hiding this comment

ebadiere left a comment

Choose a reason for hiding this comment

sonarcloud bot commented Oct 11, 2024

Quality Gate failed

github-actions bot commented Oct 11, 2024

🚨 Memory Leak Detected 🚨

Details

Recommendations

codecov bot commented Oct 11, 2024

Codecov Report

victor-yanev commented Sep 20, 2024 •

edited

Loading

github-actions bot commented Sep 20, 2024 •

edited

Loading

github-actions bot commented Sep 25, 2024 •

edited

Loading