# Ethereum 2.0 E2E Test Suite

This is a test-suite for conformity end-2-end tests for Prysm's implementation of the Ethereum 2.0 specification. Implementation teams have decided to utilize YAML as a general conformity test format for the current beacon chain's runtime functionality.

The test suite opts for YAML due to wide language support and support for inline comments.

# Testing Format

The testing format follows the official ETH2.0 Specification created [here](https://github.com/ethereum/eth2.0-specs/blob/master/specs/test-format.md)

## Stateful Tests

Chain tests check for conformity of a certain client to the beacon chain specification for items such as the fork choice rule and Casper FFG validator rewards & penalties. Stateful tests need to specify a certain configuration of a beacon chain, with items such as the number validators, in the YAML file. Sample tests will all required fields are shown below.

### State Transition

The most important use case for this test format is to verify the ins and outs of the Ethereum Phase 0 Beacon Chain state advancement. The specification details very strict guidelines for blocks to successfully trigger a state transition, including items such as Casper Proof of Stake slashing conditions of validators, pseudorandomness in the form of RANDAO, and attestation on shard blocks being processed all inside each incoming beacon block. The YAML configuration for this test type allows for configuring a state transition run over N slots, triggering slashing conditions, processing deposits of new validators, and more.

An example state transition test for testing slot and block processing will look as follows:

```yaml
title: Sample Ethereum Serenity State Transition Tests
summary: Testing full state transition block processing
test_suite: prysm
fork: sapphire
version: 1.0
test_cases:
  - config:
      epoch_length: 64
      deposits_for_chain_start: 1000
      num_slots: 32 # Testing advancing state to slot < EpochLength
    results:
      slot: 32
      num_validators: 1000
  - config:
      epoch_length: 64
      deposits_for_chain_start: 16384
      num_slots: 64
      deposits:
        - slot: 1
          amount: 32
          merkle_index: 0
          pubkey: !!binary |
            SlAAbShSkUg7PLiPHZI/rTS1uAvKiieOrifPN6Moso0=
        - slot: 15
          amount: 32
          merkle_index: 1
          pubkey: !!binary |
            Oklajsjdkaklsdlkajsdjlajslkdjlkasjlkdjlajdsd
        - slot: 55
          amount: 32
          merkle_index: 2
          pubkey: !!binary |
            LkmqmqoodLKAslkjdkajsdljasdkajlksjdasldjasdd
      proposer_slashings:
        - slot: 16 # At slot 16, we trigger a proposal slashing occurring
          proposer_index: 16385 # We penalize the proposer that was just added from slot 15
          proposal_1_shard: 0
          proposal_1_slot: 15
          proposal_1_root: !!binary |
            LkmqmqoodLKAslkjdkajsdljasdkajlksjdasldjasdd
          proposal_2_shard: 0
          proposal_2_slot: 15
          proposal_2_root: !!binary |
            LkmqmqoodLKAslkjdkajsdljasdkajlksjdasldjasdd
      casper_slashings:
        - slot: 59 # At slot 59, we trigger a casper slashing
          slashable_vote_data_1_slot: 55
          slashable_vote_data_2_slot: 55
          slashable_vote_data_1_justified_slot: 0
          slashable_vote_data_2_justified_slot: 1
          slashable_vote_data_1_custody_0_indices: [16386]
          slashable_vote_data_1_custody_1_indices: []
          slashable_vote_data_2_custody_0_indices: []
          slashable_vote_data_2_custody_1_indices: [16386]
    results:
      slot: 64
      num_validators: 16387
      penalized_validators: [16385, 16386] # We test that the validators at indices 16385, 16386 were indeed penalized
  - config:
      skip_slots: [10, 20]
      epoch_length: 64
      deposits_for_chain_start: 1000
      num_slots: 128 # Testing advancing state's slot == 2*EpochLength
      deposits:
        - slot: 10
          amount: 32
          merkle_index: 0
          pubkey: !!binary |
            SlAAbShSkUg7PLiPHZI/rTS1uAvKiieOrifPN6Moso0=
        - slot: 20
          amount: 32
          merkle_index: 1
          pubkey: !!binary |
            Oklajsjdkaklsdlkajsdjlajslkdjlkasjlkdjlajdsd
    results:
      slot: 128
      num_validators: 1000 # Validator registry should not have grown if slots 10 and 20 were skipped
```

#### Test Configuration Options

The following configuration options are available for state transition tests:

**Config**

- **skip_slots**: `[int]` determines which slot numbers to simulate a proposer not submitting a block in the state transition TODO
- **epoch_length**: `int` the number of slots in an epoch
- **deposits_for_chain_start**: `int` the number of eth deposits needed for the beacon chain to initialize (this simulates an initial validator registry based on this number in the test)
- **num_slots**: `int` the number of times we run a state transition in the test
- **deposits**: `[Deposit Config]` trigger a new validator deposit into the beacon state based on configuration options
- **proposer_slashings**: `[Proposer Slashing Config]` trigger a proposer slashing at a certain slot for a certain proposer index
- **casper_slashings**: `[Casper Slashing Config]` trigger a casper slashing at a certain slot
- **validator_exits**: `[Validator Exit Config]` trigger a voluntary validator exit at a certain slot for a validator index

**Deposit Config**

- **slot**: `int` a slot in which to trigger a deposit during a state transition test
- **amount**: `int` the ETH deposit amount to trigger
- **merkle_index**: `int` the index of the deposit in the validator deposit contract's Merkle trie
- **pubkey**: `!!binary` the public key of the validator in the triggered deposit object

**Proposer Slashing Config**

- **slot**: `int` a slot in which to trigger a proposer slashing during a state transition test
- **proposer_index**: `int` the proposer to penalize
- **proposal_1_shard**: `int` the first proposal data's shard id
- **proposal_1_slot**: `int` the first proposal data's slot
- **proposal_1_root**: `!!binary` the second proposal data's block root
- **proposal_2_shard**: `int` the second proposal data's shard id
- **proposal_2_slot**: `int` the second proposal data's slot
- **proposal_2_root**: `!!binary` the second proposal data's block root

**Casper Slashing Config**

- **slot**: `int` a slot in which to trigger a casper slashing during a state transition test
- **slashable_vote_data_1_slot**: `int` the slot of the attestation data of slashableVoteData1
- **slashable_vote_data_2_slot**: `int` the slot of the attestation data of slashableVoteData2
- **slashable_vote_data_1_justified_slot**: `int` the justified slot of the attestation data of slashableVoteData1
- **slashable_vote_data_2_justified_slot**: `int` the justified slot of the attestation data of slashableVoteData2
- **slashable_vote_data_1_custody_0_indices**: `[int]` the custody indices 0 for slashableVoteData1
- **slashable_vote_data_1_custody_1_indices**: `[int]` the custody indices 1 for slashableVoteData1
- **slashable_vote_data_2_custody_0_indices**: `[int]` the custody indices 0 for slashableVoteData2
- **slashable_vote_data_2_custody_1_indices**: `[int]` the custody indices 1 for slashableVoteData2

**Validator Exit Config**

- **slot**: `int` the slot at which a validator wants to voluntarily exit the validator registry
- **validator_index**: `int` the index of the validator in the registry that is exiting

#### Test Results

The following are **mandatory** fields as they correspond to checks done at the end of the test run.

- **slot**: `int` check the slot of the state resulting from applying N state transitions in the test
- **num_validators** `[int]` check the number of validators in the validator registry after applying N state transitions
- **penalized_validators** `[int]` the list of validator indices we verify were penalized during the test
- **exited_validators**: `[int]` the list of validator indices we verify voluntarily exited the registry during the test

## Stateless Tests

Stateless tests represent simple unit test definitions for important invariants in the ETH2.0 runtime. In particular, these test conformity across clients with respect to items such as Simple Serialize (SSZ), Signature Aggregation (BLS), and Validator Shuffling

**Simple Serialize**

TODO

**Signature Aggregation**

TODO

**Validator Shuffling**

```yaml
title: Shuffling Algorithm Tests
summary: Test vectors for shuffling a list based upon a seed using `shuffle`
test_suite: shuffle
fork: tchaikovsky
version: 1.0

test_cases:
  - input: []
    output: []
    seed: !!binary ""
  - name: boring_list
    description: List with a single element, 0
    input: [0]
    output: [0]
    seed: !!binary ""
  - input: [255]
    output: [255]
    seed: !!binary ""
  - input: [4, 6, 2, 6, 1, 4, 6, 2, 1, 5]
    output: [1, 6, 4, 1, 6, 6, 2, 2, 4, 5]
    seed: !!binary ""
  - input: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]
    output: [4, 7, 10, 13, 3, 1, 2, 9, 12, 6, 11, 8, 5]
    seed: !!binary ""
  - input: [65, 6, 2, 6, 1, 4, 6, 2, 1, 5]
    output: [6, 65, 2, 5, 4, 2, 6, 6, 1, 1]
    seed: !!binary |
      JlAYJ5H2j8g7PLiPHZI/rTS1uAvKiieOrifPN6Moso0=
```

# Using the Runner

First, create a directory containing the YAML files you wish to test (or use the default `./sampletests` directory included with Prysm).
Then, make sure you have the following folder structure for the directory:

```
yourtestdir/
  fork-choice-tests/
    *.yaml
    ...
  shuffle-tests/
    *.yaml
    ...
  state-tests/
    *.yaml
    ...
```

Then, navigate to the test runner's directory and use the go tool as follows:

```bash
go run main.go -tests-dir /path/to/your/testsdir
```

The runner will then start up a simulated backend and run all your specified YAML tests.

```bash
[2018-11-06 15:01:44]  INFO ----Running Chain Tests----
[2018-11-06 15:01:44]  INFO Running 4 YAML Tests
[2018-11-06 15:01:44]  INFO Title: Sample Ethereum 2.0 Beacon Chain Test
[2018-11-06 15:01:44]  INFO Summary: Basic, functioning fork choice rule for Ethereum 2.0
[2018-11-06 15:01:44]  INFO Test Suite: prysm
[2018-11-06 15:01:44]  INFO Test Runs Finished In: 0.000643545 Seconds
```