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

Bill status enum

9 files changed, 104 insertions, 42 deletions

diff --git a/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/billing/Bill.java b/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/billing/Bill.java
index 1acb4964ea6..e7959d2057a 100644
--- a/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/billing/Bill.java
+++ b/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/billing/Bill.java
@@ -8,16 +8,11 @@ import com.yahoo.config.provision.TenantName;
 import com.yahoo.config.provision.zone.ZoneId;
 
 import java.math.BigDecimal;
-import java.time.Clock;
 import java.time.LocalDate;
-import java.time.ZoneOffset;
 import java.time.ZonedDateTime;
 import java.util.List;
-import java.util.Map;
 import java.util.Objects;
 import java.util.Optional;
-import java.util.SortedMap;
-import java.util.TreeMap;
 import java.util.UUID;
 import java.util.function.Function;
 
@@ -69,7 +64,7 @@ public class Bill {
         return tenant;
     }
 
-    public String status() {
+    public BillStatus status() {
         return statusHistory.current();
     }
 
@@ -389,28 +384,4 @@ public class Bill {
         }
     }
 
-    public static class StatusHistory {
-        SortedMap<ZonedDateTime, String> history;
-
-        public StatusHistory(SortedMap<ZonedDateTime, String> history) {
-            this.history = history;
-        }
-
-        public static StatusHistory open(Clock clock) {
-            var now = clock.instant().atZone(ZoneOffset.UTC);
-            return new StatusHistory(
-                    new TreeMap<>(Map.of(now, "OPEN"))
-            );
-        }
-
-        public String current() {
-            return history.get(history.lastKey());
-        }
-
-        public SortedMap<ZonedDateTime, String> getHistory() {
-            return history;
-        }
-
-    }
-
 }
diff --git a/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/billing/BillStatus.java b/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/billing/BillStatus.java
new file mode 100644
index 00000000000..d6c6262069b
--- /dev/null
+++ b/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/billing/BillStatus.java
@@ -0,0 +1,30 @@
+package com.yahoo.vespa.hosted.controller.api.integration.billing;
+
+/**
+ * @author gjoranv
+ */
+public enum BillStatus {
+    OPEN,       // All bills start in this state. The bill can be modified and exported/synced to external systems.
+    FROZEN,     // Syncing to external systems is switched off. Reviews should be done in this state.
+    CLOSED,     // End state for a valid bill.
+    VOID;       // End state, indicating that the bill is not valid.
+
+    private static final String LEGACY_ISSUED = "ISSUED";         // Legacy state, used by historical bills
+    private static final String LEGACY_EXPORTED = "EXPORTED";     // Legacy state, used by historical bills
+
+    private final String value;
+
+    BillStatus() {
+        this.value = name();
+    }
+
+    public String value() {
+        return value;
+    }
+
+    public static BillStatus from(String status) {
+        if (LEGACY_ISSUED.equals(status) || LEGACY_EXPORTED.equals(status)) return OPEN;
+        return Enum.valueOf(BillStatus.class, status.toUpperCase());
+    }
+
+}
diff --git a/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/billing/BillingController.java b/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/billing/BillingController.java
index 45c22c0db28..0aae466feb2 100644
--- a/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/billing/BillingController.java
+++ b/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/billing/BillingController.java
@@ -90,7 +90,7 @@ public interface BillingController {
     boolean deleteInstrument(TenantName tenant, String userId, String instrumentId);
 
     /** Change the status of the given bill */
-    void updateBillStatus(Bill.Id billId, String agent, String status);
+    void updateBillStatus(Bill.Id billId, String agent, BillStatus status);
 
     /** Add a line item to the given bill */
     void addLineItem(TenantName tenant, String description, BigDecimal amount, Optional<Bill.Id> billId, String agent);
diff --git a/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/billing/BillingDatabaseClient.java b/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/billing/BillingDatabaseClient.java
index 3e24314ba5c..c5859cd7d2f 100644
--- a/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/billing/BillingDatabaseClient.java
+++ b/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/billing/BillingDatabaseClient.java
@@ -69,7 +69,7 @@ public interface BillingDatabaseClient {
      * @param agent     The agent that added the status
      * @param status    The new status of the bill
      */
-    void setStatus(Bill.Id billId, String agent, String status);
+    void setStatus(Bill.Id billId, String agent, BillStatus status);
 
     List<Bill.LineItem> getUnusedLineItems(TenantName tenantName);
 
diff --git a/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/billing/BillingDatabaseClientMock.java b/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/billing/BillingDatabaseClientMock.java
index ee7679f54ca..a6bcc9bf0ed 100644
--- a/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/billing/BillingDatabaseClientMock.java
+++ b/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/billing/BillingDatabaseClientMock.java
@@ -26,7 +26,7 @@ public class BillingDatabaseClientMock implements BillingDatabaseClient {
     private final Map<Bill.Id, List<Bill.LineItem>> lineItems = new HashMap<>();
     private final Map<TenantName, List<Bill.LineItem>> uncommittedLineItems = new HashMap<>();
 
-    private final Map<Bill.Id, Bill.StatusHistory> statuses = new HashMap<>();
+    private final Map<Bill.Id, StatusHistory> statuses = new HashMap<>();
     private final Map<Bill.Id, ZonedDateTime> startTimes = new HashMap<>();
     private final Map<Bill.Id, ZonedDateTime> endTimes = new HashMap<>();
     private final Map<Bill.Id, String> exportedInvoiceIds = new HashMap<>();
@@ -54,7 +54,7 @@ public class BillingDatabaseClientMock implements BillingDatabaseClient {
                 .findFirst();
     }
 
-    public String getStatus(Bill.Id invoiceId) {
+    public BillStatus getStatus(Bill.Id invoiceId) {
         return statuses.get(invoiceId).current();
     }
 
@@ -62,7 +62,7 @@ public class BillingDatabaseClientMock implements BillingDatabaseClient {
     public Bill.Id createBill(TenantName tenant, ZonedDateTime startTime, ZonedDateTime endTime, String agent) {
         var invoiceId = Bill.Id.generate();
         invoices.put(invoiceId, tenant);
-        statuses.computeIfAbsent(invoiceId, l -> Bill.StatusHistory.open(clock));
+        statuses.computeIfAbsent(invoiceId, l -> StatusHistory.open(clock));
         startTimes.put(invoiceId, startTime);
         endTimes.put(invoiceId, endTime);
         return invoiceId;
@@ -72,7 +72,7 @@ public class BillingDatabaseClientMock implements BillingDatabaseClient {
     public Optional<Bill> readBill(Bill.Id billId) {
         var invoice = Optional.ofNullable(invoices.get(billId));
         var lines = lineItems.getOrDefault(billId, List.of());
-        var status = statuses.getOrDefault(billId, Bill.StatusHistory.open(clock));
+        var status = statuses.getOrDefault(billId, StatusHistory.open(clock));
         var start = startTimes.getOrDefault(billId, startTime);
         var end = endTimes.getOrDefault(billId, endTime);
         var exportedId = exportedInvoiceId(billId);
@@ -90,8 +90,8 @@ public class BillingDatabaseClientMock implements BillingDatabaseClient {
     }
 
     @Override
-    public void setStatus(Bill.Id invoiceId, String agent, String status) {
-        statuses.computeIfAbsent(invoiceId, k -> Bill.StatusHistory.open(clock))
+    public void setStatus(Bill.Id invoiceId, String agent, BillStatus status) {
+        statuses.computeIfAbsent(invoiceId, k -> StatusHistory.open(clock))
                 .getHistory()
                 .put(ZonedDateTime.now(), status);
     }
diff --git a/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/billing/BillingReporterMock.java b/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/billing/BillingReporterMock.java
index 4985033d378..689ecc356dc 100644
--- a/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/billing/BillingReporterMock.java
+++ b/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/billing/BillingReporterMock.java
@@ -4,7 +4,10 @@ package com.yahoo.vespa.hosted.controller.api.integration.billing;
 import com.yahoo.vespa.hosted.controller.tenant.BillingReference;
 import com.yahoo.vespa.hosted.controller.tenant.CloudTenant;
 
+import java.math.BigDecimal;
 import java.time.Clock;
+import java.time.ZonedDateTime;
+import java.util.Optional;
 import java.util.UUID;
 
 public class BillingReporterMock implements BillingReporter {
@@ -23,7 +26,8 @@ public class BillingReporterMock implements BillingReporter {
 
     @Override
     public InvoiceUpdate maintainInvoice(Bill bill) {
-        return new InvoiceUpdate(0,0,1);
+        dbClient.addLineItem(bill.tenant(), maintainedMarkerItem(), Optional.of(bill.id()));
+        return new InvoiceUpdate(1,0,0);
     }
 
     @Override
@@ -34,4 +38,8 @@ public class BillingReporterMock implements BillingReporter {
         return exportedId;
     }
 
+    private static Bill.LineItem maintainedMarkerItem() {
+        return new Bill.LineItem("maintained", "", BigDecimal.valueOf(0.0), "", "", ZonedDateTime.now());
+    }
+
 }
diff --git a/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/billing/MockBillingController.java b/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/billing/MockBillingController.java
index 7a4a787fb11..f8e83b44510 100644
--- a/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/billing/MockBillingController.java
+++ b/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/billing/MockBillingController.java
@@ -74,7 +74,7 @@ public class MockBillingController implements BillingController {
                 .add(new Bill(
                         billId,
                         tenant,
-                        Bill.StatusHistory.open(clock),
+                        StatusHistory.open(clock),
                         List.of(),
                         startTime,
                         endTime
@@ -119,7 +119,7 @@ public class MockBillingController implements BillingController {
     }
 
     @Override
-    public void updateBillStatus(Bill.Id billId, String agent, String status) {
+    public void updateBillStatus(Bill.Id billId, String agent, BillStatus status) {
         var now = clock.instant().atZone(ZoneOffset.UTC);
         committedBills.values().stream()
                 .flatMap(List::stream)
@@ -238,6 +238,6 @@ public class MockBillingController implements BillingController {
     private Bill emptyBill() {
         var start = clock.instant().atZone(ZoneOffset.UTC);
         var end = clock.instant().atZone(ZoneOffset.UTC);
-        return new Bill(Bill.Id.of("empty"), TenantName.defaultName(), Bill.StatusHistory.open(clock), List.of(), start, end);
+        return new Bill(Bill.Id.of("empty"), TenantName.defaultName(), StatusHistory.open(clock), List.of(), start, end);
     }
 }
diff --git a/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/billing/StatusHistory.java b/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/billing/StatusHistory.java
new file mode 100644
index 00000000000..6335ada1396
--- /dev/null
+++ b/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/billing/StatusHistory.java
@@ -0,0 +1,35 @@
+package com.yahoo.vespa.hosted.controller.api.integration.billing;
+
+import java.time.Clock;
+import java.time.ZoneOffset;
+import java.time.ZonedDateTime;
+import java.util.Map;
+import java.util.SortedMap;
+import java.util.TreeMap;
+
+/**
+ * @author ogronnesby
+ */
+public class StatusHistory {
+    SortedMap<ZonedDateTime, BillStatus> history;
+
+    public StatusHistory(SortedMap<ZonedDateTime, BillStatus> history) {
+        this.history = history;
+    }
+
+    public static StatusHistory open(Clock clock) {
+        var now = clock.instant().atZone(ZoneOffset.UTC);
+        return new StatusHistory(
+                new TreeMap<>(Map.of(now, BillStatus.OPEN))
+        );
+    }
+
+    public BillStatus current() {
+        return history.get(history.lastKey());
+    }
+
+    public SortedMap<ZonedDateTime, BillStatus> getHistory() {
+        return history;
+    }
+
+}
diff --git a/controller-api/src/test/java/com/yahoo/vespa/hosted/controller/api/integration/billing/BillStatusTest.java b/controller-api/src/test/java/com/yahoo/vespa/hosted/controller/api/integration/billing/BillStatusTest.java
new file mode 100644
index 00000000000..9647a11a4ba
--- /dev/null
+++ b/controller-api/src/test/java/com/yahoo/vespa/hosted/controller/api/integration/billing/BillStatusTest.java
@@ -0,0 +1,18 @@
+package com.yahoo.vespa.hosted.controller.api.integration.billing;
+
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+/**
+ * @author gjoranv
+ */
+public class BillStatusTest {
+
+    @Test
+    void legacy_states_are_converted() {
+        assertEquals(BillStatus.OPEN, BillStatus.from("ISSUED"));
+        assertEquals(BillStatus.OPEN, BillStatus.from("EXPORTED"));
+    }
+
+}