Merge branch 'master' of https://github.com/BrianSantivanez/softlayer-python into issue1829

Brian Flores · Brian Flores · commit d376545e0666 · 2023-02-01T14:35:02.000-04:00
diff --git a/SoftLayer/CLI/account/events.py b/SoftLayer/CLI/account/events.py
@@ -10,22 +10,26 @@
 
 
 @click.command(cls=SLCommand)
+@click.option('--announcement', is_flag=True, default=False,
+              help="Show only announcement events.")
 @click.option('--ack-all', is_flag=True, default=False,
-              help="Acknowledge every upcoming event. Doing so will turn off the popup in the control portal")
+              help="Acknowledge every upcoming event. Doing so will turn off the popup in the control portal.")
+@click.option('--date-min', help="Earliest date to retrieve events for [MM/DD/YYYY]. Default: 2 days ago.")
 @click.option('--planned', is_flag=True, default=False,
-              help="Show only planned events")
+              help="Show only planned events.")
 @click.option('--unplanned', is_flag=True, default=False,
-              help="Show only unplanned events")
-@click.option('--announcement', is_flag=True, default=False,
-              help="Show only announcement events")
+              help="Show only unplanned events.")
 @environment.pass_env
-def cli(env, ack_all, planned, unplanned, announcement):
+def cli(env, ack_all, planned, unplanned, announcement, date_min):
     """Summary and acknowledgement of upcoming and ongoing maintenance events"""
 
+    if date_min:
+        utils.verify_date(date_min)
+
     manager = AccountManager(env.client)
-    planned_events = manager.get_upcoming_events("PLANNED")
-    unplanned_events = manager.get_upcoming_events("UNPLANNED_INCIDENT")
-    announcement_events = manager.get_upcoming_events("ANNOUNCEMENT")
+    planned_events = manager.get_upcoming_events("PLANNED", date_min)
+    unplanned_events = manager.get_upcoming_events("UNPLANNED_INCIDENT", date_min)
+    announcement_events = manager.get_upcoming_events("ANNOUNCEMENT", date_min)
 
     add_ack_flag(planned_events, manager, ack_all)
     add_ack_flag(unplanned_events, manager, ack_all)
diff --git a/SoftLayer/CLI/account/invoices.py b/SoftLayer/CLI/account/invoices.py
@@ -11,12 +11,12 @@
 
 
 @click.command(cls=SLCommand)
-@click.option('--limit', default=50, show_default=True,
-              help="How many invoices to get back.")
-@click.option('--closed', is_flag=True, default=False, show_default=True,
-              help="Include invoices with a CLOSED status.")
 @click.option('--all', 'get_all', is_flag=True, default=False, show_default=True,
               help="Return ALL invoices. There may be a lot of these.")
+@click.option('--closed', is_flag=True, default=False, show_default=True,
+              help="Include invoices with a CLOSED status.")
+@click.option('--limit', default=50, show_default=True,
+              help="How many invoices to get back.")
 @environment.pass_env
 def cli(env, limit, closed=False, get_all=False):
     """List invoices"""
diff --git a/SoftLayer/CLI/account/orders.py b/SoftLayer/CLI/account/orders.py
@@ -13,7 +13,7 @@
 @click.command(cls=SLCommand)
 @click.option('--limit', '-l',
               help='How many results to get in one api call',
-              default=100,
+              default=50,
               show_default=True)
 @environment.pass_env
 def cli(env, limit):
diff --git a/SoftLayer/CLI/block/replication/disaster_recovery_failover.py b/SoftLayer/CLI/block/replication/disaster_recovery_failover.py
@@ -15,7 +15,7 @@
 After using this method, to failback to the original volume, please open a support ticket.
 If you wish to test failover, please use replica-failover.""")
 @click.argument('volume-id')
-@click.option('--replicant-id', help="ID of the replicant volume")
+@click.option('--replicant-id', help="ID of the replicant volume.")
 @environment.pass_env
 def cli(env, volume_id, replicant_id):
     """Failover an inaccessible block volume to its available replicant volume."""
diff --git a/SoftLayer/CLI/block/replication/failback.py b/SoftLayer/CLI/block/replication/failback.py
@@ -10,7 +10,7 @@
 @click.argument('volume-id')
 @environment.pass_env
 def cli(env, volume_id):
-    """Failback a block volume from the given replicant volume."""
+    """Failback a block volume from the given replica volume."""
     block_storage_manager = SoftLayer.BlockStorageManager(env.client)
 
     success = block_storage_manager.failback_from_replicant(volume_id)
diff --git a/SoftLayer/CLI/block/replication/failover.py b/SoftLayer/CLI/block/replication/failover.py
@@ -8,10 +8,10 @@
 
 @click.command(cls=SoftLayer.CLI.command.SLCommand, )
 @click.argument('volume-id')
-@click.option('--replicant-id', help="ID of the replicant volume")
+@click.option('--replicant-id', help="ID of the replicant volume.")
 @environment.pass_env
 def cli(env, volume_id, replicant_id):
-    """Failover a block volume to the given replicant volume."""
+    """Failover a block volume to the given replica volume."""
     block_storage_manager = SoftLayer.BlockStorageManager(env.client)
 
     success = block_storage_manager.failover_to_replicant(
diff --git a/SoftLayer/CLI/block/replication/locations.py b/SoftLayer/CLI/block/replication/locations.py
@@ -22,12 +22,12 @@
 
 @click.command(cls=SoftLayer.CLI.command.SLCommand, )
 @click.argument('volume-id')
-@click.option('--sortby', help='Column to sort by', default='Long Name')
 @click.option('--columns',
               callback=column_helper.get_formatter(COLUMNS),
               help='Columns to display. Options: {0}'.format(
                   ', '.join(column.name for column in COLUMNS)),
               default=','.join(DEFAULT_COLUMNS))
+@click.option('--sortby', help='Column to sort by', default='Long Name')
 @environment.pass_env
 def cli(env, columns, sortby, volume_id):
     """List suitable replication datacenters for the given volume."""
diff --git a/SoftLayer/CLI/block/replication/order.py b/SoftLayer/CLI/block/replication/order.py
@@ -14,22 +14,16 @@
 
 @click.command(cls=SoftLayer.CLI.command.SLCommand, context_settings=CONTEXT_SETTINGS)
 @click.argument('volume_id')
-@click.option('--snapshot-schedule', '-s',
-              help='Snapshot schedule to use for replication, '
-              '(HOURLY | DAILY | WEEKLY)',
-              required=True,
-              type=click.Choice(['HOURLY', 'DAILY', 'WEEKLY']))
-@click.option('--location', '-l',
-              help='Short name of the data center for the replicant '
-              '(e.g.: dal09)',
+@click.option('--datacenter', '-d',
+              help='Short name of the datacenter for the replica (e.g.: dal09)',
               required=True)
-@click.option('--tier',
-              help='Endurance Storage Tier (IOPS per GB) of the primary'
-              ' volume for which a replicant is ordered [optional]',
-              type=click.Choice(['0.25', '2', '4', '10']))
-@click.option('--os-type',
-              help='Operating System Type (e.g.: LINUX) of the primary'
-              ' volume for which a replica is ordered [optional]',
+@click.option('--iops', '-i',
+              help='Performance Storage IOPs, between 100 and 6000 in multiples of 100. If no IOPS value is specified,'
+              ' the IOPS value of the original volume will be used.',
+              type=int)
+@click.option('--os-type', '-o',
+              help='Operating System Type (eg. LINUX) of the primary volume for '
+              'which a replica is ordered [optional].',
               type=click.Choice([
                   'HYPER_V',
                   'LINUX',
@@ -38,22 +32,39 @@
                   'WINDOWS_GPT',
                   'WINDOWS',
                   'XEN']))
+@click.option('--snapshot-schedule', '-s',
+              help='Snapshot schedule to use for replication. Options are: '
+              'HOURLY, DAILY, WEEKLY',
+              required=True,
+              type=click.Choice(['HOURLY', 'DAILY', 'WEEKLY']))
+@click.option('--tier', '-t',
+              help='Endurance Storage Tier (IOPS per GB) of the primary volume for which a replica is ordered '
+              '[optional]. If no tier is specified, the tier of the original volume will be used',
+              type=click.Choice(['0.25', '2', '4', '10']))
 @environment.pass_env
-def cli(env, volume_id, snapshot_schedule, location, tier, os_type):
+def cli(env, volume_id, snapshot_schedule, datacenter, tier, os_type, iops):
     """Order a block storage replica volume."""
     block_manager = SoftLayer.BlockStorageManager(env.client)
     block_volume_id = helpers.resolve_id(block_manager.resolve_ids, volume_id, 'Block Volume')
 
     if tier is not None:
         tier = float(tier)
 
+    if iops is not None:
+        if iops < 100 or iops > 6000:
+            raise exceptions.ArgumentError(f"Invalid value for '--iops' / '-i': '{iops}' is not one "
+                                           "of between 100 and 6000.")
+        if iops % 100 != 0:
+            raise exceptions.ArgumentError(f"Invalid value for '--iops' / '-i': '{iops}' is not a multiple of 100.")
+
     try:
         order = block_manager.order_replicant_volume(
             block_volume_id,
             snapshot_schedule=snapshot_schedule,
-            location=location,
+            location=datacenter,
             tier=tier,
             os_type=os_type,
+            iops=iops
         )
     except ValueError as ex:
         raise exceptions.ArgumentError(str(ex))
diff --git a/SoftLayer/CLI/block/replication/partners.py b/SoftLayer/CLI/block/replication/partners.py
@@ -14,15 +14,15 @@
 
 @click.command(cls=SoftLayer.CLI.command.SLCommand, )
 @click.argument('volume-id')
-@click.option('--sortby', help='Column to sort by', default='Username')
 @click.option('--columns',
               callback=column_helper.get_formatter(COLUMNS),
               help='Columns to display. Options: {0}'.format(
                   ', '.join(column.name for column in COLUMNS)),
               default=','.join(DEFAULT_COLUMNS))
+@click.option('--sortby', help='Column to sort by', default='Username')
 @environment.pass_env
 def cli(env, columns, sortby, volume_id):
-    """List existing replicant volumes for a block volume."""
+    """List existing replica volumes for a block volume."""
     block_storage_manager = SoftLayer.BlockStorageManager(env.client)
 
     legal_volumes = block_storage_manager.get_replication_partners(
diff --git a/SoftLayer/CLI/virt/capture.py b/SoftLayer/CLI/virt/capture.py
@@ -29,7 +29,7 @@ def cli(env, identifier, name, all, note):
     table.align['name'] = 'r'
     table.align['value'] = 'l'
 
-    table.add_row(['vs_id', capture['guestId']])
+    table.add_row(['globalIdentifier', capture['globalIdentifier']])
     table.add_row(['date', capture['createDate'][:10]])
     table.add_row(['time', capture['createDate'][11:19]])
     table.add_row(['transaction', formatting.transaction_status(capture)])
diff --git a/SoftLayer/CLI/vlan/list.py b/SoftLayer/CLI/vlan/list.py
@@ -65,7 +65,7 @@ def cli(env, sortby, datacenter, number, name, limit):
             vlan.get('vlanNumber'),
             vlan.get('fullyQualifiedName'),
             vlan.get('name') or formatting.blank(),
-            vlan.get('networkSpace').capitalize(),
+            vlan.get('networkSpace', 'Direct Link').capitalize(),
             utils.lookup(vlan, 'primaryRouter', 'datacenter', 'name'),
             get_pod_with_closed_announcement(vlan, pods),
             get_gateway_firewall(vlan),
diff --git a/SoftLayer/fixtures/SoftLayer_Account.py b/SoftLayer/fixtures/SoftLayer_Account.py
@@ -485,7 +485,7 @@
 
 getNetworkVlans = [{
     'id': 1,
-    'networkSpace': 'PRIVATE',
+    'networkSpace': '',
     'hardwareCount': 0,
     'hardware': [],
     'vlanNumber': 12,
diff --git a/SoftLayer/fixtures/SoftLayer_Virtual_Guest.py b/SoftLayer/fixtures/SoftLayer_Virtual_Guest.py
@@ -716,14 +716,15 @@
 setUserMetadata = ['meta']
 reloadOperatingSystem = 'OK'
 setTags = True
-createArchiveTransaction = {
+createArchiveTemplate = {
     'createDate': '2018-12-10T17:29:18-06:00',
     'elapsedSeconds': 0,
     'guestId': 12345678,
     'hardwareId': None,
     'id': 12345,
     'modifyDate': '2018-12-10T17:29:18-06:00',
-    'statusChangeDate': '2018-12-10T17:29:18-06:00'
+    'statusChangeDate': '2018-12-10T17:29:18-06:00',
+    'globalIdentifier': '495c47c2-80af-4fef-87a9-97faf132345678'
 }
 
 executeRescueLayer = True
diff --git a/SoftLayer/managers/account.py b/SoftLayer/managers/account.py
@@ -53,10 +53,11 @@ def get_summary(self):
         """
         return self.client.call('Account', 'getObject', mask=mask)
 
-    def get_upcoming_events(self, event_type):
+    def get_upcoming_events(self, event_type, date_min=None):
         """Retrieves a list of Notification_Occurrence_Events that have not ended yet
 
         :param: String event_type: notification event type.
+        :param: String date_min: greater Than Date to data recovery, default is 2 days ago.
         :return: SoftLayer_Notification_Occurrence_Event
         """
         mask = "mask[id, subject, startDate, endDate, modifyDate, statusCode, acknowledgedFlag, " \
@@ -70,21 +71,32 @@ def get_upcoming_events(self, event_type):
             }
         }
 
-        self.add_event_filter(_filter, event_type)
+        self.add_event_filter(_filter, event_type, date_min)
 
         return self.client.call('Notification_Occurrence_Event', 'getAllObjects', filter=_filter, mask=mask, iter=True)
 
     @staticmethod
-    def add_event_filter(_filter, event_type):
+    def add_event_filter(_filter, event_type, date_min=None):
         """Add data to the object filter.
 
         :param: _filter: event filter.
         :param: string event_type: event type.
+        :param: string date_min: greater Than Date to data recovery, default is 2 days ago.
         """
+
         if event_type == 'PLANNED':
-            _filter['endDate'] = {
-                'operation': '> sysdate - 2'
-            }
+            if date_min:
+                _filter['endDate'] = {
+                    'operation': 'greaterThanDate',
+                    'options': [{
+                        'name': 'date',
+                        'value': [date_min]
+                    }]
+                }
+            else:
+                _filter['endDate'] = {
+                    'operation': '> sysdate - 2'
+                }
             _filter['startDate'] = {
                 'operation': 'orderBy',
                 'options': [{
@@ -94,9 +106,18 @@ def add_event_filter(_filter, event_type):
             }
 
         if event_type == 'UNPLANNED_INCIDENT':
-            _filter['modifyDate'] = {
-                'operation': '> sysdate - 2'
-            }
+            if date_min:
+                _filter['modifyDate'] = {
+                    'operation': 'greaterThanDate',
+                    'options': [{
+                        'name': 'date',
+                        'value': [date_min]
+                    }]
+                }
+            else:
+                _filter['modifyDate'] = {
+                    'operation': '> sysdate - 2'
+                }
 
         if event_type == 'ANNOUNCEMENT':
             _filter['statusCode'] = {
diff --git a/SoftLayer/managers/storage.py b/SoftLayer/managers/storage.py
@@ -217,7 +217,8 @@ def order_replicant_volume(self,
                                snapshot_schedule,
                                location,
                                tier=None,
-                               os_type=None):
+                               os_type=None,
+                               iops=None):
         """Places an order for a replicant volume.
 
         :param volume_id: The ID of the primary volume to be replicated
@@ -239,9 +240,12 @@ def order_replicant_volume(self,
         storage_class = storage_utils.block_or_file(
             block_volume['storageType']['keyName'])
 
+        if iops is None:
+            iops = int(block_volume['provisionedIops'])
+
         order = storage_utils.prepare_replicant_order_object(
             self, snapshot_schedule, location, tier, block_volume,
-            storage_class)
+            storage_class, iops)
 
         if storage_class == 'block':
             if os_type is None:
diff --git a/SoftLayer/managers/storage_utils.py b/SoftLayer/managers/storage_utils.py
@@ -645,7 +645,7 @@ def _get_order_type_and_category(service_offering, storage_type, volume_type):
 
 
 def prepare_replicant_order_object(manager, snapshot_schedule, location,
-                                   tier, volume, volume_type):
+                                   tier, volume, volume_type, iops):
     """Prepare the order object which is submitted to the placeOrder() method
 
     :param manager: The File or Block manager calling this function
@@ -730,7 +730,7 @@ def prepare_replicant_order_object(manager, snapshot_schedule, location,
                     "A replica volume cannot be ordered for this performance "
                     "volume since it does not support Encryption at Rest.")
             volume_is_performance = True
-            iops = int(volume['provisionedIops'])
+
             prices = [
                 find_price_by_category(package, billing_item_category_code),
                 find_price_by_category(package, 'storage_' + volume_type),
diff --git a/SoftLayer/managers/vs.py b/SoftLayer/managers/vs.py
@@ -996,7 +996,7 @@ def capture(self, instance_id, name, additional_disks=False, notes=None):
 
             disks_to_capture.append(block_device)
 
-        return self.guest.createArchiveTransaction(
+        return self.guest.createArchiveTemplate(
             name, disks_to_capture, notes, id=instance_id)
 
     def upgrade(self, instance_id, cpus=None, memory=None, nic_speed=None, public=True, preset=None, disk=None):
diff --git a/SoftLayer/utils.py b/SoftLayer/utils.py
@@ -13,7 +13,7 @@
 
 from rich.console import Console
 from rich.theme import Theme
-
+from SoftLayer.CLI import exceptions
 # pylint: disable=no-member, invalid-name
 
 UUID_RE = re.compile(r'^[0-9A-F]{8}-[0-9A-F]{4}-4[0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}$', re.I)
@@ -371,6 +371,18 @@ def clean_time(sltime, in_format='%Y-%m-%dT%H:%M:%S%z', out_format='%Y-%m-%d %H:
         return sltime
 
 
+def verify_date(date):
+    """Verify if the date format is correct
+
+    :param string date: A date in format string
+    :return a exception if the date is not the correct format
+    """
+    try:
+        date = datetime.datetime.strptime(date, '%m/%d/%Y')
+    except Exception as exc:
+        raise exceptions.CLIAbort('Date invalid, example date: mm/dd/yyyy, 01/15/2023.') from exc
+
+
 def timestamp(date):
     """Converts a datetime to timestamp
 
diff --git a/setup.py b/setup.py
diff --git a/tests/CLI/modules/block_tests.py b/tests/CLI/modules/block_tests.py
diff --git a/tests/CLI/modules/vlan_tests.py b/tests/CLI/modules/vlan_tests.py
diff --git a/tests/CLI/modules/vs/vs_tests.py b/tests/CLI/modules/vs/vs_tests.py
diff --git a/tests/managers/storage_utils_tests.py b/tests/managers/storage_utils_tests.py
diff --git a/tests/managers/vs/vs_tests.py b/tests/managers/vs/vs_tests.py
diff --git a/tools/requirements.txt b/tools/requirements.txt
