Merge pull request #2904 from ethereum/ralexstokes-patch-1

Update README.md for test formats
This commit is contained in:
Danny Ryan 2022-06-03 07:01:40 -06:00 committed by GitHub
commit 2e980222f4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -29,7 +29,7 @@ This document defines the YAML format and structure used for consensus spec test
## About ## About
Ethereum 2.0 uses YAML as the format for all cross client tests. This document describes at a high level the general format to which all test files should conform. The consensus layer uses YAML as the format for all cross client tests. This document describes at a high level the general format to which all test files should conform.
### Test-case formats ### Test-case formats
@ -115,7 +115,6 @@ some tests of earlier forks repeat with updated state data.
The well known bls/shuffling/ssz_static/operations/epoch_processing/etc. Handlers can change the format, but there is a general target to test. The well known bls/shuffling/ssz_static/operations/epoch_processing/etc. Handlers can change the format, but there is a general target to test.
### `<test handler name>/` ### `<test handler name>/`
Specialization within category. All suites in here will have the same test case format. Specialization within category. All suites in here will have the same test case format.
@ -171,9 +170,6 @@ bls_setting: int -- optional, can have 3 different values:
but there is no change of outcome when running the test if BLS is ON or OFF. but there is no change of outcome when running the test if BLS is ON or OFF.
1: known as "BLS required" - if the test validity is strictly dependent on BLS being ON 1: known as "BLS required" - if the test validity is strictly dependent on BLS being ON
2: known as "BLS ignored" - if the test validity is strictly dependent on BLS being OFF 2: known as "BLS ignored" - if the test validity is strictly dependent on BLS being OFF
reveal_deadlines_setting: -- optional, can have 2 different values:
0: default, `process_reveal_deadlines` is ON.
1: `process_reveal_deadlines` is OFF.
``` ```
##### `config.yaml` ##### `config.yaml`