eth2.0-specs/specs/test_formats/sanity/blocks.md

43 lines
1.1 KiB
Markdown
Raw Normal View History

2019-05-23 23:03:21 +00:00
# Sanity blocks testing
Sanity tests to cover a series of one or more blocks being processed, aiming to cover common changes.
## Test case format
2019-07-30 13:06:15 +00:00
### `meta.yaml`
2019-05-23 23:03:21 +00:00
```yaml
2019-07-30 13:06:15 +00:00
description: string -- Optional. Description of test case, purely for debugging purposes.
bls_setting: int -- see general test-format spec.
2019-07-30 13:06:15 +00:00
blocks_count: int -- the number of blocks processed in this test.
2019-05-23 23:03:21 +00:00
```
2019-07-30 13:06:15 +00:00
### `pre.yaml`
A YAML-encoded `BeaconState`, the state before running the block transitions.
Also available as `pre.ssz`.
2019-07-30 13:06:15 +00:00
### `blocks_<index>.yaml`
A series of files, with `<index>` in range `[0, blocks_count)`. Blocks need to be processed in order,
following the main transition function (i.e. process slot and epoch transitions in between blocks as normal)
Each file is a YAML-encoded `BeaconBlock`.
Each block is also available as `blocks_<index>.ssz`
### `post.yaml`
A YAML-encoded `BeaconState`, the state after applying the block transitions.
Also available as `post.ssz`.
2019-07-30 13:06:15 +00:00
2019-05-23 23:03:21 +00:00
## Condition
The resulting state should match the expected `post` state, or if the `post` state is left blank,
the handler should reject the series of blocks as invalid.