Add tests on current configuration check for cooker instantiation

swh/vault/cookers/__init__.py

-# Copyright (C) 2017  The Software Heritage developers
+# Copyright (C) 2017-2020  The Software Heritage developers
 # See the AUTHORS file at the top-level directory of this distribution
 # License: GNU General Public License version 3, or any later version
 # See top-level LICENSE file for more information
@@ -24,26 +24,37 @@ def get_cooker_cls(obj_type):
     return COOKER_TYPES[obj_type]
 
 
-def get_cooker(obj_type, obj_id):
+def get_cooker(obj_type: str, obj_id: str):
+    """Instantiate a cooker class of type obj_type.
+
+    Returns:
+        Cooker class in charge of cooking the obj_type with id obj_id.
+
+    Raises:
+        ValueError in case of a missing top-level vault key configuration or a storage
+          key.
+        EnvironmentError in case the vault configuration reference a non remote class.
+
+    """
     if "SWH_CONFIG_FILENAME" in os.environ:
         cfg = read_config(os.environ["SWH_CONFIG_FILENAME"], DEFAULT_CONFIG)
     else:
         cfg = load_named_config(DEFAULT_CONFIG_PATH, DEFAULT_CONFIG)
     cooker_cls = get_cooker_cls(obj_type)
     if "vault" not in cfg:
-        raise ValueError("missing '%vault' configuration")
+        raise ValueError("missing 'vault' configuration")
 
     vcfg = cfg["vault"]
     if vcfg["cls"] != "remote":
         raise EnvironmentError(
-            "This vault backend can only be a 'remote' " "configuration", err=True
+            "This vault backend can only be a 'remote' configuration"
         )
     args = vcfg["args"]
     if "storage" not in args:
         args["storage"] = cfg.get("storage")
 
     if not args.get("storage"):
-        raise ValueError("invalid configuration; missing 'storage' config entry.")
+        raise ValueError("invalid configuration: missing 'storage' config entry.")
 
     storage = get_storage(**args.pop("storage"))
     backend = get_vault(**vcfg)

swh/vault/cookers/base.py

@@ -15,8 +15,6 @@ from swh.model import hashutil
 MAX_BUNDLE_SIZE = 2 ** 29  # 512 MiB
 DEFAULT_CONFIG_PATH = "vault/cooker"
 DEFAULT_CONFIG = {
-    "storage": ("dict", {"cls": "remote", "args": {"url": "http://localhost:5002/",},}),
-    "vault": ("dict", {"cls": "remote", "args": {"url": "http://localhost:5005/",},}),
     "max_bundle_size": ("int", MAX_BUNDLE_SIZE),
 }
 

swh/vault/tests/test_init_cookers.py

+# Copyright (C) 2017-2020  The Software Heritage developers
+# See the AUTHORS file at the top-level directory of this distribution
+# License: GNU General Public License version 3, or any later version
+# See top-level LICENSE file for more information
+
+import os
+from typing import Dict
+
+import pytest
+import yaml
+
+from swh.vault.cookers import COOKER_TYPES, get_cooker
+from swh.vault.tests.test_backend import TEST_HEX_ID
+
+
+@pytest.fixture
+def swh_cooker_config():
+    return {
+        "vault": {
+            "cls": "remote",
+            "args": {
+                "url": "mock://vault-backend",
+                "storage": {"cls": "remote", "url": "mock://storage-url"},
+            },
+        }
+    }
+
+
+def write_config_to_env(config: Dict, tmp_path, monkeypatch) -> str:
+    """Write the configuration dict into a temporary file, then reference that path to
+       SWH_CONFIG_FILENAME environment variable.
+
+    """
+    conf_path = os.path.join(str(tmp_path), "cooker.yml")
+    with open(conf_path, "w") as f:
+        f.write(yaml.dump(config))
+    monkeypatch.setenv("SWH_CONFIG_FILENAME", conf_path)
+    return conf_path
+
+
+def test_write_to_env(swh_cooker_config, tmp_path, monkeypatch):
+    actual_path = write_config_to_env(swh_cooker_config, tmp_path, monkeypatch)
+
+    assert os.path.exists(actual_path) is True
+    assert os.environ["SWH_CONFIG_FILENAME"] == actual_path
+
+    with open(actual_path, "r") as f:
+        actual_config = yaml.safe_load(f.read())
+    assert actual_config == swh_cooker_config
+
+
+@pytest.mark.parametrize(
+    "config_ko,exception_class,exception_msg",
+    [
+        ({}, ValueError, "missing 'vault' configuration"),
+        (
+            {"vault": {"cls": "local"}},
+            EnvironmentError,
+            "This vault backend can only be a 'remote' configuration",
+        ),
+        (
+            {"vault": {"cls": "remote", "args": {"missing-storage-key": ""}}},
+            ValueError,
+            "invalid configuration: missing 'storage' config entry",
+        ),
+        ({"vault": {"cls": "remote"}}, KeyError, "args",),
+    ],
+)
+def test_get_cooker_config_ko(
+    config_ko, exception_class, exception_msg, monkeypatch, tmp_path
+):
+    """Misconfigured cooker should fail the instantiation with exception message
+
+    """
+    write_config_to_env(config_ko, tmp_path, monkeypatch)
+
+    with pytest.raises(exception_class, match=exception_msg):
+        get_cooker("directory", TEST_HEX_ID)
+
+
+@pytest.mark.parametrize(
+    "config_ok",
+    [
+        {
+            "vault": {
+                "cls": "remote",
+                "args": {
+                    "url": "mock://vault-backend",
+                    "storage": {"cls": "remote", "url": "mock://storage-url"},
+                },
+            }
+        },
+        {
+            "vault": {"cls": "remote", "args": {"url": "mock://vault-backend",},},
+            "storage": {"cls": "remote", "url": "mock://storage-url"},
+        },
+    ],
+)
+def test_get_cooker_nominal(config_ok, tmp_path, monkeypatch):
+    """Correct configuration should allow the instantiation of the cookers
+
+    """
+    for cooker_type in COOKER_TYPES.keys():
+        write_config_to_env(config_ok, tmp_path, monkeypatch)
+
+        cooker = get_cooker(cooker_type, TEST_HEX_ID)
+
+        assert cooker is not None
+        assert isinstance(cooker, COOKER_TYPES[cooker_type])