Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ethereum/tests

Common tests for all Ethereum implementations
https://github.com/ethereum/tests

Last synced: 3 days ago
JSON representation

Common tests for all Ethereum implementations

Awesome Lists containing this project

README 

        
Ethereum Execution Tests (EVM)   [![Build Status](https://travis-ci.org/ethereum/tests.svg?branch=develop)](https://travis-ci.org/ethereum/tests)

=====



Common tests for all clients to test against. Test execution tool: https://github.com/ethereum/retesteth



Test Formats

------------



Maintained tests:



```

/BasicTests

/BlockchainTests

/GeneralStateTests

/TransactionTests

/EIPTests

/EOFTests

/RLPTest

/src

```



See descriptions of the different test formats in the official documentation at  http://ethereum-tests.readthedocs.io/.



*Note*:  

The format of BlockchainTests recently changed with the introduction of a new field ``sealEngine`` (values: ``NoProof`` | ``Ethash``), see related JSON Schema [change](https://github.com/ethereum/tests/commit/3be71ec3364a01fd4f2cb9b9fd086f3f69f0225c) or BlockchainTest format [docs](https://ethereum-tests.readthedocs.io/en/latest/test_types/blockchain_tests.html) for reference.



This means that you can skip PoW validation for ``NoProof`` tests but also has the consequence that it is not possible to rely on/check ``PoW`` related block parameters for these tests any more.



Clients using the library

-------------------------



The following clients make use of the tests from this library. You can use these implementations for inspiration on how to integrate. If your client is missing, please submit a PR (requirement: at least some minimal test documentation)!



- [Mana](https://github.com/mana-ethereum/mana) (Elixir): [Docs](https://github.com/mana-ethereum/mana#testing), Test location: ``ethereum_common_tests``

- [go-ethereum](https://github.com/ethereum/go-ethereum) (Go): [Docs](https://github.com/ethereum/go-ethereum/wiki/Developers'-Guide), Test location: ``tests/testdata``

- [Parity Ethereum](https://github.com/paritytech/parity-ethereum) (Rust): [Docs](https://wiki.parity.io/Coding-guide), Test location: ``ethcore/res/ethereum/tests``

- [ethereumjs-vm](https://github.com/ethereumjs/ethereumjs-vm) (JavaScript): [Docs](https://github.com/ethereumjs/ethereumjs-vm#testing), Test location: ``ethereumjs-testing`` dependency

- [Trinity](https://github.com/ethereum/py-evm) (Python): [Docs](https://py-evm.readthedocs.io/en/latest/contributing.html#running-the-tests), Test location: `fixtures`

- [Hyperledger Besu](https://github.com/hyperledger/besu) (Java): [Docs](https://wiki.hyperledger.org/display/BESU/Testing), Test Location: ``ethereum/referencetests/src/test/resources``

- [Nethermind](https://github.com/NethermindEth/nethermind) (C#) [Docs](https://nethermind.readthedocs.io), Test Location: ``src/tests``

- [Nimbus-eth1](https://github.com/status-im/nimbus-eth1) (Nim) [Docs](https://github.com/status-im/nimbus-eth1/wiki/Understanding-and-debugging-Nimbus-EVM-JSON-tests), Test location: ``tests/fixtures``

- [Mantis](https://github.com/input-output-hk/mantis) (Scala) [Docs](https://docs.mantisclient.io/), Test Location: ``https://github.com/input-output-hk/mantis/tree/develop/ets``

- [KEVM](https://github.com/runtimeverification/evm-semantics/) (Python) [Docs](https://github.com/runtimeverification/evm-semantics/?tab=readme-ov-file#documentationsupport), Test Location: ``tests/ethereum-tests``



Using the Tests

---------------



We do [versioned tag releases](https://github.com/ethereum/tests/releases) for tests and you should aim to run your client libraries against the latest repository snapshot tagged. 



Generally the [develop](https://github.com/ethereum/tests/tree/develop) branch in ``ethereum/tests`` is always meant to be stable and you should be able to run your test against.



Contribute to the Test Suite

----------------------------



See the dedicated [section](https://ethereum-tests.readthedocs.io/en/latest/how2contribute.html) in the docs on how to write new tests. Or [read a shorter description here](https://github.com/ethereum/retesteth/wiki/Creating-a-State-Test-with-retesteth).



If you want to follow up with current tasks and what is currently in the works, have a look at the [issues](https://github.com/ethereum/tests/issues) 



Currently the geth evm ``t8ntool`` client is the reference client for generating tests. Besu client also has support for generating the tests using rpc test protocol. See at https://github.com/ethereum/retesteth/wiki



Testing stats

---------------------------



Testing results are available at http://retesteth.ethdevops.io/  

There is a web tool for vmtracing the tests using supported clients and retesteth: http://retesteth.ethdevops.io/web/  

All blockchain tests are being run by hive tool: https://hivetests.ethdevops.io/  



Contents of this repository

---------------------------



Do not change test files in folders: 

* StateTests

* BlockchainTests

* TransactionTests 

* VMTests



It is being created by the testFillers which could be found at src folder. The filler specification and wiki are in development so please ask on gitter channel for more details.



If you want to modify a test filler or add a new test please contact @wdimitry at telegram

Use the following guide: https://github.com/ethereum/retesteth/wiki/Creating-a-State-Test-with-retesteth