test(api): add unit tests for feature flags and types

amimas · amimas · commit 8cbe591a6aeb · 2026-03-15T17:53:35.000-04:00
This adds unit tests for the new logic introduced with the feature
flags API.

- Verifies the custom `save()` method in `ProjectFeatureFlag` correctly
  handles renaming by using the old name in the URL and the new name
  in the request body.
- Verifies the `CommaSeparatedStringAttribute` correctly converts a
  Python list to a comma-separated string for API calls.
- Verifies the `JsonAttribute` correctly handles JSON string parsing.
diff --git a/tests/unit/objects/test_project_feature_flag_user_lists.py b/tests/unit/objects/test_project_feature_flag_user_lists.py
@@ -0,0 +1,36 @@
+"""
+Unit tests for Project Feature Flag User Lists.
+"""
+
+import pytest
+import responses
+
+from gitlab import Gitlab
+
+
+@pytest.fixture
+def project():
+    gl = Gitlab("http://localhost", private_token="private_token", api_version="4")
+    return gl.projects.get(1, lazy=True)
+
+
+def test_create_user_list_with_list_conversion(project):
+    """
+    Verify that passing a list of integers for user_xids is converted
+    to a comma-separated string in the API payload.
+    """
+    with responses.RequestsMock() as rs:
+        rs.add(
+            responses.POST,
+            "http://localhost/api/v4/projects/1/feature_flags_user_lists",
+            json={"iid": 1, "name": "list", "user_xids": "1,2,3"},
+            status=201,
+        )
+
+        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
@@ -0,0 +1,48 @@
+"""
+Unit tests for Project Feature Flags.
+"""
+
+import pytest
+import responses
+
+from gitlab import Gitlab
+from gitlab.v4.objects import ProjectFeatureFlag
+
+
+@pytest.fixture
+def project():
+    gl = Gitlab("http://localhost", private_token="private_token", api_version="4")
+    return gl.projects.get(1, lazy=True)
+
+
+def test_feature_flag_rename(project):
+    """
+    Verify that renaming a feature flag uses the old name in the URL
+    and the new name in the payload.
+    """
+    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"
+
+    with responses.RequestsMock() as rs:
+        rs.add(
+            responses.PUT,
+            "http://localhost/api/v4/projects/1/feature_flags/old_name",
+            json={"name": "new_name", "version": "new_version_flag", "active": True},
+            status=200,
+        )
+
+        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"
diff --git a/tests/unit/test_types.py b/tests/unit/test_types.py
@@ -122,3 +122,40 @@ def test_csv_string_attribute_get_for_api_from_int_list():
 def test_lowercase_string_attribute_get_for_api():
     o = types.LowercaseStringAttribute("FOO")
     assert o.get_for_api(key="spam") == ("spam", "foo")
+
+
+# JSONAttribute tests
+def test_json_attribute() -> None:
+    attr = types.JsonAttribute()
+
+    attr.set_from_cli('{"key": "value"}')
+    assert attr.get() == {"key": "value"}
+
+    attr.set_from_cli("  ")
+    assert attr.get() is None
+
+
+# CommaSeparatedStringAttribute tests
+def test_comma_separated_string_attribute() -> None:
+    # Test with list of integers
+    attr = types.CommaSeparatedStringAttribute([1, 2, 3])
+    assert attr.get_for_api(key="ids") == ("ids", "1,2,3")
+
+    # Test with list of strings
+    attr = types.CommaSeparatedStringAttribute(["a", "b"])
+    assert attr.get_for_api(key="names") == ("names", "a,b")
+
+    # Test with string value (should be preserved)
+    attr = types.CommaSeparatedStringAttribute("1,2,3")
+    assert attr.get_for_api(key="ids") == ("ids", "1,2,3")
+
+    # Test CLI setting
+    attr = types.CommaSeparatedStringAttribute()
+    attr.set_from_cli("1, 2, 3")
+    assert attr.get() == ["1", "2", "3"]
+
+    attr.set_from_cli("")
+    assert attr.get() == []
+
+    # Verify transform_in_post is True
+    assert types.CommaSeparatedStringAttribute.transform_in_post is True
