✨ feat(all): add application-wide configuration manager

[raxhvl]

🗒️ Description

This PR introduces a package to manage environment and application configurations.

.
├── src
│   └── 📁 config  [Application wide environment and configurations]
│       ├── 📄 __init__.py
│       ├── 📄 app.py [Configurations for application framework]
│       ├── 📄 docs.py [Configurations for documentation]
│       └── 📄 env.py  [Exposes `env.yaml` to the application]
└── 📄 env.yaml [Environment file (git ignored)]

Environment Configurations

Application-wide environment configuration, which varies across staging, production, and development environments are read from env.yaml in the project root.

This file will not be tracked by git, making it safe for storing local secrets.

To get started, run the command env_init cli to initialize your environment configuration.

Usage

1. Generate env file

Run the env_init cli tool.

➜ uv run env_init
Env file created:  execution-spec-tests/env.yaml

which should generate an env.yaml in the project root.

remote_nodes:
  - name: mainnet_archive
    # Replace with your Ethereum RPC node URL
    node_url: http://example.com
    # Optional: Headers for RPC requests
    rpc_headers:
      client-secret: <secret>

2. Import EnvConfig

from config import EnvConfig
EnvConfig().remote_nodes[0].name
'mainnet_archive'

Application configuration

Application configuration are pydantic classes.

from config import DocsConfig
DocsConfig().TARGET_FORK
'Prague'

🔗 Related Issues

closes #891, closes #893

✅ Checklist

• All: Set appropriate labels for the changes.
• All: Considered squashing commits to improve commit history.
• All: Added an entry to CHANGELOG.md.
• All: Considered updating the online docs in the ./docs/ directory.
• Tests: All converted JSON/YML tests from ethereum/tests have been added to converted-ethereum-tests.txt.
• Tests: A PR with removal of converted JSON/YML tests from ethereum/tests have been opened.
• Tests: Included the type and version of evm t8n tool used to locally execute test cases: e.g., ref with commit hash or geth 1.13.1-stable-3f40e65.
• Tests: Ran mkdocs serve locally and verified the auto-generated docs for new tests in the Test Case Reference are correctly formatted.

[raxhvl]

@danceratopz let me know if this needs a changelog entry.

[danceratopz]

Good suggestions thanks! I made a further suggestion to help people get started with config below.

As we discussed via DM, we should probably move away from a JSON config at some point. Unless we go with a pydantic-settings setup for gentest's config, but that might be overkill :)

[raxhvl]

@danceratopz Let me know where should I document this so the team is aware.

[danceratopz]

Thanks for this, really like how this is shaping up! ☄️ A few nits below!

[danceratopz]

@danceratopz Let me know where should I document this so the team is aware.

As this config will be limited to gentest (for starters), you could re-use gentest's docstrings in a new HTML page for gentest under here:
https://ethereum.github.io/execution-spec-tests/main/library/cli/
which gets generated from:
https://github.com/ethereum/execution-spec-tests/blob/619e7d8340802f457f5f4e1ada0bff3826a1c27c/src/cli/evm_bytes.py
and here:
https://github.com/ethereum/execution-spec-tests/blob/619e7d8340802f457f5f4e1ada0bff3826a1c27c/docs/library/cli/evm_bytes.md

But feel free to leave this until to you start work on gentest proper, it's ok for me if we skip it for now.

If you're very motivated, you could add a short explainer under the developer docs:
https://ethereum.github.io/execution-spec-tests/main/dev/

[raxhvl]

I have made the following updates

1. Default configs: Now using a template. Also Default config is itself a Config model so it will also be validated
   

   execution-spec-tests/src/config/env.py

   Lines 89 to 97 in 7a5df43

   	DEFAULT_CONFIG = Config(
   	remote_nodes=[
   	RemoteNode(
   	name="mainnet_archive",
   	node_url="http://example.com",
   	rpc_headers={"client-secret": "<secret>"},
   	)
   	]
   	)

2. Overriding exiting environment: Show a friendly message

❯ uv run env_init
🚧 The configuration file 'execution-spec-tests/env.yaml' already exists. Please update it manually if needed.

3. Nudge user if the env.yaml does not exist

FileNotFoundError: The configuration file 'execution-spec-tests/env.yaml' does not exist. Run `uv run env_int` to create it.

If this looks okay then I will start documenting it.

[danceratopz]

I have made the following updates
....
If this looks okay then I will start documenting it.

Thanks for addressing the nits. Looks great, thanks! Ready for doc.

[raxhvl]

@danceratopz All done.

[danceratopz]

This is great! 🌟 Thanks a lot for this!