chores(fill): remove --flat-output and all logic associated with it (#2018)

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

Author: felix314159

docs/CHANGELOG.md

@@ -82,6 +82,7 @@ Users can select any of the artifacts depending on their testing needs for their
 - ✨ Added support for the `--benchmark-gas-values` flag in the `fill` command, allowing a single genesis file to be used across different gas limit settings when generating fixtures. ([#1895](https://github.com/ethereum/execution-spec-tests/pull/1895)).
 - ✨ Static tests can now specify a maximum fork where they should be filled for ([#1977](https://github.com/ethereum/execution-spec-tests/pull/1977)).
 - ✨ Static tests can now be filled in every format using `--generate-all-formats` ([#2006](https://github.com/ethereum/execution-spec-tests/pull/2006)).
+- 💥 Flag `--flat-output` has been removed due to having been unneeded for an extended period of time ([#2018](https://github.com/ethereum/execution-spec-tests/pull/2018)).
 - ✨ Add support for `BlockchainEngineSyncFixture` format for tests marked with `pytest.mark.verify_sync` to enable client synchronization testing via `consume sync` command ([#2007](https://github.com/ethereum/execution-spec-tests/pull/2007)).
 
 #### `consume`

src/ethereum_test_fixtures/collector.py

@@ -108,7 +108,6 @@ class FixtureCollector:
     """Collects all fixtures generated by the test cases."""
 
     output_dir: Path
-    flat_output: bool
     fill_static_tests: bool
     single_fixture_per_file: bool
     filler_path: Path
@@ -121,21 +120,16 @@ class FixtureCollector:
 
     def get_fixture_basename(self, info: TestInfo) -> Path:
         """Return basename of the fixture file for a given test case."""
-        if self.flat_output:
-            if self.single_fixture_per_file:
-                return Path(info.get_single_test_name(mode="test"))
-            return Path(info.get_single_test_name(mode="module"))
-        else:
-            module_relative_output_dir = info.get_module_relative_output_dir(self.filler_path)
+        module_relative_output_dir = info.get_module_relative_output_dir(self.filler_path)
 
-            # Each legacy test filler has only 1 test per file if it's a !state test!
-            # So no need to create directory Add11/add11.json it can be plain add11.json
-            if self.fill_static_tests:
-                return module_relative_output_dir.parent / info.original_name
+        # Each legacy test filler has only 1 test per file if it's a !state test!
+        # So no need to create directory Add11/add11.json it can be plain add11.json
+        if self.fill_static_tests:
+            return module_relative_output_dir.parent / info.original_name
 
-            if self.single_fixture_per_file:
-                return module_relative_output_dir / info.get_single_test_name(mode="test")
-            return module_relative_output_dir / info.get_single_test_name(mode="module")
+        if self.single_fixture_per_file:
+            return module_relative_output_dir / info.get_single_test_name(mode="test")
+        return module_relative_output_dir / info.get_single_test_name(mode="module")
 
     def add_fixture(self, info: TestInfo, fixture: BaseFixture) -> Path:
         """Add fixture to the list of fixtures of a given test case."""

src/pytest_plugins/filler/filler.py

@@ -477,13 +477,6 @@ def pytest_addoption(parser: pytest.Parser):
         default=False,
         help="Clean (remove) the output directory before filling fixtures.",
     )
-    test_group.addoption(
-        "--flat-output",
-        action="store_true",
-        dest="flat_output",
-        default=False,
-        help="Output each test case in the directory without the folder structure.",
-    )
     test_group.addoption(
         "--single-fixture-per-file",
         action="store_true",
@@ -1061,7 +1054,6 @@ def fixture_collector(
 
     fixture_collector = FixtureCollector(
         output_dir=fixture_output.directory,
-        flat_output=fixture_output.flat_output,
         fill_static_tests=request.config.getoption("fill_static_tests_enabled"),
         single_fixture_per_file=fixture_output.single_fixture_per_file,
         filler_path=filler_path,

src/pytest_plugins/filler/fixture_output.py

@@ -14,10 +14,6 @@ class FixtureOutput(BaseModel):
     """Represents the output destination for generated test fixtures."""
 
     output_path: Path = Field(description="Directory path to store the generated test fixtures")
-    flat_output: bool = Field(
-        default=False,
-        description="Output each test case in the directory without the folder structure",
-    )
     single_fixture_per_file: bool = Field(
         default=False,
         description=(
@@ -221,7 +217,6 @@ def from_config(cls, config: pytest.Config) -> "FixtureOutput":
 
         return cls(
             output_path=output_path,
-            flat_output=config.getoption("flat_output"),
             single_fixture_per_file=config.getoption("single_fixture_per_file"),
             clean=config.getoption("clean"),
             generate_pre_alloc_groups=config.getoption("generate_pre_alloc_groups"),

src/pytest_plugins/filler/tests/test_filler.py

@@ -150,44 +150,6 @@ def test_shanghai_two(state_test, x):
             [2, 2, 2, 2, 2, 2, 2, 2, 2, 6, 6, 6],
             id="build-name-in-fixtures-ini-file",
         ),
-        pytest.param(
-            ["--flat-output"],
-            [
-                Path("fixtures/blockchain_tests/paris_one.json"),
-                Path("fixtures/blockchain_tests_engine/paris_one.json"),
-                Path("fixtures/state_tests/paris_one.json"),
-                Path("fixtures/blockchain_tests/paris_two.json"),
-                Path("fixtures/blockchain_tests_engine/paris_two.json"),
-                Path("fixtures/state_tests/paris_two.json"),
-                Path("fixtures/blockchain_tests/shanghai_one.json"),
-                Path("fixtures/blockchain_tests_engine/shanghai_one.json"),
-                Path("fixtures/state_tests/shanghai_one.json"),
-                Path("fixtures/blockchain_tests/shanghai_two.json"),
-                Path("fixtures/blockchain_tests_engine/shanghai_two.json"),
-                Path("fixtures/state_tests/shanghai_two.json"),
-            ],
-            [2, 2, 2, 2, 2, 2, 2, 2, 2, 6, 6, 6],
-            id="flat-output",
-        ),
-        pytest.param(
-            ["--flat-output", "--output", "other_fixtures"],
-            [
-                Path("other_fixtures/blockchain_tests/paris_one.json"),
-                Path("other_fixtures/blockchain_tests_engine/paris_one.json"),
-                Path("other_fixtures/state_tests/paris_one.json"),
-                Path("other_fixtures/blockchain_tests/paris_two.json"),
-                Path("other_fixtures/blockchain_tests_engine/paris_two.json"),
-                Path("other_fixtures/state_tests/paris_two.json"),
-                Path("other_fixtures/blockchain_tests/shanghai_one.json"),
-                Path("other_fixtures/blockchain_tests_engine/shanghai_one.json"),
-                Path("other_fixtures/state_tests/shanghai_one.json"),
-                Path("other_fixtures/blockchain_tests/shanghai_two.json"),
-                Path("other_fixtures/blockchain_tests_engine/shanghai_two.json"),
-                Path("other_fixtures/state_tests/shanghai_two.json"),
-            ],
-            [2, 2, 2, 2, 2, 2, 2, 2, 2, 6, 6, 6],
-            id="flat-output_custom-output-dir",
-        ),
         pytest.param(
             ["--single-fixture-per-file"],
             [
@@ -418,97 +380,6 @@ def test_shanghai_two(state_test, x):
             [1] * 36,
             id="single-fixture-per-file_custom_output_dir",
         ),
-        pytest.param(
-            ["--flat-output", "--single-fixture-per-file"],
-            [
-                Path(
-                    "fixtures/blockchain_tests/paris_one__fork_Paris_blockchain_test_from_state_test.json"
-                ),
-                Path("fixtures/state_tests/paris_one__fork_Paris_state_test.json"),
-                Path(
-                    "fixtures/blockchain_tests_engine/paris_one__fork_Paris_blockchain_test_engine_from_state_test.json"
-                ),
-                Path(
-                    "fixtures/blockchain_tests/paris_one__fork_Shanghai_blockchain_test_from_state_test.json"
-                ),
-                Path("fixtures/state_tests/paris_one__fork_Shanghai_state_test.json"),
-                Path(
-                    "fixtures/blockchain_tests_engine/paris_one__fork_Shanghai_blockchain_test_engine_from_state_test.json"
-                ),
-                Path(
-                    "fixtures/blockchain_tests/paris_two__fork_Paris_blockchain_test_from_state_test.json"
-                ),
-                Path("fixtures/state_tests/paris_two__fork_Paris_state_test.json"),
-                Path(
-                    "fixtures/blockchain_tests_engine/paris_two__fork_Paris_blockchain_test_engine_from_state_test.json"
-                ),
-                Path(
-                    "fixtures/blockchain_tests/paris_two__fork_Shanghai_blockchain_test_from_state_test.json"
-                ),
-                Path("fixtures/state_tests/paris_two__fork_Shanghai_state_test.json"),
-                Path(
-                    "fixtures/blockchain_tests_engine/paris_two__fork_Shanghai_blockchain_test_engine_from_state_test.json"
-                ),
-                Path(
-                    "fixtures/blockchain_tests/shanghai_one__fork_Paris_blockchain_test_from_state_test.json"
-                ),
-                Path("fixtures/state_tests/shanghai_one__fork_Paris_state_test.json"),
-                Path(
-                    "fixtures/blockchain_tests_engine/shanghai_one__fork_Paris_blockchain_test_engine_from_state_test.json"
-                ),
-                Path(
-                    "fixtures/blockchain_tests/shanghai_one__fork_Shanghai_blockchain_test_from_state_test.json"
-                ),
-                Path("fixtures/state_tests/shanghai_one__fork_Shanghai_state_test.json"),
-                Path(
-                    "fixtures/blockchain_tests_engine/shanghai_one__fork_Shanghai_blockchain_test_engine_from_state_test.json"
-                ),
-                Path(
-                    "fixtures/blockchain_tests/shanghai_two__fork_Paris_blockchain_test_from_state_test_x_1.json"
-                ),
-                Path("fixtures/state_tests/shanghai_two__fork_Paris_state_test_x_1.json"),
-                Path(
-                    "fixtures/blockchain_tests_engine/shanghai_two__fork_Paris_blockchain_test_engine_from_state_test_x_1.json"
-                ),
-                Path(
-                    "fixtures/blockchain_tests/shanghai_two__fork_Paris_blockchain_test_from_state_test_x_2.json"
-                ),
-                Path("fixtures/state_tests/shanghai_two__fork_Paris_state_test_x_2.json"),
-                Path(
-                    "fixtures/blockchain_tests_engine/shanghai_two__fork_Paris_blockchain_test_engine_from_state_test_x_2.json"
-                ),
-                Path(
-                    "fixtures/blockchain_tests/shanghai_two__fork_Paris_blockchain_test_from_state_test_x_3.json"
-                ),
-                Path("fixtures/state_tests/shanghai_two__fork_Paris_state_test_x_3.json"),
-                Path(
-                    "fixtures/blockchain_tests_engine/shanghai_two__fork_Paris_blockchain_test_engine_from_state_test_x_3.json"
-                ),
-                Path(
-                    "fixtures/blockchain_tests/shanghai_two__fork_Shanghai_blockchain_test_from_state_test_x_1.json"
-                ),
-                Path("fixtures/state_tests/shanghai_two__fork_Shanghai_state_test_x_1.json"),
-                Path(
-                    "fixtures/blockchain_tests_engine/shanghai_two__fork_Shanghai_blockchain_test_engine_from_state_test_x_1.json"
-                ),
-                Path(
-                    "fixtures/blockchain_tests/shanghai_two__fork_Shanghai_blockchain_test_from_state_test_x_2.json"
-                ),
-                Path("fixtures/state_tests/shanghai_two__fork_Shanghai_state_test_x_2.json"),
-                Path(
-                    "fixtures/blockchain_tests_engine/shanghai_two__fork_Shanghai_blockchain_test_engine_from_state_test_x_2.json"
-                ),
-                Path(
-                    "fixtures/blockchain_tests/shanghai_two__fork_Shanghai_blockchain_test_from_state_test_x_3.json"
-                ),
-                Path("fixtures/state_tests/shanghai_two__fork_Shanghai_state_test_x_3.json"),
-                Path(
-                    "fixtures/blockchain_tests_engine/shanghai_two__fork_Shanghai_blockchain_test_engine_from_state_test_x_3.json"
-                ),
-            ],
-            [1] * 36,
-            id="flat-single-per-file_flat-output",
-        ),
     ],
 )
 def test_fixture_output_based_on_command_line_args(

src/pytest_plugins/filler/tests/test_generate_all_formats.py

@@ -27,7 +27,6 @@ class MockConfig:
         def getoption(self, option):
             option_values = {
                 "output": "/tmp/test",
-                "flat_output": False,
                 "single_fixture_per_file": False,
                 "clean": False,
                 "generate_pre_alloc_groups": False,
@@ -51,7 +50,6 @@ class MockConfig:
         def getoption(self, option):
             option_values = {
                 "output": "/tmp/fixtures.tar.gz",  # Tarball output
-                "flat_output": False,
                 "single_fixture_per_file": False,
                 "clean": False,
                 "generate_pre_alloc_groups": False,
@@ -76,7 +74,6 @@ class MockConfig:
         def getoption(self, option):
             option_values = {
                 "output": "/tmp/fixtures",  # Regular directory output
-                "flat_output": False,
                 "single_fixture_per_file": False,
                 "clean": False,
                 "generate_pre_alloc_groups": False,
@@ -101,7 +98,6 @@ class MockConfig:
         def getoption(self, option):
             option_values = {
                 "output": "/tmp/fixtures.tar.gz",  # Tarball output
-                "flat_output": False,
                 "single_fixture_per_file": False,
                 "clean": False,
                 "generate_pre_alloc_groups": False,