Ronerez/s3bucket (#206)

Author: saimonation

cterasdk/core/cloudfs.py

@@ -18,6 +18,7 @@ class CloudFS(BaseCommand):
     :ivar cterasdk.core.cloudfs.CloudDrives drives: Object holding Cloud Drive Folders APIs
     :ivar cterasdk.core.cloudfs.Backups backups: Object holding Backup Folders APIs
     :ivar cterasdk.core.cloudfs.Zones zones: Object holding Zones APIs
+    :ivar cterasdk.core.cloudfs.Exports exports: Object holding Bucket Exports APIs
     """
 
     def __init__(self, portal):
@@ -26,6 +27,7 @@ def __init__(self, portal):
         self.drives = CloudDrives(self._portal)
         self.backups = Backups(self._portal)
         self.zones = Zones(self._portal)
+        self.exports = Exports(self._portal)
 
 
 class FolderGroups(BaseCommand):
@@ -192,7 +194,7 @@ def modify(self, current_name, owner, new_name=None, new_owner=None, new_group=N
         if new_name:
             param.name = new_name
         if new_owner:
-            param.owner = self._portal.users.get(owner, ['baseObjectRef']).baseObjectRef
+            param.owner = self._portal.users.get(new_owner, ['baseObjectRef']).baseObjectRef
         if new_group:
             param.group = self._portal.cloudfs.groups.get(new_group, include=['baseObjectRef']).baseObjectRef
         if description:
@@ -533,3 +535,77 @@ def _zone_param(name, policy_type, description=None, zid=None):
         param.delta.devicesDelta.added = []
         param.delta.devicesDelta.removed = []
         return param
+
+
+class Exports(BaseCommand):
+    """ S3 Exports APIs """
+
+    def get(self, name):
+        """
+        Get Buckets
+
+        :param str name: Bucket name
+        """
+        return self._portal.get(f'/buckets/{name}')
+
+    def get_endpoint(self, name):
+        """
+        Get Endpoint
+
+        :param str name: Bucket name
+        :returns: Bucket endpoint
+        :rtype: str
+        """
+        return self.get(name).url
+
+    def all(self):
+        """
+        List Buckets
+        """
+        param = query.QueryParamBuilder().startFrom(0).countLimit(25).orFilter(True).build()
+        return query.iterator(self._portal, '/buckets', param)
+
+    def add(self, name, drive_name, drive_owner, description=None):
+        """
+        Add Bucket
+
+        :param str name: Bucket name
+        :param str drive_name: Cloud Drive Folder name
+        :param str drive_owner: Cloud Drive Folder owner
+        :param str,optional description: Bucket description
+        """
+        param = Object()
+        param._classname = 'Bucket'  # pylint: disable=protected-access
+        param.description = description
+        param.name = name
+        param.cloudDrive = self._portal.cloudfs.drives.find(drive_name, drive_owner, include=['baseObjectRef']).baseObjectRef
+        logging.getLogger().info('Adding Bucket. %s', {'name': name})
+        response = self._portal.add('/buckets', param)
+        logging.getLogger().info('Bucket Added. %s', {'name': name})
+        return response
+
+    def modify(self, name, description):
+        """
+        Modify Bucket
+
+        :param str name: Bucket name
+        :param str description: Bucket description
+        """
+
+        bucket = self.get(name)
+        bucket.description = description
+        logging.getLogger().info("Modifying Bucket. %s", {'name': name})
+        response = self._portal.put(f'/buckets/{name}', bucket)
+        logging.getLogger().info("Bucket modified. %s", {'name': name})
+        return response
+
+    def delete(self, name):
+        """
+        Remove Bucket
+
+        :param str name: Bucket name
+        """
+        logging.getLogger().info('Deleting Bucket. %s', {'name': name})
+        response = self._portal.delete(f'/buckets/{name}')
+        logging.getLogger().info('Bucket deleted. %s', {'name': name})
+        return response

cterasdk/core/credentials.py

@@ -0,0 +1,64 @@
+import logging
+
+from .types import UserAccount
+from .base_command import BaseCommand
+
+
+class Credentials(BaseCommand):
+    """
+    Portal Credential Management APIs
+
+    :ivar cterasdk.core.credentials.S3 s3: Object holding the Portal S3 Credential Management APIs.
+    """
+
+    def __init__(self, portal):
+        super().__init__(portal)
+        self.s3 = S3(self._portal)
+
+
+class S3(BaseCommand):
+    """S3 Credential Management APIs"""
+
+    def _user_account(self, user_account=None):
+        return user_account if user_account else UserAccount(self._portal.session().user.name)
+
+    def all(self, user_account=None):
+        """
+        List Credentials
+
+        :param cterasdk.core.types.UserAccount,optional user_account: User account
+        """
+        user_account = self._user_account(user_account)
+        param = self._portal.users.get(user_account, ['uid']).uid
+        logging.getLogger().info('Listing Credentials. %s', {'user': str(user_account)})
+        return self._portal.execute('', 'getApiKeys', param)
+
+    def create(self, user_account=None):
+        """
+        Create Credential
+
+        :param cterasdk.core.types.UserAccount,optional user_account: User account
+        """
+        user_account = self._user_account(user_account)
+        param = self._portal.users.get(user_account, ['uid']).uid
+        logging.getLogger().info('Creating Credential. %s', {'type': 's3', 'user': str(user_account)})
+        response = self._portal.execute('', 'createApiKey', param)
+        logging.getLogger().info('Credetial created. %s', {'type': 's3', 'user': str(user_account)})
+        return response
+
+    def delete(self, access_key_id, user_account=None):
+        """
+        Delete Credential
+
+        :param str access_key_id: Access Key ID
+        :param cterasdk.core.types.UserAccount,optional user_account: User account
+        """
+        user_account = self._user_account(user_account)
+        for key in self.all(user_account):
+            if key.accessKey == access_key_id:
+                logging.getLogger().info('Deleting Credential. %s', {'type': 's3'})
+                response = self._portal.execute('', 'deleteApiKey', key.uid)
+                logging.getLogger().info('Credetial deleted. %s', {'type': 's3'})
+                return response
+        logging.getLogger().warning('Could not find access key. %s', {'key': access_key_id})
+        return None

cterasdk/core/users.py

@@ -11,10 +11,16 @@
 class Users(BaseCommand):
     """
     Portal User Management APIs
+
+    :ivar cterasdk.core.credentials.Credentials credentials: Object holding Portal User Credential Management APIs.
     """
 
     default = ['name']
 
+    def __init__(self, portal):
+        super().__init__(portal)
+        self.credentials = Credentials(self._portal)
+
     def _get_entire_object(self, user_account):
         ref = f'/users/{user_account.name}' if user_account.is_local \
             else f'/domains/{user_account.directory}/adUsers/{user_account.name}'
@@ -169,3 +175,46 @@ def delete(self, user):
         logging.getLogger().info('User deleted. %s', {'user': str(user)})
 
         return response
+
+
+class Credentials(BaseCommand):
+    """
+    Portal Credential Management APIs
+
+    :ivar cterasdk.core.credentials.S3 s3: Object holding the Portal User S3 Credential Management APIs.
+    """
+
+    def __init__(self, portal):
+        super().__init__(portal)
+        self.s3 = S3(self._portal)
+
+
+class S3(BaseCommand):
+    """
+    S3 Credential Management APIs
+    """
+
+    def all(self, user_account):
+        """
+        List Credentials
+
+        :param cterasdk.core.types.UserAccount user_account: User account
+        """
+        return self._portal.credentials.s3.all(user_account)
+
+    def create(self, user_account):
+        """
+        Create Credential
+
+        :param cterasdk.core.types.UserAccount user_account: User account
+        """
+        return self._portal.credentials.s3.create(user_account)
+
+    def delete(self, access_key_id, user_account):
+        """
+        Delete Credential
+
+        :param str access_key_id: Access Key ID
+        :param cterasdk.core.types.UserAccount user_account: User account
+        """
+        return self._portal.credentials.s3.delete(access_key_id, user_account)

cterasdk/object/Portal.py

@@ -17,6 +17,7 @@
 from ..core import reports
 from ..core import servers
 from ..core import devices
+from ..core import credentials
 from ..core import session
 from ..core import storage_classes
 from ..core import domains
@@ -84,6 +85,7 @@ def __init__(self, host, port, https):
         self.roles = roles.Roles(self)
         self.settings = settings.Settings(self)
         self.storage_classes = storage_classes.StorageClasses(self)
+        self.credentials = credentials.Credentials(self)
         self.tasks = taskmgr.Tasks(self)
         self.templates = templates.Templates(self)
         self.firmwares = firmwares.Firmwares(self)
@@ -133,6 +135,7 @@ def _omit_fields(self):
             'logs',
             'roles',
             'settings',
+            'credentials',
             'tasks',
             'templates',
             'firmwares'

docs/source/user_guides/Portal/EndUser.rst

@@ -38,3 +38,32 @@ Logging in
 .. code-block:: python
 
    user.logout()
+
+
+Managing S3 Credentials
+=======================
+.. automethod:: cterasdk.core.credentials.S3.all
+   :noindex:
+
+.. code-block:: python
+
+   """List all S3 credentials"""
+   for credential in user.credentials.s3.all():
+       print(credential.accessKey, credential.activated)
+
+.. automethod:: cterasdk.core.credentials.S3.create
+   :noindex:
+
+.. code-block:: python
+
+   """Create an S3 credential"""
+   credential = user.credentials.s3.create()
+
+.. automethod:: cterasdk.core.credentials.S3.delete
+   :noindex:
+
+.. code-block:: python
+
+   """Delete an S3 credentials"""
+   access_key_id = 'ABCDEFGHIJKLMOP'
+   user.credentials.s3.delete(access_key_id)

docs/source/user_guides/Portal/GlobalAdmin.rst

@@ -1039,6 +1039,37 @@ Directory Services
    admin.directoryservice.disconnect()
 
 
+Credentials
+-----------
+.. automethod:: cterasdk.core.credentials.S3.all
+   :noindex:
+
+.. code-block:: python
+
+   """List all of 'jsmith@demo.local' S3 credentials"""
+   jsmith = portal_types.UserAccount('jsmith', 'demo.local')
+   for credential in user.credentials.s3.all(jsmith):
+       print(credential.accessKey, credential.activated)
+
+.. automethod:: cterasdk.core.credentials.S3.create
+   :noindex:
+
+.. code-block:: python
+
+   """Create an S3 credential for a service account"""
+   service_account = portal_types.UserAccount('service_account')
+   credential = user.credentials.s3.create(service_account)
+
+.. automethod:: cterasdk.core.credentials.S3.delete
+   :noindex:
+
+.. code-block:: python
+
+   """Delete an S3 credentials associated with a user account"""
+   user_account = portal_types.UserAccount('jsmith', 'demo.local')
+   access_key_id = 'ABCDEFGHIJKLMOP'
+   user.credentials.s3.delete(access_key_id, user_account)
+
 Groups
 ------
 

tests/ut/test_core_credentials_s3_admin.py

@@ -0,0 +1,53 @@
+# pylint: disable=protected-access
+import munch
+
+from cterasdk.core.types import UserAccount
+from cterasdk.core import credentials
+from tests.ut import base_core
+
+
+class TestCoreCredentialsS3(base_core.BaseCoreTest):
+
+    def setUp(self):
+        super().setUp()
+        self._user_account = UserAccount('user')
+        self._uid = 1500
+        self._access_key_id = 'ABCD'
+        self._access_key_uid = 2500
+        self._mock_get_user_uid = self.patch_call("cterasdk.core.users.Users.get")
+        self._mock_get_user_uid.return_value = munch.Munch({'uid': self._uid})
+
+    def test_list_s3_credentials(self):
+        execute_response = 'Success'
+        self._init_global_admin(execute_response=execute_response)
+        ret = credentials.S3(self._global_admin).all(self._user_account)
+        self._mock_get_user_uid.assert_called_once_with(self._user_account, ['uid'])
+        self._global_admin.execute.assert_called_once_with('', 'getApiKeys', self._uid)
+        self.assertEqual(ret, execute_response)
+
+    def test_create_s3_credential(self):
+        execute_response = 'Success'
+        self._init_global_admin(execute_response=execute_response)
+        ret = credentials.S3(self._global_admin).create(self._user_account)
+        self._mock_get_user_uid.assert_called_once_with(self._user_account, ['uid'])
+        self._global_admin.execute.assert_called_once_with('', 'createApiKey', self._uid)
+        self.assertEqual(ret, execute_response)
+
+    def test_delete_s3_credential_success(self):
+        execute_response = 'Success'
+        mock_get_s3_credentials = self.patch_call("cterasdk.core.credentials.S3.all")
+        mock_get_s3_credentials.return_value = [munch.Munch({'accessKey': self._access_key_id, 'uid': self._access_key_uid})]
+        self._init_global_admin(execute_response=execute_response)
+        ret = credentials.S3(self._global_admin).delete(self._access_key_id, self._user_account)
+        mock_get_s3_credentials.assert_called_once_with(self._user_account)
+        self._global_admin.execute.assert_called_once_with('', 'deleteApiKey', self._access_key_uid)
+        self.assertEqual(ret, execute_response)
+
+    def test_delete_s3_credential_not_found(self):
+        self._init_global_admin()
+        mock_get_s3_credentials = self.patch_call("cterasdk.core.credentials.S3.all")
+        mock_get_s3_credentials.return_value = [munch.Munch({'accessKey': self._access_key_id, 'uid': self._access_key_uid})]
+        ret = credentials.S3(self._global_admin).delete('not_found', self._user_account)
+        mock_get_s3_credentials.assert_called_once_with(self._user_account)
+        self._global_admin.execute.assert_not_called()
+        self.assertEqual(ret, None)