Saimon/portal settings (#231)

Author: saimonation

cterasdk/core/enum.py

@@ -312,6 +312,34 @@ class PlanItem:
     Storage = 'Storage'
 
 
+class PlanService:
+    """
+    Plan Service
+
+    :ivar str CloudDrive: Cloud Drive
+    :ivar str CloudBackup: Cloud Backup
+    :ivar str Seeding: Seeding
+    :ivar str Remote: Remote Access
+    """
+    CloudDrive = 'Cloud folders'
+    CloudBackup = 'Cloud Backup'
+    Seeding = 'Seeding'
+    Remote = 'Remote Access'
+
+
+class PlanServiceState:
+    """
+    Plan Service State
+
+    :ivar str Enabled: Enabled
+    :ivar str Disabled: Disabled
+    :ivar str Connect: Cloud Drive Connect
+    """
+    Enabled = 'OK'
+    Disabled = 'Disabled'
+    Connect = 'Lite'
+
+
 class ListFilter:
     """
     Cloud Drive Folder List Filter

cterasdk/core/plans.py

@@ -78,15 +78,17 @@ def get(self, name, include=None):
             raise ObjectNotFoundException('Could not find subscription plan', f'/plans/{name}', name=name)
         return plan
 
-    def add(self, name, retention=None, quotas=None):
+    def add(self, name, services=None, retention=None, quotas=None):
         """
         Add a subscription plan
 
+        :param dict,optional services: Services to enable or disable
         :param dict,optional retention: The data retention policy
         :param dict,optional quotas: The items included in the plan and their respective quota
         """
         plan = self._core.api.defaults('Plan')
         plan.name = name
+        Plans._assign_services(plan, services)
         Plans._assign_retention(plan, retention)
         Plans._assign_quotas(plan, quotas)
         try:
@@ -97,15 +99,17 @@ def add(self, name, retention=None, quotas=None):
             logging.getLogger('cterasdk.core').error("Plan creation failed.")
             raise CTERAException('Plan creation failed', error)
 
-    def modify(self, name, retention=None, quotas=None, apply_changes=True):
+    def modify(self, name, services=None, retention=None, quotas=None, apply_changes=True):
         """
         Modify a subscription plan
 
+        :param dict,optional services: Services to enable or disable
         :param dict,optional retention: The data retention policy
         :param dict,optional quotas: The items included in the plan and their respective quota
         :param bool,optional apply_changes: Apply provisioning changes immediately
         """
         plan = self._get_entire_object(name)
+        Plans._assign_services(plan, services)
         Plans._assign_retention(plan, retention)
         Plans._assign_quotas(plan, quotas)
         try:
@@ -121,6 +125,14 @@ def modify(self, name, retention=None, quotas=None, apply_changes=True):
             logging.getLogger('cterasdk.core').error("Could not modify subscription plan.")
             raise CTERAException('Could not modify subscription plan', error)
 
+    @staticmethod
+    def _assign_services(plan, services):
+        if services is not None:
+            for service in plan.services:
+                service_state = services.get(service.serviceName, None)
+                if service_state:
+                    service.serviceState = service_state
+
     @staticmethod
     def _assign_retention(plan, retention):
         if retention is not None:

cterasdk/core/settings.py

@@ -1,21 +1,61 @@
 import logging
 
+from ..common import Object
 from .base_command import BaseCommand
 
 
 class Settings(BaseCommand):
     """
-    Portal Settings APIs
+    CTERA Portal Settings APIs
 
     :ivar cterasdk.core.settings.GlobalSettings global_settings: Object holding the Portal Global Settings APIs
     """
 
-    def __init__(self, portal):
-        super().__init__(portal)
-        self.global_settings = GlobalSettings(self._core)
+    def __init__(self, core):
+        super().__init__(core)
+        self.global_settings = GlobalSettings(core)
+        self.portal = PortalSettings(core)
+
+
+class PortalSettings(BaseCommand):
+    """
+    Virtual Portal Settings APIs
+    """
+    def get(self):
+        if self.session().in_tenant_context():
+            return self._core.api.execute('', 'getSettings').settings
+        return self._core.api.get('/settings/defaultPortalSettings')
+
+    def use_global_settings(self):
+        return self.update()
+
+    def update(self, settings=None):
+        """
+        Update Portal Settings
+
+        :param cterasdk.common.object.Objcet settings: Settings, defaults to using the global settings.
+        """
+        if not self.session().in_tenant_context():
+            self._core.api.put('/settings/defaultPortalSettings', settings)
+        else:
+            param = PortalSettings._create_settings_parameter()
+            if settings:
+                param.fromSystem = False
+                param.settings = settings
+            self._core.api.execute('', 'setSettings', param)
+
+    @staticmethod
+    def _create_settings_parameter():
+        param = Object()
+        param._classname = 'SettingsParam'  # pylint: disable=protected-access
+        param.fromSystem = True
+        return param
 
 
 class GlobalSettings(BaseCommand):
+    """
+    Global Settings APIs
+    """
 
     def get_timezone(self):
         """

docs/source/UserGuides/Portal/Administration.rst

@@ -310,9 +310,10 @@ Subscription Plans
    """
 
    name = 'good_plan'
+   services = {core_enum.PlanService.CloudBackup: core_enum.PlanServiceState.Disabled, core_enum.PlanService.CloudDrive: core_enum.PlanServiceState.Disabled}
    retention = {core_enum.PlanRetention.Daily: 7, core_enum.PlanRetention.Monthly: 12}
    quotas = {core_enum.PlanItem.EV16: 10, core_enum.PlanItem.EV32: 5, core_enum.PlanItem.Share: 100}
-   admin.plans.add(name, retention, quotas)
+   admin.plans.add(name, services, retention, quotas)
 
 .. automethod:: cterasdk.core.plans.Plans.modify
    :noindex:
@@ -326,9 +327,10 @@ Subscription Plans
    """
 
    name = 'good_plan'
+   services = {core_enum.PlanService.CloudBackup: core_enum.PlanServiceState.Disabled, core_enum.PlanService.CloudDrive: core_enum.PlanServiceState.Disabled}
    retention = {core_enum.PlanRetention.Daily: 30, core_enum.PlanRetention.Monthly: 36}
    quotas = {core_enum.PlanItem.EV16: 20, core_enum.PlanItem.EV32: 10, core_enum.PlanItem.Share: 200}
-   admin.plans.modify(name, retention, quotas)
+   admin.plans.modify(name, services, retention, quotas)
 
 .. automethod:: cterasdk.core.plans.Plans.delete
    :noindex:
@@ -1561,6 +1563,30 @@ Timezone
 
    admin.settings.global_settings.set_timzeone('(GMT-05:00) Eastern Time (US , Canada)')
 
+
+Virtual Portal Settings
+=======================
+
+.. automethod:: cterasdk.core.settings.PortalSettings.get
+   :noindex:
+
+.. code:: python
+
+   admin.settings.portal.get()
+
+.. automethod:: cterasdk.core.settings.PortalSettings.use_global_settings
+   :noindex:
+
+.. automethod:: cterasdk.core.settings.PortalSettings.update
+   :noindex:
+
+.. code:: python
+
+   settings = admin.settings.portal.get()
+   settings.defaultMail = 'support@acme.com'  # assign default email to domain users without an email address
+   admin.settings.portal.update(settings)  # apply settings changes
+
+
 TLS Certificate
 ===============
 

tests/ut/test_core_plans.py

@@ -155,7 +155,7 @@ def test_modify_success_without_apply_changes(self):
             Connect=5,
             Storage=4096
         )
-        plans.Plans(self._global_admin).modify(self._plan_name, retention, quotas, False)
+        plans.Plans(self._global_admin).modify(self._plan_name, retention=retention, quotas=quotas, apply_changes=False)
         self._global_admin.api.get.assert_called_once_with(f'/plans/{self._plan_name}')
         self._global_admin.api.put.assert_called_once_with(f'/plans/{self._plan_name}', mock.ANY)
         expected_param = self._get_plan_object(retention, licenses)