Merge pull request #10 from marioevz/folder-structure-refactor

Folder Structure Refactor

Author: lightclient

.gitignore

@@ -8,7 +8,7 @@ __pycache__/
 *.py[cod]
 *$py.class
 venv/
-fixtures/
+/fixtures/
 
 # C extensions
 *.so

README.md

@@ -33,17 +33,18 @@ how to build go-ethereum utilities.
 
 ## Overview 
 
-### `ethereum_test`
+### `ethereum_test_tools`
 
-The `ethereum_test` package provides primitives and helpers to allow developers
-to easily test the consensus logic of Ethereum clients. 
+The `ethereum_test_tools` package provides primitives and helpers to allow
+developers to easily test the consensus logic of Ethereum clients. 
 
-### `ethereum_test_filler`
+### `ethereum_test_filling_tool`
 
-The `ethereum_test_filler` pacakge is a CLI application that recursively searches
-a given directory for Python modules that export test filler functions generated
-using `ethereum_test`. It then processes the fillers using the transition tool
-and the block builder tool, and writes the resulting fixture to file.
+The `ethereum_test_filling_tool` pacakge is a CLI application that recursively
+searches a given directory for Python modules that export test filler functions
+generated using `ethereum_test_tools`.
+It then processes the fillers using the transition tool and the block builder
+tool, and writes the resulting fixture to file.
 
 ### `evm_block_builder`
 
@@ -53,7 +54,7 @@ This is a wrapper around the [block builder][b11r] (b11r) tool.
 
 This is a wrapper around the [transaction][t8n] (t8n) tool.
 
-### `ethereum_tests`
+### `fillers`
 
 Contains all the Ethereum consensus tests available in this repository.
 
@@ -92,7 +93,7 @@ The Blockchain tests span multiple blocks which can contain or not transactions,
 
 ### Adding a New Test
 
-All currently implemented tests can be found in the `src/ethereum_tests`
+All currently implemented tests can be found in the `fillers`
 directory, which is composed of many subdirectories, and each one represents a
 different test category.
 
@@ -103,11 +104,11 @@ vectors.
 A new test can be added by either:
 
 - Adding a new `test_` python function to an existing file in any of the
-  existing category subdirectories within `src/ethereum_tests`.
+  existing category subdirectories within `fillers`.
 - Creating a new source file in an existing category, and populating it with
   the new test function(s).
 - Creating an entirely new category by adding a subdirectory in
-  `src/ethereum_tests` with the appropriate source files and test functions.
+  `fillers` with the appropriate source files and test functions.
 
 ### Test Spec Generator Functions
 
@@ -124,8 +125,8 @@ following decorators:
 These decorators specify the forks on which the test vector is supposed to run.
 
 They also automatically append necessary information for the
-`ethereum_test_filler` to process when the generator is being executed to fill
-the tests.
+`ethereum_test_filling_tool` to process when the generator is being executed to
+fill the tests.
 
 The test vector function must take only one `str` parameter: the fork name.
 
@@ -234,7 +235,7 @@ Within the `post` dictionary object, an account address can be:
 The `Account` object is used to specify the properties of an account to be
 verified in the post state.
 
-The python representation can be found in [src/ethereum_test/types.py](src/ethereum_test/types.py).
+The python representation can be found in [src/ethereum_test_tools/common/types.py](src/ethereum_test_tools/common/types.py).
 
 It can verify the following properties of an account:
 - `nonce`: the scalar value equal to a) the number of transactions sent by

src/ethereum_tests/example/__init__.py fillers/example/__init__.pysrc/ethereum_tests/example/__init__.py renamed to fillers/example/__init__.py

@@ -2,7 +2,7 @@
 Test Yul Source Code Examples
 """
 
-from ethereum_test import (
+from ethereum_test_tools import (
     Account,
     Environment,
     StateTest,

src/ethereum_tests/example/example.py fillers/example/example.pysrc/ethereum_tests/example/example.py renamed to fillers/example/example.py

@@ -2,7 +2,7 @@
 Test EIP-1344 CHAINID opcode
 """
 
-from ethereum_test import (
+from ethereum_test_tools import (
     Account,
     Environment,
     StateTest,

src/ethereum_tests/vm/__init__.py fillers/vm/__init__.pysrc/ethereum_tests/vm/__init__.py renamed to fillers/vm/__init__.py

@@ -2,7 +2,7 @@
 Test DUP opcodes
 """
 
-from ethereum_test import (
+from ethereum_test_tools import (
     Account,
     Environment,
     StateTest,

src/ethereum_tests/vm/chain_id.py fillers/vm/chain_id.pysrc/ethereum_tests/vm/chain_id.py renamed to fillers/vm/chain_id.py

@@ -12,11 +12,10 @@ classifiers =
 
 [options]
 packages =
-    ethereum_test
-    ethereum_tests
-    ethereum_test_filler
-    evm_transition_tool
     evm_block_builder
+    evm_transition_tool
+    ethereum_test_tools
+    ethereum_test_filling_tool
 
 package_dir =
     =src
@@ -29,7 +28,7 @@ install_requires =
     types-setuptools==57.4.4
 
 [options.package_data]
-ethereum_test =
+ethereum_test_tools =
     py.typed
 evm_transition_tool =
     py.typed
@@ -38,7 +37,7 @@ evm_block_builder =
 
 [options.entry_points]
 console_scripts =
-    tf = ethereum_test_filler.main:main
+    tf = ethereum_test_filling_tool.main:main
 
 [options.extras_require]
 test =
@@ -78,6 +77,8 @@ per-file-ignore =
 
 extend-exclude =
     setup.py
-    tests/
+    src/evm_block_builder/tests/
+    src/evm_transition_tool/tests/
+    src/ethereum_test_tools/tests/
 
 # vim: set ft=dosini: