diff --git a/docs/getting_started/repository_overview.md b/docs/getting_started/repository_overview.md index 669a464707..ff08e51f13 100644 --- a/docs/getting_started/repository_overview.md +++ b/docs/getting_started/repository_overview.md @@ -4,43 +4,43 @@ The most relevant folders and files in the repo are: ```text -📁 execution-test-specs/ -├─╴📁 tests/ # test cases -│ ├── 📁 eips/ -│ ├── 📁 vm/ +📁 execution-specs/ +├─╴📁 tests/ # test cases organized by fork +│ ├── 📁 amsterdam/ +│ ├── 📁 osaka/ +│ ├── 📁 prague/ │ └── 📁 ... ├─╴📁 fixtures/ # default fixture output dir │ ├── 📁 blockchain_tests/ │ ├── 📁 blockchain_tests_engine/ │ ├── 📁 state_tests/ │ └── 📁 ... -├─╴📁 src/ # library & framework packages -│ ├── 📁 ethereum_test_fork/ -│ ├── 📁 ethereum_test_tools/ +├─╴📁 packages/ # library & framework packages +│ └── 📁 testing/ +│ └── 📁 src/ +│ └── 📁 execution_testing/ +├─╴📁 src/ # execution spec packages +│ ├── 📁 ethereum/ │ └── 📁 ... ├─╴📁 docs/ # markdown documentation -│ ├── 📁 getting_started -│ ├── 📁 dev +│ ├── 📁 getting_started/ +│ ├── 📁 dev/ │ └── 📁 ... -├─╴📁 .vscode/ # visual studio code config -│ ├── 📄 settings.recommended.json # copy to settings.json -│ ├── 📄 launch.recommended.json -│ └── 📄 extensions.json └── 📄 whitelist.txt # spellcheck dictionary ``` #### `tests/` -Contains the implementation of the Ethereum consensus tests available in this repository. +Contains the implementation of the Ethereum consensus tests available in this repository, organized by fork. + +#### `packages/` + +Contains the `execution_testing` package which provides tools to define test cases and to interface with the `evm t8n` command. Additionally, it contains packages that enable test case execution by customizing pytest which acts as the test framework. #### `src/` -Contains various packages that help to define test cases and to interface with the `evm t8n` command. Additionally, it contains some packages that enable test case execution by customizing pytest which acts as the test framework. +Contains the Ethereum execution spec packages. #### `docs/` Contains documentation configuration and source files. - -#### `.vscode/` - -See [VS Code Setup](./setup_vs_code.md). diff --git a/docs/writing_tests/checklist_templates/eip_testing_checklist_template.md b/docs/writing_tests/checklist_templates/eip_testing_checklist_template.md index 57520b2a4f..05b9616b7d 100644 --- a/docs/writing_tests/checklist_templates/eip_testing_checklist_template.md +++ b/docs/writing_tests/checklist_templates/eip_testing_checklist_template.md @@ -1040,10 +1040,10 @@ Verify, given multiple initial values, that a block is accepted or rejected depe ### Framework Changes - Add the new header field to the relevant objects: - - `ethereum_test_fixtures.FixtureHeader`. - - `ethereum_test_fixtures.FixtureExecutionPayload`. - - `ethereum_test_specs.Header`. -- Add the appropriate `header_*_required` fork method to `BaseFork` in `ethereum_test_forks`. + - `execution_testing.fixtures.FixtureHeader`. + - `execution_testing.fixtures.FixtureExecutionPayload`. + - `execution_testing.specs.Header`. +- Add the appropriate `header_*_required` fork method to `BaseFork` in `execution_testing.forks`. ## New Block Body Field @@ -1068,10 +1068,10 @@ Verify, given multiple initial values, that a block is accepted or rejected depe ### Framework Changes - Add the new body field to the relevant objects. - - `ethereum_test_fixtures.FixtureBlockBase`. - - `ethereum_test_fixtures.FixtureEngineNewPayload`. - - `ethereum_test_specs.Block`. -- Modify `ethereum_test_specs.BlockchainTest` filling behavior to account for the new block field. + - `execution_testing.fixtures.FixtureBlockBase`. + - `execution_testing.fixtures.FixtureEngineNewPayload`. + - `execution_testing.specs.Block`. +- Modify `execution_testing.specs.BlockchainTest` filling behavior to account for the new block field. ## Gas Cost Changes