feat(cli): add support for renaming project feature flags

amimas · JohnVillalovos · commit 0901d9757f62 · 2026-03-23T07:13:08.000-07:00
This adds the `--new-name` option to the `project-feature-flag update` command,
allowing users to rename feature flags via the CLI.

The `ProjectFeatureFlagManager.update()` method is overridden to handle the
`new_name` parameter, mapping it to `name` in the API payload, while the
original `name` is used as the resource ID in the URL.

A functional test `test_project_feature_flag_cli_rename` is added to verify
this behavior.
diff --git a/gitlab/v4/objects/feature_flags.py b/gitlab/v4/objects/feature_flags.py
@@ -36,12 +36,12 @@ def _get_save_url_id(self) -> str | int | None:
     def save(self, **kwargs: Any) -> dict[str, Any] | None:
         """Save the changes made to the object to the server.
 
-        The object is updated to match what the server returns.
+        This is the standard method to use when updating a feature flag object
+        that you have already retrieved.
 
-        This method overrides the default ``save()`` method to handle renaming
-        feature flags. When the name is modified, the API requires the original
-        name in the URL to identify the resource, while the new name is sent
-        in the request body.
+        It is overridden here to correctly handle renaming. When `name` is
+        changed, the API requires the *original* name in the URL, and this
+        method provides it.
 
         Args:
             **kwargs: Extra options to send to the server (e.g. sudo)
@@ -71,7 +71,35 @@ class ProjectFeatureFlagManager(CRUDMixin[ProjectFeatureFlag]):
         required=("name",), optional=("version", "description", "active", "strategies")
     )
     _update_attrs = RequiredOptional(
-        optional=("name", "description", "active", "strategies")
+        # new_name is used for renaming via CLI and mapped to 'name' in update()
+        optional=("name", "new_name", "description", "active", "strategies")
     )
     _list_filters = ("scope",)
     _types = {"strategies": types.JsonAttribute}
+
+    def update(
+        self,
+        id: str | int | None = None,
+        new_data: dict[str, Any] | None = None,
+        **kwargs: Any,
+    ) -> dict[str, Any]:
+        """Update a Project Feature Flag.
+
+        This is a lower-level method called by `ProjectFeatureFlag.save()` and
+        is also used directly by the CLI.
+
+        The `new_name` parameter is a special case to support renaming via the
+        CLI (`--new-name`). It is converted to the `name` parameter that the
+        GitLab API expects in the request body.
+
+        Args:
+            id: The current name of the feature flag.
+            new_data: The dictionary of attributes to update.
+            **kwargs: Extra options to send to the server (e.g. sudo)
+        """
+        new_data = new_data or {}
+        # When used via CLI, we have 'new_name' to distinguish from the ID 'name'.
+        # When used via .save(), the object passes 'name' directly in new_data.
+        if "new_name" in new_data:
+            new_data["name"] = new_data.pop("new_name")
+        return super().update(id, new_data, **kwargs)
diff --git a/tests/functional/cli/test_cli_project_feature_flags.py b/tests/functional/cli/test_cli_project_feature_flags.py
@@ -160,3 +160,44 @@ def test_project_feature_flag_cli_create_with_malformed_strategies(gitlab_cli, p
     ret = gitlab_cli(cmd)
     assert not ret.success
     assert "Could not parse JSON data" in ret.stderr
+
+
+def test_project_feature_flag_cli_rename(gitlab_cli, project, feature_flag_cli):
+    new_name = "cli_renamed_flag"
+    cmd = [
+        "project-feature-flag",
+        "update",
+        "--project-id",
+        str(project.id),
+        "--name",
+        feature_flag_cli,
+        "--new-name",
+        new_name,
+    ]
+    ret = gitlab_cli(cmd)
+    assert ret.success
+
+    cmd = [
+        "-o",
+        "json",
+        "project-feature-flag",
+        "get",
+        "--project-id",
+        str(project.id),
+        "--name",
+        new_name,
+    ]
+    ret = gitlab_cli(cmd)
+    assert ret.success
+    data = json.loads(ret.stdout)
+    assert data["name"] == new_name
+    # Cleanup renamed flag
+    cmd = [
+        "project-feature-flag",
+        "delete",
+        "--project-id",
+        str(project.id),
+        "--name",
+        new_name,
+    ]
+    gitlab_cli(cmd)
