Merge pull request #29038 from vespa-engine/bill-status-enum

Bill status enum

5 files changed, 35 insertions, 18 deletions

diff --git a/controller-server/src/main/java/com/yahoo/vespa/hosted/controller/maintenance/BillingReportMaintainer.java b/controller-server/src/main/java/com/yahoo/vespa/hosted/controller/maintenance/BillingReportMaintainer.java
index a12c341c1d1..7868c3fe611 100644
--- a/controller-server/src/main/java/com/yahoo/vespa/hosted/controller/maintenance/BillingReportMaintainer.java
+++ b/controller-server/src/main/java/com/yahoo/vespa/hosted/controller/maintenance/BillingReportMaintainer.java
@@ -5,7 +5,7 @@ import com.yahoo.config.provision.SystemName;
 import com.yahoo.config.provision.TenantName;
 import com.yahoo.vespa.hosted.controller.Controller;
 import com.yahoo.vespa.hosted.controller.LockedTenant;
-import com.yahoo.vespa.hosted.controller.api.integration.billing.Bill;
+import com.yahoo.vespa.hosted.controller.api.integration.billing.BillStatus;
 import com.yahoo.vespa.hosted.controller.api.integration.billing.BillingController;
 import com.yahoo.vespa.hosted.controller.api.integration.billing.BillingDatabaseClient;
 import com.yahoo.vespa.hosted.controller.api.integration.billing.BillingReporter;
@@ -66,7 +66,7 @@ public class BillingReportMaintainer extends ControllerMaintainer {
     InvoiceUpdate maintainInvoices() {
         var billsNeedingMaintenance = databaseClient.readBills().stream()
                 .filter(bill -> bill.getExportedId().isPresent())
-                .filter(exported -> ! exported.status().equals("ISSUED")) // TODO: This status does not yet exist.
+                .filter(exported -> exported.status() == BillStatus.OPEN)
                 .toList();
 
         var updates = new InvoiceUpdate.Counter();
diff --git a/controller-server/src/main/java/com/yahoo/vespa/hosted/controller/restapi/billing/BillingApiHandler.java b/controller-server/src/main/java/com/yahoo/vespa/hosted/controller/restapi/billing/BillingApiHandler.java
index 696f759d16e..6dc29ebe08c 100644
--- a/controller-server/src/main/java/com/yahoo/vespa/hosted/controller/restapi/billing/BillingApiHandler.java
+++ b/controller-server/src/main/java/com/yahoo/vespa/hosted/controller/restapi/billing/BillingApiHandler.java
@@ -19,12 +19,14 @@ import com.yahoo.vespa.hosted.controller.ApplicationController;
 import com.yahoo.vespa.hosted.controller.Controller;
 import com.yahoo.vespa.hosted.controller.TenantController;
 import com.yahoo.vespa.hosted.controller.api.integration.billing.Bill;
+import com.yahoo.vespa.hosted.controller.api.integration.billing.BillStatus;
 import com.yahoo.vespa.hosted.controller.api.integration.billing.BillingController;
 import com.yahoo.vespa.hosted.controller.api.integration.billing.CollectionMethod;
 import com.yahoo.vespa.hosted.controller.api.integration.billing.InstrumentOwner;
 import com.yahoo.vespa.hosted.controller.api.integration.billing.PaymentInstrument;
 import com.yahoo.vespa.hosted.controller.api.integration.billing.PlanId;
 import com.yahoo.vespa.hosted.controller.api.integration.billing.PlanRegistry;
+import com.yahoo.vespa.hosted.controller.api.integration.billing.StatusHistory;
 import com.yahoo.vespa.hosted.controller.api.role.Role;
 import com.yahoo.vespa.hosted.controller.api.role.SecurityContext;
 import com.yahoo.vespa.hosted.controller.restapi.ErrorResponses;
@@ -238,7 +240,7 @@ public class BillingApiHandler extends ThreadedHttpRequestHandler {
     private HttpResponse setBillStatus(HttpRequest request, String billId, String userId) {
         Inspector inspector = inspectorOrThrow(request);
         String status = getInspectorFieldOrThrow(inspector, "status");
-        billingController.updateBillStatus(Bill.Id.of(billId), userId, status);
+        billingController.updateBillStatus(Bill.Id.of(billId), userId, BillStatus.from(status));
         return new MessageResponse("Updated status of invoice " + billId);
     }
 
@@ -380,7 +382,7 @@ public class BillingApiHandler extends ThreadedHttpRequestHandler {
         billCursor.setString("to", bill.getEndDate().format(DATE_TIME_FORMATTER));
 
         billCursor.setString("amount", bill.sum().toString());
-        billCursor.setString("status", bill.status());
+        billCursor.setString("status", bill.status().value());
         var statusCursor = billCursor.setArray("statusHistory");
         renderStatusHistory(statusCursor, bill.statusHistory());
 
@@ -392,14 +394,14 @@ public class BillingApiHandler extends ThreadedHttpRequestHandler {
         });
     }
 
-    private void renderStatusHistory(Cursor cursor, Bill.StatusHistory statusHistory) {
+    private void renderStatusHistory(Cursor cursor, StatusHistory statusHistory) {
         statusHistory.getHistory()
                 .entrySet()
                 .stream()
                 .forEach(entry -> {
                     var c = cursor.addObject();
                     c.setString("at", entry.getKey().format(DATE_TIME_FORMATTER));
-                    c.setString("status", entry.getValue());
+                    c.setString("status", entry.getValue().value());
                 });
     }
 
diff --git a/controller-server/src/main/java/com/yahoo/vespa/hosted/controller/restapi/billing/BillingApiHandlerV2.java b/controller-server/src/main/java/com/yahoo/vespa/hosted/controller/restapi/billing/BillingApiHandlerV2.java
index 35d09fd541b..edec869f559 100644
--- a/controller-server/src/main/java/com/yahoo/vespa/hosted/controller/restapi/billing/BillingApiHandlerV2.java
+++ b/controller-server/src/main/java/com/yahoo/vespa/hosted/controller/restapi/billing/BillingApiHandlerV2.java
@@ -25,6 +25,7 @@ import com.yahoo.vespa.hosted.controller.api.integration.billing.Plan;
 import com.yahoo.vespa.hosted.controller.api.integration.billing.PlanId;
 import com.yahoo.vespa.hosted.controller.api.integration.billing.PlanRegistry;
 import com.yahoo.vespa.hosted.controller.api.integration.billing.Quota;
+import com.yahoo.vespa.hosted.controller.api.integration.billing.StatusHistory;
 import com.yahoo.vespa.hosted.controller.api.role.Role;
 import com.yahoo.vespa.hosted.controller.api.role.SecurityContext;
 import com.yahoo.vespa.hosted.controller.restapi.ErrorResponses;
@@ -461,7 +462,7 @@ public class BillingApiHandlerV2 extends RestApiRequestHandler<BillingApiHandler
         slime.setString("from", bill.getStartDate().format(DateTimeFormatter.ISO_LOCAL_DATE));
         slime.setString("to", bill.getEndDate().format(DateTimeFormatter.ISO_LOCAL_DATE));
         slime.setString("total", bill.sum().toString());
-        slime.setString("status", bill.status());
+        slime.setString("status", bill.status().value());
     }
 
     private void usageToSlime(Cursor slime, Bill bill) {
@@ -476,16 +477,16 @@ public class BillingApiHandlerV2 extends RestApiRequestHandler<BillingApiHandler
         slime.setString("from", bill.getStartDate().format(DateTimeFormatter.ISO_LOCAL_DATE));
         slime.setString("to", bill.getEndDate().format(DateTimeFormatter.ISO_LOCAL_DATE));
         slime.setString("total", bill.sum().toString());
-        slime.setString("status", bill.status());
+        slime.setString("status", bill.status().value());
         toSlime(slime.setArray("statusHistory"), bill.statusHistory());
         toSlime(slime.setArray("items"), bill.lineItems());
     }
 
-    private void toSlime(Cursor slime, Bill.StatusHistory history) {
+    private void toSlime(Cursor slime, StatusHistory history) {
         history.getHistory().forEach((key, value) -> {
             var c = slime.addObject();
             c.setString("at", key.format(DateTimeFormatter.ISO_OFFSET_DATE_TIME));
-            c.setString("status", value);
+            c.setString("status", value.value());
         });
     }
 
diff --git a/controller-server/src/test/java/com/yahoo/vespa/hosted/controller/maintenance/BillingReportMaintainerTest.java b/controller-server/src/test/java/com/yahoo/vespa/hosted/controller/maintenance/BillingReportMaintainerTest.java
index a224af83401..5cb46664a75 100644
--- a/controller-server/src/test/java/com/yahoo/vespa/hosted/controller/maintenance/BillingReportMaintainerTest.java
+++ b/controller-server/src/test/java/com/yahoo/vespa/hosted/controller/maintenance/BillingReportMaintainerTest.java
@@ -4,6 +4,7 @@ package com.yahoo.vespa.hosted.controller.maintenance;
 import com.yahoo.config.provision.SystemName;
 import com.yahoo.config.provision.TenantName;
 import com.yahoo.vespa.hosted.controller.ControllerTester;
+import com.yahoo.vespa.hosted.controller.api.integration.billing.BillStatus;
 import com.yahoo.vespa.hosted.controller.api.integration.billing.InvoiceUpdate;
 import com.yahoo.vespa.hosted.controller.api.integration.billing.PlanRegistryMock;
 import com.yahoo.vespa.hosted.controller.tenant.BillingReference;
@@ -43,25 +44,38 @@ public class BillingReportMaintainerTest {
     }
 
     @Test
-    void only_bills_with_exported_id_are_maintained() {
+    void only_open_bills_with_exported_id_are_maintained() {
         var t1 = tester.createTenant("t1");
         var billingController = tester.controller().serviceRegistry().billingController();
         var billingDb = tester.controller().serviceRegistry().billingDatabase();
 
         var start = LocalDate.of(2020, 5, 23).atStartOfDay(ZoneOffset.UTC);
         var end = start.toLocalDate().plusDays(6).atStartOfDay(ZoneOffset.UTC);
+
         var bill1 = billingDb.createBill(t1, start, end, "non-exported");
         var bill2 = billingDb.createBill(t1, start, end, "exported");
+        var bill3 = billingDb.createBill(t1, start, end, "exported-and-frozen");
+        billingDb.setStatus(bill3, "foo", BillStatus.FROZEN);
 
         billingController.setPlan(t1, PlanRegistryMock.paidPlan.id(), false, true);
 
         tester.controller().serviceRegistry().billingReporter().exportBill(billingDb.readBill(bill2).get(), "FOO", cloudTenant(t1));
+        tester.controller().serviceRegistry().billingReporter().exportBill(billingDb.readBill(bill3).get(), "FOO", cloudTenant(t1));
         var updates = maintainer.maintainInvoices();
-        assertEquals(new InvoiceUpdate(0, 0, 1), updates);
+        assertEquals(new InvoiceUpdate(1, 0, 0), updates);
+
+        assertTrue(billingDb.readBill(bill1).get().getExportedId().isEmpty());
 
         var exportedBill = billingDb.readBill(bill2).get();
         assertEquals("EXT-ID-123", exportedBill.getExportedId().get());
-        assertTrue(billingDb.readBill(bill1).get().getExportedId().isEmpty());
+        var lineItems = exportedBill.lineItems();
+        assertEquals(1, lineItems.size());
+        assertEquals("maintained", lineItems.get(0).id());
+
+        var frozenBill = billingDb.readBill(bill3).get();
+        assertEquals("EXT-ID-123", frozenBill.getExportedId().get());
+        assertEquals(0, frozenBill.lineItems().size());
+
     }
 
     private CloudTenant cloudTenant(TenantName tenantName) {
diff --git a/controller-server/src/test/java/com/yahoo/vespa/hosted/controller/restapi/billing/BillingApiHandlerTest.java b/controller-server/src/test/java/com/yahoo/vespa/hosted/controller/restapi/billing/BillingApiHandlerTest.java
index 7f68fbf6909..f3147d2adde 100644
--- a/controller-server/src/test/java/com/yahoo/vespa/hosted/controller/restapi/billing/BillingApiHandlerTest.java
+++ b/controller-server/src/test/java/com/yahoo/vespa/hosted/controller/restapi/billing/BillingApiHandlerTest.java
@@ -4,9 +4,11 @@ package com.yahoo.vespa.hosted.controller.restapi.billing;
 import com.yahoo.config.provision.SystemName;
 import com.yahoo.config.provision.TenantName;
 import com.yahoo.vespa.hosted.controller.api.integration.billing.Bill;
+import com.yahoo.vespa.hosted.controller.api.integration.billing.BillStatus;
 import com.yahoo.vespa.hosted.controller.api.integration.billing.CollectionMethod;
 import com.yahoo.vespa.hosted.controller.api.integration.billing.MockBillingController;
 import com.yahoo.vespa.hosted.controller.api.integration.billing.PlanId;
+import com.yahoo.vespa.hosted.controller.api.integration.billing.StatusHistory;
 import com.yahoo.vespa.hosted.controller.api.role.Role;
 import com.yahoo.vespa.hosted.controller.restapi.ContainerTester;
 import com.yahoo.vespa.hosted.controller.restapi.ControllerContainerCloudTest;
@@ -26,12 +28,10 @@ import java.util.Optional;
 import java.util.Set;
 import java.util.TreeMap;
 
-import static com.yahoo.application.container.handler.Request.Method.DELETE;
 import static com.yahoo.application.container.handler.Request.Method.GET;
 import static com.yahoo.application.container.handler.Request.Method.PATCH;
 import static com.yahoo.application.container.handler.Request.Method.POST;
 import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertTrue;
 
 /**
  * @author olaa
@@ -152,14 +152,14 @@ public class BillingApiHandlerTest extends ControllerContainerCloudTest {
     void adding_new_status() {
         billingController.addBill(tenant, createBill(), true);
 
-        var requestBody = "{\"status\":\"DONE\"}";
+        var requestBody = "{\"status\":\"CLOSED\"}";
         var request = request("/billing/v1/invoice/id-1/status", POST)
                 .data(requestBody)
                 .roles(financeAdmin);
         tester.assertResponse(request, "{\"message\":\"Updated status of invoice id-1\"}");
 
         var bill = billingController.getBillsForTenant(tenant).get(0);
-        assertEquals("DONE", bill.status());
+        assertEquals(BillStatus.CLOSED, bill.status());
     }
 
     @Test
@@ -211,7 +211,7 @@ public class BillingApiHandlerTest extends ControllerContainerCloudTest {
     static Bill createBill() {
         var start = LocalDate.of(2020, 5, 23).atStartOfDay(ZoneOffset.UTC);
         var end = start.toLocalDate().plusDays(6).atStartOfDay(ZoneOffset.UTC);
-        var statusHistory = new Bill.StatusHistory(new TreeMap<>(Map.of(start, "OPEN")));
+        var statusHistory = new StatusHistory(new TreeMap<>(Map.of(start, BillStatus.OPEN)));
         return new Bill(
                 Bill.Id.of("id-1"),
                 TenantName.defaultName(),