feature(v3) add user v3

antechrestos · antechrestos · commit c2f220930d97 · 2026-01-06T20:57:27.000+01:00
Closes #271
diff --git a/cloudfoundry_client/client.py b/cloudfoundry_client/client.py
@@ -44,6 +44,7 @@
 from cloudfoundry_client.v3.spaces import SpaceManager
 from cloudfoundry_client.v3.tasks import TaskManager
 from cloudfoundry_client.v3.jobs import JobManager
+from cloudfoundry_client.v3.users import UserManager
 
 _logger = logging.getLogger(__name__)
 
@@ -130,6 +131,7 @@ def __init__(self, cloud_controller_v3_url: str, credential_manager: "CloudFound
         self.service_plans = ServicePlanManager(target_endpoint, credential_manager)
         self.spaces = SpaceManager(target_endpoint, credential_manager)
         self.tasks = TaskManager(target_endpoint, credential_manager)
+        self.users = UserManager(target_endpoint, credential_manager)
 
 
 class CloudFoundryClient(CredentialManager):
diff --git a/cloudfoundry_client/v3/buildpacks.py b/cloudfoundry_client/v3/buildpacks.py
@@ -26,8 +26,8 @@ def create(
             "enabled": enabled,
             "locked": locked,
             "stack": stack,
-            "metadata": {"labels": meta_labels, "annotations": meta_annotations},
         }
+        self._metadata(data, meta_labels, meta_annotations)
         return super(BuildpackManager, self)._create(data)
 
     def remove(self, buildpack_guid: str, asynchronous: bool = True) -> str | None:
@@ -50,8 +50,8 @@ def update(
             "enabled": enabled,
             "locked": locked,
             "stack": stack,
-            "metadata": {"labels": meta_labels, "annotations": meta_annotations},
         }
+        self._metadata(data, meta_labels, meta_annotations)
         return super(BuildpackManager, self)._update(buildpack_guid, data)
 
     def upload(self, buildpack_guid: str, buildpack_zip: str, asynchronous: bool = False) -> Entity:
diff --git a/cloudfoundry_client/v3/domains.py b/cloudfoundry_client/v3/domains.py
@@ -39,8 +39,8 @@ def create(
                 "organization": organization,
                 "shared_organizations": shared_organizations,
             },
-            "metadata": {"labels": meta_labels, "annotations": meta_annotations},
         }
+        self._metadata(data, meta_labels, meta_annotations)
         return super(DomainManager, self)._create(data)
 
     def list_domains_for_org(self, org_guid: str, **kwargs) -> Pagination[Entity]:
diff --git a/cloudfoundry_client/v3/entities.py b/cloudfoundry_client/v3/entities.py
@@ -312,3 +312,12 @@ def _append_encoded_parameter(parameters: list[str], args: tuple[str, Any]) -> l
             return "%s?%s" % (url, "&".join(functools.reduce(_append_encoded_parameter, sorted(list(kwargs.items())), [])))
         else:
             return url
+
+    def _metadata(self, data, meta_labels, meta_annotations):
+        if meta_labels or meta_annotations:
+            metadata = dict()
+            if meta_labels:
+                metadata["labels"] = meta_labels
+            if meta_annotations:
+                metadata["annotations"] = meta_annotations
+            data["metadata"] = metadata
diff --git a/cloudfoundry_client/v3/isolation_segments.py b/cloudfoundry_client/v3/isolation_segments.py
@@ -11,13 +11,15 @@ def __init__(self, target_endpoint: str, client: "CloudFoundryClient"):
         super(IsolationSegmentManager, self).__init__(target_endpoint, client, "/v3/isolation_segments")
 
     def create(self, name: str, meta_labels: dict | None = None, meta_annotations: dict | None = None) -> Entity:
-        data = {"name": name, "metadata": {"labels": meta_labels, "annotations": meta_annotations}}
+        data = {"name": name}
+        self._metadata(data, meta_labels, meta_annotations)
         return super(IsolationSegmentManager, self)._create(data)
 
     def update(
         self, isolation_segment_guid: str, name: str, meta_labels: dict | None = None, meta_annotations: dict | None = None
     ) -> Entity:
-        data = {"name": name, "metadata": {"labels": meta_labels, "annotations": meta_annotations}}
+        data = {"name": name}
+        self._metadata(data, meta_labels, meta_annotations)
         return super(IsolationSegmentManager, self)._update(isolation_segment_guid, data)
 
     def entitle_organizations(self, isolation_segment_guid: str, *org_guids: str) -> ToManyRelationship:
diff --git a/cloudfoundry_client/v3/organizations.py b/cloudfoundry_client/v3/organizations.py
@@ -13,7 +13,8 @@ def __init__(self, target_endpoint: str, client: "CloudFoundryClient"):
     def create(
         self, name: str, suspended: bool, meta_labels: dict | None = None, meta_annotations: dict | None = None
     ) -> Entity:
-        data = {"name": name, "suspended": suspended, "metadata": {"labels": meta_labels, "annotations": meta_annotations}}
+        data = {"name": name, "suspended": suspended}
+        self._metadata(data, meta_labels, meta_annotations)
         return super(OrganizationManager, self)._create(data)
 
     def update(
@@ -27,13 +28,7 @@ def update(
         data = {"name": name}
         if suspended is not None:
             data["suspended"] = suspended
-        metadata = {}
-        if meta_labels is not None:
-            metadata["labels"] = meta_labels
-        if meta_annotations is not None:
-            metadata["annotations"] = meta_annotations
-        if len(metadata) > 0:
-            data["metadata"] = metadata
+        self._metadata(data, meta_labels, meta_annotations)
         return super(OrganizationManager, self)._update(guid, data)
 
     def remove(self, guid: str, asynchronous: bool = True) -> str | None:
diff --git a/cloudfoundry_client/v3/service_brokers.py b/cloudfoundry_client/v3/service_brokers.py
@@ -22,13 +22,7 @@ def create(
     ) -> Entity:
         credentials = {"type": "basic", "credentials": {"username": auth_username, "password": auth_password}}
         payload = dict(name=name, url=url, authentication=credentials)
-        if meta_labels or meta_annotations:
-            metadata = dict()
-            if meta_labels:
-                metadata["labels"] = meta_labels
-            if meta_annotations:
-                metadata["annotations"] = meta_annotations
-            payload["metadata"] = metadata
+        self._metadata(payload, meta_labels, meta_annotations)
         if space_guid:
             payload["relationships"] = dict(space=ToOneRelationship(space_guid))
         return super(ServiceBrokerManager, self)._create(payload)
@@ -50,13 +44,7 @@ def update(
             payload["url"] = url
         if auth_username and auth_password:
             payload["authentication"] = {"type": "basic", "credentials": {"username": auth_username, "password": auth_password}}
-        if meta_labels or meta_annotations:
-            metadata = dict()
-            if meta_labels:
-                metadata["labels"] = meta_labels
-            if meta_annotations:
-                metadata["annotations"] = meta_annotations
-            payload["metadata"] = metadata
+        self._metadata(payload, meta_labels, meta_annotations)
         return super(ServiceBrokerManager, self)._update(guid, payload)
 
     def remove(self, guid: str, asynchronous: bool = True) -> str | None:
diff --git a/cloudfoundry_client/v3/service_instances.py b/cloudfoundry_client/v3/service_instances.py
@@ -30,13 +30,7 @@ def create(
             data["parameters"] = parameters
         if tags:
             data["tags"] = tags
-        if meta_labels or meta_annotations:
-            metadata = dict()
-            if meta_labels:
-                metadata["labels"] = meta_labels
-            if meta_annotations:
-                metadata["annotations"] = meta_annotations
-            data["metadata"] = metadata
+        self._metadata(data, meta_labels, meta_annotations)
         return super(ServiceInstanceManager, self)._create(data)
 
     def update(
@@ -62,17 +56,11 @@ def update(
             data["maintenance_info"] = {"version": maintenance_info}
         if tags:
             data["tags"] = tags
-        if meta_labels or meta_annotations:
-            metadata = dict()
-            if meta_labels:
-                metadata["labels"] = meta_labels
-            if meta_annotations:
-                metadata["annotations"] = meta_annotations
-            data["metadata"] = metadata
-        return super(ServiceInstanceManager, self)._update(instance_guid, data)
+        super()._metadata(data, meta_labels, meta_annotations)
+        return super()._update(instance_guid, data)
 
     def remove(self, guid: str, asynchronous: bool = True):
-        super(ServiceInstanceManager, self)._remove(guid, asynchronous)
+        super()._remove(guid, asynchronous)
 
     def get_permissions(self, instance_guid: str) -> JsonObject:
         return super(ServiceInstanceManager, self)._get(
diff --git a/cloudfoundry_client/v3/service_offerings.py b/cloudfoundry_client/v3/service_offerings.py
@@ -12,13 +12,7 @@ def __init__(self, target_endpoint: str, client: "CloudFoundryClient"):
 
     def update(self, guid: str, meta_labels: dict | None = None, meta_annotations: dict | None = None) -> Entity:
         payload = dict()
-        if meta_labels or meta_annotations:
-            metadata = dict()
-            if meta_labels:
-                metadata["labels"] = meta_labels
-            if meta_annotations:
-                metadata["annotations"] = meta_annotations
-            payload["metadata"] = metadata
+        self._metadata(payload, meta_labels, meta_annotations)
         return super(ServiceOfferingsManager, self)._update(guid, payload)
 
     def remove(self, guid: str, purge: bool = False) -> None:
diff --git a/cloudfoundry_client/v3/service_plans.py b/cloudfoundry_client/v3/service_plans.py
@@ -17,11 +17,7 @@ def update(
         meta_annotations: dict | None = None,
     ) -> Entity:
         payload = {"metadata": {}}
-
-        if meta_labels:
-            payload["metadata"]["labels"] = meta_labels
-        if meta_annotations:
-            payload["metadata"]["annotations"] = meta_annotations
+        self._metadata(payload, meta_labels, meta_annotations)
         return super(ServicePlanManager, self)._update(guid, payload)
 
     def remove(self, guid: str):
diff --git a/cloudfoundry_client/v3/users.py b/cloudfoundry_client/v3/users.py
@@ -0,0 +1,40 @@
+from typing import TYPE_CHECKING
+
+from cloudfoundry_client.v3.entities import Entity, EntityManager
+
+if TYPE_CHECKING:
+    from cloudfoundry_client.client import CloudFoundryClient
+
+
+class UserManager(EntityManager):
+    def __init__(self, target_endpoint: str, client: "CloudFoundryClient"):
+        super(UserManager, self).__init__(target_endpoint, client, "/v3/users")
+
+    def create(
+        self,
+        user_info: str | tuple[str, str],
+        meta_labels: dict | None = None,
+        meta_annotations: dict | None = None,
+    ) -> Entity:
+        data = {}
+        if isinstance(user_info, str):
+            data["guid"] = user_info
+        else:
+            username, origin = user_info
+            data["username"] = username
+            data["origin"] = origin
+        self._metadata(data, meta_labels, meta_annotations)
+        return super(UserManager, self)._create(data)
+
+    def update(
+            self,
+            guid: str,
+            meta_labels: dict | None = None,
+            meta_annotations: dict | None = None,
+    ) -> Entity:
+        data = {}
+        self._metadata(data, meta_labels, meta_annotations)
+        return super(UserManager, self)._update(guid, data)
+
+    def remove(self, guid: str) -> str | None:
+        return super(UserManager, self)._remove(guid)
diff --git a/tests/fixtures/v3/users/GET_response.json b/tests/fixtures/v3/users/GET_response.json
@@ -0,0 +1,50 @@
+{
+  "pagination": {
+    "total_results": 3,
+    "total_pages": 2,
+    "first": {
+      "href": "https://api.example.org/v3/users?page=1&per_page=2"
+    },
+    "last": {
+      "href": "https://api.example.org/v3/users?page=2&per_page=2"
+    },
+    "next": null,
+    "previous": null
+  },
+  "resources": [
+    {
+      "guid": "client_id",
+      "created_at": "2019-03-08T01:06:19Z",
+      "updated_at": "2019-03-08T01:06:19Z",
+      "username": null,
+      "presentation_name": "client_id",
+      "origin": null,
+      "metadata": {
+        "labels": {},
+        "annotations": {}
+      },
+      "links": {
+        "self": {
+          "href": "https://api.example.org/v3/users/3a5d3d89-3f89-4f05-8188-8a2b298c79d5"
+        }
+      }
+    },
+    {
+      "guid": "9da93b89-3f89-4f05-7238-8a2b123c79l9",
+      "created_at": "2019-03-08T01:06:19Z",
+      "updated_at": "2019-03-08T01:06:19Z",
+      "username": "some-name",
+      "presentation_name": "some-name",
+      "origin": "uaa",
+      "metadata": {
+        "labels": {},
+        "annotations": {}
+      },
+      "links": {
+        "self": {
+          "href": "https://api.example.org/v3/users/9da93b89-3f89-4f05-7238-8a2b123c79l9"
+        }
+      }
+    }
+  ]
+}
diff --git a/tests/fixtures/v3/users/GET_{id}_response.json b/tests/fixtures/v3/users/GET_{id}_response.json
@@ -0,0 +1,17 @@
+{
+  "guid": "3a5d3d89-3f89-4f05-8188-8a2b298c79d5",
+  "created_at": "2019-03-08T01:06:19Z",
+  "updated_at": "2019-03-08T01:06:19Z",
+  "username": "some-name",
+  "presentation_name": "some-name",
+  "origin": "uaa",
+  "metadata": {
+    "labels": {},
+    "annotations": {}
+  },
+  "links": {
+    "self": {
+      "href": "https://api.example.org/v3/users/3a5d3d89-3f89-4f05-8188-8a2b298c79d5"
+    }
+  }
+}
diff --git a/tests/fixtures/v3/users/PATCH_{id}_response.json b/tests/fixtures/v3/users/PATCH_{id}_response.json
@@ -0,0 +1,21 @@
+{
+  "guid": "3a5d3d89-3f89-4f05-8188-8a2b298c79d5",
+  "created_at": "2019-03-08T01:06:19Z",
+  "updated_at": "2019-03-08T01:06:19Z",
+  "username": "some-name",
+  "presentation_name": "some-name",
+  "origin": "uaa",
+  "metadata": {
+    "labels": {
+      "enviroment": "production"
+    },
+    "annotations": {
+      "note": "detailed information"
+    }
+  },
+  "links": {
+    "self": {
+      "href": "https://api.example.org/v3/users/3a5d3d89-3f89-4f05-8188-8a2b298c79d5"
+    }
+  }
+}
diff --git a/tests/fixtures/v3/users/POST_response.json b/tests/fixtures/v3/users/POST_response.json
@@ -0,0 +1,17 @@
+{
+  "guid": "3a5d3d89-3f89-4f05-8188-8a2b298c79d5",
+  "created_at": "2019-03-08T01:06:19Z",
+  "updated_at": "2019-03-08T01:06:19Z",
+  "username": "some-name",
+  "presentation_name": "some-name",
+  "origin": "uaa",
+  "metadata": {
+    "labels": {},
+    "annotations": {}
+  },
+  "links": {
+    "self": {
+      "href": "https://api.example.org/v3/users/3a5d3d89-3f89-4f05-8188-8a2b298c79d5"
+    }
+  }
+}
diff --git a/tests/v3/test_buildpacks.py b/tests/v3/test_buildpacks.py
@@ -47,7 +47,6 @@ def test_update(self):
                 "enabled": True,
                 "position": 42,
                 "stack": "windows64",
-                "metadata": {"labels": None, "annotations": None},
             },
         )
         self.assertIsNotNone(result)
@@ -66,7 +65,6 @@ def test_create(self):
                 "enabled": True,
                 "position": 42,
                 "stack": "windows64",
-                "metadata": {"labels": None, "annotations": None},
             },
         )
         self.assertIsNotNone(result)
diff --git a/tests/v3/test_domains.py b/tests/v3/test_domains.py
@@ -76,7 +76,6 @@ def test_create(self):
                         ]
                     },
                 },
-                "metadata": {"labels": None, "annotations": None},
             },
         )
         self.assertIsNotNone(result)
diff --git a/tests/v3/test_isolation_segments.py b/tests/v3/test_isolation_segments.py
@@ -51,7 +51,7 @@ def test_update(self):
         result = self.client.v3.isolation_segments.update("isolation_segment_id", "new-name", meta_labels=dict(key="value"))
         self.client.patch.assert_called_with(
             self.client.patch.return_value.url,
-            json={"name": "new-name", "metadata": {"labels": {"key": "value"}, "annotations": None}},
+            json={"name": "new-name", "metadata": {"labels": {"key": "value"}}},
         )
         self.assertIsNotNone(result)
         self.assertIsInstance(result, Entity)
diff --git a/tests/v3/test_organizations.py b/tests/v3/test_organizations.py
@@ -78,7 +78,7 @@ def test_create(self):
         self.client.post.assert_called_with(
             self.client.post.return_value.url,
             files=None,
-            json={"name": "my-organization", "suspended": False, "metadata": {"labels": None, "annotations": None}},
+            json={"name": "my-organization", "suspended": False},
         )
         self.assertIsNotNone(result)
 
diff --git a/tests/v3/test_users.py b/tests/v3/test_users.py

Original file line number	Diff line number	Diff line change
`@@ -39,8 +39,8 @@ def create(`
`39`	`39`	`"organization": organization,`
`40`	`40`	`"shared_organizations": shared_organizations,`
`41`	`41`	`},`
`42`		`- "metadata": {"labels": meta_labels, "annotations": meta_annotations},`
`43`	`42`	`}`
	`43`	`+ self._metadata(data, meta_labels, meta_annotations)`
`44`	`44`	`return super(DomainManager, self)._create(data)`
`45`	`45`
`46`	`46`	`def list_domains_for_org(self, org_guid: str, **kwargs) -> Pagination[Entity]:`