From 70e7dde8b7dbbcdf3e283c98ffd1c13e5d5650c6 Mon Sep 17 00:00:00 2001
From: Christopher Gallo <chrisagallo@gmail.com>
Date: Tue, 10 Oct 2023 15:48:14 -0500
Subject: [PATCH 1/2] #2107 updating block|file volume-modify help messages

---
 SoftLayer/CLI/block/limit.py        |  2 +-
 SoftLayer/CLI/block/modify.py       | 19 +++++++++----------
 SoftLayer/CLI/command.py            |  9 ++++++---
 SoftLayer/CLI/file/modify.py        | 15 +++++++--------
 SoftLayer/managers/storage.py       |  6 +-----
 SoftLayer/managers/storage_utils.py |  6 ++----
 SoftLayer/utils.py                  |  4 ++++
 7 files changed, 30 insertions(+), 31 deletions(-)

diff --git a/SoftLayer/CLI/block/limit.py b/SoftLayer/CLI/block/limit.py
index 7b64b0b98..6af71c9e3 100644
--- a/SoftLayer/CLI/block/limit.py
+++ b/SoftLayer/CLI/block/limit.py
@@ -23,7 +23,7 @@ def cli(env, sortby, datacenter):
     Example::
         slcli block volume-limits
         This command lists the storage limits per datacenter for this account.
-"""
+    """
 
     block_manager = SoftLayer.BlockStorageManager(env.client)
     block_volumes = block_manager.list_block_volume_limit()
diff --git a/SoftLayer/CLI/block/modify.py b/SoftLayer/CLI/block/modify.py
index fac2af594..187ff8d7e 100644
--- a/SoftLayer/CLI/block/modify.py
+++ b/SoftLayer/CLI/block/modify.py
@@ -20,22 +20,21 @@
 @click.option('--new-iops', '-i',
               type=int,
               help='Performance Storage IOPS, between 100 and 6000 in multiples of 100 [only for performance volumes] '
-                   '***If no IOPS value is specified, the original IOPS value of the volume will be used.***\n'
-                   'Requirements: [If original IOPS/GB for the volume is less than 0.3, new IOPS/GB must also be '
-                   'less than 0.3. If original IOPS/GB for the volume is greater than or equal to 0.3, new IOPS/GB '
-                   'for the volume must also be greater than or equal to 0.3.]')
+                   '***If no IOPS value is specified, the original IOPS value of the volume will be used.***')
 @click.option('--new-tier', '-t',
-              help='Endurance Storage Tier (IOPS per GB) [only for endurance volumes] '
-                   '***If no tier is specified, the original tier of the volume will be used.***\n'
-                   'Requirements: [If original IOPS/GB for the volume is 0.25, new IOPS/GB for the volume must also '
-                   'be 0.25. If original IOPS/GB for the volume is greater than 0.25, new IOPS/GB for the volume '
-                   'must also be greater than 0.25.]',
+              help='Endurance Storage Tier (IOPS per GB) [only for endurance volumes] Classic Choices: '
+                   '***If no tier is specified, the original tier of the volume will be used.***',
               type=click.Choice(['0.25', '2', '4', '10']))
 @environment.pass_env
 def cli(env, volume_id, new_size, new_iops, new_tier):
-    """Modify an existing block storage volume.
+    """Modify an existing block storage volume. Choices.
+
+    Valid size and iops options can be found here:
+        https://cloud.ibm.com/docs/BlockStorage/index.html#provisioning-considerations
+        https://cloud.ibm.com/docs/BlockStorage?topic=BlockStorage-orderingBlockStorage&interface=cli
 
     Example::
+
         slcli block volume-modify 12345678 --new-size 1000 --new-iops 4000
         This command modify a volume 12345678 with size is 1000GB, IOPS is 4000.
 
diff --git a/SoftLayer/CLI/command.py b/SoftLayer/CLI/command.py
index b38f89d7c..b64232014 100644
--- a/SoftLayer/CLI/command.py
+++ b/SoftLayer/CLI/command.py
@@ -28,6 +28,8 @@ class OptionHighlighter(RegexHighlighter):
         r"(?P<option>\-\-[\w\-]+)",  # long options like --verbose
         r"(?P<default_option>\[[^\]]+\])",  # anything between [], usually default options
         r"(?P<option_choices>Choices: )",
+        r"(?P<example_block>Example::)",
+        r"(?P<url>(file|https|http|ws|wss)://[-0-9a-zA-Z$_+!`(),.?/;:&=%#~]*)"
     ]
 
 
@@ -90,7 +92,7 @@ def format_help_text(self, ctx: click.Context, formatter: click.formatting.HelpF
 
         if text:
             text = inspect.cleandoc(text).partition("\f")[0]
-        self.console.print(f"\n\t{text}\n")
+        self.console.print(f"\n\t{text}\n", highlight=True)
 
     def format_epilog(self, ctx: click.Context, formatter: click.formatting.HelpFormatter) -> None:
         """Writes the epilog if it exists, then prints out any sub-commands if they exist."""
@@ -188,9 +190,10 @@ def format_help_text(self, ctx: click.Context, formatter: click.formatting.HelpF
             text = f"(Deprecated) {text}"
 
         if text:
-            text = inspect.cleandoc(text)
+            text = f"\n\t{inspect.cleandoc(text)}\n"
 
-        self.console.print(f"\n\t{text}\n", highlight=False)
+        # Can't use F-string here because it messes with highlights
+        self.console.print(self.highlighter(text))
 
     def format_epilog(self, ctx: click.Context, formatter: click.formatting.HelpFormatter) -> None:
         """Writes the epilog if it exists, then prints out any sub-commands if they exist."""
diff --git a/SoftLayer/CLI/file/modify.py b/SoftLayer/CLI/file/modify.py
index 27bb3f69f..4c905b8bf 100644
--- a/SoftLayer/CLI/file/modify.py
+++ b/SoftLayer/CLI/file/modify.py
@@ -21,23 +21,22 @@
 @click.option('--new-iops', '-i',
               type=int,
               help='Performance Storage IOPS, between 100 and 6000 in multiples of 100 [only for performance volumes] '
-                   '***If no IOPS value is specified, the original IOPS value of the volume will be used.***\n'
-                   'Requirements: [If original IOPS/GB for the volume is less than 0.3, new IOPS/GB must also be '
-                   'less than 0.3. If original IOPS/GB for the volume is greater than or equal to 0.3, new IOPS/GB '
-                   'for the volume must also be greater than or equal to 0.3.]')
+                   '***If no IOPS value is specified, the original IOPS value of the volume will be used.***')
 @click.option('--new-tier', '-t',
               help='Endurance Storage Tier (IOPS per GB) [only for endurance volumes] '
-                   '***If no tier is specified, the original tier of the volume will be used.***\n'
-                   'Requirements: [If original IOPS/GB for the volume is 0.25, new IOPS/GB for the volume must also '
-                   'be 0.25. If original IOPS/GB for the volume is greater than 0.25, new IOPS/GB for the volume '
-                   'must also be greater than 0.25.]',
+                   '***If no tier is specified, the original tier of the volume will be used.***',
               type=click.Choice(['0.25', '2', '4', '10']))
 @click.option('--force',  default=False, is_flag=True, help="Force modify")
 @environment.pass_env
 def cli(env, volume_id, new_size, new_iops, new_tier, force):
     """Modify an existing file storage volume.
 
+    Valid size and iops options can be found here:
+        https://cloud.ibm.com/docs/BlockStorage/index.html#provisioning-considerations
+        https://cloud.ibm.com/docs/FileStorage?topic=FileStorage-orderingFileStorage&interface=cli
+
     Example::
+
             slcli file volume-modify 12345678 --new-size 1000 --new-iops 400
     """
     if not force:
diff --git a/SoftLayer/managers/storage.py b/SoftLayer/managers/storage.py
index 48cda5a88..467f03127 100644
--- a/SoftLayer/managers/storage.py
+++ b/SoftLayer/managers/storage.py
@@ -313,11 +313,7 @@ def order_duplicate_volume(self,
 
         return self.client.call('Product_Order', 'placeOrder', order)
 
-    def order_modified_volume(self,
-                              volume_id,
-                              new_size=None,
-                              new_iops=None,
-                              new_tier_level=None):
+    def order_modified_volume(self, volume_id, new_size=None, new_iops=None, new_tier_level=None):
         """Places an order for modifying an existing block volume.
 
         :param volume_id: The ID of the volume to be modified
diff --git a/SoftLayer/managers/storage_utils.py b/SoftLayer/managers/storage_utils.py
index 6c3e8343e..97e3638a3 100644
--- a/SoftLayer/managers/storage_utils.py
+++ b/SoftLayer/managers/storage_utils.py
@@ -419,8 +419,7 @@ def find_snapshot_schedule_id(volume, snapshot_schedule_keyname):
             if schedule['type']['keyname'] == snapshot_schedule_keyname:
                 return schedule['id']
 
-    raise ValueError("The given snapshot schedule ID was not found for "
-                     "the given storage volume")
+    raise ValueError("The given snapshot schedule ID was not found for the given storage volume")
 
 
 def prepare_snapshot_order_object(manager, volume, capacity, tier, upgrade, iops):
@@ -436,8 +435,7 @@ def prepare_snapshot_order_object(manager, volume, capacity, tier, upgrade, iops
     """
     # Ensure the storage volume has not been cancelled
     if 'billingItem' not in volume:
-        raise exceptions.SoftLayerError(
-            'This volume has been cancelled; unable to order snapshot space')
+        raise exceptions.SoftLayerError('This volume has been cancelled; unable to order snapshot space')
 
     # Determine and validate the storage volume's billing item category
     billing_item_category_code = volume['billingItem']['categoryCode']
diff --git a/SoftLayer/utils.py b/SoftLayer/utils.py
index 136decced..5cdabadb7 100644
--- a/SoftLayer/utils.py
+++ b/SoftLayer/utils.py
@@ -492,6 +492,8 @@ def console_color_themes(theme):
                 "option_keyword": "bold dark_cyan",
                 "args_keyword": "bold green4",
                 "option_choices": "gold3",
+                "example_block": "underline deep_pink3",
+                "url": "underline blue",
             })
         )
     return Console(theme=Theme(
@@ -509,6 +511,8 @@ def console_color_themes(theme):
             "option_keyword": "bold cyan",
             "args_keyword": "bold green",
             "option_choices": "gold3",
+            "example_block": "underline light_coral",
+            "url": "underline blue",
         })
     )
 

From 4aec4fc0deec5ef10d691affbc99424159d12f21 Mon Sep 17 00:00:00 2001
From: Christopher Gallo <chrisagallo@gmail.com>
Date: Tue, 10 Oct 2023 15:50:05 -0500
Subject: [PATCH 2/2] #2107 fixed a typo

---
 SoftLayer/CLI/file/modify.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/SoftLayer/CLI/file/modify.py b/SoftLayer/CLI/file/modify.py
index 4c905b8bf..5b71331b9 100644
--- a/SoftLayer/CLI/file/modify.py
+++ b/SoftLayer/CLI/file/modify.py
@@ -32,7 +32,7 @@ def cli(env, volume_id, new_size, new_iops, new_tier, force):
     """Modify an existing file storage volume.
 
     Valid size and iops options can be found here:
-        https://cloud.ibm.com/docs/BlockStorage/index.html#provisioning-considerations
+        https://cloud.ibm.com/docs/FileStorage/index.html#provisioning-considerations
         https://cloud.ibm.com/docs/FileStorage?topic=FileStorage-orderingFileStorage&interface=cli
 
     Example::