-
Notifications
You must be signed in to change notification settings - Fork 87
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(docs): remove redirect to landing page & set latest alias to ma…
…in (#998)
- Loading branch information
1 parent
2c5c008
commit 7f01630
Showing
6 changed files
with
92 additions
and
103 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
File renamed without changes
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,82 @@ | ||
| <!-- markdownlint-disable MD041 (MD041=first-line-heading) --> | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta http-equiv="refresh" content="0; url=./getting_started/overview/" /> | ||
| <title>Redirecting...</title> | ||
| </head> | ||
| <body> | ||
| <p>If you are not redirected, <a href="./getting_started/overview/">click here</a>.</p> | ||
| </body> | ||
| </html> | ||
| # Execution Spec Tests | ||
|
|
||
| <figure markdown> <!-- markdownlint-disable MD033 (MD033=no-inline-html) --> | ||
| {width="400"} | ||
| </figure> | ||
|
|
||
| @ethereum/execution-spec-tests is both a collection of test cases and a framework in Python to generate tests for Ethereum execution clients implemented. | ||
|
|
||
| The framework collects and executes the test cases in order to generate _test fixtures_ (JSON) which can be consumed by any execution client to verify their implementation of [ethereum/execution-specs](https://github.com/ethereum/execution-specs). The fixtures, which define state transition and block tests, are generated by the framework using one of the `t8n` command-line tools that are provided by most execution clients, see below for an overview of the supported `t8n` tools. | ||
|
|
||
| ```mermaid | ||
| --- | ||
| title: Test Fixture Generation with execution-spec-tests | ||
| --- | ||
| flowchart LR | ||
| style C stroke:#333,stroke-width:2px | ||
| style D stroke:#333,stroke-width:2px | ||
| style G stroke:#F9A825,stroke-width:2px | ||
| style H stroke:#F9A825,stroke-width:2px | ||
| subgraph ethereum/go-ethereum | ||
| C[<code>evm t8n</code>\nexternal executable] | ||
| end | ||
| subgraph ethereum/solidity | ||
| D[<code>solc</code>\nexternal executable] | ||
| end | ||
| subgraph ethereum/EIPs | ||
| E(<code>EIPS/EIP-*.md</code>\nSHA digest via Github API) | ||
| end | ||
| subgraph "ethereum/execution-spec-tests" | ||
| A(<code>./tests/**/*.py</code>\nPython Test Cases) | ||
| B([<code>$ fill ./tests/</code>\nPython Framework]) | ||
| end | ||
| subgraph Test Fixture Consumers | ||
| subgraph ethereum/hive | ||
| G([<code>$ hive ...</code>\nGo Test Framework]) | ||
| end | ||
| H([Client executables]) | ||
| end | ||
| C <-.-> B | ||
| D <-.-> B | ||
| A --> B | ||
| E <-.-> |retrieve latest spec version\ncheck tested spec version| B | ||
| B -->|output| F(<code>./fixtures/**/*.json</code>\nJSON Test Fixtures) | ||
| F -->|input| G | ||
| F -->|input| H | ||
| ``` | ||
|
|
||
| The generated test fixtures can be used: | ||
|
|
||
| 1. Directly by client teams' test frameworks, and, | ||
| 2. In the integration tests executed in the @ethereum/hive framework. | ||
|
|
||
| More information on how to use and download the [released test fixtures](https://github.com/ethereum/execution-spec-tests/releases) can be found [here](consuming_tests/index.md). | ||
|
|
||
| ## Relationship to ethereum/tests | ||
|
|
||
| This collection of tests is relatively new (test case development started Q4, 2022) and mainly targets recent and upcoming Ethereum specification changes. It does not replace, but rather complements the existing tests in [ethereum/tests](https://github.com/ethereum/tests). | ||
|
|
||
| ## Motivation | ||
|
|
||
| The motivation to implement test cases in [ethereum/execution-spec-tests](https://github.com/ethereum/execution-spec-tests) is: | ||
|
|
||
| 1. To implement test cases as code and ensure that changes, due to spec changes, for example, can be easily made. Moreover, changes are easily understandable and available in version control. | ||
| 2. To avoid the 2-step approach often used in [ethereum/tests](https://github.com/ethereum/tests): | ||
| 1. Code (often unavailable) -> Test case (YAML). | ||
| 2. Test case (YAML) -> Fixtures (JSON). | ||
|
|
||
| !!! success "Contributing" | ||
| Contributions via [PR](https://github.com/ethereum/execution-spec-tests/pulls) are welcome! | ||
|
|
||
| !!! bug "Reporting a Vulnerability" | ||
|
|
||
| Care is required when adding PRs or issues for functionality that is live on Ethereum mainnet. Please report vulnerabilities and verify bounty eligibility via the [bug bounty program](https://bounty.ethereum.org). | ||
|
|
||
| - **Please do not create a PR with a vulnerability visible.** | ||
| - **Please do not file a public ticket mentioning the vulnerability.** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters