Support managing local licenses on an edge filer (#117)

Author: saimonation

cterasdk/edge/licenses.py

@@ -6,7 +6,11 @@
 
 
 class Licenses(BaseCommand):
-    """ Gateway License configuration APIs """
+    """ Edge Filer License Configuration APIs """
+
+    def __init__(self, gateway):
+        super().__init__(gateway)
+        self.local = LocalLicenses(self._gateway)
 
     @staticmethod
     def infer(ctera_license):
@@ -22,7 +26,7 @@ def apply(self, ctera_license):
         """
         Apply a license
 
-        :param str ctera_license
+        :param cterasdk.edge.enum.License ctera_license: License type
         """
         inferred_license = Licenses.infer(ctera_license)
 
@@ -42,3 +46,30 @@ def get(self):
         if len(inferred_license) == 8:
             inferred_license = inferred_license + '16'
         return 'EV' + inferred_license[8:]
+
+
+class LocalLicenses(BaseCommand):
+    """ Edge Filer Local License Configuration APIs """
+
+    def get(self):
+        """
+        Retrieve a list of local licenses installed
+        """
+        return self._gateway.get('/config/device/licenses')
+
+    def add(self, code):
+        """
+        Install a local license. Use this option when running the Edge Filer as a standalone appliance.
+
+        :param str code: License code
+        """
+        logging.getLogger().info('Installing license. %s', {'code': code})
+        response = self._gateway.add('/config/device/licenses', code)
+        logging.getLogger().info("License added. %s", {'code': code})
+        return response
+
+    def clear(self):
+        """
+        Remove all local licenses
+        """
+        self._gateway.put('/config/device/licenses', [])

tests/ut/test_edge_licenses.py

@@ -8,6 +8,10 @@
 
 class TestEdgeLicenses(base_edge.BaseEdgeTest):
 
+    def setUp(self):
+        super().setUp()
+        self._local_license = 'MA645-83CDC-50127-CE61B-V64'
+
     def test_edge_get_active_licenses(self):
         actual_licenses = ['NA', 'vGateway8', 'vGateway', 'vGateway32', 'vGateway64', 'vGateway128']
         expected_licenses = ['NA', 'EV8', 'EV16', 'EV32', 'EV64', 'EV128']
@@ -32,3 +36,22 @@ def test_apply_license_raise_input_error(self):
         with self.assertRaises(exception.InputError) as error:
             licenses.Licenses(self._filer).apply('Expected Failure')
         self.assertEqual('Invalid license type', error.exception.message)
+
+    def test_get_local_license(self):
+        get_response = [self._local_license]
+        self._init_filer(get_response=get_response)
+        ret = licenses.Licenses(self._filer).local.get()
+        self._filer.get.assert_called_once_with('/config/device/licenses')
+        self.assertEqual(ret, get_response)
+
+    def test_apply_local_license(self):
+        add_response = 'Success'
+        self._init_filer(add_response=add_response)
+        ret = licenses.Licenses(self._filer).local.add(self._local_license)
+        self._filer.add.assert_called_once_with('/config/device/licenses', self._local_license)
+        self.assertEqual(ret, add_response)
+
+    def test_clear_local_license(self):
+        self._init_filer()
+        licenses.Licenses(self._filer).local.clear()
+        self._filer.put.assert_called_once_with('/config/device/licenses', [])