Restructure some things for a project invoice

* Remove attributes that we get from coldfront from the invoice. Still
  keep the CSV output consistent though.
* Hold report metadata in a dataclass and pass that around to the helper
  functions to keep things better contained.

Author: naved001

openshift_metrics/invoice.py

@@ -192,19 +192,21 @@ class Rates:
     gpu_h100: Decimal
 
 
+@dataclass()
+class ReportMetadata:
+    report_month: str
+    cluster_name: str
+    report_start_time: datetime.datetime
+    report_end_time: datetime.datetime
+    generated_at: datetime.datetime
+
+
 @dataclass
 class ProjectInvoce:
     """Represents the invoicing data for a project."""
 
-    invoice_month: str
     project: str
     project_id: str
-    pi: str
-    cluster_name: str
-    invoice_email: str
-    invoice_address: str
-    intitution: str
-    institution_specific_code: str
     rates: Rates
     su_definitions: dict
     ignore_hours: Optional[List[Tuple[datetime.datetime, datetime.datetime]]] = None
@@ -240,30 +242,30 @@ def get_rate(self, su_type) -> Decimal:
             return self.rates.gpu_h100
         return Decimal(0)
 
-    def generate_invoice_rows(self, report_month, report_start_time, report_end_time, generated_at) -> List[str]:
+    def generate_invoice_rows(self, metadata: ReportMetadata) -> List[str]:
         rows = []
         for su_type, hours in self.su_hours.items():
             if hours > 0:
                 hours = math.ceil(hours)
                 rate = self.get_rate(su_type)
                 cost = (rate * hours).quantize(Decimal(".01"), rounding=ROUND_HALF_UP)
                 row = [
-                    report_month,
-                    report_start_time,
-                    report_end_time,
+                    metadata.report_month,
+                    metadata.report_start_time.strftime("%Y-%m-%d%H:%M:%SZ"),
+                    metadata.report_end_time.strftime("%Y-%m-%d%H:%M:%SZ"),
                     self.project,
                     self.project_id,
-                    self.pi,
-                    self.cluster_name,
-                    self.invoice_email,
-                    self.invoice_address,
-                    self.intitution,
-                    self.institution_specific_code,
+                    "",  # pi
+                    metadata.cluster_name,
+                    "",  # invoice_email
+                    "",  # invoice_address
+                    "",  # institution
+                    "",  # institution_specific_code
                     hours,
                     su_type,
                     rate,
                     cost,
-                    generated_at,
+                    metadata.generated_at.strftime("%Y-%m-%d%H:%M:%SZ"),
                 ]
                 rows.append(row)
         return rows

openshift_metrics/merge.py

@@ -210,8 +210,12 @@ def main():
     else:
         pod_report_file = f"Pod NERC OpenShift {report_month}.csv"
 
-    report_start_date = datetime.strptime(report_start_date, "%Y-%m-%d").replace(tzinfo=UTC)
-    report_end_date = datetime.strptime(report_end_date, "%Y-%m-%d").replace(tzinfo=UTC) + timedelta(days=1)
+    report_start_date = datetime.strptime(report_start_date, "%Y-%m-%d").replace(
+        tzinfo=UTC
+    )
+    report_end_date = datetime.strptime(report_end_date, "%Y-%m-%d").replace(
+        tzinfo=UTC
+    ) + timedelta(days=1)
 
     logger.info(
         f"Generating report from {report_start_date} to {report_end_date} for {cluster_name}"
@@ -227,33 +231,29 @@ def main():
 
     su_definitions = get_su_definitions(report_month)
 
-    generated_at = datetime.now(UTC).strftime("%Y-%m-%d%H:%M:%SZ")
-    report_start_time = report_start_date.strftime("%Y-%m-%d%H:%M:%SZ")
-    report_end_time = report_end_date.strftime("%Y-%m-%d%H:%M:%SZ")
+    report_metadata = invoice.ReportMetadata(
+        report_month=report_month,
+        cluster_name=cluster_name,
+        report_start_time=report_start_date,
+        report_end_time=report_end_date,
+        generated_at=datetime.now(UTC),
+    )
 
     utils.write_metrics_by_namespace(
         condensed_metrics_dict=condensed_metrics_dict,
         file_name=invoice_file,
-        report_month=report_month,
+        report_metadata=report_metadata,
         rates=invoice_rates,
         su_definitions=su_definitions,
-        cluster_name=cluster_name,
-        report_start_time=report_start_time,
-        report_end_time=report_end_time,
-        generated_at=generated_at,
         ignore_hours=ignore_hours,
     )
     utils.write_metrics_by_classes(
         condensed_metrics_dict=condensed_metrics_dict,
         file_name=class_invoice_file,
-        report_month=report_month,
+        report_metadata=report_metadata,
         rates=invoice_rates,
         su_definitions=su_definitions,
-        cluster_name=cluster_name,
         namespaces_with_classes=["rhods-notebooks"],
-        report_start_time=report_start_time,
-        report_end_time=report_end_time,
-        generated_at=generated_at,
         ignore_hours=ignore_hours,
     )
     utils.write_metrics_by_pod(

openshift_metrics/utils.py

@@ -60,13 +60,9 @@ def csv_writer(rows, file_name):
 def write_metrics_by_namespace(
     condensed_metrics_dict,
     file_name,
-    report_month,
+    report_metadata: invoice.ReportMetadata,
     rates,
     su_definitions,
-    cluster_name,
-    report_start_time,
-    report_end_time,
-    generated_at,
     ignore_hours=None,
 ):
     """
@@ -98,15 +94,8 @@ def write_metrics_by_namespace(
     for namespace, pods in condensed_metrics_dict.items():
         if namespace not in invoices:
             project_invoice = invoice.ProjectInvoce(
-                invoice_month=report_month,
                 project=namespace,
                 project_id=namespace,
-                pi="",
-                cluster_name=cluster_name,
-                invoice_email="",
-                invoice_address="",
-                intitution="",
-                institution_specific_code="",
                 rates=rates,
                 su_definitions=su_definitions,
                 ignore_hours=ignore_hours,
@@ -134,7 +123,7 @@ def write_metrics_by_namespace(
                 project_invoice.add_pod(pod_obj)
 
     for project_invoice in invoices.values():
-        rows.extend(project_invoice.generate_invoice_rows(report_month, report_start_time, report_end_time, generated_at))
+        rows.extend(project_invoice.generate_invoice_rows(report_metadata))
 
     csv_writer(rows, file_name)
 
@@ -191,14 +180,10 @@ def write_metrics_by_pod(
 def write_metrics_by_classes(
     condensed_metrics_dict,
     file_name,
-    report_month,
+    report_metadata: invoice.ReportMetadata,
     rates,
     namespaces_with_classes,
     su_definitions,
-    cluster_name,
-    report_start_time,
-    report_end_time,
-    generated_at,
     ignore_hours=None,
 ):
     """
@@ -240,15 +225,8 @@ def write_metrics_by_classes(
 
             if project_name not in invoices:
                 project_invoice = invoice.ProjectInvoce(
-                    invoice_month=report_month,
                     project=project_name,
                     project_id=project_name,
-                    pi="",
-                    cluster_name=cluster_name,
-                    invoice_email="",
-                    invoice_address="",
-                    intitution="",
-                    institution_specific_code="",
                     su_definitions=su_definitions,
                     rates=rates,
                     ignore_hours=ignore_hours,
@@ -274,6 +252,6 @@ def write_metrics_by_classes(
                 project_invoice.add_pod(pod_obj)
 
     for project_invoice in invoices.values():
-        rows.extend(project_invoice.generate_invoice_rows(report_month, report_start_time, report_end_time, generated_at))
+        rows.extend(project_invoice.generate_invoice_rows(report_metadata))
 
     csv_writer(rows, file_name)