fix(consume): fix consume cache's --cache-folder flag (#1851)

Author: richardgreg

docs/CHANGELOG.md

@@ -46,6 +46,7 @@ Users can select any of the artifacts depending on their testing needs for their
 
 #### `consume`
 
+- 🐞 Fix `consume cache --cache-folder` parameter being ignored, now properly caches fixtures in the specified directory instead of always using the default system cache location.
 - 🔀 `consume` now automatically avoids GitHub API calls when using direct release URLs (better for CI environments), while release specifiers like `stable@latest` continue to use the API for version resolution ([#1788](https://github.com/ethereum/execution-spec-tests/pull/1788)).
 - 🔀 Refactor consume simulator architecture to use explicit pytest plugin structure with forward-looking architecture ([#1801](https://github.com/ethereum/execution-spec-tests/pull/1801)).
 - 🔀 Add exponential retry logic to initial fcu within consume engine ([#1815](https://github.com/ethereum/execution-spec-tests/pull/1815)).

src/pytest_plugins/consume/consume.py

@@ -6,7 +6,7 @@
 from dataclasses import dataclass
 from io import BytesIO
 from pathlib import Path
-from typing import List, Tuple
+from typing import List, Optional, Tuple
 from urllib.parse import urlparse
 
 import platformdirs
@@ -114,22 +114,28 @@ class FixturesSource:
     was_cached: bool = False
 
     @classmethod
-    def from_input(cls, input_source: str) -> "FixturesSource":
+    def from_input(
+        cls, input_source: str, cache_folder: Optional[Path] = None
+    ) -> "FixturesSource":
         """Determine the fixture source type and return an instance."""
+        if cache_folder is None:
+            cache_folder = CACHED_DOWNLOADS_DIRECTORY
         if input_source == "stdin":
             return cls(input_option=input_source, path=Path(), is_local=False, is_stdin=True)
         if is_release_url(input_source):
-            return cls.from_release_url(input_source)
+            return cls.from_release_url(input_source, cache_folder)
         if is_url(input_source):
-            return cls.from_url(input_source)
+            return cls.from_url(input_source, cache_folder)
         if ReleaseTag.is_release_string(input_source):
-            return cls.from_release_spec(input_source)
+            return cls.from_release_spec(input_source, cache_folder)
         return cls.validate_local_path(Path(input_source))
 
     @classmethod
-    def from_release_url(cls, url: str) -> "FixturesSource":
+    def from_release_url(cls, url: str, cache_folder: Optional[Path] = None) -> "FixturesSource":
         """Create a fixture source from a supported github repo release URL."""
-        downloader = FixtureDownloader(url, CACHED_DOWNLOADS_DIRECTORY)
+        if cache_folder is None:
+            cache_folder = CACHED_DOWNLOADS_DIRECTORY
+        downloader = FixtureDownloader(url, cache_folder)
         was_cached, path = downloader.download_and_extract()
 
         return cls(
@@ -142,9 +148,11 @@ def from_release_url(cls, url: str) -> "FixturesSource":
         )
 
     @classmethod
-    def from_url(cls, url: str) -> "FixturesSource":
+    def from_url(cls, url: str, cache_folder: Optional[Path] = None) -> "FixturesSource":
         """Create a fixture source from a direct URL."""
-        downloader = FixtureDownloader(url, CACHED_DOWNLOADS_DIRECTORY)
+        if cache_folder is None:
+            cache_folder = CACHED_DOWNLOADS_DIRECTORY
+        downloader = FixtureDownloader(url, cache_folder)
         was_cached, path = downloader.download_and_extract()
         return cls(
             input_option=url,
@@ -156,11 +164,13 @@ def from_url(cls, url: str) -> "FixturesSource":
         )
 
     @classmethod
-    def from_release_spec(cls, spec: str) -> "FixturesSource":
+    def from_release_spec(cls, spec: str, cache_folder: Optional[Path] = None) -> "FixturesSource":
         """Create a fixture source from a release spec (e.g., develop@latest)."""
+        if cache_folder is None:
+            cache_folder = CACHED_DOWNLOADS_DIRECTORY
         url = get_release_url(spec)
         release_page = get_release_page_url(url)
-        downloader = FixtureDownloader(url, CACHED_DOWNLOADS_DIRECTORY)
+        downloader = FixtureDownloader(url, cache_folder)
         was_cached, path = downloader.download_and_extract()
         return cls(
             input_option=spec,
@@ -307,7 +317,9 @@ def pytest_configure(config):  # noqa: D103
         # NOTE: Setting `type=FixturesSource.from_input` in pytest_addoption() causes the option to
         # be evaluated twice which breaks the result of `was_cached`; the work-around is to call it
         # manually here.
-        config.fixtures_source = FixturesSource.from_input(config.option.fixtures_source)
+        config.fixtures_source = FixturesSource.from_input(
+            config.option.fixtures_source, Path(config.option.fixture_cache_folder)
+        )
     config.fixture_source_flags = ["--input", config.fixtures_source.input_option]
 
     if "cache" in sys.argv and not config.fixtures_source:

src/pytest_plugins/consume/tests/test_fixtures_source_input_types.py

@@ -3,7 +3,7 @@
 from pathlib import Path
 from unittest.mock import MagicMock, patch
 
-from pytest_plugins.consume.consume import FixturesSource
+from pytest_plugins.consume.consume import CACHED_DOWNLOADS_DIRECTORY, FixturesSource
 
 
 class TestSimplifiedConsumeBehavior:
@@ -141,7 +141,7 @@ def test_from_input_handles_release_url(self):
 
             FixturesSource.from_input(test_url)
 
-            mock_from_release_url.assert_called_once_with(test_url)
+            mock_from_release_url.assert_called_once_with(test_url, CACHED_DOWNLOADS_DIRECTORY)
 
     def test_from_input_handles_release_spec(self):
         """Test that from_input properly handles release specs."""
@@ -152,7 +152,7 @@ def test_from_input_handles_release_spec(self):
 
             FixturesSource.from_input(test_spec)
 
-            mock_from_release_spec.assert_called_once_with(test_spec)
+            mock_from_release_spec.assert_called_once_with(test_spec, CACHED_DOWNLOADS_DIRECTORY)
 
     def test_from_input_handles_regular_url(self):
         """Test that from_input properly handles regular URLs."""
@@ -163,4 +163,4 @@ def test_from_input_handles_regular_url(self):
 
             FixturesSource.from_input(test_url)
 
-            mock_from_url.assert_called_once_with(test_url)
+            mock_from_url.assert_called_once_with(test_url, CACHED_DOWNLOADS_DIRECTORY)