refactor: enhance request body validation in unit test and update method

amimas · JohnVillalovos · commit d320a400b53f · 2026-03-23T07:13:08.000-07:00
Used `responses.matchers.json_params_matchers` in unit test to validate
request body instead of manual assertion.

Modified the `update` method of `ProjectFeatureFlagManager` so that
caller provided data is not mutated or updated.
diff --git a/gitlab/v4/objects/feature_flags.py b/gitlab/v4/objects/feature_flags.py
@@ -97,9 +97,10 @@ def update(
             new_data: The dictionary of attributes to update.
             **kwargs: Extra options to send to the server (e.g. sudo)
         """
-        new_data = new_data or {}
+        # Avoid mutating the caller-provided new_data dict by working on a copy.
+        data = dict(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)
+        if "new_name" in data:
+            data["name"] = data.pop("new_name")
+        return super().update(id, data, **kwargs)
diff --git a/tests/unit/objects/test_project_feature_flag_user_lists.py b/tests/unit/objects/test_project_feature_flag_user_lists.py
@@ -16,12 +16,15 @@ def test_create_user_list_with_list_conversion(project):
             "http://localhost/api/v4/projects/1/feature_flags_user_lists",
             json={"iid": 1, "name": "list", "user_xids": "1,2,3"},
             status=201,
+            match=[
+                responses.matchers.json_params_matcher(
+                    {"name": "list", "user_xids": "1,2,3"}
+                )
+            ],
         )
 
         project.feature_flags_user_lists.create(
             {"name": "list", "user_xids": [1, 2, 3]}
         )
 
         assert len(rs.calls) == 1
-        # Verify that the list [1, 2, 3] was converted to "1,2,3" in the JSON body
-        assert b'"user_xids": "1,2,3"' in rs.calls[0].request.body
diff --git a/tests/unit/objects/test_project_feature_flags.py b/tests/unit/objects/test_project_feature_flags.py
@@ -15,10 +15,6 @@ def test_feature_flag_rename(project):
     flag_content = {"name": "old_name", "version": "new_version_flag", "active": True}
     flag = ProjectFeatureFlag(project.feature_flags, flag_content)
 
-    # Simulate fetching from API (populates _attrs)
-    flag._attrs = flag_content.copy()
-    flag._updated_attrs = {}
-
     # Rename locally
     flag.name = "new_name"
 
@@ -28,13 +24,12 @@ def test_feature_flag_rename(project):
             "http://localhost/api/v4/projects/1/feature_flags/old_name",
             json={"name": "new_name", "version": "new_version_flag", "active": True},
             status=200,
+            match=[responses.matchers.json_params_matcher({"name": "new_name"})],
         )
 
         flag.save()
 
         assert len(rs.calls) == 1
         # URL should use the old name (ID)
         assert rs.calls[0].request.url.endswith("/feature_flags/old_name")
-        # Body should contain the new name
-        assert b'"name": "new_name"' in rs.calls[0].request.body
         assert flag.name == "new_name"
