Merge pull request #1502 from FernandoOjeda/ft/cdn_edit_option

allmightyspiff · web-flow · commit 18cbb16c791b · 2021-07-15T14:56:03.000-05:00
Add the cdn edit option.
diff --git a/SoftLayer/CLI/cdn/edit.py b/SoftLayer/CLI/cdn/edit.py
@@ -0,0 +1,81 @@
+"""Edit a CDN Account."""
+# :license: MIT, see LICENSE for more details.
+
+import click
+
+import SoftLayer
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import formatting
+from SoftLayer.CLI import helpers
+
+
+@click.command()
+@click.argument('identifier')
+@click.option('--header', '-H',
+              type=click.STRING,
+              help="Host header."
+              )
+@click.option('--http-port', '-t',
+              type=click.INT,
+              help="HTTP port."
+              )
+@click.option('--origin', '-o',
+              type=click.STRING,
+              help="Origin server address."
+              )
+@click.option('--respect-headers', '-r',
+              type=click.Choice(['1', '0']),
+              help="Respect headers. The value 1 is On and 0 is Off."
+              )
+@click.option('--cache', '-c', multiple=True, type=str,
+              help="Cache key optimization. These are the valid options to choose: 'include-all', 'ignore-all', "
+                   "'include-specified', 'ignore-specified'. If you select 'include-specified' or 'ignore-specified' "
+                   "please add a description too using again --cache, "
+                   "e.g --cache=include-specified --cache=description."
+              )
+@click.option('--performance-configuration', '-p',
+              type=click.Choice(['General web delivery', 'Large file optimization', 'Video on demand optimization']),
+              help="Optimize for, General web delivery', 'Large file optimization', 'Video on demand optimization', "
+                   "the Dynamic content acceleration option is not added because this has a special configuration."
+              )
+@environment.pass_env
+def cli(env, identifier, header, http_port, origin, respect_headers, cache, performance_configuration):
+    """Edit a CDN Account.
+
+       Note: You can use the hostname or uniqueId as IDENTIFIER.
+    """
+
+    manager = SoftLayer.CDNManager(env.client)
+    cdn_id = helpers.resolve_id(manager.resolve_ids, identifier, 'CDN')
+
+    cache_result = {}
+    if cache:
+        if len(cache) > 1:
+            cache_result['cacheKeyQueryRule'] = cache[0]
+            cache_result['description'] = cache[1]
+        else:
+            cache_result['cacheKeyQueryRule'] = cache[0]
+
+    cdn_result = manager.edit(cdn_id, header=header, http_port=http_port, origin=origin,
+                              respect_headers=respect_headers, cache=cache_result,
+                              performance_configuration=performance_configuration)
+
+    table = formatting.KeyValueTable(['name', 'value'])
+    table.align['name'] = 'r'
+    table.align['value'] = 'l'
+
+    for cdn in cdn_result:
+        table.add_row(['Create Date', cdn.get('createDate')])
+        table.add_row(['Header', cdn.get('header')])
+        table.add_row(['Http Port', cdn.get('httpPort')])
+        table.add_row(['Origin Type', cdn.get('originType')])
+        table.add_row(['Performance Configuration', cdn.get('performanceConfiguration')])
+        table.add_row(['Protocol', cdn.get('protocol')])
+        table.add_row(['Respect Headers', cdn.get('respectHeaders')])
+        table.add_row(['Unique Id', cdn.get('uniqueId')])
+        table.add_row(['Vendor Name', cdn.get('vendorName')])
+        table.add_row(['Cache key optimization', cdn.get('cacheKeyQueryRule')])
+        table.add_row(['cname', cdn.get('cname')])
+        table.add_row(['Origin server address', cdn.get('originHost')])
+
+    env.fout(table)
diff --git a/SoftLayer/CLI/routes.py b/SoftLayer/CLI/routes.py
@@ -62,6 +62,7 @@
 
     ('cdn', 'SoftLayer.CLI.cdn'),
     ('cdn:detail', 'SoftLayer.CLI.cdn.detail:cli'),
+    ('cdn:edit', 'SoftLayer.CLI.cdn.edit:cli'),
     ('cdn:list', 'SoftLayer.CLI.cdn.list:cli'),
     ('cdn:origin-add', 'SoftLayer.CLI.cdn.origin_add:cli'),
     ('cdn:origin-list', 'SoftLayer.CLI.cdn.origin_list:cli'),
diff --git a/SoftLayer/fixtures/SoftLayer_Network_CdnMarketplace_Configuration_Mapping.py b/SoftLayer/fixtures/SoftLayer_Network_CdnMarketplace_Configuration_Mapping.py
@@ -1,6 +1,8 @@
 listDomainMappings = [
     {
+        "cacheKeyQueryRule": "include-all",
         "cname": "cdnakauuiet7s6u6.cdnedge.bluemix.net",
+        "createDate": "2020-09-29T15:19:01-06:00",
         "domain": "test.example.com",
         "header": "test.example.com",
         "httpPort": 80,
@@ -17,6 +19,7 @@
 listDomainMappingByUniqueId = [
     {
         "cname": "cdnakauuiet7s6u6.cdnedge.bluemix.net",
+        "performanceConfiguration": "Large file optimization",
         "domain": "test.example.com",
         "header": "test.example.com",
         "httpPort": 80,
@@ -29,3 +32,21 @@
         "vendorName": "akamai"
     }
 ]
+
+updateDomainMapping = [
+    {
+        "createDate": "2021-02-09T19:32:29-06:00",
+        "originType": "HOST_SERVER",
+        "path": "/*",
+        "performanceConfiguration": "Large file optimization",
+        "protocol": "HTTP",
+        "respectHeaders": True,
+        "uniqueId": "424406419091111",
+        "vendorName": "akamai",
+        "header": "www.test.com",
+        "httpPort": 83,
+        "cname": "cdn.test.cloud",
+        "originHost": "1.1.1.1",
+        "cacheKeyQueryRule": "include: test"
+    }
+]
diff --git a/SoftLayer/managers/cdn.py b/SoftLayer/managers/cdn.py
@@ -5,10 +5,13 @@
 
     :license: MIT, see LICENSE for more details.
 """
-
+import SoftLayer
 from SoftLayer import utils
 
 
+# pylint: disable=no-self-use,too-many-lines,too-many-instance-attributes
+
+
 class CDNManager(utils.IdentifierMixin, object):
     """Manage Content Delivery Networks in the account.
 
@@ -27,6 +30,7 @@ def __init__(self, client):
         self.cdn_path = self.client['SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path']
         self.cdn_metrics = self.client['Network_CdnMarketplace_Metrics']
         self.cdn_purge = self.client['SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge']
+        self.resolvers = [self._get_ids_from_hostname]
 
     def list_cdn(self, **kwargs):
         """Lists Content Delivery Networks for the active user.
@@ -170,3 +174,90 @@ def start_data(self):
     def end_date(self):
         """Retrieve the cdn usage metric end date."""
         return self._end_date
+
+    def edit(self, identifier, header=None, http_port=None, origin=None,
+             respect_headers=None, cache=None, performance_configuration=None):
+        """Edit the cdn object.
+
+        :param string identifier: The CDN identifier.
+        :param header: The cdn Host header.
+        :param http_port: The cdn HTTP port.
+        :param origin: The cdn Origin server address.
+        :param respect_headers: The cdn Respect headers.
+        :param cache: The cdn Cache key optimization.
+        :param performance_configuration: The cdn performance configuration.
+
+        :returns: SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping[].
+        """
+        cdn_instance_detail = self.get_cdn(str(identifier))
+
+        config = {
+            'uniqueId': cdn_instance_detail.get('uniqueId'),
+            'originType': cdn_instance_detail.get('originType'),
+            'protocol': cdn_instance_detail.get('protocol'),
+            'path': cdn_instance_detail.get('path'),
+            'vendorName': cdn_instance_detail.get('vendorName'),
+            'cname': cdn_instance_detail.get('cname'),
+            'domain': cdn_instance_detail.get('domain'),
+            'httpPort': cdn_instance_detail.get('httpPort'),
+            'origin': cdn_instance_detail.get('originHost'),
+            'header': cdn_instance_detail.get('header')
+        }
+
+        if header:
+            config['header'] = header
+
+        if http_port:
+            config['httpPort'] = http_port
+
+        if origin:
+            config['origin'] = origin
+
+        if respect_headers:
+            config['respectHeaders'] = respect_headers
+
+        if cache:
+            if 'include-specified' in cache['cacheKeyQueryRule']:
+                cache_key_rule = self.get_cache_key_query_rule('include', cache)
+                config['cacheKeyQueryRule'] = cache_key_rule
+            elif 'ignore-specified' in cache['cacheKeyQueryRule']:
+                cache_key_rule = self.get_cache_key_query_rule('ignore', cache)
+                config['cacheKeyQueryRule'] = cache_key_rule
+            else:
+                config['cacheKeyQueryRule'] = cache['cacheKeyQueryRule']
+
+        if performance_configuration:
+            config['performanceConfiguration'] = performance_configuration
+
+        return self.cdn_configuration.updateDomainMapping(config)
+
+    def _get_ids_from_hostname(self, hostname):
+        """Get the cdn object detail.
+
+        :param string hostname: The CDN identifier.
+        :returns: SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping[].
+        """
+        result = []
+        cdn_list = self.cdn_configuration.listDomainMappings()
+        for cdn in cdn_list:
+            if cdn.get('domain', '').lower() == hostname.lower():
+                result.append(cdn.get('uniqueId'))
+                break
+
+        return result
+
+    @staticmethod
+    def get_cache_key_query_rule(cache_type, cache):
+        """Get the cdn object detail.
+
+        :param string cache_type: Cache type.
+        :param  cache: Cache description.
+
+        :return: string value.
+        """
+        if 'description' not in cache:
+            raise SoftLayer.SoftLayerError('Please add a description to be able to update the'
+                                           ' cache.')
+        cache_result = '%s: %s' % (cache_type, cache['description'])
+
+        return cache_result
diff --git a/docs/cli/cdn.rst b/docs/cli/cdn.rst
@@ -27,3 +27,7 @@ Interacting with CDN
 .. click:: SoftLayer.CLI.cdn.purge:cli
    :prog: cdn purge
    :show-nested:
+
+.. click:: SoftLayer.CLI.cdn.edit:cli
+   :prog: cdn edit
+   :show-nested:
diff --git a/tests/CLI/modules/cdn_tests.py b/tests/CLI/modules/cdn_tests.py
@@ -95,3 +95,34 @@ def test_remove_origin(self):
 
         self.assert_no_fail(result)
         self.assertEqual(result.output, "Origin with path /example1 has been deleted\n")
+
+    def test_edit_header(self):
+        result = self.run_command(['cdn', 'edit', 'test.example.com', '--header=www.test.com'])
+        self.assert_no_fail(result)
+        header_result = json.loads(result.output)
+        self.assertEqual('www.test.com', header_result['Header'])
+
+    def test_edit_http_port(self):
+        result = self.run_command(['cdn', 'edit', 'test.example.com', '--http-port=83'])
+        self.assert_no_fail(result)
+        header_result = json.loads(result.output)
+        self.assertEqual(83, header_result['Http Port'])
+
+    def test_edit_respect_headers(self):
+        result = self.run_command(['cdn', 'edit', 'test.example.com', '--respect-headers=1'])
+        self.assert_no_fail(result)
+        header_result = json.loads(result.output)
+        self.assertEqual(True, header_result['Respect Headers'])
+
+    def test_edit_cache(self):
+        result = self.run_command(['cdn', 'edit', 'test.example.com', '--cache', 'include-specified',
+                                   '--cache', 'test'])
+        self.assert_no_fail(result)
+        header_result = json.loads(result.output)
+        self.assertEqual('include: test', header_result['Cache key optimization'])
+
+    def test_edit_cache_by_uniqueId(self):
+        result = self.run_command(['cdn', 'edit', '9934111111111', '--cache', 'include-specified', '--cache', 'test'])
+        self.assert_no_fail(result)
+        header_result = json.loads(result.output)
+        self.assertEqual('include: test', header_result['Cache key optimization'])
diff --git a/tests/managers/cdn_tests.py b/tests/managers/cdn_tests.py
@@ -5,6 +5,7 @@
     :license: MIT, see LICENSE for more details.
 """
 
+from SoftLayer import fixtures
 from SoftLayer.managers import cdn
 from SoftLayer import testing
 
@@ -102,3 +103,37 @@ def test_purge_content(self):
         self.assert_called_with('SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge',
                                 'createPurge',
                                 args=args)
+
+    def test_cdn_edit(self):
+        identifier = '9934111111111'
+        header = 'www.test.com'
+        result = self.cdn_client.edit(identifier, header=header)
+
+        self.assertEqual(fixtures.SoftLayer_Network_CdnMarketplace_Configuration_Mapping.
+                         updateDomainMapping, result)
+
+        self.assert_called_with(
+            'SoftLayer_Network_CdnMarketplace_Configuration_Mapping',
+            'updateDomainMapping',
+            args=({
+                'uniqueId': '9934111111111',
+                'originType': 'HOST_SERVER',
+                'protocol': 'HTTP',
+                'path': '/',
+                'vendorName': 'akamai',
+                'cname': 'cdnakauuiet7s6u6.cdnedge.bluemix.net',
+                'domain': 'test.example.com',
+                'httpPort': 80,
+                'header': 'www.test.com',
+                'origin': '1.1.1.1'
+            },)
+        )
+
+    def test_cdn_instance_by_hostname(self):
+        hostname = 'test.example.com'
+        result = self.cdn_client._get_ids_from_hostname(hostname)
+        expected_result = fixtures.SoftLayer_Network_CdnMarketplace_Configuration_Mapping.listDomainMappings
+        self.assertEqual(expected_result[0]['uniqueId'], result[0])
+        self.assert_called_with(
+            'SoftLayer_Network_CdnMarketplace_Configuration_Mapping',
+            'listDomainMappings',)
