feat: ✨ collect all Sprout-specific property errors

seedcase_sprout/core/sprout_checks/get_sprout_package_errors.py

@@ -0,0 +1,29 @@
+from seedcase_sprout.core.checks.check_error import CheckError
+from seedcase_sprout.core.sprout_checks.check_fields_present import (
+    check_fields_present,
+)
+from seedcase_sprout.core.sprout_checks.check_required_package_properties_not_blank import (  # noqa: E501
+    check_required_package_properties_not_blank,
+)
+from seedcase_sprout.core.sprout_checks.required_fields import (
+    PACKAGE_SPROUT_REQUIRED_FIELDS,
+)
+
+
+def get_sprout_package_errors(
+    properties: dict, check_required: bool
+) -> list[CheckError]:
+    """Checks the package `properties` against Sprout-specific requirements only.
+
+    Args:
+        properties: The package properties.
+        check_required: Whether the function should enforce the presence of required
+            fields.
+
+    Returns:
+        A list of errors. An empty list if no errors were found.
+    """
+    errors = check_required_package_properties_not_blank(properties)
+    if check_required:
+        errors += check_fields_present(properties, PACKAGE_SPROUT_REQUIRED_FIELDS)
+    return errors

seedcase_sprout/core/sprout_checks/get_sprout_resource_errors.py

@@ -0,0 +1,48 @@
+import seedcase_sprout.core.checks as checks
+from seedcase_sprout.core.sprout_checks.check_fields_not_blank import (
+    check_fields_not_blank,
+)
+from seedcase_sprout.core.sprout_checks.check_fields_present import (
+    check_fields_present,
+)
+from seedcase_sprout.core.sprout_checks.check_id_in_resource_path import (
+    check_id_in_resource_path,
+)
+from seedcase_sprout.core.sprout_checks.check_no_inline_data import check_no_inline_data
+from seedcase_sprout.core.sprout_checks.check_resource_path_string import (
+    check_resource_path_string,
+)
+from seedcase_sprout.core.sprout_checks.required_fields import (
+    RESOURCE_SPROUT_REQUIRED_FIELDS,
+)
+
+
+def get_sprout_resource_errors(
+    properties: dict, check_required: bool, index: int | None = None
+) -> list[checks.CheckError]:
+    """Checks the resource `properties` against Sprout-specific requirements only.
+
+    Args:
+        properties: The resource properties.
+        check_required: Whether the function should enforce the presence of required
+            fields.
+        index: The index of the resource properties. Defaults to None.
+
+    Returns:
+        A list of errors. An empty list if no errors were found.
+    """
+    errors = check_resource_path_string(properties, index)
+    errors += check_id_in_resource_path(properties, index)
+    errors += check_no_inline_data(properties, index)
+    errors += check_fields_not_blank(
+        properties,
+        RESOURCE_SPROUT_REQUIRED_FIELDS,
+        index,
+    )
+
+    if check_required:
+        errors += check_fields_present(
+            properties, RESOURCE_SPROUT_REQUIRED_FIELDS, index
+        )
+
+    return errors

tests/core/sprout_checks/test_get_sprout_package_errors.py

@@ -0,0 +1,86 @@
+from pytest import fixture, mark
+
+from seedcase_sprout.core.properties import PackageProperties
+from seedcase_sprout.core.sprout_checks.get_blank_value_for_type import (
+    get_blank_value_for_type,
+)
+from seedcase_sprout.core.sprout_checks.get_sprout_package_errors import (
+    get_sprout_package_errors,
+)
+from seedcase_sprout.core.sprout_checks.required_fields import (
+    PACKAGE_SPROUT_REQUIRED_FIELDS,
+)
+
+
+@fixture
+def properties():
+    return PackageProperties(
+        name="package-1",
+        id="abc1",
+        title="Package 1",
+        description="A package.",
+        version="1.0.0",
+        created="2024-05-14T05:00:01+00:00",
+        licenses=[{"name": "a-license"}],
+        contributors=[{"title": "a contributor"}],
+        sources=[{"title": "a source"}],
+    ).compact_dict
+
+
+# Check required fields
+
+
+def test_passes_full_package_properties(properties):
+    """Should pass with a full set of package properties."""
+    assert get_sprout_package_errors(properties, check_required=True) == []
+
+
+@mark.parametrize("name,type", PACKAGE_SPROUT_REQUIRED_FIELDS.items())
+def test_error_found_if_fields_are_blank(properties, name, type):
+    """Should find an error if there is one required field that is present but blank."""
+    properties[name] = get_blank_value_for_type(type)
+
+    errors = get_sprout_package_errors(properties, check_required=True)
+
+    assert len(errors) == 1
+    assert errors[0].json_path == f"$.{name}"
+    assert errors[0].validator == "blank"
+
+
+@mark.parametrize("name", PACKAGE_SPROUT_REQUIRED_FIELDS.keys())
+def test_error_found_if_required_fields_are_missing(properties, name):
+    """Should find an error if there is a missing required field and required fields are
+    enforced."""
+    del properties[name]
+
+    errors = get_sprout_package_errors(properties, check_required=True)
+
+    assert len(errors) == 1
+    assert errors[0].json_path == f"$.{name}"
+    assert errors[0].validator == "required"
+
+
+# Do not check required fields
+
+
+def test_passes_full_package_properties_without_required_check(properties):
+    """Should pass with a full set of package properties."""
+    assert get_sprout_package_errors(properties, check_required=False) == []
+
+
+def test_passes_partial_package_properties_without_required_check():
+    """Should pass with missing required fields when required fields are not
+    enforced."""
+    assert get_sprout_package_errors({}, check_required=False) == []
+
+
+@mark.parametrize("name,type", PACKAGE_SPROUT_REQUIRED_FIELDS.items())
+def test_error_found_if_fields_are_blank_without_required_check(properties, name, type):
+    """Should find an error if there is one required field that is present but blank."""
+    properties[name] = get_blank_value_for_type(type)
+
+    errors = get_sprout_package_errors(properties, check_required=False)
+
+    assert len(errors) == 1
+    assert errors[0].json_path == f"$.{name}"
+    assert errors[0].validator == "blank"

tests/core/sprout_checks/test_get_sprout_resource_errors.py

@@ -0,0 +1,123 @@
+from pathlib import Path
+
+from pytest import fixture, mark
+
+from seedcase_sprout.core.properties import ResourceProperties
+from seedcase_sprout.core.sprout_checks.get_blank_value_for_type import (
+    get_blank_value_for_type,
+)
+from seedcase_sprout.core.sprout_checks.get_json_path_to_resource_field import (
+    get_json_path_to_resource_field,
+)
+from seedcase_sprout.core.sprout_checks.get_sprout_resource_errors import (
+    get_sprout_resource_errors,
+)
+from seedcase_sprout.core.sprout_checks.required_fields import (
+    RESOURCE_SPROUT_REQUIRED_FIELDS,
+)
+
+
+@fixture
+def properties():
+    return ResourceProperties(
+        name="resource-1",
+        path=str(Path("resources", "1", "data.parquet")),
+        title="Resource 1",
+        description="A resource.",
+    ).compact_dict
+
+
+@fixture
+def properties_partial():
+    return ResourceProperties(
+        path=str(Path("resources", "1", "data.parquet")),
+    ).compact_dict
+
+
+# Check required fields
+
+
+def test_passes_full_resource_properties(properties):
+    """Should pass with a full set of resource properties."""
+    assert get_sprout_resource_errors(properties, check_required=True) == []
+
+
+@mark.parametrize("index", [None, 2])
+def test_error_found_if_inline_data_is_set(properties, index):
+    """Should find an error if inline data is set."""
+    properties["data"] = "some data"
+
+    errors = get_sprout_resource_errors(properties, check_required=True, index=index)
+
+    assert len(errors) == 1
+    assert errors[0].json_path == get_json_path_to_resource_field("data", index)
+    assert errors[0].validator == "inline-data"
+
+
+@mark.parametrize("index", [None, 2])
+@mark.parametrize("name,type", RESOURCE_SPROUT_REQUIRED_FIELDS.items())
+def test_error_found_if_fields_are_blank(properties, name, type, index):
+    """Should find an error if there is one required field that is present but blank."""
+    properties[name] = get_blank_value_for_type(type)
+
+    errors = get_sprout_resource_errors(properties, check_required=True, index=index)
+    blank_errors = [error for error in errors if error.validator == "blank"]
+
+    assert len(blank_errors) == 1
+    assert blank_errors[0].json_path == get_json_path_to_resource_field(name, index)
+
+
+@mark.parametrize("index", [None, 2])
+@mark.parametrize("name", RESOURCE_SPROUT_REQUIRED_FIELDS.keys())
+def test_error_found_if_required_fields_are_missing(properties, name, index):
+    """Should find an error if there is a missing required field and required fields are
+    enforced."""
+    del properties[name]
+
+    errors = get_sprout_resource_errors(properties, check_required=True, index=index)
+    required_errors = [error for error in errors if error.validator == "required"]
+
+    assert len(required_errors) == 1
+    assert required_errors[0].json_path == get_json_path_to_resource_field(name, index)
+
+
+# Do not check required fields
+
+
+def test_passes_full_resource_properties_without_required_check(properties):
+    """Should pass with a full set of resource properties."""
+    assert get_sprout_resource_errors(properties, check_required=False) == []
+
+
+def test_passes_partial_resource_properties_without_required_check():
+    """Should pass with missing required fields when required fields are not
+    enforced."""
+    assert get_sprout_resource_errors({}, check_required=False) == []
+
+
+@mark.parametrize("path", ["", [], str(Path("resources", "1"))])
+def test_error_found_if_data_path_is_incorrect_(properties, path):
+    """Should find at least one error if `path` contains no resource ID, is not a
+    string, or is otherwise malformed."""
+    properties["path"] = path
+
+    errors = get_sprout_resource_errors(properties, check_required=False)
+
+    assert len(errors) >= 1
+
+
+@mark.parametrize("index", [None, 2])
+@mark.parametrize("name,type", RESOURCE_SPROUT_REQUIRED_FIELDS.items())
+def test_error_found_if_fields_are_blank_without_required_check(
+    properties_partial, name, type, index
+):
+    """Should find an error if there is one required field that is present but blank."""
+    properties_partial[name] = get_blank_value_for_type(type)
+
+    errors = get_sprout_resource_errors(
+        properties_partial, check_required=False, index=index
+    )
+    blank_errors = [error for error in errors if error.validator == "blank"]
+
+    assert len(blank_errors) == 1
+    assert blank_errors[0].json_path == get_json_path_to_resource_field(name, index)