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

refactor(e2e): move addresses and private keys to config #2308

Merged
merged 9 commits into from
Jun 27, 2024

Conversation

gartnera
Copy link
Member

@gartnera gartnera commented Jun 3, 2024

Description

Move all localnet secrets to the e2e config file to allow easy randomization. I still need to finish the TODO items, but please take an initial look. Notes:

  • --config is now a required parameter to zetae2e. DefaultConfig() is no longer used for localnet e2e testing.
  • zetae2e init now generates keypairs

TODO:

  • move from hardcoded addresses in start-zetae2e.sh to loading from config file
  • move from hardcoded addresses in start-zetacored.sh to loading from config file

Closes #2238

Relates to DEVOP-642

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

Copy link

gitguardian bot commented Jun 3, 2024

⚠️ GitGuardian has uncovered 16 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request
GitGuardian id GitGuardian status Secret Commit Filename
11033143 Triggered Generic High Entropy Secret ead440e cmd/zetae2e/config/localnet.yml View secret
11033143 Triggered Generic High Entropy Secret ead440e cmd/zetae2e/config/local.yml View secret
11033143 Triggered Generic High Entropy Secret 24ce481 cmd/zetae2e/config/local.yml View secret
11033143 Triggered Generic High Entropy Secret a371762 cmd/zetae2e/local/accounts.go View secret
11033143 Triggered Generic High Entropy Secret ead440e cmd/zetae2e/config/localnet.yml View secret
11033143 Triggered Generic High Entropy Secret ead440e cmd/zetae2e/config/local.yml View secret
11033143 Triggered Generic High Entropy Secret 24ce481 cmd/zetae2e/config/localnet.yml View secret
11033144 Triggered Generic High Entropy Secret a371762 cmd/zetae2e/local/accounts.go View secret
11033144 Triggered Generic High Entropy Secret 24ce481 cmd/zetae2e/config/localnet.yml View secret
11033145 Triggered Generic High Entropy Secret a371762 cmd/zetae2e/local/accounts.go View secret
11033145 Triggered Generic High Entropy Secret 24ce481 cmd/zetae2e/config/localnet.yml View secret
11033146 Triggered Generic High Entropy Secret a371762 cmd/zetae2e/local/accounts.go View secret
11033146 Triggered Generic High Entropy Secret 24ce481 cmd/zetae2e/config/localnet.yml View secret
11478175 Triggered Generic High Entropy Secret 24ce481 cmd/zetae2e/config/localnet.yml View secret
11478176 Triggered Generic High Entropy Secret 24ce481 cmd/zetae2e/config/localnet.yml View secret
11759679 Triggered Generic High Entropy Secret a371762 cmd/zetae2e/local/accounts.go View secret
🛠 Guidelines to remediate hardcoded secrets
  1. Understand the implications of revoking this secret by investigating where it is used in your code.
  2. Replace and store your secret safely. Learn here the best practices.
  3. Revoke and rotate this secret.
  4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider


🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Copy link

github-actions bot commented Jun 3, 2024

!!!WARNING!!!
nosec detected in the following files: cmd/zetae2e/stress.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 Jun 3, 2024
@gartnera gartnera added the no-changelog Skip changelog CI check label Jun 3, 2024
Copy link

codecov bot commented Jun 3, 2024

Codecov Report

Attention: Patch coverage is 40.00000% with 63 lines in your changes missing coverage. Please review.

Project coverage is 69.10%. Comparing base (47d835a) to head (e769d2b).

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##           develop    #2308      +/-   ##
===========================================
- Coverage    69.45%   69.10%   -0.35%     
===========================================
  Files          307      308       +1     
  Lines        19056    19221     +165     
===========================================
+ Hits         13235    13283      +48     
- Misses        5166     5267     +101     
- Partials       655      671      +16     
Files Coverage Δ
e2e/config/config.go 29.09% <40.00%> (ø)

@gartnera gartnera marked this pull request as ready for review June 3, 2024 21:52
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.

On #2238

We want to use the zetae2e local command to initialize/test the devnet?
It might make sense to rename local into dev or something similar then IMO

e2e/config/config.go Outdated Show resolved Hide resolved
e2e/config/config.go Outdated Show resolved Hide resolved
cmd/zetae2e/config/localnet.yml Outdated Show resolved Hide resolved
@lumtis
Copy link
Member

lumtis commented Jun 6, 2024

Is this one ready for re-review @gartnera ?

@gartnera gartnera marked this pull request as draft June 17, 2024 23:17
@gartnera gartnera force-pushed the refactor-e2e-secrets branch from 41aff9f to 50acbd1 Compare June 18, 2024 17:37
@gartnera gartnera force-pushed the refactor-e2e-secrets branch from 985fd33 to 88b3e0c Compare June 25, 2024 18:40
Copy link
Contributor

coderabbitai bot commented Jun 25, 2024

Important

Review skipped

Review was skipped due to path filters

Files ignored due to path filters (58)
  • Dockerfile-localnet is excluded by none and included by none
  • cmd/zetae2e/README.md is excluded by none and included by none
  • cmd/zetae2e/balances.go is excluded by none and included by none
  • cmd/zetae2e/bitcoin_address.go is excluded by none and included by none
  • cmd/zetae2e/config/clients.go is excluded by none and included by none
  • cmd/zetae2e/config/config.go is excluded by none and included by none
  • cmd/zetae2e/config/config_test.go is excluded by none and included by none
  • cmd/zetae2e/config/contracts.go is excluded by none and included by none
  • cmd/zetae2e/config/example.yml is excluded by none and included by none
  • cmd/zetae2e/config/local.yml is excluded by none and included by none
  • cmd/zetae2e/config/localnet.yml is excluded by none and included by none
  • cmd/zetae2e/init.go is excluded by none and included by none
  • cmd/zetae2e/local/accounts.go is excluded by none and included by none
  • cmd/zetae2e/local/admin.go is excluded by none and included by none
  • cmd/zetae2e/local/bitcoin.go is excluded by none and included by none
  • cmd/zetae2e/local/config.go is excluded by none and included by none
  • cmd/zetae2e/local/erc20.go is excluded by none and included by none
  • cmd/zetae2e/local/ethereum.go is excluded by none and included by none
  • cmd/zetae2e/local/local.go is excluded by none and included by none
  • cmd/zetae2e/local/misc.go is excluded by none and included by none
  • cmd/zetae2e/local/performance.go is excluded by none and included by none
  • cmd/zetae2e/local/test_runner.go is excluded by none and included by none
  • cmd/zetae2e/local/zeta.go is excluded by none and included by none
  • cmd/zetae2e/local/zevm_mp.go is excluded by none and included by none
  • cmd/zetae2e/run.go is excluded by none and included by none
  • cmd/zetae2e/setup_bitcoin.go is excluded by none and included by none
  • cmd/zetae2e/show_tss.go is excluded by none and included by none
  • cmd/zetae2e/stress.go is excluded by none and included by none
  • contrib/localnet/orchestrator/Dockerfile.fastbuild is excluded by none and included by none
  • contrib/localnet/orchestrator/start-zetae2e.sh is excluded by none and included by none
  • contrib/localnet/scripts/start-zetacored.sh is excluded by none and included by none
  • e2e/config/config.go is excluded by none and included by none
  • e2e/config/config_test.go is excluded by none and included by none
  • e2e/e2etests/test_context_upgrade.go is excluded by none and included by none
  • e2e/e2etests/test_crosschain_swap.go is excluded by none and included by none
  • e2e/e2etests/test_erc20_deposit.go is excluded by none and included by none
  • e2e/e2etests/test_erc20_deposit_refund.go is excluded by none and included by none
  • e2e/e2etests/test_erc20_multiple_deposits.go is excluded by none and included by none
  • e2e/e2etests/test_erc20_multiple_withdraws.go is excluded by none and included by none
  • e2e/e2etests/test_eth_deposit_call.go is excluded by none and included by none
  • e2e/e2etests/test_eth_deposit_liquidity_cap.go is excluded by none and included by none
  • e2e/e2etests/test_eth_deposit_refund.go is excluded by none and included by none
  • e2e/e2etests/test_message_passing_external_chains.go is excluded by none and included by none
  • e2e/e2etests/test_message_passing_external_chains_revert_fail.go is excluded by none and included by none
  • e2e/e2etests/test_migrate_chain_support.go is excluded by none and included by none
  • e2e/e2etests/test_rate_limiter.go is excluded by none and included by none
  • e2e/e2etests/test_stress_eth_withdraw.go is excluded by none and included by none
  • e2e/e2etests/test_update_bytecode_zrc20.go is excluded by none and included by none
  • e2e/e2etests/test_zeta_deposit.go is excluded by none and included by none
  • e2e/e2etests/test_zeta_withdraw_bitcoin_revert.go is excluded by none and included by none
  • e2e/e2etests/test_zrc20_swap.go is excluded by none and included by none
  • e2e/runner/balances.go is excluded by none and included by none
  • e2e/runner/bitcoin.go is excluded by none and included by none
  • e2e/runner/evm.go is excluded by none and included by none
  • e2e/runner/runner.go is excluded by none and included by none
  • e2e/runner/setup_bitcoin.go is excluded by none and included by none
  • e2e/runner/setup_evm.go is excluded by none and included by none
  • e2e/runner/zeta.go is excluded by none and included by none

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


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

@gartnera gartnera marked this pull request as ready for review June 25, 2024 19:14
@gartnera gartnera requested a review from swift1337 as a code owner June 25, 2024 19:14
@gartnera gartnera requested a review from lumtis June 25, 2024 19:14
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.

We might want to introduce a ignore file for GitGuardian if possible

e2e/config/config.go Outdated Show resolved Hide resolved
@gartnera gartnera force-pushed the refactor-e2e-secrets branch from 096a7f4 to ead440e Compare June 26, 2024 21:51
e2e/config/config.go Outdated Show resolved Hide resolved
@gartnera gartnera merged commit 98c63b9 into develop Jun 27, 2024
17 of 19 checks passed
@gartnera gartnera deleted the refactor-e2e-secrets branch June 27, 2024 16:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow randomizing localnet secrets
3 participants