Skip to content

Commit ea028c9

Browse files
authored
fix(docs): add missing lines code coverage field to eip checklist (ethereum#2137)
* fix(docs): docs ci build failed due to being in strict mode and emitting warning from missing field in eip-checking-template * fix: disable strict mode for building docs, only errors should lead to ci failure * fix: info warnings about missing navigation elements that spam ci output * PR feedback
1 parent 7ab5c83 commit ea028c9

2 files changed

Lines changed: 16 additions & 2 deletions

File tree

docs/navigation.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,10 @@
2727
* [Testing Checklist Templates](writing_tests/checklist_templates/index.md)
2828
* [EIP Execution Layer Testing Checklist Template](writing_tests/checklist_templates/eip_testing_checklist_template.md)
2929
* [Post-mortems](writing_tests/post_mortems.md)
30-
* [Tutorial: Adding a State Test](writing_tests/tutorials/state_transition.md)
30+
* Tutorials
31+
* [Adding a State Test](writing_tests/tutorials/state_transition.md)
32+
* [Adding a Blockchain Test](writing_tests/tutorials/blockchain.md)
33+
* [Opcode Metadata](writing_tests/opcode_metadata.md)
3134
* [Porting Legacy Tests](writing_tests/porting_legacy_tests.md)
3235
* [Filling Tests](filling_tests/index.md)
3336
* [Getting Started](filling_tests/getting_started.md)
@@ -48,6 +51,7 @@
4851
* [Blockchain Engine Tests](running_tests/test_formats/blockchain_test_engine.md)
4952
* [Blockchain Engine X Tests](running_tests/test_formats/blockchain_test_engine_x.md)
5053
* [Transaction Tests](running_tests/test_formats/transaction_test.md)
54+
* [Blockchain Sync Tests](running_tests/test_formats/blockchain_test_sync.md)
5155
* [Common Types](running_tests/test_formats/common_types.md)
5256
* [Exceptions](running_tests/test_formats/exceptions.md)
5357
* [Hive](running_tests/hive/index.md)
@@ -65,6 +69,7 @@
6569
* [Execute Hive](./running_tests/execute/hive.md)
6670
* [Execute Remote](./running_tests/execute/remote.md)
6771
* [Execute Eth Config](./running_tests/execute/eth_config.md)
72+
* [Transaction Metadata](./running_tests/execute/transaction_metadata.md)
6873
* [Useful Pytest Options](running_tests/useful_pytest_options.md)
6974
* [Developer Doc](dev/index.md)
7075
* [Managing Configurations](dev/configurations.md)
@@ -75,9 +80,14 @@
7580
* [Logging](dev/logging.md)
7681
* [Enabling Precommit Checks](dev/precommit.md)
7782
* [Running Github Actions Locally](dev/test_actions_locally.md)
83+
* [Dependencies and Packaging](dev/deps_and_packaging.md)
7884
* [Changelog](CHANGELOG.md)
85+
* [Changelog Section Template](changelog_section_template.md)
7986
* [Library Reference](library/index.md)
8087
* [EEST CLI Tools](library/cli/index.md)
88+
* [eest](library/cli/eest.md)
89+
* [evm_bytes](library/cli/evm_bytes.md)
90+
* [extract_config](library/cli/extract_config.md)
8191
* [Execution Testing Base Types Package](library/execution_testing_base_types.md)
8292
* [Execution Testing Exceptions Package](library/execution_testing_exceptions.md)
8393
* [Execution Testing Fixtures Package](library/execution_testing_fixtures.md)
@@ -88,3 +98,6 @@
8898
* [Execution Testing VM Package](library/execution_testing_vm.md)
8999
* [Execution Testing Client CLIs Package](library/execution_testing_client_clis.md)
90100
* [Pytest Plugins](library/pytest_plugins/index.md)
101+
* [Filler](library/pytest_plugins/filler.md)
102+
* [Forks](library/pytest_plugins/forks.md)
103+
* [Spec Version Checker](library/pytest_plugins/spec_version_checker.md)

docs/writing_tests/checklist_templates/eip_testing_checklist_template.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ Depending on the changes introduced by an EIP, the following template is the min
1818
| ID | Description | Status | Tests |
1919
| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------ | ----- |
2020
| `general/code_coverage/eels` | Run produced tests against [EELS](https://github.com/ethereum/execution-specs) and verify that line code coverage of new added lines for the EIP is 100%, with only exceptions being unreachable code lines. | | |
21-
| `general/code_coverage/test_coverage` | Run coverage on the test code itself (as a basic logic sanity check), i.e., `uv run fill --cov tests`. | | |
21+
| `general/code_coverage/test_coverage` | Run coverage on the test code itself (as a basic logic sanity check), i.e., `uv run fill --cov tests`. | | |
22+
| `general/code_coverage/missed_lines` | Document any lines missed in coverage reports and explain why they are acceptable (e.g., unreachable code, general infrastructure not related to the EIP). | | |
2223
| `general/code_coverage/second_client` | Optional - Run against a second client and verify sufficient code coverage over new code added for the EIP. | | |
2324

2425
#### Fuzzing

0 commit comments

Comments
 (0)