History

Danny Ryan 89fa914e73 Merge pull request #1478 from ethereum/hash-type-fix Avoid Hash <> hash() type and func confusion		2019-11-12 16:41:21 -07:00
..
eth2spec	Merge pull request #1478 from ethereum/hash-type-fix	2019-11-12 16:41:21 -07:00
README.md	[reopen] Eth2 shorthand standardized (#1452 )	2019-10-28 15:53:10 +08:00
__init__.py	The new test structure starts to take shape	2019-05-15 15:02:27 +02:00
requirements-testing.txt	Xdist tests for parallelism (#1201 )	2019-06-21 14:18:28 -06:00
requirements.txt	ssz==0.1.3	2019-07-25 00:16:29 +08:00
setup.py	ssz==0.1.3	2019-07-25 00:16:29 +08:00

README.md

Eth2 Executable Python Spec (PySpec)

The executable Python spec is built from the Eth2 specification, complemented with the necessary helper functions for hashing, BLS, and more.

With this executable spec, test-generators can easily create test-vectors for client implementations, and the spec itself can be verified to be consistent and coherent through sanity tests implemented with pytest.

Building

All the dynamic parts of the spec can be build at once with make pyspec.

Alternatively, you can build a sub-set of the pyspec: make phase0.

Or, to build a single file, specify the path, e.g. make test_libs/pyspec/eth2spec/phase0/spec.py.

Py-tests

After building, you can install the dependencies for running the pyspec tests with make install_test.

These tests are not intended for client-consumption. These tests are sanity tests, to verify if the spec itself is consistent.

How to run tests

Automated

Run make test from the root of the specs repository (after running make install_test if have not before).

Manual

From within the pyspec folder:

Install dependencies:

python3 -m venv venv
. venv/bin/activate
pip3 install -r requirements-testing.txt

Note: Make sure to run make -B pyspec from the root of the specs repository, to build the parts of the pyspec module derived from the markdown specs. The -B flag may be helpful to force-overwrite the pyspec output after you made a change to the markdown source files.

Run the tests:

pytest --config=minimal eth2spec

Note the package-name, this is to locate the tests.

How to view code coverage report

Run make open_cov from the root of the specs repository after running make test to open the html code coverage report.

Contributing

Contributions are welcome, but consider implementing your idea as part of the spec itself first. The pyspec is not a replacement.

License

Same as the spec itself; see LICENSE file in the specs repository root.