Merge pull request #159 from dandersonsw/features/add_roles_manager

Implement Roles in v3 API

Author: antechrestos

README.rst

@@ -249,6 +249,7 @@ Available managers on API V3 are:
 - ``organizations``
 - ``organization_quotas``
 - ``processes``
+- ``roles``
 - ``security_groups``
 - ``service_brokers``
 - ``service_credential_bindings``

main/cloudfoundry_client/client.py

@@ -32,6 +32,7 @@
 from cloudfoundry_client.v3.organization_quotas import OrganizationQuotaManager
 from cloudfoundry_client.v3.processes import ProcessManager
 from cloudfoundry_client.v3.organizations import OrganizationManager
+from cloudfoundry_client.v3.roles import RoleManager
 from cloudfoundry_client.v3.security_groups import SecurityGroupManager
 from cloudfoundry_client.v3.service_brokers import ServiceBrokerManager
 from cloudfoundry_client.v3.service_credential_bindings import ServiceCredentialBindingManager
@@ -106,6 +107,7 @@ def __init__(self, target_endpoint: str, credential_manager: "CloudFoundryClient
         self.organizations = OrganizationManager(target_endpoint, credential_manager)
         self.organization_quotas = OrganizationQuotaManager(target_endpoint, credential_manager)
         self.processes = ProcessManager(target_endpoint, credential_manager)
+        self.roles = RoleManager(target_endpoint, credential_manager)
         self.security_groups = SecurityGroupManager(target_endpoint, credential_manager)
         self.service_brokers = ServiceBrokerManager(target_endpoint, credential_manager)
         self.service_credential_bindings = ServiceCredentialBindingManager(target_endpoint, credential_manager)

main/cloudfoundry_client/v3/roles.py

@@ -0,0 +1,14 @@
+from typing import TYPE_CHECKING
+
+from cloudfoundry_client.v3.entities import EntityManager
+
+if TYPE_CHECKING:
+    from cloudfoundry_client.client import CloudFoundryClient
+
+
+class RoleManager(EntityManager):
+    def __init__(self, target_endpoint: str, client: "CloudFoundryClient"):
+        super(RoleManager, self).__init__(target_endpoint, client, "/v3/roles")
+
+    def remove(self, role_guid: str):
+        super(RoleManager, self)._remove(role_guid)

test/fixtures/v3/roles/GET_response.json

@@ -0,0 +1,82 @@
+{
+    "pagination": {
+       "total_results": 3,
+       "total_pages": 2,
+       "first": {
+          "href": "https://api.example.org/v3/roles?page=1&per_page=2"
+       },
+       "last": {
+          "href": "https://api.example.org/v3/roles?page=2&per_page=2"
+       },
+       "next": {
+          "href": null
+       },
+       "previous": null
+    },
+    "resources": [
+       {
+          "guid": "40557c70-d1bd-4976-a2ab-a85f5e882418",
+          "created_at": "2019-10-10T17:19:12Z",
+          "updated_at": "2019-10-10T17:19:12Z",
+          "type": "organization_auditor",
+          "relationships": {
+             "user": {
+                "data": {
+                   "guid": "59eadb5f-fc13-414f-84ba-77a35e239cc8"
+                }
+             },
+             "organization": {
+                "data": {
+                   "guid": "05c5da3b-6cbc-421c-87c3-20bb3c41ab7c"
+                }
+             },
+             "space": {
+                "data": null
+             }
+          },
+          "links": {
+             "self": {
+                "href": "https://api.example.org/v3/roles/40557c70-d1bd-4976-a2ab-a85f5e882418"
+             },
+             "user": {
+                "href": "https://api.example.org/v3/users/59eadb5f-fc13-414f-84ba-77a35e239cc8"
+             },
+             "organization": {
+                "href": "https://api.example.org/v3/organizations/05c5da3b-6cbc-421c-87c3-20bb3c41ab7c"
+             }
+          }
+       },
+       {
+          "guid": "12347c70-d1bd-4976-a2ab-a85f5e882418",
+          "created_at": "2047-11-10T17:19:12Z",
+          "updated_at": "2047-11-10T17:19:12Z",
+          "type": "space_auditor",
+          "relationships": {
+             "user": {
+                "data": {
+                   "guid": "47eadb5f-fc13-414f-84ba-47a35e239cc8"
+                }
+             },
+             "organization": {
+                "data": null
+             },
+             "space": {
+                "data": {
+                   "guid": "47c5da3b-6cbc-421c-87c3-20bb3c41ab7c"
+                }
+             }
+          },
+          "links": {
+             "self": {
+                "href": "https://api.example.org/v3/roles/12347c70-d1bd-4976-a2ab-a85f5e882418"
+             },
+             "user": {
+                "href": "https://api.example.org/v3/users/47eadb5f-fc13-414f-84ba-77a35e239cc8"
+             },
+             "space": {
+                "href": "https://api.example.org/v3/spaces/47c5da3b-6cbc-421c-87c3-20bb3c41ab7c"
+             }
+          }
+       }
+    ]
+ }

test/fixtures/v3/roles/GET_{id}_response.json

@@ -0,0 +1,32 @@
+{
+    "guid": "role_id",
+    "created_at": "2019-10-10T17:19:12Z",
+    "updated_at": "2019-10-10T17:19:12Z",
+    "type": "organization_auditor",
+    "relationships": {
+       "user": {
+          "data": {
+             "guid": "59eadb5f-fc13-414f-84ba-77a35e239cc8"
+          }
+       },
+       "organization": {
+          "data": {
+             "guid": "05c5da3b-6cbc-421c-87c3-20bb3c41ab7c"
+          }
+       },
+       "space": {
+          "data": null
+       }
+    },
+    "links": {
+       "self": {
+          "href": "https://api.example.org/v3/roles/40557c70-d1bd-4976-a2ab-a85f5e882418"
+       },
+       "user": {
+          "href": "https://api.example.org/v3/users/59eadb5f-fc13-414f-84ba-77a35e239cc8"
+       },
+       "organization": {
+          "href": "https://api.example.org/v3/organizations/05c5da3b-6cbc-421c-87c3-20bb3c41ab7c"
+       }
+    }
+ }

test/v3/test_roles.py

@@ -0,0 +1,37 @@
+import unittest
+from http import HTTPStatus
+
+from abstract_test_case import AbstractTestCase
+from cloudfoundry_client.v3.entities import Entity
+
+
+class TestRoles(unittest.TestCase, AbstractTestCase):
+    @classmethod
+    def setUpClass(cls):
+        cls.mock_client_class()
+
+    def setUp(self):
+        self.build_client()
+
+    def test_list(self):
+        self.client.get.return_value = self.mock_response("/v3/roles", HTTPStatus.OK, None, "v3", "roles",
+                                                          "GET_response.json")
+        all_roles = [role for role in self.client.v3.roles.list()]
+        self.client.get.assert_called_with(self.client.get.return_value.url)
+        self.assertEqual(2, len(all_roles))
+        self.assertEqual(all_roles[0]["type"], "organization_auditor")
+        self.assertIsInstance(all_roles[0], Entity)
+
+    def test_get(self):
+        self.client.get.return_value = self.mock_response(
+            "/v3/roles/role_id", HTTPStatus.OK, None, "v3", "roles", "GET_{id}_response.json"
+        )
+        role = self.client.v3.roles.get("role_id")
+        self.client.get.assert_called_with(self.client.get.return_value.url)
+        self.assertEqual(role["type"], "organization_auditor")
+        self.assertIsInstance(role, Entity)
+
+    def test_remove(self):
+        self.client.delete.return_value = self.mock_response("/v3/roles/role_id", HTTPStatus.NO_CONTENT, None)
+        self.client.v3.roles.remove("role_id")
+        self.client.delete.assert_called_with(self.client.delete.return_value.url)