aboutsummaryrefslogtreecommitdiffstats
path: root/controller-server
diff options
context:
space:
mode:
authorgjoranv <gjoranv@gmail.com>2023-10-27 12:04:44 +0200
committergjoranv <gjoranv@gmail.com>2023-10-30 13:20:49 +0100
commit1dd6e2d1f9de204ab341ffcaec53ceffb5696955 (patch)
tree9e6abb274439e34c7525540bfa960b6be1a3693c /controller-server
parente5f53beca8c5e69f4656c424f0ef1963b75ccd48 (diff)
Handle bills whose invoice has been deleted in the external system.
- Reset their exported id in the database. - Stop maintaining such bills for following runs. - Propagate a more refined "invoice update" up from billing reporter. - Improve mocks to enable more thorough testing.
Diffstat (limited to 'controller-server')
-rw-r--r--controller-server/src/main/java/com/yahoo/vespa/hosted/controller/maintenance/BillingReportMaintainer.java26
-rw-r--r--controller-server/src/test/java/com/yahoo/vespa/hosted/controller/integration/ServiceRegistryMock.java3
-rw-r--r--controller-server/src/test/java/com/yahoo/vespa/hosted/controller/maintenance/BillingReportMaintainerTest.java53
3 files changed, 68 insertions, 14 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 7868c3fe611..a755e2145b0 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,17 +5,21 @@ 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;
+import com.yahoo.vespa.hosted.controller.api.integration.billing.FailedInvoiceUpdate;
import com.yahoo.vespa.hosted.controller.api.integration.billing.InvoiceUpdate;
+import com.yahoo.vespa.hosted.controller.api.integration.billing.ModifiableInvoiceUpdate;
import com.yahoo.vespa.hosted.controller.api.integration.billing.Plan;
import com.yahoo.vespa.hosted.controller.api.integration.billing.PlanRegistry;
import com.yahoo.vespa.hosted.controller.tenant.CloudTenant;
import com.yahoo.vespa.hosted.controller.tenant.Tenant;
import java.time.Duration;
+import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Set;
@@ -63,17 +67,31 @@ public class BillingReportMaintainer extends ControllerMaintainer {
});
}
- InvoiceUpdate maintainInvoices() {
+ List<InvoiceUpdate> maintainInvoices() {
+ var updates = new ArrayList<InvoiceUpdate>();
+
var billsNeedingMaintenance = databaseClient.readBills().stream()
.filter(bill -> bill.getExportedId().isPresent())
.filter(exported -> exported.status() == BillStatus.OPEN)
.toList();
- var updates = new InvoiceUpdate.Counter();
for (var bill : billsNeedingMaintenance) {
- updates.add(reporter.maintainInvoice(bill));
+ var exportedId = bill.getExportedId().orElseThrow();
+ var update = reporter.maintainInvoice(bill);
+ if (update instanceof ModifiableInvoiceUpdate modifiable && ! modifiable.isEmpty()) {
+ log.fine(invoiceMessage(bill.id(), exportedId) + " was updated with " + modifiable.itemsUpdate());
+ } else if (update instanceof FailedInvoiceUpdate failed && failed.reason == FailedInvoiceUpdate.Reason.REMOVED) {
+ log.fine(invoiceMessage(bill.id(), exportedId) + " has been deleted in the external system");
+ // Reset the exportedId to null, so that we don't maintain it again
+ databaseClient.setExportedInvoiceId(bill.id(), null);
+ }
+ updates.add(update);
}
- return updates.finish();
+ return updates;
+ }
+
+ private String invoiceMessage(Bill.Id billId, String invoiceId) {
+ return "Invoice '" + invoiceId + "' for bill '" + billId.value() + "'";
}
private Map<TenantName, CloudTenant> cloudTenants() {
diff --git a/controller-server/src/test/java/com/yahoo/vespa/hosted/controller/integration/ServiceRegistryMock.java b/controller-server/src/test/java/com/yahoo/vespa/hosted/controller/integration/ServiceRegistryMock.java
index 39d867d813d..2d1f06f3602 100644
--- a/controller-server/src/test/java/com/yahoo/vespa/hosted/controller/integration/ServiceRegistryMock.java
+++ b/controller-server/src/test/java/com/yahoo/vespa/hosted/controller/integration/ServiceRegistryMock.java
@@ -100,6 +100,7 @@ public class ServiceRegistryMock extends AbstractComponent implements ServiceReg
private final PlanRegistry planRegistry = new PlanRegistryMock();
private final ResourceDatabaseClient resourceDb = new ResourceDatabaseClientMock(planRegistry);
private final BillingDatabaseClient billingDb = new BillingDatabaseClientMock(clock, planRegistry);
+ private final BillingReporterMock billingReporter = new BillingReporterMock(clock, billingDb);
private final MockBillingController billingController = new MockBillingController(clock, billingDb);
private final RoleMaintainerMock roleMaintainer = new RoleMaintainerMock();
@@ -325,7 +326,7 @@ public class ServiceRegistryMock extends AbstractComponent implements ServiceReg
@Override
public BillingReporter billingReporter() {
- return new BillingReporterMock(clock(), billingDb);
+ return billingReporter;
}
}
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 5cb46664a75..91e08fb168e 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
@@ -5,7 +5,9 @@ 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.BillingReporterMock;
+import com.yahoo.vespa.hosted.controller.api.integration.billing.FailedInvoiceUpdate;
+import com.yahoo.vespa.hosted.controller.api.integration.billing.ModifiableInvoiceUpdate;
import com.yahoo.vespa.hosted.controller.api.integration.billing.PlanRegistryMock;
import com.yahoo.vespa.hosted.controller.tenant.BillingReference;
import com.yahoo.vespa.hosted.controller.tenant.CloudTenant;
@@ -46,7 +48,6 @@ public class BillingReportMaintainerTest {
@Test
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);
@@ -57,25 +58,59 @@ public class BillingReportMaintainerTest {
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 reporter = tester.controller().serviceRegistry().billingReporter();
+ reporter.exportBill(billingDb.readBill(bill2).get(), "FOO", cloudTenant(t1));
+ reporter.exportBill(billingDb.readBill(bill3).get(), "FOO", cloudTenant(t1));
var updates = maintainer.maintainInvoices();
- assertEquals(new InvoiceUpdate(1, 0, 0), updates);
assertTrue(billingDb.readBill(bill1).get().getExportedId().isEmpty());
+ // Only the exported open bill is maintained
+ assertEquals(1, updates.size());
+ assertEquals(bill2, updates.get(0).billId());
+ assertEquals(ModifiableInvoiceUpdate.class, updates.get(0).getClass());
var exportedBill = billingDb.readBill(bill2).get();
- assertEquals("EXT-ID-123", exportedBill.getExportedId().get());
+ assertEquals("EXPORTED-" + exportedBill.id().value(), exportedBill.getExportedId().get());
+ // Verify that the bill has been updated with a marker line item by the mock
var lineItems = exportedBill.lineItems();
assertEquals(1, lineItems.size());
assertEquals("maintained", lineItems.get(0).id());
+ // The frozen bill is untouched by the maintainer
var frozenBill = billingDb.readBill(bill3).get();
- assertEquals("EXT-ID-123", frozenBill.getExportedId().get());
+ assertEquals("EXPORTED-" + frozenBill.id().value(), frozenBill.getExportedId().get());
assertEquals(0, frozenBill.lineItems().size());
+ }
+
+ @Test
+ void bills_whose_invoice_has_been_deleted_in_the_external_system_are_no_longer_maintained() {
+ var t1 = tester.createTenant("t1");
+ 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, "exported-then-deleted");
+
+ var reporter = (BillingReporterMock)tester.controller().serviceRegistry().billingReporter();
+ reporter.exportBill(billingDb.readBill(bill1).get(), "FOO", cloudTenant(t1));
+
+ var updates = maintainer.maintainInvoices();
+ assertEquals(1, updates.size());
+ assertEquals(ModifiableInvoiceUpdate.class, updates.get(0).getClass());
+
+ // Delete invoice from the external system
+ reporter.deleteExportedBill(bill1);
+
+ // Maintainer should report that the invoice has been removed
+ updates = maintainer.maintainInvoices();
+ assertEquals(1, updates.size());
+ assertEquals(FailedInvoiceUpdate.class, updates.get(0).getClass());
+ assertEquals(FailedInvoiceUpdate.Reason.REMOVED, ((FailedInvoiceUpdate)updates.get(0)).reason);
+ // The bill should no longer be maintained
+ updates = maintainer.maintainInvoices();
+ assertEquals(0, updates.size());
}
private CloudTenant cloudTenant(TenantName tenantName) {