eth2.0-specs/specs/test_formats/epoch_processing
protolambda ff2b533c40
update test format docs with new test structure
2019-07-30 14:09:20 +02:00
..
README.md update test format docs with new test structure 2019-07-30 14:09:20 +02:00

README.md

Epoch processing tests

The different epoch sub-transitions are tested individually with test handlers. The format is similar to block-processing state-transition tests. There is no "change" factor however, the transitions are pure functions with just the pre-state as input. Hence, the format is shared between each test-handler. (See test condition documentation on how to run the tests.)

Test case format

meta.yaml

description: string    -- Optional description of test case, purely for debugging purposes.
                          Tests should use the directory name of the test case as identifier, not the description.
bls_setting: int       -- see general test-format spec.

pre.yaml

A YAML-encoded BeaconState, the state before running the epoch sub-transition.

A pre.ssz is also available as substitute.

post.yaml

A YAML-encoded BeaconState, the state after applying the epoch sub-transition.

A post.ssz is also available as substitute.

Condition

A handler of the epoch_processing test-runner should process these cases, calling the corresponding processing implementation (same name, prefixed with process_). This excludes the other parts of the epoch-transition. The provided pre-state is already transitioned to just before the specific sub-transition of focus of the handler.

Sub-transitions:

  • justification_and_finalization
  • crosslinks
  • rewards_and_penalties - planned testing extension
  • registry_updates
  • slashings
  • final_updates

The resulting state should match the expected post state.