Merge pull request #866 from sunilvrajput/sunil-sl-master

STAAS (File and Block) Hourly billing changes

Author: allmightyspiff

SoftLayer/CLI/block/duplicate.py

@@ -49,15 +49,23 @@
               type=int,
               help='The size of snapshot space to order for the duplicate. '
                    '***If no snapshot space size is specified, the snapshot '
-                   'space size of the origin volume will be used.***\n'
+                   'space size of the origin block volume will be used.***\n'
                    'Input "0" for this parameter to order a duplicate volume '
                    'with no snapshot space.')
+@click.option('--billing',
+              type=click.Choice(['hourly', 'monthly']),
+              default='monthly',
+              help="Optional parameter for Billing rate (default to monthly)")
 @environment.pass_env
 def cli(env, origin_volume_id, origin_snapshot_id, duplicate_size,
-        duplicate_iops, duplicate_tier, duplicate_snapshot_size):
+        duplicate_iops, duplicate_tier, duplicate_snapshot_size, billing):
     """Order a duplicate block storage volume."""
     block_manager = SoftLayer.BlockStorageManager(env.client)
 
+    hourly_billing_flag = False
+    if billing.lower() == "hourly":
+        hourly_billing_flag = True
+
     if duplicate_tier is not None:
         duplicate_tier = float(duplicate_tier)
 
@@ -68,7 +76,8 @@ def cli(env, origin_volume_id, origin_snapshot_id, duplicate_size,
             duplicate_size=duplicate_size,
             duplicate_iops=duplicate_iops,
             duplicate_tier_level=duplicate_tier,
-            duplicate_snapshot_size=duplicate_snapshot_size
+            duplicate_snapshot_size=duplicate_snapshot_size,
+            hourly_billing_flag=hourly_billing_flag
         )
     except ValueError as ex:
         raise exceptions.ArgumentError(str(ex))

SoftLayer/CLI/block/order.py

@@ -56,13 +56,27 @@
                   'storage_as_a_service',
                   'enterprise',
                   'performance']))
+@click.option('--billing',
+              type=click.Choice(['hourly', 'monthly']),
+              default='monthly',
+              help="Optional parameter for Billing rate (default to monthly)")
 @environment.pass_env
 def cli(env, storage_type, size, iops, tier, os_type,
-        location, snapshot_size, service_offering):
+        location, snapshot_size, service_offering, billing):
     """Order a block storage volume."""
     block_manager = SoftLayer.BlockStorageManager(env.client)
     storage_type = storage_type.lower()
 
+    hourly_billing_flag = False
+    if billing.lower() == "hourly":
+        hourly_billing_flag = True
+
+    if hourly_billing_flag and service_offering != 'storage_as_a_service':
+        raise exceptions.CLIAbort(
+            'Hourly billing is only available for the storage_as_a_service '
+            'service offering'
+        )
+
     if storage_type == 'performance':
         if iops is None:
             raise exceptions.CLIAbort(
@@ -87,7 +101,8 @@ def cli(env, storage_type, size, iops, tier, os_type,
                 iops=iops,
                 os_type=os_type,
                 snapshot_size=snapshot_size,
-                service_offering=service_offering
+                service_offering=service_offering,
+                hourly_billing_flag=hourly_billing_flag
             )
         except ValueError as ex:
             raise exceptions.ArgumentError(str(ex))
@@ -107,7 +122,8 @@ def cli(env, storage_type, size, iops, tier, os_type,
                 tier_level=float(tier),
                 os_type=os_type,
                 snapshot_size=snapshot_size,
-                service_offering=service_offering
+                service_offering=service_offering,
+                hourly_billing_flag=hourly_billing_flag
             )
         except ValueError as ex:
             raise exceptions.ArgumentError(str(ex))

SoftLayer/CLI/file/duplicate.py

@@ -45,15 +45,23 @@
               type=int,
               help='The size of snapshot space to order for the duplicate. '
                    '***If no snapshot space size is specified, the snapshot '
-                   'space size of the origin volume will be used.***\n'
+                   'space size of the origin file volume will be used.***\n'
                    'Input "0" for this parameter to order a duplicate volume '
                    'with no snapshot space.')
+@click.option('--billing',
+              type=click.Choice(['hourly', 'monthly']),
+              default='monthly',
+              help="Optional parameter for Billing rate (default to monthly)")
 @environment.pass_env
 def cli(env, origin_volume_id, origin_snapshot_id, duplicate_size,
-        duplicate_iops, duplicate_tier, duplicate_snapshot_size):
+        duplicate_iops, duplicate_tier, duplicate_snapshot_size, billing):
     """Order a duplicate file storage volume."""
     file_manager = SoftLayer.FileStorageManager(env.client)
 
+    hourly_billing_flag = False
+    if billing.lower() == "hourly":
+        hourly_billing_flag = True
+
     if duplicate_tier is not None:
         duplicate_tier = float(duplicate_tier)
 
@@ -64,7 +72,8 @@ def cli(env, origin_volume_id, origin_snapshot_id, duplicate_size,
             duplicate_size=duplicate_size,
             duplicate_iops=duplicate_iops,
             duplicate_tier_level=duplicate_tier,
-            duplicate_snapshot_size=duplicate_snapshot_size
+            duplicate_snapshot_size=duplicate_snapshot_size,
+            hourly_billing_flag=hourly_billing_flag
         )
     except ValueError as ex:
         raise exceptions.ArgumentError(str(ex))

SoftLayer/CLI/file/order.py

@@ -44,13 +44,27 @@
                   'storage_as_a_service',
                   'enterprise',
                   'performance']))
+@click.option('--billing',
+              type=click.Choice(['hourly', 'monthly']),
+              default='monthly',
+              help="Optional parameter for Billing rate (default to monthly)")
 @environment.pass_env
 def cli(env, storage_type, size, iops, tier,
-        location, snapshot_size, service_offering):
+        location, snapshot_size, service_offering, billing):
     """Order a file storage volume."""
     file_manager = SoftLayer.FileStorageManager(env.client)
     storage_type = storage_type.lower()
 
+    hourly_billing_flag = False
+    if billing.lower() == "hourly":
+        hourly_billing_flag = True
+
+    if hourly_billing_flag and service_offering != 'storage_as_a_service':
+        raise exceptions.CLIAbort(
+            'Hourly billing is only available for the storage_as_a_service '
+            'service offering'
+        )
+
     if storage_type == 'performance':
         if iops is None:
             raise exceptions.CLIAbort(
@@ -74,7 +88,8 @@ def cli(env, storage_type, size, iops, tier,
                 size=size,
                 iops=iops,
                 snapshot_size=snapshot_size,
-                service_offering=service_offering
+                service_offering=service_offering,
+                hourly_billing_flag=hourly_billing_flag
             )
         except ValueError as ex:
             raise exceptions.ArgumentError(str(ex))
@@ -93,7 +108,8 @@ def cli(env, storage_type, size, iops, tier,
                 size=size,
                 tier_level=float(tier),
                 snapshot_size=snapshot_size,
-                service_offering=service_offering
+                service_offering=service_offering,
+                hourly_billing_flag=hourly_billing_flag
             )
         except ValueError as ex:
             raise exceptions.ArgumentError(str(ex))

SoftLayer/fixtures/SoftLayer_Network_Storage.py

@@ -10,6 +10,7 @@
         }],
         'cancellationDate': '',
         'categoryCode': 'storage_as_a_service',
+        'hourlyFlag': None,
         'id': 454,
         'location': {'id': 449500}
     },

SoftLayer/managers/block.py

@@ -234,9 +234,10 @@ def order_replicant_volume(self, volume_id, snapshot_schedule,
         :return: Returns a SoftLayer_Container_Product_Order_Receipt
         """
 
-        block_mask = 'billingItem[activeChildren],storageTierLevel,osType,'\
-                     'staasVersion,hasEncryptionAtRest,snapshotCapacityGb,'\
-                     'schedules,hourlySchedule,dailySchedule,weeklySchedule,'\
+        block_mask = 'billingItem[activeChildren,hourlyFlag],'\
+                     'storageTierLevel,osType,staasVersion,'\
+                     'hasEncryptionAtRest,snapshotCapacityGb,schedules,'\
+                     'hourlySchedule,dailySchedule,weeklySchedule,'\
                      'storageType[keyName],provisionedIops'
         block_volume = self.get_block_volume_details(volume_id,
                                                      mask=block_mask)
@@ -261,7 +262,8 @@ def order_replicant_volume(self, volume_id, snapshot_schedule,
     def order_duplicate_volume(self, origin_volume_id, origin_snapshot_id=None,
                                duplicate_size=None, duplicate_iops=None,
                                duplicate_tier_level=None,
-                               duplicate_snapshot_size=None):
+                               duplicate_snapshot_size=None,
+                               hourly_billing_flag=False):
         """Places an order for a duplicate block volume.
 
         :param origin_volume_id: The ID of the origin volume to be duplicated
@@ -270,10 +272,12 @@ def order_duplicate_volume(self, origin_volume_id, origin_snapshot_id=None,
         :param duplicate_iops: The IOPS per GB for the duplicate volume
         :param duplicate_tier_level: Tier level for the duplicate volume
         :param duplicate_snapshot_size: Snapshot space size for the duplicate
+        :param hourly_billing_flag: Billing type, monthly (False)
+            or hourly (True), default to monthly.
         :return: Returns a SoftLayer_Container_Product_Order_Receipt
         """
 
-        block_mask = 'id,billingItem[location],snapshotCapacityGb,'\
+        block_mask = 'id,billingItem[location,hourlyFlag],snapshotCapacityGb,'\
                      'storageType[keyName],capacityGb,originalVolumeSize,'\
                      'provisionedIops,storageTierLevel,osType[keyName],'\
                      'staasVersion,hasEncryptionAtRest'
@@ -288,7 +292,8 @@ def order_duplicate_volume(self, origin_volume_id, origin_snapshot_id=None,
 
         order = storage_utils.prepare_duplicate_order_object(
             self, origin_volume, duplicate_iops, duplicate_tier_level,
-            duplicate_size, duplicate_snapshot_size, 'block'
+            duplicate_size, duplicate_snapshot_size, 'block',
+            hourly_billing_flag
         )
 
         order['osFormatType'] = {'keyName': os_type}
@@ -308,7 +313,8 @@ def delete_snapshot(self, snapshot_id):
 
     def order_block_volume(self, storage_type, location, size, os_type,
                            iops=None, tier_level=None, snapshot_size=None,
-                           service_offering='storage_as_a_service'):
+                           service_offering='storage_as_a_service',
+                           hourly_billing_flag=False):
         """Places an order for a block volume.
 
         :param storage_type: 'performance' or 'endurance'
@@ -321,10 +327,12 @@ def order_block_volume(self, storage_type, location, size, os_type,
             if snapshot space should also be ordered (None if not ordered)
         :param service_offering: Requested offering package to use in the order
             ('storage_as_a_service', 'enterprise', or 'performance')
+        :param hourly_billing_flag: Billing type, monthly (False)
+            or hourly (True), default to monthly.
         """
         order = storage_utils.prepare_volume_order_object(
             self, storage_type, location, size, iops, tier_level,
-            snapshot_size, service_offering, 'block'
+            snapshot_size, service_offering, 'block', hourly_billing_flag
         )
 
         order['osFormatType'] = {'keyName': os_type}
@@ -352,8 +360,9 @@ def order_snapshot_space(self, volume_id, capacity, tier,
         :param boolean upgrade: Flag to indicate if this order is an upgrade
         :return: Returns a SoftLayer_Container_Product_Order_Receipt
         """
-        block_mask = 'id,billingItem[location],storageType[keyName],'\
-            'storageTierLevel,provisionedIops,staasVersion,hasEncryptionAtRest'
+        block_mask = 'id,billingItem[location,hourlyFlag],'\
+            'storageType[keyName],storageTierLevel,provisionedIops,'\
+            'staasVersion,hasEncryptionAtRest'
         block_volume = self.get_block_volume_details(volume_id,
                                                      mask=block_mask,
                                                      **kwargs)
@@ -376,7 +385,7 @@ def cancel_snapshot_space(self, volume_id,
 
         block_volume = self.get_block_volume_details(
             volume_id,
-            mask='mask[id,billingItem[activeChildren]]')
+            mask='mask[id,billingItem[activeChildren,hourlyFlag]]')
 
         if 'activeChildren' not in block_volume['billingItem']:
             raise exceptions.SoftLayerError(
@@ -394,6 +403,9 @@ def cancel_snapshot_space(self, volume_id,
             raise exceptions.SoftLayerError(
                 'No snapshot space found to cancel')
 
+        if utils.lookup(block_volume, 'billingItem', 'hourlyFlag'):
+            immediate = True
+
         return self.client['Billing_Item'].cancelItem(
             immediate,
             True,
@@ -456,9 +468,12 @@ def cancel_block_volume(self, volume_id,
         """
         block_volume = self.get_block_volume_details(
             volume_id,
-            mask='mask[id,billingItem[id]]')
+            mask='mask[id,billingItem[id,hourlyFlag]]')
         billing_item_id = block_volume['billingItem']['id']
 
+        if utils.lookup(block_volume, 'billingItem', 'hourlyFlag'):
+            immediate = True
+
         return self.client['Billing_Item'].cancelItem(
             immediate,
             True,