fix: cli: url-encode path components of the URL

JohnVillalovos · JohnVillalovos · commit d7ee0cbf74f6 · 2022-01-01T16:49:31.000-08:00
In the CLI we need to make sure the components put into the path portion of the URL are url-encoded. Otherwise they will be interpreted as part of the path. For example can specify the project ID as a path, but in the URL it must be url-encoded or it doesn't work. Also stop adding the components of the path as query parameters in the URL. Closes: #783
diff --git a/gitlab/v4/cli.py b/gitlab/v4/cli.py
@@ -39,6 +39,7 @@ def __init__(
         self.action = action.lower()
         self.gl = gl
         self.args = args
+        self.parent_args = {}
         self.mgr_cls: Union[
             Type[gitlab.mixins.CreateMixin],
             Type[gitlab.mixins.DeleteMixin],
@@ -53,7 +54,15 @@ def __init__(
         # the class _path attribute, and replace the value with the result.
         if TYPE_CHECKING:
             assert self.mgr_cls._path is not None
-        self.mgr_cls._path = self.mgr_cls._path.format(**self.args)
+        # Items in the path need to be url-encoded
+        if self.mgr_cls._from_parent_attrs:
+            for k in self.mgr_cls._from_parent_attrs:
+                if k in self.args:
+                    self.parent_args[k] = gitlab.utils.clean_str_id(self.args[k])
+                    # If we don't delete it then it will be added to the URL as a
+                    # query-string
+                    del self.args[k]
+        self.mgr_cls._path = self.mgr_cls._path.format(**self.parent_args)
         self.mgr = self.mgr_cls(gl)
 
         if self.mgr_cls._types:
@@ -85,7 +94,7 @@ def do_custom(self) -> Any:
             data = {}
             if self.mgr._from_parent_attrs:
                 for k in self.mgr._from_parent_attrs:
-                    data[k] = self.args[k]
+                    data[k] = self.parent_args[k]
             if not issubclass(self.cls, gitlab.mixins.GetWithoutIdMixin):
                 if TYPE_CHECKING:
                     assert isinstance(self.cls._id_attr, str)
