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

Jump to bottom

test: add helper method for overriding env variables #3022

Merged

victor-yanev merged 28 commits into main from add-helper-method-for-overriding-env-variables

Oct 11, 2024

Contributor

victor-yanev commented Sep 20, 2024 •

edited

Loading

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.)


          test: add helper method for overriding env variables

08731d1

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

victor-yanev added enhancement Technical Debt labels

victor-yanev self-assigned this

victor-yanev requested review from AlfredoG87, ebadiere, georgi-l95, Ivo-Yankov, a team and lukelee-sl as code owners

September 20, 2024 14:02

github-actions bot commented Sep 20, 2024 •

edited

Loading

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.


          chore: improve readability

7e74328

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

acuarica reviewed

View reviewed changes

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

acuarica reviewed

View reviewed changes

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


          fix: usages

c19d59a

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

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 <victor.yanev@limechain.tech>


          fix: utils.spec.ts

08dcd68

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>


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

030df8f

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>


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

fbbcec8

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>


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

00714c5

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>


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

4d97b99

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>


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

e771bac

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>


          fix: sdkClient.spec.ts

f2f25e4

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>


          fix: cacheService.spec.ts

ad61287

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>


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

7b2585c

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>


          fix: rateLimiter.spec.ts

f8f5034

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>


          fix: failing tests

5c76ef8

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

github-actions bot commented Sep 25, 2024 •

edited

Loading

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.


          chore: revert some changes in rpc_batch3.spec.ts

fbf7eae

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>


          chore: add docs with examples to overrideEnvs and withOverriddenEnvs

03720d9

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

victor-yanev requested a review from Nana-EC

September 26, 2024 08:40

Nana-EC reviewed

View reviewed changes

Collaborator

Nana-EC left a comment

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

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 <victor.yanev@limechain.tech>


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

57c80b8

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>


          fix: build image test

62cda73

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

victor-yanev requested a review from Nana-EC

September 27, 2024 14:40

ebadiere modified the milestones: 0.57.0, 0.58.0

ebadiere reviewed

View reviewed changes

Contributor

ebadiere left a comment

LG, but now there is a merge conflict.

victor-yanev added 5 commits

October 7, 2024 14:06


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

d1bc498

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

# 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


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

6c7e2c2

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

# Conflicts:
#	packages/relay/tests/lib/repositories/hbarLimiter/ethAddressHbarSpendingPlanRepository.spec.ts
#	packages/relay/tests/lib/repositories/hbarLimiter/hbarSpendingPlanRepository.spec.ts


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

de2f554

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

# Conflicts:
#	packages/relay/tests/lib/repositories/hbarLimiter/ethAddressHbarSpendingPlanRepository.spec.ts
#	packages/relay/tests/lib/repositories/hbarLimiter/hbarSpendingPlanRepository.spec.ts


          chore: address comments + fix conflicts after merge

7f9c5e2

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>


          chore: optimize TTL tests in localLRUCache.spec.ts

a07616d

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

konstantinabl previously approved these changes

View reviewed changes


          fix: failing unit test after merge from main

90a1ad4

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

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 <victor.yanev@limechain.tech>

sonarqubecloud bot commented Oct 11, 2024

Quality Gate failed

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

See analysis details on SonarCloud

victor-yanev requested review from ebadiere and konstantinabl

October 11, 2024 13:51

natanasow approved these changes

View reviewed changes

github-actions bot commented Oct 11, 2024

🚨 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.

ebadiere approved these changes

View reviewed changes

konstantinabl approved these changes

View reviewed changes

victor-yanev merged commit 2e2fc07 into main

42 of 43 checks passed

victor-yanev deleted the add-helper-method-for-overriding-env-variables branch

October 11, 2024 14:11

codecov bot commented Oct 11, 2024

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

konstantinabl pushed a commit that referenced this pull request


          test: add helper method for overriding env variables (#3022)

a4a8ed0

* test: add helper method for overriding env variables

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

* chore: improve readability

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

* fix: usages

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

* fix: cacheService.spec.ts

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

* fix: utils.spec.ts

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

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

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

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

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

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

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

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

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

* fix: sdkClient.spec.ts

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

* fix: cacheService.spec.ts

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

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

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

* fix: rateLimiter.spec.ts

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

* fix: failing tests

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

* chore: revert some changes in rpc_batch3.spec.ts

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

* fix: subscribe.spec.ts

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

* chore: add docs with examples to `overrideEnvs` and `withOverriddenEnvs`

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

* chore: address comments

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

* fix: build image test

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

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

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

* chore: address comments + fix conflicts after merge

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

* chore: optimize TTL tests in localLRUCache.spec.ts

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

* fix: failing unit test after merge from main

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

* chore: optimize imports after merge from main

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

---------

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

konstantinabl konstantinabl approved these changes

natanasow natanasow approved these changes

ebadiere ebadiere approved these changes

AlfredoG87 Awaiting requested review from AlfredoG87

georgi-l95 Awaiting requested review from georgi-l95 georgi-l95 is a code owner

Ivo-Yankov Awaiting requested review from Ivo-Yankov Ivo-Yankov is a code owner

lukelee-sl Awaiting requested review from lukelee-sl

acuarica Awaiting requested review from acuarica

Nana-EC Awaiting requested review from Nana-EC Nana-EC is a code owner

Labels

enhancement Technical Debt