Escape pod labels when removing (#631)

Author: jacobtomlinson

kr8s/_data_utils.py

@@ -160,3 +160,15 @@ def sort_versions(
     if reverse:
         output.reverse()
     return output
+
+
+def escape_rfc6901(path: str) -> str:
+    """Escape a path for use in RFC 6901.
+
+    Args:
+        path: The path to escape.
+
+    Returns:
+        The escaped path.
+    """
+    return path.replace("~", "~0").replace("/", "~1")

kr8s/_objects.py

@@ -29,6 +29,7 @@
 from kr8s._data_utils import (
     dict_to_selector,
     dot_to_nested_dict,
+    escape_rfc6901,
     list_dict_unpack,
     xdict,
 )
@@ -736,8 +737,10 @@ async def async_remove_label(self, *labels: str) -> None:
         """Remove labels from this object in Kubernetes."""
         if not labels:
             raise ValueError("No labels provided")
+
         operations = [
-            {"op": "remove", "path": "/metadata/labels/" + label} for label in labels
+            {"op": "remove", "path": "/metadata/labels/" + escape_rfc6901(label)}
+            for label in labels
         ]
         await self.async_patch(operations, type="json")
 

kr8s/tests/test_data_utils.py

@@ -8,6 +8,7 @@
     dict_list_pack,
     dict_to_selector,
     dot_to_nested_dict,
+    escape_rfc6901,
     list_dict_unpack,
     sort_versions,
     xdict,
@@ -120,3 +121,10 @@ def test_sort_version_priorities_key():
     for _ in range(30):
         random.shuffle(sample)
         assert sort_versions(list(sample), key=lambda x: x["version"]) == versions
+
+
+def test_escape_rfc6901():
+    assert escape_rfc6901("foo") == "foo"
+    assert escape_rfc6901("foo~bar") == "foo~0bar"
+    assert escape_rfc6901("foo/bar") == "foo~1bar"
+    assert escape_rfc6901("foo/bar/baz") == "foo~1bar~1baz"

kr8s/tests/test_objects.py

@@ -542,6 +542,10 @@ async def test_pod_label(example_pod_spec):
     assert "fizz" in pod.labels
     await pod.remove_label("fizz")
     assert "fizz" not in pod.labels
+    await pod.label({"foo/bar": "baz"})
+    assert "foo/bar" in pod.labels
+    await pod.label("foo/bar-")
+    assert "foo/bar" not in pod.labels
     await pod.delete()