fix: better isolate tests from local configuration files

### what

ensure default config paths (including credentials) are pointed to temp files
in tests

### why

ensure tests are isolated from the environment. Some tests currently fail if
running locally when a configuration file is present

### testing

tested locally

### docs

n/a

Author: albertodonato

stacklet/client/platform/client.py

@@ -7,8 +7,10 @@
 import jmespath
 
 # import the commands so the registry is populated when the client is instantiated
-from . import commands  # noqa
-from .config import DEFAULT_CONFIG_FILE
+from . import (
+    commands,  # noqa
+    config,
+)
 from .context import StackletContext
 from .executor import StackletGraphqlExecutor
 from .utils import PAGINATION_OPTIONS
@@ -17,8 +19,8 @@
 def platform_client(pager=False, expr=False):
     # for more pythonic experience, pass expr=True to de-graphqlize the result
     # for automatic pagination handling, pass pager=True
-    context = StackletContext(config_file=DEFAULT_CONFIG_FILE)
-    if not DEFAULT_CONFIG_FILE.exists() or not context.credentials.api_token():
+    context = StackletContext(config_file=config.DEFAULT_CONFIG_FILE)
+    if not context.config_file.exists() or not context.credentials.api_token():
         raise ValueError("Please configure and authenticate on stacklet-admin cli")
 
     d = {}

stacklet/client/platform/config.py

@@ -107,7 +107,9 @@ def validate(cls, config: JSONDict):
 class StackletCredentials:
     """Manage credentials files."""
 
-    def __init__(self, config_dir: Path = DEFAULT_CONFIG_DIR) -> None:
+    def __init__(self, config_dir: Path | None = None) -> None:
+        if config_dir is None:
+            config_dir = DEFAULT_CONFIG_DIR
         self.config_dir = config_dir
         self._access_token_file = self.config_dir / "credentials"
         self._id_token_file = self.config_dir / "id"

tests/conftest.py

@@ -18,14 +18,29 @@ def requests_adapter() -> Iterator[requests_mock.Adapter]:
         yield adapter
 
 
+@pytest.fixture(autouse=True)
+def default_stacklet_dir(tmp_path_factory) -> Iterator[Path]:
+    """A default .stacklet directory for testing."""
+    default_config_dir = tmp_path_factory.mktemp(".stacklet")
+    with patch("stacklet.client.platform.config.DEFAULT_CONFIG_DIR", default_config_dir):
+        yield default_config_dir
+
+
+@pytest.fixture(autouse=True)
+def default_config_file(default_stacklet_dir) -> Iterator[Path]:
+    """Override default config file path."""
+    default_config_file = default_stacklet_dir / "config.json"
+    with patch("stacklet.client.platform.config.DEFAULT_CONFIG_FILE", default_config_file):
+        yield default_config_file
+
+
 @pytest.fixture
-def mock_api_token() -> Iterator[str]:
-    token = "mock-token"
-    with patch(
-        "stacklet.client.platform.config.StackletCredentials.api_token",
-        return_value=token,
-    ):
-        yield token
+def api_token_in_file(default_stacklet_dir) -> str:
+    """Provide a configured API token saved to file."""
+    token = "fake-token"
+    token_file = default_stacklet_dir / "credentials"
+    token_file.write_text(token)
+    return token
 
 
 @pytest.fixture
@@ -67,7 +82,7 @@ def invoke(*cmdargs: str, with_config=True) -> Result:
 
 
 @pytest.fixture
-def run_query(requests_adapter, sample_config_file, mock_api_token, invoke_cli):
+def run_query(requests_adapter, sample_config_file, api_token_in_file, invoke_cli):
     def run(base_command: str, args: list[str], response: JSONDict) -> tuple[Result, JSONDict]:
         requests_adapter.register_uri(
             "POST",

tests/test_client.py

@@ -1,14 +1,13 @@
 # Copyright Stacklet, Inc.
 # SPDX-License-Identifier: Apache-2.0
 
-from unittest.mock import patch
+import json
 
 from stacklet.client.platform.client import platform_client
 
 
-@patch("stacklet.client.platform.client.StackletContext")
-def test_client_loaded_commands(_, sample_config_file):
-    with patch("stacklet.client.platform.client.DEFAULT_CONFIG_FILE", sample_config_file):
-        client = platform_client()
+def test_client_loaded_commands(default_config_file, sample_config, api_token_in_file):
+    default_config_file.write_text(json.dumps(sample_config))
+    client = platform_client()
     for attr in ("list_bindings", "list_accounts", "list_repository", "list_policies"):
         assert hasattr(client, attr)

tests/test_cube.py

@@ -16,7 +16,7 @@ def test_missing_token(self, sample_config_file):
         with pytest.raises(MissingToken):
             _request(context, "GET", "v1/meta")
 
-    def test_request_with_token(self, requests_adapter, sample_config_file, mock_api_token):
+    def test_request_with_token(self, requests_adapter, sample_config_file, api_token_in_file):
         """Test that cubejs request works with valid token."""
         context = StackletContext(config_file=sample_config_file)
 
@@ -31,7 +31,7 @@ def test_request_with_token(self, requests_adapter, sample_config_file, mock_api
         assert result == expected_response
 
     def test_cubejs_meta_command(
-        self, requests_adapter, sample_config_file, invoke_cli, mock_api_token
+        self, requests_adapter, sample_config_file, invoke_cli, api_token_in_file
     ):
         """Test cubejs meta command through CLI."""
         expected_response = {

tests/test_graphql.py

@@ -11,7 +11,7 @@
 
 
 @pytest.fixture
-def executor(mock_api_token, sample_config_file) -> StackletGraphqlExecutor:
+def executor(api_token_in_file, sample_config_file) -> StackletGraphqlExecutor:
     context = StackletContext(config_file=sample_config_file)
     return StackletGraphqlExecutor(context)
 
@@ -22,9 +22,9 @@ def test_missing_token(self, sample_config_file):
         with pytest.raises(MissingToken):
             StackletGraphqlExecutor(context)
 
-    def test_executor_run(self, requests_adapter, executor):
+    def test_executor_run(self, requests_adapter, api_token_in_file, executor):
         assert executor.api == "mock://stacklet.acme.org/api"
-        assert executor.session.headers["authorization"] == "Bearer mock-token"
+        assert executor.session.headers["authorization"] == f"Bearer {api_token_in_file}"
 
         requests_adapter.register_uri(
             "POST",
@@ -82,7 +82,7 @@ def test_executor_run(self, requests_adapter, executor):
         }
 
     def test_graphql_executor(
-        self, requests_adapter, sample_config_file, invoke_cli, mock_api_token
+        self, requests_adapter, sample_config_file, api_token_in_file, invoke_cli
     ):
         snippet = '{ platform { dashboardDefinition(name:"cis-v140") } }'