pylock: refine and test some validation erros

Author: sbidoul

src/pip/_internal/models/pylock.py

@@ -85,7 +85,8 @@ def _get(d: Dict[str, Any], expected_type: Type[T], key: str) -> Optional[T]:
         return None
     if not isinstance(value, expected_type):
         raise PylockValidationError(
-            f"{key} has unexpected type {type(value)} (expected {expected_type})"
+            f"{key!r} has unexpected type {type(value).__name__} "
+            f"(expected {expected_type.__name__})"
         )
     return value
 
@@ -114,7 +115,7 @@ def _get_as(
     try:
         return target_type(value)
     except Exception as e:
-        raise PylockValidationError(f"Error parsing value of {key!r}: {e}") from e
+        raise PylockValidationError(f"Error in {key!r}: {e}") from e
 
 
 def _get_required_as(
@@ -145,15 +146,13 @@ def _get_list_as(
     for i, item in enumerate(value):
         if not isinstance(item, expected_type):
             raise PylockValidationError(
-                f"Item {i} of {key} has unpexpected type {type(item)} "
-                f"(expected {expected_type})"
+                f"Item {i} of {key!r} has unexpected type {type(item).__name__} "
+                f"(expected {expected_type.__name__})"
             )
         try:
             result.append(target_type(item))
         except Exception as e:
-            raise PylockValidationError(
-                f"Error parsing item {i} of {key!r}: {e}"
-            ) from e
+            raise PylockValidationError(f"Error in item {i} of {key!r}: {e}") from e
     return result
 
 
@@ -167,7 +166,7 @@ def _get_object(
     try:
         return target_type.from_dict(value)
     except Exception as e:
-        raise PylockValidationError(f"Error parsing value of {key!r}: {e}") from e
+        raise PylockValidationError(f"Error in {key!r}: {e}") from e
 
 
 def _get_list_of_objects(
@@ -184,9 +183,7 @@ def _get_list_of_objects(
         try:
             result.append(target_type.from_dict(item))
         except Exception as e:
-            raise PylockValidationError(
-                f"Error parsing item {i} of {key!r}: {e}"
-            ) from e
+            raise PylockValidationError(f"Error in item {i} of {key!r}: {e}") from e
     return result
 
 

tests/unit/test_pylock.py

@@ -108,7 +108,7 @@ def test_pylock_packages_without_dist() -> None:
     with pytest.raises(PylockValidationError) as exc_info:
         Pylock.from_dict(data)
     assert str(exc_info.value) == (
-        "Error parsing item 0 of 'packages': "
+        "Error in item 0 of 'packages': "
         "Exactly one of vcs, directory, archive must be set "
         "if sdist and wheels are not set"
     )
@@ -140,3 +140,76 @@ def test_pylock_basic_package() -> None:
     assert package.marker == Marker('os_name == "posix"')
     assert package.requires_python == SpecifierSet(">=3.10, !=3.10.1")
     assert pylock.to_dict() == data
+
+
+def test_pylock_invalid_archive() -> None:
+    data = {
+        "lock-version": "1.0",
+        "created-by": "pip",
+        "requires-python": ">=3.10",
+        "environments": ['os_name == "posix"'],
+        "packages": [
+            {
+                "name": "example",
+                "archive": {
+                    # "path": "example.tar.gz",
+                    "hashes": {"sha256": "f" * 40},
+                },
+            }
+        ],
+    }
+    with pytest.raises(PylockValidationError) as exc_info:
+        Pylock.from_dict(data)
+    assert str(exc_info.value) == (
+        "Error in item 0 of 'packages': "
+        "Error in 'archive': "
+        "No path nor url set for archive package"
+    )
+
+
+def test_pylock_invalid_wheel() -> None:
+    data = {
+        "lock-version": "1.0",
+        "created-by": "pip",
+        "requires-python": ">=3.10",
+        "environments": ['os_name == "posix"'],
+        "packages": [
+            {
+                "name": "example",
+                "wheels": [
+                    {
+                        "name": "example-1.0-py3-none-any.whl",
+                        "path": "./example-1.0-py3-none-any.whl",
+                        # "hashes": {"sha256": "f" * 40},
+                    }
+                ],
+            }
+        ],
+    }
+    with pytest.raises(PylockValidationError) as exc_info:
+        Pylock.from_dict(data)
+    assert str(exc_info.value) == (
+        "Error in item 0 of 'packages': "
+        "Error in item 0 of 'wheels': "
+        "Missing required key 'hashes'"
+    )
+
+
+def test_pylock_invalid_environments() -> None:
+    data = {
+        "lock-version": "1.0",
+        "created-by": "pip",
+        "environments": [
+            'os_name == "posix"',
+            'invalid_marker == "..."',
+        ],
+        "packages": [],
+    }
+    with pytest.raises(PylockValidationError) as exc_info:
+        Pylock.from_dict(data)
+    assert str(exc_info.value) == (
+        "Error in item 1 of 'environments': "
+        "Expected a marker variable or quoted string\n"
+        '    invalid_marker == "..."\n'
+        "    ^"
+    )