[COST-5432] - Add the ability to generate reserved instances (#538)

* Adding RIs option to AWS EC2 generator

Author: lcouzens

nise/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "4.7.0"
+__version__ = "4.7.1"
 
 
 VERSION = __version__.split(".")

nise/generators/aws/ec2_generator.py

@@ -25,7 +25,17 @@ class EC2Generator(AWSGenerator):
 
     INSTANCE_TYPES = (
         # NOTE: Each tuple represents
-        # (instance type, physical_cores, vCPUs, memory, storage, family, cost, rate, savings, description)
+        # (instance type,
+        # physical_cores,
+        # vCPUs,
+        # memory,
+        # storage,
+        # family,
+        # cost,
+        # rate,
+        # Reserved_instances,
+        # savings,
+        # description)
         (
             "m5.large",
             "1",
@@ -38,6 +48,7 @@ class EC2Generator(AWSGenerator):
             "0.045",
             1,
             False,
+            False,
             "${cost} per On Demand Linux {inst_type} Instance Hour",
         ),
         (
@@ -52,6 +63,7 @@ class EC2Generator(AWSGenerator):
             "0.17",
             1,
             False,
+            False,
             "${cost} per On Demand Linux {inst_type} Instance Hour",
         ),
         (
@@ -66,6 +78,7 @@ class EC2Generator(AWSGenerator):
             "0.099",
             1,
             False,
+            False,
             "${cost} per On Demand Linux {inst_type} Instance Hour",
         ),
         (
@@ -80,6 +93,7 @@ class EC2Generator(AWSGenerator):
             "0.067",
             1,
             False,
+            False,
             "${cost} per On Demand Linux {inst_type} Instance Hour",
         ),
     )
@@ -124,6 +138,7 @@ def __init__(self, start_date, end_date, currency, payer_account, usage_accounts
                 instance_type.get("rate"),
                 instance_type.get("saving"),
                 instance_type.get("amount", "1"),
+                instance_type.get("reserved_instance", False),
                 instance_type.get("negation", False),
                 "${cost} per On Demand Linux {inst_type} Instance Hour",
             )
@@ -141,6 +156,7 @@ def _update_data(self, row, start, end, **kwargs):
             rate,
             saving,
             amount,
+            reserved_instance,
             negation,
             description,
         ) = self._instance_type
@@ -203,6 +219,18 @@ def _update_data(self, row, start, end, **kwargs):
         # Overwrite lineItem/LineItemType for items with applied Savings plan
         if saving is not None:
             row["lineItem/LineItemType"] = "SavingsPlanCoveredUsage"
+        # Overwrite lineitem/LineItemType for RI's discount usage
+        if reserved_instance:
+            row["lineItem/LineItemType"] = "DiscountedUsage"
+            row["lineItem/UnblendedCost"] = 0
+            row["lineItem/UnblendedRate"] = 0
+            row["lineItem/BlendedCost"] = 0
+            row["lineItem/BlendedRate"] = 0
+            row["lineItem/LineItemDescription"] = f"{inst_type} reserved instance applied"
+            row["pricing/publicOnDemandCost"] = "convertible"
+            row["pricing/publicOnDemandRate"] = "No Upfront"
+            row["savingsPlan/SavingsPlanEffectiveCost"] = None
+            row["savingsPlan/SavingsPlanRate"] = None
 
         if negation:
             row["lineItem/LineItemType"] = "SavingsPlanNegation"

tests/aws_static_report.yml

@@ -20,6 +20,14 @@ generators:
         cost: 1.000
         rate: 0.500
         saving: 0.250
+  - EC2Generator:
+      start_date: today
+      end_date: today
+      processor_arch: 32-bit
+      resource_id: 55555555
+      product_sku: VEAJHRNKTJZQ
+      region: us-east-1a
+      reserved_instance: True
   - S3Generator:
       start_date: last_month
       end_date: last_month

tests/test_aws_generator.py

@@ -395,6 +395,7 @@ def test_init_with_attributes(self):
             "rate": "1",
             "saving": "1",
             "amount": 1,
+            "reserved_instance": False,
             "negation": False,
         }
         self.attributes["instance_type"] = self.instance_type
@@ -419,6 +420,19 @@ def test_update_data_ec2_negation(self):
 
         self.assertEqual(row["lineItem/LineItemType"], "SavingsPlanNegation")
 
+    def test_update_data_ec2_reserved_instances(self):
+        """Test EC2 specific update data with Reserved Instances."""
+        self.instance_type = {"reserved_instance": True}
+        self.attributes["instance_type"] = self.instance_type
+        generator = EC2Generator(
+            self.two_hours_ago, self.now, self.currency, self.payer_account, self.usage_accounts, self.attributes
+        )
+        start_row = {}
+        row = generator._update_data(start_row, self.two_hours_ago, self.now)
+
+        self.assertEqual(row["lineItem/LineItemType"], "DiscountedUsage")
+        self.assertEqual(row["lineItem/UnblendedCost"], 0)
+
     def test_update_data(self):
         """Test EBS specific update data method."""
         generator = EC2Generator(