Define py-geth and geth versions in one place only:

- The ``py-geth`` version set in ``setup.py`` is the exact version extracted and used by the circleci setup.
- The ``geth`` version that is set in the ``GETH_BINARY`` for fixture generation is the exact version used in the name of the ``.zip`` for the test fixture and is automatically updated in the circleci config for builds.

Author: fselmo

.circleci/config.yml

@@ -1,13 +1,10 @@
 version: 2.1
 
 parameters:
+  # NOTE: Do not update the `geth_version` manually. It is updated during the
+  # integration test fixture generation.
   geth_version:
-    # update default value when updating geth integration test fixture
-    default: "v1.14.5"
-    type: string
-  pygeth_version:
-    # update default value when updating geth integration test fixture
-    default: "5.0.0b1"
+    default: "1.14.5"
     type: string
   go_version:
     default: "1.22.4"
@@ -66,8 +63,8 @@ geth_steps: &geth_steps
         command: |
           if [ "<< pipeline.parameters.geth_version >>" != "custom" ]; then
             export GOROOT=/usr/local/go
-            export GETH_BINARY="$HOME/.py-geth/geth-<< pipeline.parameters.geth_version >>/bin/geth"
-            echo "configured geth version: << pipeline.parameters.geth_version >>"
+            export GETH_BINARY="$HOME/.py-geth/geth-v<< pipeline.parameters.geth_version >>/bin/geth"
+            echo "configured geth version: v<< pipeline.parameters.geth_version >>"
             if [ ! -e "$GETH_BINARY" ]; then
               echo "GETH_BINARY not set, installing geth..."
               curl -O https://storage.googleapis.com/golang/go<< pipeline.parameters.go_version >>.linux-amd64.tar.gz
@@ -77,10 +74,12 @@ geth_steps: &geth_steps
               sudo ln -s /usr/local/go/bin/go /usr/local/bin/go
               sudo apt-get update
               sudo apt-get install -y build-essential
-              pip install --user "py-geth>=<< pipeline.parameters.pygeth_version >>"
-              python -m geth.install << pipeline.parameters.geth_version >>
+              pygeth_version=$(python web3/scripts/parse_pygeth_version.py)
+              echo "installing py-geth$pygeth_version"
+              pip install --user "py-geth$pygeth_version"
+              python -m geth.install v<< pipeline.parameters.geth_version >>
             fi
-            sudo ln -s /home/circleci/.py-geth/geth-<< pipeline.parameters.geth_version >>/bin/geth /usr/local/bin/geth
+            sudo ln -s /home/circleci/.py-geth/geth-v<< pipeline.parameters.geth_version >>/bin/geth /usr/local/bin/geth
           else
             export GOROOT=/usr/local/go
             export GETH_BINARY="./custom_geth"

docs/contributing.rst

@@ -379,7 +379,7 @@ Geth Fixtures
 
    .. code:: sh
 
-       $ GETH_BINARY=~/.py-geth/geth-v1.14.5/bin/geth python ./tests/integration/generate_fixtures/go_ethereum.py ./tests/integration/geth-1.14.5-fixture
+       $ GETH_BINARY=~/.py-geth/geth-v1.14.5/bin/geth python ./tests/integration/generate_fixtures/go_ethereum.py
 
 3. The output of this script is your fixture, a zip file, which is now stored in ``/tests/integration/``.
    Update the ``/tests/integration/go_ethereum/conftest.py`` and

setup.py

@@ -26,9 +26,6 @@
         "sphinx-autobuild>=2021.3.14",
         "sphinx_rtd_theme>=1.0.0",
         "towncrier>=21,<22",
-        # web3 will work but emit warnings with eth-account>=0.12.2,
-        # but doctests fail between 0.12.2 and 0.13.0
-        "eth-account>=0.13.0",
     ],
     "test": [
         "eth-tester[py-evm]>=0.11.0b1,<0.13.0b1",

tests/core/test_library_files.py

@@ -11,9 +11,7 @@
 
 def test_no_default_exceptions_are_raised_within_web3py():
     for root, dirs, files in os.walk(WEB3_PATH):
-        if "module_testing" in dirs:
-            dirs.remove("module_testing")
-            continue
+        [dirs.remove(dir_) for dir_ in dirs if dir_ in ("scripts", "module_testing")]
         for file in files:
             if file.endswith(".py"):
                 file_path = os.path.join(root, file)

tests/integration/generate_fixtures/go_ethereum.py

@@ -2,10 +2,10 @@
 import json
 import os
 import pprint
+import re
 import shutil
 import socket
 import subprocess
-import sys
 import time
 
 import common
@@ -361,6 +361,32 @@ def setup_chain_state(w3):
     return geth_fixture
 
 
+def update_circleci_geth_version(new_version):
+    file_path = "./.circleci/config.yml"
+    with open(file_path) as file:
+        lines = file.readlines()
+
+    replaced = False
+    for i, line in enumerate(lines):
+        if "geth_version:" in line:
+            if "default:" in lines[i + 1]:
+                lines[i + 1] = f'    default: "{new_version}"\n'
+                replaced = True
+                break
+
+    if not replaced:
+        raise ValueError("`geth_version` for circleci not found / replaced.")
+
+    with open(file_path, "w") as file:
+        file.writelines(lines)
+    print(f"Updated geth_version to {new_version}")
+
+
 if __name__ == "__main__":
-    fixture_dir = sys.argv[1]
-    generate_go_ethereum_fixture(fixture_dir)
+    geth_binary = os.environ.get("GETH_BINARY", None)
+    if not geth_binary:
+        raise ValueError("GETH_BINARY not set. Cannot generate geth fixture.")
+
+    geth_version = re.search(r"geth-v([\d.]+)/", geth_binary).group(1)
+    generate_go_ethereum_fixture(f"./tests/integration/geth-{geth_version}-fixture")
+    update_circleci_geth_version(geth_version)

web3/scripts/parse_pygeth_version.py

@@ -0,0 +1,16 @@
+import re
+
+
+def get_pygeth_version() -> str:
+    with open("setup.py") as f:
+        setup_contents = f.read()
+    version_match = re.search(r"py-geth\s*([><=~!]+)\s*([\d.]+)", setup_contents)
+    if version_match:
+        return "".join(version_match.group(1, 2))
+    else:
+        raise ValueError("py-geth not found in setup.py")
+
+
+if __name__ == "__main__":
+    version = get_pygeth_version()
+    print(version)