Saimon/support xattrs cloudfolders (#253)

Author: saimonation

cterasdk/core/cloudfs.py

@@ -5,7 +5,7 @@
 from .base_command import BaseCommand
 from . import query, devices
 from .enum import ListFilter, PolicyType
-from .types import ComplianceSettingsBuilder
+from .types import ComplianceSettingsBuilder, ExtendedAttributesBuilder
 from ..common import union, Object
 from ..exceptions import CTERAException, ObjectNotFoundException
 
@@ -137,7 +137,7 @@ class CloudDrives(BaseCommand):
     def _get_entire_object(self, name, owner):
         return self._core.api.get(f'{self.find(name, owner, include=["baseObjectRef"]).baseObjectRef}')
 
-    def add(self, name, group, owner, winacls=True, description=None, quota=None, compliance_settings=None):
+    def add(self, name, group, owner, winacls=True, description=None, quota=None, compliance_settings=None, xattrs=None):
         """
         Create a new Cloud Drive Folder (Cloud Volume)
 
@@ -149,6 +149,8 @@ def add(self, name, group, owner, winacls=True, description=None, quota=None, co
         :param str,optional quota: Cloud drive folder quota in GB
         :param cterasdk.common.object.Object,optional compliance_settings: Compliance settings, defaults to disabled.
          Use :func:`cterasdk.core.types.ComplianceSettingsBuilder` to build the compliance settings object
+        :param cterasdk.common.object.Object,optional xattrs: Extended attributes, defaults to MacOS.
+         Use :func:`cterasdk.core.types.ExtendedAttributesBuilder` to build the extended attributes object
         """
         param = Object()
         param.name = name
@@ -159,6 +161,7 @@ def add(self, name, group, owner, winacls=True, description=None, quota=None, co
         if description:
             param.description = description
         param.wormSettings = compliance_settings if compliance_settings else ComplianceSettingsBuilder.default().build()
+        param.extendedAttributes = xattrs if xattrs else ExtendedAttributesBuilder.default().build()
 
         try:
             response = self._core.api.execute('', 'addCloudDrive', param)
@@ -174,8 +177,8 @@ def add(self, name, group, owner, winacls=True, description=None, quota=None, co
             )
             raise error
 
-    def modify(self, current_name, owner, new_name=None, new_owner=None, new_group=None,
-               description=None, winacls=None, quota=None, compliance_settings=None):
+    def modify(self, current_name, owner, new_name=None, new_owner=None, new_group=None,  # pylint: disable=too-many-arguments
+               description=None, winacls=None, quota=None, compliance_settings=None, xattrs=None):
         """
         Modify a Cloud Drive Folder (Cloud Volume)
 
@@ -189,6 +192,8 @@ def modify(self, current_name, owner, new_name=None, new_owner=None, new_group=N
         :param str,optional quota: Folder quota in GB
         :param cterasdk.common.object.Object,optional compliance_settings: Compliance settings.
          Use :func:`cterasdk.core.types.ComplianceSettingsBuilder` to build the compliance settings object
+        :param cterasdk.common.object.Object,optional xattrs: Extended attributes.
+         Use :func:`cterasdk.core.types.ExtendedAttributesBuilder` to build the extended attributes object
         """
         param = self._get_entire_object(current_name, owner)
         if new_name:
@@ -205,6 +210,8 @@ def modify(self, current_name, owner, new_name=None, new_owner=None, new_group=N
             param.folderQuota = quota
         if compliance_settings:
             param.wormSettings = compliance_settings
+        if xattrs:
+            param.extendedAttributes = xattrs
         try:
             response = self._core.api.put(f'/{param.baseObjectRef}', param)
             logging.getLogger('cterasdk.core').info('Cloud drive folder updated. %s', {'name': current_name})

cterasdk/core/enum.py

@@ -607,6 +607,15 @@ class RetentionMode:
     Compliance = 'Compliance'
 
 
+class ExtendedAttributes:
+    """
+    Extended Attributes
+
+    :ivar str MacOS: MacOS
+    """
+    MacOS = 'MacOS'
+
+
 class Duration:
     """
     Duration

cterasdk/core/types.py

@@ -4,7 +4,7 @@
 from ..lib import FileSystem
 
 from .enum import PortalAccountType, CollaboratorType, FileAccessMode, PlanCriteria, TemplateCriteria, \
-                  BucketType, LocationType, Platform, RetentionMode, Duration
+                  BucketType, LocationType, Platform, RetentionMode, Duration, ExtendedAttributes
 
 
 CloudFSFolderFindingHelper = namedtuple('CloudFSFolderFindingHelper', ('name', 'owner'))
@@ -698,6 +698,40 @@ def build(self):
         return self.settings
 
 
+class ExtendedAttribute(Object):
+
+    def __init__(self, name, supported):
+        self._classname = 'ExtendedAttributesInfo'  # pylint: disable=protected-access
+        self.name = name
+        self.supported = supported
+
+
+class ExtendedAttributesBuilder:
+
+    def __init__(self, enable, xattrs):
+        self.xattrs = Object()
+        self.xattrs._classname = 'ExtendedAttributes'  # pylint: disable=protected-access
+        self.xattrs.enable = enable
+        self.xattrs.attributes = xattrs
+
+    @staticmethod
+    def default():
+        return ExtendedAttributesBuilder(True, [ExtendedAttribute(ExtendedAttributes.MacOS, True)])
+
+    @staticmethod
+    def disabled():
+        return ExtendedAttributesBuilder(False, [ExtendedAttribute(ExtendedAttributes.MacOS, True)])
+
+    def add(self, xattr):
+        """
+        :param cterasdk.core.enum.ExtendedAttributes xattr: Extended attribute
+        """
+        self.xattrs.append(xattr)
+
+    def build(self):
+        return self.xattrs
+
+
 class RoleSettings(Object):  # pylint: disable=too-many-instance-attributes
     """
     Role Settings

docs/source/UserGuides/Portal/Administration.rst

@@ -1380,8 +1380,11 @@ Cloud Drive Folders
    """Create a Cloud Drive folder, owned by a local user account 'svc_account'"""
    svc_account = core_types.UserAccount('svc_account')
    admin.cloudfs.drives.add('DIR-001', 'FG-001', svc_account)
-   admin.cloudfs.drives.add('DIR-003', 'FG-003', svc_account, winacls = False) # disable Windows ACL's
-   admin.cloudfs.drives.add('DIR-003', 'FG-003', svc_account, quota = 1024) # Set folder quota, in GB
+   admin.cloudfs.drives.add('DIR-002', 'FG-002', svc_account, winacls=False,
+                            xattrs=core_types.ExtendedAttributesBuilder.disabled().build()) # Disable xattrs and Windows ACL's
+   admin.cloudfs.drives.add('DIR-003', 'FG-003', svc_account, winacls=True,
+                            xattrs=core_types.ExtendedAttributesBuilder.disabled().build()) # Disable xattrs, Enable Windows ACL's
+   admin.cloudfs.drives.add('DIR-004', 'FG-004', svc_account, quota=1024) # Set folder quota, in GB
 
    """Create a Cloud Drive folder, owned by the domain user 'ctera.local\wbruce'"""
    wbruce = core_types.UserAccount('wbruce', 'ctera.local')
@@ -1409,6 +1412,7 @@ Cloud Drive Folders
    settings = core_types.ComplianceSettingsBuilder.enterprise(1, core_enum.Duration.Years).grace_period(1, core_enum.Duration.Hours).build()
    admin.cloudfs.drives.add('Compliance', 'FG-Compliance', svc_account, compliance_settings=settings)
 
+
 .. automethod:: cterasdk.core.cloudfs.CloudDrives.modify
    :noindex:
 

tests/ut/test_core_cloudfs_cloud_drives.py

@@ -3,7 +3,7 @@
 
 from cterasdk import exceptions
 from cterasdk.core import cloudfs
-from cterasdk.core.types import UserAccount, ComplianceSettingsBuilder
+from cterasdk.core.types import UserAccount, ComplianceSettingsBuilder, ExtendedAttributesBuilder
 from cterasdk.core import query
 from cterasdk.common import Object, union
 from tests.ut import base_core
@@ -118,13 +118,14 @@ def test_add_cloud_drive_with_local_owner_winacls_false(self):
         self._mock_get_user_base_object_ref()
         self._mock_get_folder_group()
 
-        ret = cloudfs.CloudDrives(self._global_admin).add(self._name, self._group, self._local_user_account, False)
+        ret = cloudfs.CloudDrives(self._global_admin).add(self._name, self._group, self._local_user_account, False,
+                                                          xattrs=ExtendedAttributesBuilder.disabled().build())
 
         self._global_admin.users.get.assert_called_once_with(self._local_user_account, ['baseObjectRef'])
         self._global_admin.cloudfs.groups.get.assert_called_once_with(self._group, ['baseObjectRef'])
         self._global_admin.api.execute.assert_called_once_with('', 'addCloudDrive', mock.ANY)
 
-        expected_param = self._get_add_cloud_drive_object(winacls=False)
+        expected_param = self._get_add_cloud_drive_object(winacls=False, xattrs=ExtendedAttributesBuilder.disabled().build())
         actual_param = self._global_admin.api.execute.call_args[0][2]
         self._assert_equal_objects(actual_param, expected_param)
 
@@ -171,7 +172,7 @@ def test_undelete_with_local_owner(self):
         self._global_admin.users.get.assert_called_once_with(self._local_user_account, ['displayName'])
         self._global_admin.files.undelete.assert_called_once_with(f'Users/{self._owner}/{self._name}')
 
-    def _get_add_cloud_drive_object(self, winacls=True, description=None, quota=None, compliance_settings=None):
+    def _get_add_cloud_drive_object(self, winacls=True, description=None, quota=None, compliance_settings=None, xattrs=None):
         add_cloud_drive_param = Object()
         add_cloud_drive_param.name = self._name
         add_cloud_drive_param.owner = self._owner
@@ -181,6 +182,7 @@ def _get_add_cloud_drive_object(self, winacls=True, description=None, quota=None
         if description:
             add_cloud_drive_param.description = description
         add_cloud_drive_param.wormSettings = compliance_settings if compliance_settings else ComplianceSettingsBuilder.default().build()
+        add_cloud_drive_param.extendedAttributes = xattrs if xattrs else ExtendedAttributesBuilder.default().build()
         return add_cloud_drive_param
 
     def _mock_get_user_base_object_ref(self):