docs: add a guide for E2E tests to run #3285
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 Walkthrough📝 Walkthrough📝 WalkthroughWalkthroughThe changes in this pull request introduce a comprehensive new section in the Changes
Possibly related PRs
Suggested labels
Suggested reviewers
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (6)
e2e/TESTING_GUIDE.md (6)
1-5: Enhance introduction clarity and fix punctuationThe introduction requires minor refinements:
-# Regular E2E tests +# Regular E2E Tests -This page lists the regular E2E tests to run when testing the network, in case of upgrade, etc.. -These snippets are aimed to be copy-pasted in the input in the E2E CI tool. +This guide outlines the standard E2E tests required for network validation, upgrades, and maintenance. +All commands provided can be directly copy-pasted into the E2E CI tool's input field.🧰 Tools
🪛 LanguageTool
[typographical] ~3-~3: Two consecutive dots
Context: ...ing the network, in case of upgrade, etc.. These snippets are aimed to be copy-pas...(DOUBLE_PUNCTUATION)
12-92: Add language specifications to code blocksFor improved readability and proper syntax highlighting, specify the language for all code blocks.
Example format:
-``` +```shell eth_deposit:100000000000000 eth_withdraw:100000000000000Please apply this change to all code blocks in the document. <details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary> [style] ~18-~18: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. Context: ...0000 ``` ## ERC20 observation When we want to verify the network correctly observe cr... (REP_WANT_TO_VB) --- [style] ~28-~28: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. Context: ...``` ## Gateway basic workflow When we want to verify the gateway basic workflow, the ... (REP_WANT_TO_VB) --- [style] ~46-~46: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. Context: ...`` ## Gateway revert workflow When we want to verify the gateway revert workflow, the... (REP_WANT_TO_VB) </details> <details> <summary>🪛 Markdownlint (0.37.0)</summary> 12-12: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 22-22: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 32-32: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 40-40: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 52-52: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 64-64: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 70-70: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 76-76: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 82-82: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 90-90: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </details> </details> --- `10-11`: **Standardize amount documentation and highlight critical information** The documentation of amounts needs standardization and better visibility of critical information. ```diff -The amount provided represent `0.0001` unit for coin with 18 decimals. +The amounts are specified as follows: +- Standard transactions: `0.0001` units (for tokens with 18 decimals) +- ERC20 transactions: Small values compatible with various decimal configurations + +> **Important**: The required amounts for `depositAndCall` operations vary by network due to gas prices. +> Values provided are estimates and may need adjustment based on current network conditions.Also applies to: 20-21, 58-61
62-84: Add versioning information for network-specific valuesThe network-specific amounts need versioning context for maintenance.
Consider adding:
- Last updated timestamp for each network's values
- Reference to where these values are maintained/updated
- Process for updating these values when gas prices change significantly
Example format:
### Ethereum Network > Last updated: December 2024 > Reference: [link to gas price calculation document] Required amounts: - ETH operations: `0.0007 ETH` - USDC operations: `3 USDC`🧰 Tools
🪛 Markdownlint (0.37.0)
64-64: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
70-70: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
76-76: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
82-82: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
86-92: Enhance visibility of experimental feature warningThe experimental nature of arbitrary calls should be more prominently displayed.
-## Gateway arbitrary calls +## Gateway Arbitrary Calls (Experimental) -Arbitrary calls feature is an experimental and niche use case for now, these tests are not necessary for regular testing. +> ⚠️ **Warning**: The arbitrary calls feature is experimental and should not be used in production environments. +> These tests are optional and not required for standard network validation.🧰 Tools
🪛 Markdownlint (0.37.0)
90-90: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
1-92: Enhance document navigation and structureConsider adding:
- Table of contents at the beginning
- Cross-references between related sections
- Quick reference table summarizing all test commands
Example TOC:
# Table of Contents 1. [Introduction](#introduction) 2. [Basic Operations](#basic-operations) - [Inbounds and Outbounds](#inbounds-and-outbounds) - [ERC20 Operations](#erc20-operations) 3. [Gateway Operations](#gateway-operations) - [Basic Workflow](#gateway-basic-workflow) - [Revert Workflow](#gateway-revert-workflow) 4. [Network-Specific Configurations](#network-specific-configurations) 5. [Experimental Features](#experimental-features)🧰 Tools
🪛 LanguageTool
[typographical] ~3-~3: Two consecutive dots
Context: ...ing the network, in case of upgrade, etc.. These snippets are aimed to be copy-pas...(DOUBLE_PUNCTUATION)
[style] ~18-~18: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...0000 ``` ## ERC20 observation When we want to verify the network correctly observe cr...(REP_WANT_TO_VB)
[style] ~28-~28: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...``` ## Gateway basic workflow When we want to verify the gateway basic workflow, the ...(REP_WANT_TO_VB)
[style] ~46-~46: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...`` ## Gateway revert workflow When we want to verify the gateway revert workflow, the...(REP_WANT_TO_VB)
🪛 Markdownlint (0.37.0)
12-12: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
22-22: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
32-32: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
40-40: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
52-52: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
64-64: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
70-70: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
76-76: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
82-82: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
90-90: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
e2e/TESTING_GUIDE.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
e2e/TESTING_GUIDE.md
[typographical] ~3-~3: Two consecutive dots
Context: ...ing the network, in case of upgrade, etc.. These snippets are aimed to be copy-pas...
(DOUBLE_PUNCTUATION)
[style] ~18-~18: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...0000 ``` ## ERC20 observation When we want to verify the network correctly observe cr...
(REP_WANT_TO_VB)
[style] ~28-~28: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...``` ## Gateway basic workflow When we want to verify the gateway basic workflow, the ...
(REP_WANT_TO_VB)
[style] ~46-~46: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...`` ## Gateway revert workflow When we want to verify the gateway revert workflow, the...
(REP_WANT_TO_VB)
🪛 Markdownlint (0.37.0)
e2e/TESTING_GUIDE.md
12-12: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
22-22: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
32-32: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
40-40: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
52-52: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
64-64: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
70-70: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
76-76: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
82-82: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
90-90: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
Description
List the regular tests to run depending on the workflow to test.
This page is aimed to be linked to the playbooks and the CI tool instruction,
Summary by CodeRabbit