merged in master

Author: allmightyspiff

.github/workflows/tests.yml

@@ -15,7 +15,7 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
@@ -29,7 +29,7 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: 3.12
     - name: Install dependencies
@@ -43,7 +43,7 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: 3.12
     - name: Install dependencies
@@ -52,3 +52,19 @@ jobs:
         pip install -r tools/test-requirements.txt
     - name: Tox Analysis
       run: tox -e analysis
+  detectsecrets:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python/@v5
+      with:
+        python-version: 3.11
+    - name: Install Detect Secrets
+      run: |
+        python -m pip install --upgrade pip
+        pip install --upgrade "git+https://github.com/ibm/detect-secrets.git@master#egg=detect-secrets"
+    - name: Detect Secrets
+      run: |
+        detect-secrets scan --update .secrets.baseline
+        detect-secrets audit .secrets.baseline --report --fail-on-unaudited --omit-instructions

.pre-commit-config.yaml

@@ -10,7 +10,7 @@ repos:
     # You are encouraged to use static refs such as tags, instead of branch name
     #
     # Running "pre-commit autoupdate" automatically updates rev to latest tag
-    rev: 0.13.1+ibm.61.dss
+    rev: 0.13.1+ibm.62.dss
     hooks:
       - id: detect-secrets # pragma: whitelist secret
         # Add options for detect-secrets-hook binary. You can run `detect-secrets-hook --help` to list out all possible options.

.secrets.baseline

@@ -3,7 +3,7 @@
     "files": "^.secrets.baseline$",
     "lines": null
   },
-  "generated_at": "2023-10-13T20:28:05Z",
+  "generated_at": "2024-04-18T01:09:09Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"
@@ -532,6 +532,7 @@
     "tests/CLI/modules/hardware/hardware_basic_tests.py": [
       {
         "hashed_secret": "6367c48dd193d56ea7b0baad25b19455e529f5ee",
+        "is_secret": false,
         "is_verified": false,
         "line_number": 57,
         "type": "Secret Keyword",
@@ -573,7 +574,7 @@
         "hashed_secret": "a4c805a62a0387010cd172cfed6f6772eb92a5d6",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 33,
+        "line_number": 32,
         "type": "Secret Keyword",
         "verified_result": null
       }
@@ -761,7 +762,7 @@
       }
     ]
   },
-  "version": "0.13.1+ibm.61.dss",
+  "version": "0.13.1+ibm.62.dss",
   "word_list": {
     "file": null,
     "hash": null

README.rst

@@ -2,19 +2,12 @@ SoftLayer API Python Client
 ===========================
 .. image:: https://github.com/softlayer/softlayer-python/workflows/Tests/badge.svg
     :target: https://github.com/softlayer/softlayer-python/actions?query=workflow%3ATests
-
 .. image:: https://github.com/softlayer/softlayer-python/workflows/documentation/badge.svg
     :target: https://github.com/softlayer/softlayer-python/actions?query=workflow%3Adocumentation
-
-.. image:: https://landscape.io/github/softlayer/softlayer-python/master/landscape.svg
-    :target: https://landscape.io/github/softlayer/softlayer-python/master
-
 .. image:: https://badge.fury.io/py/SoftLayer.svg
     :target: http://badge.fury.io/py/SoftLayer
-
 .. image:: https://coveralls.io/repos/github/softlayer/softlayer-python/badge.svg?branch=master
     :target: https://coveralls.io/github/softlayer/softlayer-python?branch=master
-
 .. image:: https://snapcraft.io//slcli/badge.svg
     :target: https://snapcraft.io/slcli
 

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()

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.
 

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$_+!`(),.?/;:&=%#~]*)"
         r"(?P<args_keyword>^[A-Z]+$)",
     ]
 
@@ -91,7 +93,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."""
@@ -191,9 +193,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."""

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/FileStorage/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:

SoftLayer/CLI/formatting.py

@@ -259,8 +259,7 @@ def no_going_back(confirmation):
     if not confirmation:
         confirmation = 'yes'
 
-    prompt = ('This action cannot be undone! Type "%s" or press Enter '
-              'to abort' % confirmation)
+    prompt = f"This action cannot be undone! Type '{confirmation}' or press Enter to abort"
 
     ans = click.prompt(prompt, default='', show_default=False)
     if ans.lower() == str(confirmation):

SoftLayer/CLI/hardware/update_firmware.py

@@ -12,15 +12,23 @@
 
 @click.command(cls=SoftLayer.CLI.command.SLCommand, )
 @click.argument('identifier')
+@click.option('-i', '--ipmi', is_flag=True, help="Update IPMI firmware")
+@click.option('-r', '--raid', is_flag=True, help="Update RAID firmware")
+@click.option('-b', '--bios', is_flag=True, help="Update BIOS firmware")
+@click.option('-d', '--harddrive', is_flag=True, help="Update Hard Drives firmware")
+@click.option('-n', '--network', is_flag=True, help="Update Network Card firmware")
 @environment.pass_env
-def cli(env, identifier):
-    """Update server firmware."""
+def cli(env, identifier, ipmi, raid, bios, harddrive, network):
+    """Update server firmware. By default will update all available server components."""
 
     mgr = SoftLayer.HardwareManager(env.client)
     hw_id = helpers.resolve_id(mgr.resolve_ids, identifier, 'hardware')
-    if not (env.skip_confirmations or
-            formatting.confirm('This will power off the server with id %s and '
-                               'update device firmware. Continue?' % hw_id)):
+    confirm_message = f"This will power off the server with id {hw_id} and update device firmware. Continue?"
+    if not (env.skip_confirmations or formatting.confirm(confirm_message)):
         raise exceptions.CLIAbort('Aborted.')
 
-    mgr.update_firmware(hw_id)
+    # If no options were specified, set them all to enabled.
+    if not any([ipmi, raid, bios, harddrive, network]):
+        ipmi = raid = bios = harddrive = network = 1
+    mgr.update_firmware(hw_id, ipmi, raid, bios, harddrive, network)
+    env.fout(f"[green]Firmware update for {identifier} started")

SoftLayer/CLI/security/cert_add.py

@@ -8,16 +8,10 @@
 
 
 @click.command(cls=SoftLayer.CLI.command.SLCommand, )
-@click.option('--crt',
-              type=click.Path(exists=True),
-              help="Certificate file")
-@click.option('--csr',
-              type=click.Path(exists=True),
-              help="Certificate Signing Request file")
-@click.option('--icc',
-              type=click.Path(exists=True),
-              help="Intermediate Certificate file")
-@click.option('--key', type=click.Path(exists=True), help="Private Key file")
+@click.option('--crt', required=True, type=click.Path(exists=True), help="Certificate file")
+@click.option('--key', type=click.Path(exists=True), required=True, help="Private Key file")
+@click.option('--csr', type=click.Path(exists=True), help="Certificate Signing Request file")
+@click.option('--icc', type=click.Path(exists=True), help="Intermediate Certificate file")
 @click.option('--notes', help="Additional notes")
 @environment.pass_env
 def cli(env, crt, csr, icc, key, notes):
@@ -32,13 +26,13 @@ def cli(env, crt, csr, icc, key, notes):
         template['certificate'] = file_crt.read()
     with open(key, encoding="utf-8") as file_key:
         template['privateKey'] = file_key.read()
-    with open(csr, encoding="utf-8") as file_csr:
-        if csr:
+    if csr:
+        with open(csr, encoding="utf-8") as file_csr:
             body = file_csr.read()
             template['certificateSigningRequest'] = body
 
-    with open(icc, encoding="utf-8") as file_icc:
-        if icc:
+    if icc:
+        with open(icc, encoding="utf-8") as file_icc:
             body = file_icc.read()
             template['intermediateCertificate'] = body
 

SoftLayer/managers/hardware.py

@@ -723,44 +723,46 @@ def edit(self, hardware_id, userdata=None, hostname=None, domain=None,
 
         return self.hardware.editObject(obj, id=hardware_id)
 
-    def update_firmware(self,
-                        hardware_id,
-                        ipmi=True,
-                        raid_controller=True,
-                        bios=True,
-                        hard_drive=True):
+    def update_firmware(self, hardware_id: int,
+                        ipmi: bool = True,
+                        raid_controller: bool = True,
+                        bios: bool = True,
+                        hard_drive: bool = True,
+                        network: bool = True):
         """Update hardware firmware.
 
         This will cause the server to be unavailable for ~20 minutes.
+        https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/createFirmwareUpdateTransaction/
 
-        :param int hardware_id: The ID of the hardware to have its firmware
-                                updated.
+        :param int hardware_id: The ID of the hardware to have its firmware updated.
         :param bool ipmi: Update the ipmi firmware.
         :param bool raid_controller: Update the raid controller firmware.
         :param bool bios: Update the bios firmware.
         :param bool hard_drive: Update the hard drive firmware.
+        :param bool network: Update the network card firmware
 
         Example::
 
             # Check the servers active transactions to see progress
             result = mgr.update_firmware(hardware_id=1234)
         """
 
-        return self.hardware.createFirmwareUpdateTransaction(
-            bool(ipmi), bool(raid_controller), bool(bios), bool(hard_drive), id=hardware_id)
+        return self.client.call(
+            'SoftLayer_Hardware_Server', 'createFirmwareUpdateTransaction',
+            bool(ipmi), bool(raid_controller), bool(bios), bool(hard_drive), bool(network), id=hardware_id
+        )
 
-    def reflash_firmware(self,
-                         hardware_id,
-                         ipmi=True,
-                         raid_controller=True,
-                         bios=True):
+    def reflash_firmware(self, hardware_id: int,
+                         ipmi: bool = True,
+                         raid_controller: bool = True,
+                         bios: bool = True,):
         """Reflash hardware firmware.
 
         This will cause the server to be unavailable for ~60 minutes.
         The firmware will not be upgraded but rather reflashed to the version installed.
+        https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/createFirmwareReflashTransaction/
 
-        :param int hardware_id: The ID of the hardware to have its firmware
-                                reflashed.
+        :param int hardware_id: The ID of the hardware to have its firmware reflashed.
         :param bool ipmi: Reflash the ipmi firmware.
         :param bool raid_controller: Reflash the raid controller firmware.
         :param bool bios: Reflash the bios firmware.

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

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']