Add bindings for Overcloud Role API entrypoints

Add the entrypoint for the new Overcloud Role type provided in the
Tuskar API after the domain model refactor.

Change-Id: I559bc36fdc6bc44c5cf47eb9e1edc66c983bfd6b
Implements: blueprint update-to-match-api-changes

tuskarclient/tests/v1/test_client.py

@@ -55,5 +55,7 @@ class ClientTest(tutils.TestCase):
         self.client = client.Client(self.endpoint)
 
     def test_managers_present(self):
+        self.assertThat(self.client, HasManager('OvercloudRoleManager',
+                                                'overcloud_roles'))
         self.assertThat(self.client, HasManager('OvercloudManager',
                                                 'overclouds'))

tuskarclient/tests/v1/test_overcloud_roles.py

@@ -0,0 +1,80 @@
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+import mock
+
+import tuskarclient.tests.utils as tutils
+from tuskarclient.v1 import overcloud_roles
+
+
+class OvercloudRoleManagerTest(tutils.TestCase):
+
+    def setUp(self):
+        """Create a mock API object and bind to the OvercloudManager manager.
+        """
+        super(OvercloudRoleManagerTest, self).setUp()
+        self.api = mock.Mock()
+        self.rcm = overcloud_roles.OvercloudRoleManager(self.api)
+
+    def test_get(self):
+        """Test a standard GET operation to read/retrieve the Overcloud Role.
+        """
+        self.rcm._get = mock.Mock(return_value='fake_overcloud_role')
+
+        self.assertEqual(self.rcm.get(42), 'fake_overcloud_role')
+        self.rcm._get.assert_called_once_with('/v1/overcloud_roles/42')
+
+    def test_get_404(self):
+        """Test a 404 response to a standard GET."""
+        self.rcm._get = mock.Mock(return_value=None)
+
+        self.assertEqual(self.rcm.get('fake_overcloud_role'), None)
+        self.rcm._get.assert_called_once_with(
+            '/v1/overcloud_roles/fake_overcloud_role')
+
+    def test_list(self):
+        """Test retrieving a list of Overcloud Roles via GET."""
+        self.rcm._list = mock.Mock(return_value=['fake_overcloud_role'])
+
+        self.assertEqual(self.rcm.list(), ['fake_overcloud_role'])
+        self.rcm._list.assert_called_once_with('/v1/overcloud_roles')
+
+    def test_create(self):
+        """Test creating a new Overcloud Role via POST."""
+        self.rcm._create = mock.Mock(return_value=['fake_overcloud_role'])
+
+        self.assertEqual(
+            self.rcm.create(dummy='dummy overcloud role data'),
+            ['fake_overcloud_role'])
+
+        self.rcm._create.assert_called_once_with(
+            '/v1/overcloud_roles',
+            {'dummy': 'dummy overcloud role data'})
+
+    def test_update(self):
+        """Test updating a Overcloud Role via PUT."""
+        self.rcm._update = mock.Mock(return_value=['fake_overcloud_role'])
+
+        self.assertEqual(
+            self.rcm.update(42, dummy='dummy overcloud role data'),
+            ['fake_overcloud_role'])
+
+        self.rcm._update.assert_called_once_with(
+            '/v1/overcloud_roles/42',
+            {'dummy': 'dummy overcloud role data'})
+
+    def test_delete(self):
+        """Test deleting/removing a Overcloud Role via DELETE."""
+        self.rcm._delete = mock.Mock(return_value=None)
+
+        self.assertEqual(self.rcm.delete(42), None)
+        self.rcm._delete.assert_called_once_with('/v1/overcloud_roles/42')

tuskarclient/v1/client.py

@@ -11,6 +11,7 @@
 #    under the License.
 
 from tuskarclient.common import http
+from tuskarclient.v1 import overcloud_roles
 from tuskarclient.v1 import overclouds
 
 
@@ -24,4 +25,6 @@ class Client(object):
 
     def __init__(self, *args, **kwargs):
         self.http_client = http.HTTPClient(*args, **kwargs)
+        self.overcloud_roles = overcloud_roles.OvercloudRoleManager(
+            self.http_client)
         self.overclouds = overclouds.OvercloudManager(self.http_client)

tuskarclient/v1/overcloud_roles.py

@@ -0,0 +1,95 @@
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+from tuskarclient.common import base
+
+
+class OvercloudRole(base.Resource):
+    """Represents an instance of an Overcloud Role in the Tuskar API.
+
+    :param manager: Manager object
+    :param info: dictionary representing the resource attributes
+    :param loaded: prevent lazy-loading if set to True
+    """
+
+
+class OvercloudRoleManager(base.Manager):
+    """OvercloudRoleManager interacts with the Tuskar API and provides CRUD
+    operations for the overcloud role type.
+
+    """
+
+    #: The class used to represent an overcloud role instance
+    resource_class = OvercloudRole
+
+    @staticmethod
+    def _path(overcloud_role_id=None):
+
+        if overcloud_role_id:
+            return '/v1/overcloud_roles/%s' % overcloud_role_id
+
+        return '/v1/overcloud_roles'
+
+    def list(self):
+        """Get a list of the existing Overcloud Roles
+
+        :return: A list of Overcloud Roles or an empty list if none exist.
+        :rtype: [tuskarclient.v1.overcloud_roles.OvercloudRole] or []
+        """
+        return self._list(self._path())
+
+    def get(self, overcloud_role_id):
+        """Get the Overcloud Role by its ID.
+
+        :param id: id of the Overcloud Role.
+        :type id: string
+
+        :return: A Overcloud Role instance or None if its not found.
+        :rtype: tuskarclient.v1.overcloud_roles.OvercloudRole or None
+        """
+        return self._get(self._single_path(overcloud_role_id))
+
+    def create(self, **fields):
+        """Create a new Overcloud Role.
+
+        :param fields: A set of key/value pairs representing a OvercloudRole
+        :type fields: string
+
+        :return: A Overcloud Role instance or None if its not found.
+        :rtype: tuskarclient.v1.overcloud_roles.OvercloudRole
+        """
+        return self._create(self._path(), fields)
+
+    def update(self, overcloud_role_id, **fields):
+        """Update an existing Overcloud Role.
+
+        :param overcloud_role_id: id of the Overcloud Role.
+        :type overcloud_role_id: string
+
+        :param fields: A set of key/value pairs representing a OvercloudRole
+        :type fields: string
+
+        :return: An OvercloudRole instance or None if its not found.
+        :rtype: tuskarclient.v1.overcloud_roles.OvercloudRole or None
+        """
+        return self._update(self._single_path(overcloud_role_id), fields)
+
+    def delete(self, overcloud_role_id):
+        """Delete a Overcloud Role.
+
+        :param id: id of the Overcloud Role.
+        :type id: string
+
+        :return: None
+        :rtype: None
+        """
+        return self._delete(self._single_path(overcloud_role_id))