From 28767959da2389df363b620a3308a1261c2ca4e0 Mon Sep 17 00:00:00 2001
From: spencer-tb <spencer@spencertaylorbrown.uk>
Date: Fri, 16 Feb 2024 16:28:07 +0700
Subject: [PATCH 1/4] feat(fw|ci): add EEST versioning to framework.

---
 .github/workflows/release.yaml                | 24 +++++++++++++++++++
 setup.cfg                                     |  4 ++--
 src/ethereum_test_tools/__init__.py           |  2 ++
 src/ethereum_test_tools/spec/__init__.py      | 10 +++++++-
 .../spec/base/base_test.py                    | 16 +++++++++++++
 src/pytest_plugins/test_filler/test_filler.py | 21 +++++++++++++++-
 6 files changed, 73 insertions(+), 4 deletions(-)
 create mode 100644 .github/workflows/release.yaml

diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
new file mode 100644
index 0000000000..a892160dc1
--- /dev/null
+++ b/.github/workflows/release.yaml
@@ -0,0 +1,24 @@
+name: Post Release Jobs
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  update-version:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      # TODO: add changelog entry updates
+      - name: Update version in setup.cfg
+        run: |
+          NEW_VERSION=$(echo ${{ github.event.release.tag_name }} | sed 's/^v//')
+          sed -i "s/^version = .*/version = $NEW_VERSION/" setup.cfg
+          
+      - name: Commit and push changes
+        run: |
+          git config --global user.email "action@github.com"
+          git config --global user.name "GitHub Action"
+          git add setup.cfg
+          git commit -m "Release EEST `${{ github.event.release.tag_name }}`"
+          git push origin HEAD:${{ github.ref }}
\ No newline at end of file
diff --git a/setup.cfg b/setup.cfg
index 24d82ed00d..c5fde659c7 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -1,9 +1,9 @@
 [metadata]
-name = test-filler
+name = execution-spec-tests
 description = Ethereum execution client test authoring framework
 long_description = file: README.md
 long_description_content_type = text/markdown
-version = 1.0.0
+version = v2.1.0
 url = https://github.com/ethereum/execution-spec-tests
 license_files =
     LICENSE
diff --git a/src/ethereum_test_tools/__init__.py b/src/ethereum_test_tools/__init__.py
index 7d6d144f74..13bd555833 100644
--- a/src/ethereum_test_tools/__init__.py
+++ b/src/ethereum_test_tools/__init__.py
@@ -53,6 +53,7 @@
     StateTest,
     StateTestFiller,
     TestInfo,
+    get_framework_version,
 )
 from .spec.blockchain.types import Block, Header
 from .vm import Opcode, OpcodeCallArg, Opcodes
@@ -112,5 +113,6 @@
     "cost_memory_bytes",
     "eip_2028_transaction_data_cost",
     "eip_2028_transaction_data_cost",
+    "get_framework_version",
     "transaction_list_root",
 )
diff --git a/src/ethereum_test_tools/spec/__init__.py b/src/ethereum_test_tools/spec/__init__.py
index 9f32e30838..cb7957a1ab 100644
--- a/src/ethereum_test_tools/spec/__init__.py
+++ b/src/ethereum_test_tools/spec/__init__.py
@@ -1,9 +1,16 @@
 """
 Test spec definitions and utilities.
 """
+
 from typing import List, Type
 
-from .base.base_test import BaseFixture, BaseTest, TestSpec, verify_post_alloc
+from .base.base_test import (
+    BaseFixture,
+    BaseTest,
+    TestSpec,
+    get_framework_version,
+    verify_post_alloc,
+)
 from .blockchain.blockchain_test import BlockchainTest, BlockchainTestFiller, BlockchainTestSpec
 from .fixture_collector import FixtureCollector, TestInfo
 from .state.state_test import StateTest, StateTestFiller, StateTestOnly, StateTestSpec
@@ -24,5 +31,6 @@
     "StateTestSpec",
     "TestInfo",
     "TestSpec",
+    "get_framework_version",
     "verify_post_alloc",
 )
diff --git a/src/ethereum_test_tools/spec/base/base_test.py b/src/ethereum_test_tools/spec/base/base_test.py
index cd436de46c..98101e4251 100644
--- a/src/ethereum_test_tools/spec/base/base_test.py
+++ b/src/ethereum_test_tools/spec/base/base_test.py
@@ -1,6 +1,8 @@
 """
 Base test class and helper functions for Ethereum state and blockchain tests.
 """
+
+import subprocess
 from abc import abstractmethod
 from dataclasses import dataclass, field
 from itertools import count
@@ -8,6 +10,8 @@
 from pathlib import Path
 from typing import Any, Callable, Dict, Generator, Iterator, List, Mapping, Optional, TextIO
 
+import pkg_resources
+
 from ethereum_test_forks import Fork
 from evm_transition_tool import FixtureFormats, TransitionTool
 
@@ -73,6 +77,17 @@ def verify_result(result: Mapping, env: Environment):
         assert result["withdrawalsRoot"] == to_hex(withdrawals_root(env.withdrawals))
 
 
+def get_framework_version() -> str:
+    """
+    Returns the version of the EEST framework.
+    """
+    latest_release = pkg_resources.get_distribution("execution-spec-tests").version
+    local_commit_hash = (
+        subprocess.check_output(["git", "rev-parse", "--short", "HEAD"]).decode().strip()
+    )
+    return f"execution-spec-tests v{latest_release}-{local_commit_hash}"
+
+
 @dataclass(kw_only=True)
 class BaseFixture:
     """
@@ -100,6 +115,7 @@ def fill_info(
         self.info["filling-transition-tool"] = t8n.version()
         if ref_spec is not None:
             ref_spec.write_info(self.info)
+        self.info["framework-version"] = get_framework_version()
 
     @abstractmethod
     def to_json(self) -> Dict[str, Any]:
diff --git a/src/pytest_plugins/test_filler/test_filler.py b/src/pytest_plugins/test_filler/test_filler.py
index a468d495c2..8d4041225a 100644
--- a/src/pytest_plugins/test_filler/test_filler.py
+++ b/src/pytest_plugins/test_filler/test_filler.py
@@ -19,7 +19,14 @@
     get_closest_fork_with_solc_support,
     get_forks_with_solc_support,
 )
-from ethereum_test_tools import SPEC_TYPES, BaseTest, FixtureCollector, TestInfo, Yul
+from ethereum_test_tools import (
+    SPEC_TYPES,
+    BaseTest,
+    FixtureCollector,
+    TestInfo,
+    Yul,
+    get_framework_version,
+)
 from evm_transition_tool import FixtureFormats, TransitionTool
 from pytest_plugins.spec_version_checker.spec_version_checker import EIPSpecTestItem
 
@@ -126,6 +133,14 @@ def pytest_addoption(parser):
         help="Path to dump the transition tool debug output.",
     )
 
+    version_group = parser.getgroup("version_info", "Versioning of the EEST framework")
+    version_group.addoption(
+        "--version-info",
+        action="store_true",
+        default=False,
+        help="Displays the versioning information of the framework.",
+    )
+
 
 @pytest.hookimpl(tryfirst=True)
 def pytest_configure(config):
@@ -175,6 +190,10 @@ def pytest_configure(config):
             f"{Frontier.solc_min_version()}",
             returncode=pytest.ExitCode.USAGE_ERROR,
         )
+    if config.getoption("version_info"):
+        pytest.exit(
+            f"'Displaying framework version information'\n" f"> {get_framework_version()}\n"
+        )
 
 
 @pytest.hookimpl(trylast=True)

From 27628426ebe8e0cfa828acadecfd5f464c9f58fb Mon Sep 17 00:00:00 2001
From: spencer-tb <spencer@spencertaylorbrown.uk>
Date: Fri, 16 Feb 2024 19:33:01 +0700
Subject: [PATCH 2/4] feat(fw): small refactor, stubs, tox.

---
 src/ethereum_test_tools/spec/base/base_test.py | 14 +++++++-------
 stubs/git/__init__.pyi                         |  9 +++++++++
 tox.ini                                        |  1 +
 3 files changed, 17 insertions(+), 7 deletions(-)
 create mode 100644 stubs/git/__init__.pyi

diff --git a/src/ethereum_test_tools/spec/base/base_test.py b/src/ethereum_test_tools/spec/base/base_test.py
index 98101e4251..0a3d9211c2 100644
--- a/src/ethereum_test_tools/spec/base/base_test.py
+++ b/src/ethereum_test_tools/spec/base/base_test.py
@@ -2,15 +2,15 @@
 Base test class and helper functions for Ethereum state and blockchain tests.
 """
 
-import subprocess
 from abc import abstractmethod
 from dataclasses import dataclass, field
+from importlib.metadata import version
 from itertools import count
 from os import path
 from pathlib import Path
 from typing import Any, Callable, Dict, Generator, Iterator, List, Mapping, Optional, TextIO
 
-import pkg_resources
+from git import InvalidGitRepositoryError, Repo
 
 from ethereum_test_forks import Fork
 from evm_transition_tool import FixtureFormats, TransitionTool
@@ -81,11 +81,11 @@ def get_framework_version() -> str:
     """
     Returns the version of the EEST framework.
     """
-    latest_release = pkg_resources.get_distribution("execution-spec-tests").version
-    local_commit_hash = (
-        subprocess.check_output(["git", "rev-parse", "--short", "HEAD"]).decode().strip()
-    )
-    return f"execution-spec-tests v{latest_release}-{local_commit_hash}"
+    try:
+        local_commit_hash = Repo(search_parent_directories=True).head.commit.hexsha[:7]
+    except InvalidGitRepositoryError:  # required for some framework tests
+        local_commit_hash = "unknown"
+    return f"execution-spec-tests v{version('execution-spec-tests')}-{local_commit_hash}"
 
 
 @dataclass(kw_only=True)
diff --git a/stubs/git/__init__.pyi b/stubs/git/__init__.pyi
new file mode 100644
index 0000000000..38517c8694
--- /dev/null
+++ b/stubs/git/__init__.pyi
@@ -0,0 +1,9 @@
+from typing import Any
+
+class Repo:
+    def __init__(self, path: str = ..., search_parent_directories: bool = ...) -> None: ...
+    @property
+    def head(self) -> Any: ...
+
+class InvalidGitRepositoryError(Exception):
+    pass
diff --git a/tox.ini b/tox.ini
index a3a8090f76..37b34eb270 100644
--- a/tox.ini
+++ b/tox.ini
@@ -10,6 +10,7 @@ development_fork = Cancun
 [testenv]
 package = wheel
 wheel_build_env = .pkg
+deps = GitPython
 
 [testenv:framework]
 description = Run checks on helper libraries and test framework

From 62a7c913ac04b6ced2c7bed558a4d366a69b7cc0 Mon Sep 17 00:00:00 2001
From: spencer-tb <spencer@spencertaylorbrown.uk>
Date: Sat, 17 Feb 2024 07:08:39 +0700
Subject: [PATCH 3/4] feat(fw): add ethereum_test_tools/utilities, clean up.

---
 setup.cfg                                      |  1 +
 src/ethereum_test_tools/__init__.py            |  2 +-
 src/ethereum_test_tools/spec/__init__.py       |  9 +--------
 src/ethereum_test_tools/spec/base/base_test.py | 15 +--------------
 src/ethereum_test_tools/utility/__init__.py    |  7 +++++++
 src/ethereum_test_tools/utility/helpers.py     | 18 ++++++++++++++++++
 tox.ini                                        |  1 -
 7 files changed, 29 insertions(+), 24 deletions(-)
 create mode 100644 src/ethereum_test_tools/utility/__init__.py
 create mode 100644 src/ethereum_test_tools/utility/helpers.py

diff --git a/setup.cfg b/setup.cfg
index c5fde659c7..7c38735ccc 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -67,6 +67,7 @@ lint =
     flake8>=6.1.0,<7
     pep8-naming==0.13.3
     fname8>=0.0.3
+    GitPython>=3.1
 
 docs =
     cairosvg>=2.7.0,<3  # required for social plugin (material)
diff --git a/src/ethereum_test_tools/__init__.py b/src/ethereum_test_tools/__init__.py
index 13bd555833..63be02a60b 100644
--- a/src/ethereum_test_tools/__init__.py
+++ b/src/ethereum_test_tools/__init__.py
@@ -53,9 +53,9 @@
     StateTest,
     StateTestFiller,
     TestInfo,
-    get_framework_version,
 )
 from .spec.blockchain.types import Block, Header
+from .utility.helpers import get_framework_version
 from .vm import Opcode, OpcodeCallArg, Opcodes
 
 __all__ = (
diff --git a/src/ethereum_test_tools/spec/__init__.py b/src/ethereum_test_tools/spec/__init__.py
index cb7957a1ab..81b0fd9a86 100644
--- a/src/ethereum_test_tools/spec/__init__.py
+++ b/src/ethereum_test_tools/spec/__init__.py
@@ -4,13 +4,7 @@
 
 from typing import List, Type
 
-from .base.base_test import (
-    BaseFixture,
-    BaseTest,
-    TestSpec,
-    get_framework_version,
-    verify_post_alloc,
-)
+from .base.base_test import BaseFixture, BaseTest, TestSpec, verify_post_alloc
 from .blockchain.blockchain_test import BlockchainTest, BlockchainTestFiller, BlockchainTestSpec
 from .fixture_collector import FixtureCollector, TestInfo
 from .state.state_test import StateTest, StateTestFiller, StateTestOnly, StateTestSpec
@@ -31,6 +25,5 @@
     "StateTestSpec",
     "TestInfo",
     "TestSpec",
-    "get_framework_version",
     "verify_post_alloc",
 )
diff --git a/src/ethereum_test_tools/spec/base/base_test.py b/src/ethereum_test_tools/spec/base/base_test.py
index 0a3d9211c2..f07169f568 100644
--- a/src/ethereum_test_tools/spec/base/base_test.py
+++ b/src/ethereum_test_tools/spec/base/base_test.py
@@ -4,14 +4,11 @@
 
 from abc import abstractmethod
 from dataclasses import dataclass, field
-from importlib.metadata import version
 from itertools import count
 from os import path
 from pathlib import Path
 from typing import Any, Callable, Dict, Generator, Iterator, List, Mapping, Optional, TextIO
 
-from git import InvalidGitRepositoryError, Repo
-
 from ethereum_test_forks import Fork
 from evm_transition_tool import FixtureFormats, TransitionTool
 
@@ -20,6 +17,7 @@
 from ...common.json import JSONEncoder
 from ...common.json import field as json_field
 from ...reference_spec.reference_spec import ReferenceSpec
+from ...utility.helpers import get_framework_version
 
 
 def verify_transactions(txs: List[Transaction] | None, result) -> List[int]:
@@ -77,17 +75,6 @@ def verify_result(result: Mapping, env: Environment):
         assert result["withdrawalsRoot"] == to_hex(withdrawals_root(env.withdrawals))
 
 
-def get_framework_version() -> str:
-    """
-    Returns the version of the EEST framework.
-    """
-    try:
-        local_commit_hash = Repo(search_parent_directories=True).head.commit.hexsha[:7]
-    except InvalidGitRepositoryError:  # required for some framework tests
-        local_commit_hash = "unknown"
-    return f"execution-spec-tests v{version('execution-spec-tests')}-{local_commit_hash}"
-
-
 @dataclass(kw_only=True)
 class BaseFixture:
     """
diff --git a/src/ethereum_test_tools/utility/__init__.py b/src/ethereum_test_tools/utility/__init__.py
new file mode 100644
index 0000000000..a454413a26
--- /dev/null
+++ b/src/ethereum_test_tools/utility/__init__.py
@@ -0,0 +1,7 @@
+"""
+Utility functions used within the EEST framework.
+"""
+
+from .helpers import get_framework_version
+
+__all__ = ("get_framework_version",)
diff --git a/src/ethereum_test_tools/utility/helpers.py b/src/ethereum_test_tools/utility/helpers.py
new file mode 100644
index 0000000000..1d4929b0d4
--- /dev/null
+++ b/src/ethereum_test_tools/utility/helpers.py
@@ -0,0 +1,18 @@
+"""
+Utility functions for the EEST framework.
+"""
+
+from importlib.metadata import version
+
+from git import InvalidGitRepositoryError, Repo
+
+
+def get_framework_version() -> str:
+    """
+    Returns the current version of the EEST framework.
+    """
+    try:
+        local_commit_hash = Repo(search_parent_directories=True).head.commit.hexsha[:7]
+    except InvalidGitRepositoryError:  # required for some framework tests
+        local_commit_hash = "unknown"
+    return f"execution-spec-tests v{version('execution-spec-tests')}-{local_commit_hash}"
diff --git a/tox.ini b/tox.ini
index 37b34eb270..a3a8090f76 100644
--- a/tox.ini
+++ b/tox.ini
@@ -10,7 +10,6 @@ development_fork = Cancun
 [testenv]
 package = wheel
 wheel_build_env = .pkg
-deps = GitPython
 
 [testenv:framework]
 description = Run checks on helper libraries and test framework

From f685b9024eb1611245a04d346b001b0bdcd1beae Mon Sep 17 00:00:00 2001
From: spencer-tb <spencer@spencertaylorbrown.uk>
Date: Sat, 17 Feb 2024 07:21:21 +0700
Subject: [PATCH 4/4] feat(ci): update post release workflow.

---
 .github/workflows/post_release.yaml | 65 +++++++++++++++++++++++++++++
 .github/workflows/release.yaml      | 24 -----------
 docs/changelog_section_template.md  |  2 +-
 3 files changed, 66 insertions(+), 25 deletions(-)
 create mode 100644 .github/workflows/post_release.yaml
 delete mode 100644 .github/workflows/release.yaml

diff --git a/.github/workflows/post_release.yaml b/.github/workflows/post_release.yaml
new file mode 100644
index 0000000000..f85407e6eb
--- /dev/null
+++ b/.github/workflows/post_release.yaml
@@ -0,0 +1,65 @@
+name: Post Release Automation
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  update-version:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Configure git user for actions
+        run: |
+          git config --global user.email "action@github.com"
+          git config --global user.name "GitHub Action"
+
+      - name: Set environment variables
+        run: |
+          echo "NEW_VERSION=${{ github.event.release.tag_name }}" >> $GITHUB_ENV
+          echo "NEW_BRANCH=release-${{ github.event.release.tag_name }}" >> $GITHUB_ENV
+          echo "COMMIT_MSG=feat(docs|fw): post ${{ github.event.release.tag_name }} release changes" >> $GITHUB_ENV
+
+      - name: Bump version in setup configuration
+        run: |
+          sed -i "s/^version = .*/version = $NEW_VERSION/" setup.cfg
+          git add setup.cfg
+
+      - name: Update changelog with release details
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          RELEASE_DATE: $(date +'%Y-%m-%d')
+        run: |
+          # Replace unreleased link with the new release information
+          RELEASE_DATE=$(date +'%Y-%m-%d')
+          ESCAPED_LINK="https:\/\/github.com\/ethereum\/execution-spec-tests\/releases\/tag\/${NEW_VERSION}"
+          RELEASE_NAME=$(gh release view ${NEW_VERSION} --json body -q '.body' | grep '^#' | head -n 1 | sed 's/^# //')
+          sed -i "s/^## 🔜 \[Unreleased\].*/## [${NEW_VERSION}](${ESCAPED_LINK}) - ${RELEASE_DATE}: ${RELEASE_NAME}/" docs/CHANGELOG.md
+
+          # Append changelog template for the new unreleased section
+          { echo ""; tail -n +5 docs/changelog_section_template.md; } > temp_template.md
+          sed -i '/\*\*Key:\*\*/ r temp_template.md' docs/CHANGELOG.md
+          rm temp_template.md
+
+          git add docs/CHANGELOG.md
+
+      - name: Create pull request with relevant changes
+        uses: peter-evans/create-pull-request@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          branch: ${{ env.NEW_BRANCH }}
+          commit-message: ${{ env.COMMIT_MSG }}
+          title: ${{ env.COMMIT_MSG }}
+          body: |
+            ## 🗒️ Description
+            Post ${{ env.NEW_VERSION }} release changes:
+            - Bump version within `setup.cfg`.
+            - Update `CHANGELOG.md` and copy in `changelog_section_template.md`.
+          base: main
\ No newline at end of file
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
deleted file mode 100644
index a892160dc1..0000000000
--- a/.github/workflows/release.yaml
+++ /dev/null
@@ -1,24 +0,0 @@
-name: Post Release Jobs
-
-on:
-  release:
-    types: [published]
-
-jobs:
-  update-version:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      # TODO: add changelog entry updates
-      - name: Update version in setup.cfg
-        run: |
-          NEW_VERSION=$(echo ${{ github.event.release.tag_name }} | sed 's/^v//')
-          sed -i "s/^version = .*/version = $NEW_VERSION/" setup.cfg
-          
-      - name: Commit and push changes
-        run: |
-          git config --global user.email "action@github.com"
-          git config --global user.name "GitHub Action"
-          git add setup.cfg
-          git commit -m "Release EEST `${{ github.event.release.tag_name }}`"
-          git push origin HEAD:${{ github.ref }}
\ No newline at end of file
diff --git a/docs/changelog_section_template.md b/docs/changelog_section_template.md
index 8cbaf9326c..e7bd6f0afb 100644
--- a/docs/changelog_section_template.md
+++ b/docs/changelog_section_template.md
@@ -2,7 +2,7 @@
 
 The following can be copy-pasted into the `CHANGELOG.md` file for a new release.
 
-## 🔜 [Unreleased]
+## 🔜 [Unreleased](https://github.com/ethereum/execution-spec-tests/releases/tag/version) - 2024-xx-xx
 
 ### 🧪 Test Cases