Skip to content
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.

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

test: fix and unit tests for query pending cctx within rate limit #2060

Merged
merged 41 commits into from
May 2, 2024

Conversation

ws4charlie
Copy link
Contributor

@ws4charlie ws4charlie commented Apr 20, 2024

Description

Add unit tests for outbound rate limiter

Done:

  • fix cctx amount conversion logic and added unit tests
  • added unit tests for grpc query
  • added total value in rate limiter window so zetaclient can print it out for monitoring
  • a few improvement

Closes: #2061

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Include instructions and any relevant details so others can reproduce.

  • Tested CCTX in localnet
  • Tested in development environment
  • Go unit tests
  • Go integration tests
  • Tested via GitHub Actions

Checklist:

  • I have added unit tests that prove my fix feature works

@ws4charlie ws4charlie marked this pull request as draft April 20, 2024 05:57
Copy link

github-actions bot commented Apr 20, 2024

!!!WARNING!!!
nosec detected in the following files: x/crosschain/keeper/grpc_query_cctx_rate_limit.go, x/crosschain/keeper/grpc_query_cctx_rate_limit_test.go

Be very careful about using #nosec in code. It can be a quick way to suppress security warnings and move forward with development, it should be employed with caution. Suppressing warnings with #nosec can hide potentially serious vulnerabilities. Only use #nosec when you're absolutely certain that the security issue is either a false positive or has been mitigated in another way.

Only suppress a single rule (or a specific set of rules) within a section of code, while continuing to scan for other problems. To do this, you can list the rule(s) to be suppressed within the #nosec annotation, e.g: /* #nosec G401 */ or //#nosec G201 G202 G203
Broad #nosec annotations should be avoided, as they can hide other vulnerabilities. The CI will block you from merging this PR until you remove #nosec annotations that do not target specific rules.

Pay extra attention to the way #nosec is being used in the files listed above.

@github-actions github-actions bot added the nosec label Apr 20, 2024
@ws4charlie ws4charlie marked this pull request as ready for review April 20, 2024 18:37
@ws4charlie ws4charlie changed the title test: unit tests for outbound rate limiter test: fix and unit tests for query pending cctx within rate limit Apr 20, 2024
@ws4charlie ws4charlie changed the base branch from develop to v16.0.0-rc April 22, 2024 22:23
Copy link
Member

@lumtis lumtis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tests look much more visual now!
I think this is fine for the test cases we currently have but I would suggest for future ones, using Zeta for CCTX as you can directly represent the amount of the CCTX.
The conversion logic is already tested in other tests.

In the core logic you want to test the rate limiter functionality. It is easier to represent with something like
rate: 1000
cctxs: [{type: zeta, amount: 500}, ...]

x/crosschain/keeper/grpc_query_cctx_rate_limit.go Outdated Show resolved Hide resolved
x/crosschain/keeper/grpc_query_cctx_rate_limit_test.go Outdated Show resolved Hide resolved
x/crosschain/keeper/grpc_query_cctx_rate_limit_test.go Outdated Show resolved Hide resolved
x/crosschain/keeper/grpc_query_cctx_rate_limit_test.go Outdated Show resolved Hide resolved
x/crosschain/keeper/grpc_query_cctx_rate_limit_test.go Outdated Show resolved Hide resolved
x/fungible/keeper/foreign_coins.go Show resolved Hide resolved
x/fungible/keeper/foreign_coins.go Show resolved Hide resolved
Copy link
Member

@lumtis lumtis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ws4charlie we need to change the logic to use smaller unit unit like azeta.
I made the change here for ZETA: #2063
This is why the unit tests are failing
We need to do the same with gas and ZRC20

@ws4charlie
Copy link
Contributor Author

@ws4charlie we need to change the logic to use smaller unit unit like azeta. I made the change here for ZETA: #2063 This is why the unit tests are failing We need to do the same with gas and ZRC20

Thie was just resolved in c011900

lumtis and others added 2 commits April 29, 2024 19:52
* add skip header option

* use option for migration test

* move bitcoin addresses tests to advanced

* show cctx in logs

* update version

* fix verification flags error
* refactor and create Withdraw ZETA general function

* new rate limiter test

* use rate limiter for admin test

* fix the test: single approval and add liquidity

* make generate

* fix liquidity

* fix uniswap pool

* change localnet chain params

* fix lint

* add cli query

* add nil check

* fix nil point

* modify tests

* eliminate nil pending nonce issue

* fix query

* set flags

* Update e2e/runner/evm.go

Co-authored-by: Charlie Chen <[email protected]>

* add back other advanced tests

* make generate

* add comment

* fix eth liquidity cap test

* fix withdraw count

---------

Co-authored-by: Charlie Chen <[email protected]>
Co-authored-by: Charlie Chen <[email protected]>
@lumtis lumtis changed the base branch from v16.0.0-rc to release/v16 April 30, 2024 11:21
Copy link
Member

@lumtis lumtis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lumtis lumtis mentioned this pull request May 2, 2024
Copy link
Contributor

@kingpinXD kingpinXD left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm , the test look complete

@lumtis lumtis merged commit 07e3a17 into release/v16 May 2, 2024
10 checks passed
@lumtis lumtis deleted the unit-test-rate-limit branch May 2, 2024 17:43
ws4charlie added a commit that referenced this pull request May 2, 2024
* refactor: allow zeta deposits to new zevm address (#2076)

* allow zevm coin deposit to unknow addresses

* add e2e tests

* add changelog

* add comments

* test(e2e): fix local e2e upgrade test (#2099)

* add skip header option

* use option for migration test

* move bitcoin addresses tests to advanced

* show cctx in logs

* update version

* fix verification flags error

* update version in changelog

* test: fix and unit tests for query pending cctx within rate limit (#2060)

* initial commit of grpc pending cctx query with rate limiter

* replace big.Float with sdk.Dec and update mock rate limiter flags

* split big loop into backwards loop and forwards loop to be more accurate

* adjust zetaclient code to query pending cctx with rate limit

* update change log and add one more rate limiter flag test

* use outboun amount for calculation

* some minimum code refactor

* created separate file for cctx query with rate limit

* improved a few error handlling

* use old cctx query as fallback when rate limiter is disabled; some renaming

* fixed unit test compile

* added unit test for fallback query

* added unit tests for cctx value conversion

* add changelog entry

* added unit tests for query pending cctxs within rate limit

* added total value in rate limiter window for monitoring purpose

* Update x/crosschain/keeper/grpc_query_cctx_rate_limit.go

Co-authored-by: Lucas Bertrand <[email protected]>

* change variable name fCoin to foreignCoin

* Update x/fungible/keeper/foreign_coins.go

Co-authored-by: Lucas Bertrand <[email protected]>

* Update x/crosschain/keeper/grpc_query_cctx_rate_limit_test.go

Co-authored-by: Lucas Bertrand <[email protected]>

* converted rate limiter query unit tests to table test

* handle edge case when pending cctxs span wider block range than sliding window

* added zero rate check; added comment to make unit test clearer

* added unit test and note for method GetAllForeignCoinMap

* treat Rate as average block rate; stop outbound when current rate limit exceeds Rate; updated metrics

* add commented unit tests back

* replace sdk.Dec with sdkmath.Int to represent cctx value in azeta

* test: disable header proof test in local upgrade test E2E test (#2051)

* add skip header option

* use option for migration test

* move bitcoin addresses tests to advanced

* show cctx in logs

* update version

* fix verification flags error

* test(e2e): add rate limiter admin E2E test (#2063)

* refactor and create Withdraw ZETA general function

* new rate limiter test

* use rate limiter for admin test

* fix the test: single approval and add liquidity

* make generate

* fix liquidity

* fix uniswap pool

* change localnet chain params

* fix lint

* add cli query

* add nil check

* fix nil point

* modify tests

* eliminate nil pending nonce issue

* fix query

* set flags

* Update e2e/runner/evm.go

Co-authored-by: Charlie Chen <[email protected]>

* add back other advanced tests

* make generate

* add comment

* fix eth liquidity cap test

* fix withdraw count

---------

Co-authored-by: Charlie Chen <[email protected]>
Co-authored-by: Charlie Chen <[email protected]>

* removed incorrect Note

* improved variable name

* add E2E test for rate limiter gas and erc20

* remove outdated comment

---------

Co-authored-by: Lucas Bertrand <[email protected]>

* more conflict resolution

---------

Co-authored-by: Tanmay <[email protected]>
Co-authored-by: Lucas Bertrand <[email protected]>
Co-authored-by: Alex Gartner <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Use table driven tests for rate limiter query Rate limiter unit tests
4 participants