♻️ refactor(eest): migrate env_init to eest make env (#996)

Co-authored-by: danceratopz <[email protected]>

Author: raxhvl

docs/CHANGELOG.md

@@ -58,6 +58,7 @@ Test fixtures for use by clients are available for each release on the [Github r
 - ✨ Add the `eest make test` command, an interactive CLI that helps users create a new test module and function ([#950](https://github.com/ethereum/execution-spec-tests/pull/950)).
 - ✨ Add the `eest clean` command that helps delete generated files and directories from the repository ([#980](https://github.com/ethereum/execution-spec-tests/pull/980)).
 - ✨ Add framework changes for EIP-7742, required for Prague devnet-5 ([#931](https://github.com/ethereum/execution-spec-tests/pull/931)).
+- ✨ Add the `eest make env` command that generates a default env file (`env.yaml`)([#996](https://github.com/ethereum/execution-spec-tests/pull/996)).
 
 ### 🔧 EVM Tools
 

docs/dev/configurations.md

@@ -19,17 +19,17 @@ Application-wide [environment configuration](https://www.12factor.net/config), w
 
 This file will not be tracked by git, making it safe for storing local secrets.
 
-To get started, run the command [env_init](../library/cli/env_init.md) cli to initialize your environment configuration.
+To get started, run the command [eest make env](../library/cli/eest.md) cli to initialize your environment configuration.
 
 ### Usage
 
 #### 1. Generate env file
 
-Run the [`env_init`](../library/cli/env_init.md) cli tool.
+Run the [`eest make env`](../library/cli/eest.md) cli tool.
 
 ```console
-➜ uv run env_init
-Env file created:  execution-spec-tests/env.yaml
+uv run eest make env
+🎉 Success! Config file created at: <path>/env.yaml
 ```
 
 which should generate an `env.yaml` in the project root.

docs/library/cli/env_init.md

@@ -2,4 +2,3 @@
 
 - [`eest`](eest.md) - A CLI tool that helps with routine tasks in ethereum/execution-spec-tests.
 - [`evm_bytes`](evm_bytes.md) - Convert the given EVM bytes from a binary file or a hex string to EEST's python opcodes.
-- [`env_init`](env_init.md) - Generate an example `env.yaml` [environment](../../dev/configurations.md) config file if it doesn't exist.

docs/library/cli/index.md

@@ -107,7 +107,6 @@ markdownlintcli2_soft_fail = "cli.tox_helpers:markdownlint"
 order_fixtures = "cli.order_fixtures:order_fixtures"
 evm_bytes = "cli.evm_bytes:evm_bytes"
 hasher = "cli.hasher:main"
-env_init = "config.env:create_default_config"
 eest = "cli.eest.cli:eest"
 
 [tool.setuptools.packages.find]

pyproject.toml

@@ -10,6 +10,8 @@
 
 import click
 
+from cli.eest.make.commands import create_default_env
+
 from .commands import test
 
 
@@ -32,3 +34,4 @@ def make():
 https://click.palletsprojects.com/en/8.0.x/commands/#nested-handling-and-contexts
 """
 make.add_command(test)
+make.add_command(create_default_env)

src/cli/eest/make/cli.py

@@ -4,6 +4,7 @@
 `cli.py`.
 """
 
+from .env import create_default_env
 from .test import test
 
-__all__ = ["test"]
+__all__ = ["test", "create_default_env"]

src/cli/eest/make/commands/__init__.py

@@ -0,0 +1,53 @@
+"""
+CLI commands for managing the environment file.
+"""
+
+import click
+from jinja2 import Environment, PackageLoader
+
+from cli.eest.quotes import get_quote
+from config.env import ENV_PATH, Config
+
+
+@click.command(short_help="Generate the default environment file (env.yaml).", name="env")
+def create_default_env():
+    """
+    A CLI command to generate the default environment file (env.yaml).
+
+    If an `env.yaml` already exists, this command will NOT override it.
+    In that case, it is recommended to manually make changes.
+
+    _Easter egg: Shows a random quote after creating the environment file._
+
+    Example:
+
+        uv run eest make env
+
+    Output:
+
+        🎉 Success! Environment file created at: <path>/env.yaml
+
+        🚀 Well begun is half done. - Aristotle
+    """
+    # Check if the env file already exists
+    if ENV_PATH.exists():
+        click.echo(
+            click.style(
+                f"🚧 The env file '{ENV_PATH}' already exists. "
+                "Please update it manually if needed.",
+                fg="red",
+            )
+        )
+        exit(1)
+
+    template_environment = Environment(
+        loader=PackageLoader("config"), trim_blocks=True, lstrip_blocks=True
+    )
+    template = template_environment.get_template("env.yaml.j2")
+
+    env_yaml = template.render(config=Config())
+
+    with ENV_PATH.open("w") as file:
+        file.write(env_yaml)
+        click.echo(click.style(f"🎉 Success! Environment file created at: {ENV_PATH}", fg="green"))
+        click.echo(get_quote())

src/cli/eest/make/commands/env.py

@@ -22,7 +22,6 @@
 from typing import Dict, List
 
 import yaml
-from jinja2 import Environment, PackageLoader
 from pydantic import BaseModel, HttpUrl, ValidationError
 
 ENV_PATH = Path(__file__).resolve().parent.parent.parent / "env.yaml"
@@ -75,30 +74,3 @@ def __init__(self):
                 super().__init__(**config_data)
             except ValidationError as e:
                 raise ValueError(f"Invalid configuration: {e}")
-
-
-def create_default_config():
-    """
-    Creates a default configuration file `env.yaml` from the Jinja2 template.
-
-    Raises:
-        IOError: If there is an error writing to the `env.yaml` file.
-    """
-    # Check if the config file already exists
-    if ENV_PATH.exists():
-        print(
-            f"🚧 The configuration file '{ENV_PATH}' already exists. "
-            "Please update it manually if needed."
-        )
-        exit(1)
-
-    template_environment = Environment(
-        loader=PackageLoader("config"), trim_blocks=True, lstrip_blocks=True
-    )
-    template = template_environment.get_template("env.yaml.j2")
-
-    env_yaml = template.render(config=Config())
-
-    with ENV_PATH.open("w") as file:
-        file.write(env_yaml)
-        print(f"Env file created: {ENV_PATH}")