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: add wait for block to tss migration test #2931

Merged
merged 5 commits into from
Sep 30, 2024
Merged

Conversation

kingpinXD
Copy link
Contributor

@kingpinXD kingpinXD commented Sep 27, 2024

Description

The change might improve the success frequency of the TSS-migration-test on the CI .

The pr adds a loop to make sure the new TSS is set before trying to migrate funds.

How Has This Been Tested?

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

Summary by CodeRabbit

  • New Features

    • Enhanced TSS generation monitoring capabilities in the end-to-end testing framework.
    • Introduced methods to ensure TSS generation is completed before proceeding with Bitcoin fund migration.
  • Bug Fixes

    • Improved error handling for TSS generation discrepancies.

Copy link
Contributor

coderabbitai bot commented Sep 27, 2024

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces enhancements to the end-to-end testing framework by adding functionality to wait for TSS (Threshold Signature Scheme) generation before executing migration logic. Specifically, it modifies the TestMigrateTSS function to include a wait for TSS generation and introduces two new methods in the E2ERunner struct to facilitate this wait. These changes aim to improve the reliability of TSS-related operations during migration processes.

Changes

File Path Change Summary
e2e/e2etests/test_migrate_tss.go Added a call to r.WaitForTssGeneration(2) in the TestMigrateTSS function to ensure TSS generation completes before migration.
e2e/runner/zeta.go Introduced two methods in E2ERunner: WaitForTssGeneration(n int64) for waiting on TSS generations and waitForTssGeneration(n int64) for checking TSS history. Also added comments for clarity.

Possibly related PRs

Suggested labels

E2E

Suggested reviewers

  • lumtis
  • fbac
  • swift1337
  • brewmaster012
  • ws4charlie
  • skosito

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@kingpinXD kingpinXD added the no-changelog Skip changelog CI check label Sep 27, 2024
@kingpinXD kingpinXD added the TSS_MIGRATION_TESTS Run TSS migration tests label Sep 27, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 4

🧹 Outside diff range and nitpick comments (2)
e2e/e2etests/test_migrate_tss.go (1)

51-51: Approve: Addition of TSS generation wait improves test reliability.

The introduction of r.WaitForTssGeneration(2) before the Bitcoin fund migration is a prudent enhancement. It aligns with the PR objective to improve the success rate of the TSS-migration CI test by ensuring TSS generation is complete before proceeding.

To improve code clarity, consider adding a brief comment explaining the purpose of the wait and the significance of the argument '2'. For example:

// Wait for TSS generation to complete (max 2 attempts) before migrating funds
r.WaitForTssGeneration(2)
e2e/runner/zeta.go (1)

44-45: Define backoff parameters as constants

For better configurability and readability, consider defining the backoff duration and maximum retries as constants or configurable variables.

Apply this diff:

+	const backoffInterval = time.Second * 5
+	const maxRetries = 10

-	bo := backoff.NewConstantBackOff(time.Second * 5)
-	boWithMaxRetries := backoff.WithMaxRetries(bo, 10)
+	bo := backoff.NewConstantBackOff(backoffInterval)
+	boWithMaxRetries := backoff.WithMaxRetries(bo, maxRetries)
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 2892114 and 773a4bf.

📒 Files selected for processing (2)
  • e2e/e2etests/test_migrate_tss.go (1 hunks)
  • e2e/runner/zeta.go (3 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
e2e/e2etests/test_migrate_tss.go (1)

Pattern **/*.go: Review the Go code, point out issues relative to principles of clean code, expressiveness, and performance.

e2e/runner/zeta.go (1)

Pattern **/*.go: Review the Go code, point out issues relative to principles of clean code, expressiveness, and performance.

🔇 Additional comments (1)
e2e/runner/zeta.go (1)

12-12: Import observertypes package

The import of observertypes is necessary for accessing TSS history and is appropriately added.

e2e/e2etests/test_migrate_tss.go Outdated Show resolved Hide resolved
e2e/runner/zeta.go Outdated Show resolved Hide resolved
e2e/runner/zeta.go Outdated Show resolved Hide resolved
e2e/runner/zeta.go Outdated Show resolved Hide resolved
e2e/runner/zeta.go Show resolved Hide resolved
e2e/runner/zeta.go Outdated Show resolved Hide resolved
e2e/runner/zeta.go Outdated Show resolved Hide resolved
e2e/runner/zeta.go Outdated Show resolved Hide resolved
Copy link

codecov bot commented Sep 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 66.39%. Comparing base (03435b4) to head (53eb719).
Report is 2 commits behind head on develop.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #2931   +/-   ##
========================================
  Coverage    66.39%   66.39%           
========================================
  Files          389      389           
  Lines        21758    21758           
========================================
  Hits         14447    14447           
  Misses        6584     6584           
  Partials       727      727           

@kingpinXD kingpinXD requested a review from lumtis September 28, 2024 06:10
e2e/runner/zeta.go Outdated Show resolved Hide resolved
@kingpinXD kingpinXD requested a review from lumtis September 30, 2024 09:36
@kingpinXD kingpinXD enabled auto-merge September 30, 2024 09:45
@kingpinXD kingpinXD added this pull request to the merge queue Sep 30, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Sep 30, 2024
@kingpinXD kingpinXD added this pull request to the merge queue Sep 30, 2024
Merged via the queue into develop with commit ebd42f9 Sep 30, 2024
32 checks passed
@kingpinXD kingpinXD deleted the e2e-test-fixes branch September 30, 2024 13:57
morde08 pushed a commit that referenced this pull request Oct 2, 2024
* add wait for block to tss migration test

* add comments

* refactor identifiers

* rename checkNumberOfTssGenerated to checkNumberOfTSSGenerated
github-merge-queue bot pushed a commit that referenced this pull request Oct 3, 2024
…guration (#2953)

* update artillery config

* more fixes

* feat: integrate authenticated calls smart contract functionality into protocol (#2904)

* e2e tests and modifications for authenticated call

* extend test with sender check and revert case

* separate tests into separate files

* cleanup

* withdraw and call support and tests

* bump protocol contracts

* split tests into separate files

* small cleanup

* fmt

* generate

* lint

* changelog

* PR  comments

* fix case in proto

* bump vote inbound gas limit in zetaclient

* fix test

* generate

* fixing tests

* call options non empty

* generate

* test fix

* rename gateway caller

* pr comments rename tests

* PR comment

* generate

* tests

* update tests fixes

* tests fixes

* fix

* test fix

* feat!: bank precompile (#2860)

* feat: bank precompile

* feat: add deposit

* feat: extend deposit

* PoC: spend amount on behalf of EOA

* feat: expand deposit with transferFrom

* use CallEVM instead on ZRC20 bindings

* divide the contract into different files

* initialize e2e testing

* remove duplicated funding

* add codecov

* expand e2e

* fix: wait for deposit tx to be mined

* apply first round of reviews

* cover al error types test

* fixes using time.Since

* Include CallContract interface

* fix eth events in deposit precompile method

* emit Deposit event

* add withdraw function

* finalize withdraw

* pack event arguments generically

* add high level event function

* first round of review fixes

* second round of reviews

* create bank account when instantiating bank

* e2e: add good and bad scenarios

* modify fmt

* chore: group input into eventData struct

* docs: document bank's methods

* chore: generate files with suffix .gen.go

* chore: assert errors with errorIs

* chore: reset e2e test by resetting allowance

* test: add first batch of unit test

* test: cover all cases

* test: complete unit test cases

* include review suggestions

* include e2e through contract

* test: add e2e through contract complete

* test: revert balance between tests

* Update precompiles/bank/const.go

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

* fix: changed coin denom

---------

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

* feat: add sender to revert context (#2919)

* e2e tests and modifications for authenticated call

* extend test with sender check and revert case

* separate tests into separate files

* cleanup

* withdraw and call support and tests

* bump protocol contracts

* split tests into separate files

* small cleanup

* fmt

* generate

* lint

* changelog

* PR  comments

* fix case in proto

* bump vote inbound gas limit in zetaclient

* fix test

* generate

* fixing tests

* call options non empty

* generate

* test fix

* rename gateway caller

* pr comments rename tests

* PR comment

* generate

* tests

* add sender in test contract

* extend e2e tests

* generate

* changelog

* PR comment

* generate

* update tests fixes

* tests fixes

* fix

* test fix

* gas limit fixes

* PR comment fix

* fix bad merge

* ci: add option to enable monitoring stack (#2927)

* ci: add option to enable monitoring stack

* start prometheus faster

* update

* ci: add rpcimportable test (#2817)

* ci: add rpcimportable test

* add ci

* fmt

* use github.com/btcsuite/btcd/btcutil in pkg/chains

* remove app imports types tests

* use standalone sdkconfig package

* fix policies test

* move crosschain keeper tests from types to keeper

* never seal config in tests

* use zeta-chain/ethermint#126

* add some comments

* use merged ethermint hash

* show resulting go.mod

* ci: Add SARIF upload to GitHub Security Dashboard (#2929)

* add semgrep sarif upload to GHAS

* added comment to clairfy the usage of the utility script

* use ghcr.io instead

* add tag to image

* bad org name

---------

Co-authored-by: jkan2 <[email protected]>

* fix: add recover to InitChainer to diplay informative message when starting a node from block 1 (#2925)

* add recover to InitChainer

* generate files

* add docs link to error message

* move InitChainErrorMessage to app.go

* Update app/app.go

Co-authored-by: Francisco de Borja Aranda Castillejo <[email protected]>

* use const for message

---------

Co-authored-by: Francisco de Borja Aranda Castillejo <[email protected]>

* test: add wait for block to tss migration test (#2931)

* add wait for block to tss migration test

* add comments

* refactor identifiers

* rename checkNumberOfTssGenerated to checkNumberOfTSSGenerated

* chore: allow full zetaclient config overlay (#2945)

* test(e2e): add gateway upgrade in upgrade test (#2932)

* add gateway upgrade

* change reference

* add v2 setup for all tests

* test v2 in light upgrade

* refactor setup to use custody v2 directly

* chore: improve localnet build performance (#2928)

* chore: improve localnet build performance

* propagate NODE_VERSION and NODE_COMMIT

* update hashes

---------

Co-authored-by: skosito <[email protected]>
Co-authored-by: Francisco de Borja Aranda Castillejo <[email protected]>
Co-authored-by: Lucas Bertrand <[email protected]>
Co-authored-by: Alex Gartner <[email protected]>
Co-authored-by: jkan2 <[email protected]>
Co-authored-by: jkan2 <[email protected]>
Co-authored-by: Tanmay <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog Skip changelog CI check TSS_MIGRATION_TESTS Run TSS migration tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants