added features cache description, Example, https port, compression, dynamic-path and prefetching

Ramkishor Chaladi · Ramkishor Chaladi · commit e00e486a5485 · 2023-07-25T17:06:38.000+05:30
diff --git a/SoftLayer/CLI/cdn/origin_add.py b/SoftLayer/CLI/cdn/origin_add.py
@@ -24,14 +24,12 @@
 @click.option('--bucket-name', '-b',
               type=click.STRING,
               help="The name of the available resource [required if --origin-type=storage]")
-@click.option('--port', '-p',
+@click.option('--http-port', '-p',
               type=click.INT,
-              help="The http port number.",
-              default=80,
-              show_default=True)
+              help="The http port number. [http or https is required]")
 @click.option('--https-port', '-s',
               type=click.INT,
-              help="The https port number."
+              help="The https port number. [http or https is required]"
               )
 @click.option('--protocol', '-P',
               type=click.STRING,
@@ -44,12 +42,15 @@
               default='web',
               show_default=True)
 @click.option('--dynamic-path', '-d',
-              help="The path that Akamai edge servers periodically fetch the test object from. example = /detection-test-object.html")
+              help="The path that Akamai edge servers periodically fetch the test object from."
+              "example = /detection-test-object.html")
 @click.option('--compression', '-i',
               help="Enable or disable compression of JPEG images for requests over certain network conditions.",
+              default='true',
               show_default=True)
 @click.option('--prefetching', '-g',
               help="Enable or disable the embedded object prefetching feature.",
+              default='true',
               show_default=True)
 @click.option('--extensions', '-e',
               type=click.STRING,
@@ -62,7 +63,7 @@
               show_default=True)
 @environment.pass_env
 def cli(env, unique_id, origin, path, origin_type, header,
-        bucket_name, port, https_port, protocol, optimize_for, 
+        bucket_name, http_port, https_port, protocol, optimize_for,
         dynamic_path, compression, prefetching,
         extensions, cache_query):
     """Create an origin path for an existing CDN mapping.
@@ -77,7 +78,7 @@ def cli(env, unique_id, origin, path, origin_type, header,
         raise exceptions.ArgumentError('[-b | --bucket-name] is required when [-t | --origin-type] is "storage"')
 
     result = manager.add_origin(unique_id, origin, path, dynamic_path, origin_type=origin_type,
-                                header=header, port=port, https_port=https_port, protocol=protocol,
+                                header=header, http_port=http_port, https_port=https_port, protocol=protocol,
                                 bucket_name=bucket_name, file_extensions=extensions,
                                 optimize_for=optimize_for,
                                 compression=compression, prefetching=prefetching,
@@ -94,8 +95,11 @@ def cli(env, unique_id, origin, path, origin_type, header,
 
     table.add_row(['Origin', result['origin']])
     table.add_row(['Origin Type', result['originType']])
+    table.add_row(['Header', result['header']])
     table.add_row(['Path', result['path']])
-    table.add_row(['Port', result['httpPort']])
+    table.add_row(['Http Port', result['httpPort']])
+    table.add_row(['Https Port', result['httpsPort']])
+    table.add_row(['Cache Key Rule', result['cacheKeyQueryRule']])
     table.add_row(['Configuration', result['performanceConfiguration']])
     table.add_row(['Status', result['status']])
 
diff --git a/SoftLayer/fixtures/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path.py b/SoftLayer/fixtures/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path.py
@@ -21,16 +21,23 @@
 
 createOriginPath = [
     {
-        "header": "test.example.com",
         "httpPort": 80,
+        "httpsPort": 81,
         "mappingUniqueId": "993419389425697",
         "origin": "10.10.10.1",
         "originType": "HOST_SERVER",
+        "header": "test.example.com",
         "path": "/example",
         "status": "RUNNING",
         "bucketName": "test-bucket",
         'fileExtension': 'jpg',
-        "performanceConfiguration": "General web delivery"
+        "performanceConfiguration": "Dynamic content acceleration",
+        "dynamicContentAcceleration": {
+                "detectionPath": "/abc.html",
+                "prefetchEnabled": True,
+                "mobileImageCompressionEnabled": True
+            },
+        "cacheKeyQueryRule": "include-all"
     }
 ]
 
diff --git a/SoftLayer/managers/cdn.py b/SoftLayer/managers/cdn.py
@@ -65,27 +65,34 @@ def get_origins(self, unique_id, **kwargs):
         return self.cdn_path.listOriginPath(unique_id, **kwargs)
 
     def add_origin(self, unique_id, origin, path, dynamic_path, origin_type="server", header=None,
-                   port=80, https_port=None, protocol='http', bucket_name=None, file_extensions=None,
+                   http_port=80, https_port=None, protocol='http', bucket_name=None, file_extensions=None,
                    optimize_for="web", compression=None, prefetching=None,
                    cache_query="include all"):
         """Creates an origin path for an existing CDN.
 
         :param str unique_id: The unique ID associated with the CDN.
         :param str path: relative path to the domain provided, e.g. "/articles/video"
+        :param str dynamic_path: The path that Akamai edge servers periodically fetch the test object from.
+                                example = /detection-test-object.html
         :param str origin: ip address or hostname if origin_type=server, API endpoint for
                            your S3 object storage if origin_type=storage
         :param str origin_type: it can be 'server' or 'storage' types.
         :param str header: the edge server uses the host header to communicate with the origin.
                            It defaults to hostname. (optional)
-        :param int port: the http port number (default: 80)
+        :param int http_port: the http port number (default: 80)
+        :param int https_port: the https port number
         :param str protocol: the protocol of the origin (default: HTTP)
         :param str bucket_name: name of the available resource
         :param str file_extensions: file extensions that can be stored in the CDN, e.g. "jpg,png"
         :param str optimize_for: performance configuration, available options: web, video, and file where:
 
-                                    - 'web' = 'General web delivery'
-                                    - 'video' = 'Video on demand optimization'
-                                    - 'file' = 'Large file optimization'
+                                - 'web' = 'General web delivery'
+                                - 'video' = 'Video on demand optimization'
+                                - 'file' = 'Large file optimization'
+                                - 'dynamic' = 'Dynamic content acceleration'
+        :param bool compression: Enable or disable compression of JPEG images for requests over
+                                certain network conditions.
+        :param bool prefetching: Enable or disable the embedded object prefetching feature.
         :param str cache_query: rules with the following formats: 'include-all', 'ignore-all',
                                'include: space separated query-names',
                                'ignore: space separated query-names'.'
@@ -104,17 +111,19 @@ def add_origin(self, unique_id, origin, path, dynamic_path, origin_type="server"
             'path': path,
             'origin': origin,
             'originType': types.get(origin_type),
-            'httpPort': port,
+            'httpPort': http_port,
             'httpsPort': https_port,
             'protocol': protocol.upper(),
-            'performanceConfiguration': performance_config.get(optimize_for, 'General web delivery'),
-            'cacheKeyQueryRule': cache_query
+            'performanceConfiguration': performance_config.get(optimize_for),
+            'cacheKeyQueryRule': cache_query,
         }
 
         if optimize_for == 'dynamic':
-            new_origin['DetectionPath']=  "/" + str(dynamic_path)
-            new_origin['PrefetchEnabled']= prefetching
-            new_origin['MobileImageCompressionEnabled']= compression
+            new_origin['dynamicContentAcceleration'] = {
+                'detectionPath': "/" + str(dynamic_path),
+                'prefetchEnabled': bool(prefetching),
+                'mobileImageCompressionEnabled': bool(compression)
+            }
 
         if header:
             new_origin['header'] = header
diff --git a/tests/CLI/modules/cdn_tests.py b/tests/CLI/modules/cdn_tests.py
@@ -66,15 +66,30 @@ def test_add_origin_server(self):
 
         self.assert_no_fail(result)
 
+    def test_add_origin_server_dynamic(self):
+        result = self.run_command(
+            ['cdn', 'origin-add', '-t', 'server', '-H=test.example.com', '-s', 81, '-o', 'dynamic', '-c=include-all',
+             '-P', 'HTTPS', '-d', 'abc.html', '-g', True, '-i', True, '1234', '10.10.10.1', '/example/videos2', ])
+
+        self.assert_no_fail(result)
+
     def test_add_origin_storage(self):
         result = self.run_command(['cdn', 'origin-add', '-t', 'storage', '-b=test-bucket', '-H=test.example.com',
                                    '-p', 80, '-o', 'web', '-c=include-all', '1234', '10.10.10.1', '/example/videos2'])
 
         self.assert_no_fail(result)
 
+    def test_add_origin_storage_dynamic(self):
+        result = self.run_command(['cdn', 'origin-add', '-t', 'storage', '-b=test-bucket', '-H=test.example.com',
+                                   '-s', 81, '-o', 'dynamic', '-c=include-all', '1234', '10.10.10.1',
+                                   '/example/videos2', '-g', True, '-i', True])
+
+        self.assert_no_fail(result)
+
     def test_add_origin_without_storage(self):
         result = self.run_command(['cdn', 'origin-add', '-t', 'storage', '-H=test.example.com', '-p', 80,
-                                   '-o', 'web', '-c=include-all', '1234', '10.10.10.1', '/example/videos2'])
+                                   '-P', 'HTTPS', '-o', 'web', '-c=include-all',
+                                   '1234', '10.10.10.1', '/example/videos2'])
 
         self.assertEqual(result.exit_code, 2)
         self.assertIsInstance(result.exception, exceptions.ArgumentError)
@@ -86,6 +101,15 @@ def test_add_origin_storage_with_file_extensions(self):
 
         self.assert_no_fail(result)
 
+    def test_add_origin_storage_with_file_extensions_dynamic(self):
+        result = self.run_command(
+            ['cdn', 'origin-add', '-t', 'storage', '-b=test-bucket', '-e', 'jpg', '-H=test.example.com', '-s', 81,
+             '-P', 'HTTPS', '-o', 'dynamic', '-d', 'abc.html', '-g', True, '-i', True,
+             '-c=include-all', '1234', '10.10.10.1', '/example/videos2',
+             ])
+
+        self.assert_no_fail(result)
+
     def test_remove_origin(self):
         result = self.run_command(['cdn', 'origin-remove', '1234',
                                    '/example1'])
diff --git a/tests/managers/cdn_tests.py b/tests/managers/cdn_tests.py
@@ -58,42 +58,54 @@ def test_get_origins(self):
                                 'listOriginPath')
 
     def test_add_origin(self):
-        self.cdn_client.add_origin("12345", "10.10.10.1", "/example/videos", origin_type="server",
-                                   header="test.example.com", port=80, protocol='http', optimize_for="web",
-                                   cache_query="include all")
+        self.cdn_client.add_origin("12345", "10.10.10.1", "/example/videos", dynamic_path="abc.html",
+                                   origin_type="server", header="test.example.com", https_port=81,
+                                   protocol='https', optimize_for="dynamic", compression=True,
+                                   prefetching=True, cache_query="include all")
 
         args = ({
             'uniqueId': "12345",
             'origin': '10.10.10.1',
             'path': '/example/videos',
-                    'originType': 'HOST_SERVER',
-                    'header': 'test.example.com',
-                    'httpPort': 80,
-                    'protocol': 'HTTP',
-                    'performanceConfiguration': 'General web delivery',
-                    'cacheKeyQueryRule': "include all"
+            'originType': 'HOST_SERVER',
+            'header': 'test.example.com',
+            'httpPort': 80,
+            'httpsPort': 81,
+            'protocol': 'HTTPS',
+            'performanceConfiguration': 'Dynamic content acceleration',
+            'cacheKeyQueryRule': "include all",
+            'dynamicContentAcceleration': {
+                'detectionPath': "/abc.html",
+                'prefetchEnabled': True,
+                'mobileImageCompressionEnabled': True
+            }
         },)
         self.assert_called_with('SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path',
                                 'createOriginPath',
                                 args=args)
 
     def test_add_origin_with_bucket_and_file_extension(self):
-        self.cdn_client.add_origin("12345", "10.10.10.1", "/example/videos", origin_type="storage",
-                                   bucket_name="test-bucket", file_extensions="jpg", header="test.example.com", port=80,
-                                   protocol='http', optimize_for="web", cache_query="include all")
+        self.cdn_client.add_origin("12345", "10.10.10.1", "/example/videos", dynamic_path="abc.html",
+                                   origin_type="server", header="test.example.com", https_port=81,
+                                   protocol='https', optimize_for="dynamic", compression=True,
+                                   prefetching=True, cache_query="include all")
 
         args = ({
             'uniqueId': "12345",
             'origin': '10.10.10.1',
             'path': '/example/videos',
-                    'originType': 'OBJECT_STORAGE',
-                    'header': 'test.example.com',
-                    'httpPort': 80,
-                    'protocol': 'HTTP',
-                    'bucketName': 'test-bucket',
-                    'fileExtension': 'jpg',
-                    'performanceConfiguration': 'General web delivery',
-                    'cacheKeyQueryRule': "include all"
+            'originType': 'HOST_SERVER',
+            'header': 'test.example.com',
+            'httpPort': 80,
+            'httpsPort': 81,
+            'protocol': 'HTTPS',
+            'performanceConfiguration': 'Dynamic content acceleration',
+            'cacheKeyQueryRule': "include all",
+            'dynamicContentAcceleration': {
+                'detectionPath': "/abc.html",
+                'prefetchEnabled': True,
+                'mobileImageCompressionEnabled': True
+            }
         },)
         self.assert_called_with('SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path',
                                 'createOriginPath',
