FIN-350 add exporting of opening balances for liability accounts to the export of profile.

Author: gjong

bpmn-process/src/main/java/com/jongsoft/finance/serialized/ExportJson.java

@@ -20,5 +20,6 @@ public class ExportJson implements Serializable {
     private List<BudgetJson> budgetPeriods;
     private List<ContractJson> contracts;
     private List<String> tags;
+    private List<TransactionJson> transactions;
 
 }

bpmn-process/src/main/java/com/jongsoft/finance/serialized/TransactionJson.java

@@ -0,0 +1,41 @@
+package com.jongsoft.finance.serialized;
+
+import com.jongsoft.finance.domain.transaction.Transaction;
+import io.micronaut.serde.annotation.Serdeable;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Getter;
+
+import java.io.Serializable;
+import java.time.LocalDate;
+
+@Builder
+@Getter
+@Serdeable
+@AllArgsConstructor
+public class TransactionJson implements Serializable {
+
+    private final String fromAccount;
+    private final String toAccount;
+
+    private final String description;
+    private final String currency;
+    private final double amount;
+
+    private final LocalDate date;
+    private final LocalDate interestDate;
+    private final LocalDate bookDate;
+
+    public static TransactionJson fromDomain(Transaction transaction) {
+        return TransactionJson.builder()
+                .fromAccount(transaction.computeFrom().getName())
+                .toAccount(transaction.computeTo().getName())
+                .description(transaction.getDescription())
+                .currency(transaction.getCurrency())
+                .amount(transaction.computeAmount(transaction.computeFrom()))
+                .date(transaction.getDate())
+                .interestDate(transaction.getInterestDate())
+                .bookDate(transaction.getBookDate())
+                .build();
+    }
+}

bpmn-process/src/main/resources/schema/profile.schema.json

@@ -39,6 +39,12 @@
       "items": {
         "type": "string"
       }
+    },
+    "transactions": {
+      "type": "array",
+      "items": {
+        "$ref": "https://www.pledger.io/schemas/transaction.schema.json"
+      }
     }
   }
 }

bpmn-process/src/main/resources/schema/transaction.schema.json

@@ -0,0 +1,44 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://www.pledger.io/schemas/transaction.schema.json",
+  "title": "Transaction",
+  "type": "object",
+  "properties": {
+    "date": {
+      "type": "string",
+      "format": "date",
+      "description": "The date of the transaction."
+    },
+    "interestDate": {
+      "type": "string",
+      "format": "date",
+      "description": "The interest date of the transaction."
+    },
+    "bookDate": {
+      "type": "string",
+      "format": "date",
+      "description": "The book date of the transaction."
+    },
+    "amount": {
+      "type": "number",
+      "description": "The amount of the transaction."
+    },
+    "currency": {
+      "type": "string",
+      "description": "The currency of the transaction."
+    },
+    "description": {
+      "type": "string",
+      "description": "The description of the transaction."
+    },
+    "fromAccount": {
+      "type": "string",
+      "description": "The account from which the transaction was made."
+    },
+    "toAccount": {
+      "type": "string",
+      "description": "The account to which the transaction was made."
+    }
+  },
+  "required": ["date", "amount", "currency", "description", "fromAccount", "toAccount"]
+}

fintrack-api/src/main/java/com/jongsoft/finance/rest/profile/ProfileExportResource.java

@@ -9,7 +9,9 @@
 import com.jongsoft.finance.domain.transaction.TransactionRule;
 import com.jongsoft.finance.domain.user.Budget;
 import com.jongsoft.finance.domain.user.Category;
+import com.jongsoft.finance.factory.FilterFactory;
 import com.jongsoft.finance.providers.DataProvider;
+import com.jongsoft.finance.providers.TransactionProvider;
 import com.jongsoft.finance.security.AuthenticationFacade;
 import com.jongsoft.finance.serialized.*;
 import com.jongsoft.lang.Collections;
@@ -37,6 +39,8 @@ public class ProfileExportResource {
     private final List<Exportable<?>> exportable;
     private final List<DataProvider<?>> dataProviders;
     private final StorageService storageService;
+    private final TransactionProvider transactionProvider;
+    private final FilterFactory filterFactory;
 
     @Get
     @Operation(
@@ -65,14 +69,15 @@ public HttpResponse<ExportJson> export() {
                                 rule,
                                 this::loadRelation))
                         .toJava())
+                .transactions(lookupRelevantTransactions())
                 .build();
 
         return HttpResponse.ok(exportJson)
                 .header(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"" + exportFileName + "\"")
                 .header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON);
     }
 
-    @SuppressWarnings("unchecked")
+    @SuppressWarnings({"unchecked", "rawtypes"})
     private <T> Sequence<T> lookupAllOf(Class<T> forClass) {
         for (Exportable exporter : exportable) {
             if (exporter.supports(forClass)) {
@@ -83,7 +88,21 @@ private <T> Sequence<T> lookupAllOf(Class<T> forClass) {
         return Collections.List();
     }
 
-    @SuppressWarnings("unchecked")
+    private List<TransactionJson> lookupRelevantTransactions() {
+        // we also want to export all opening balance transactions for liability accounts
+        var filter = filterFactory.transaction()
+                .page(0)
+                .pageSize(Integer.MAX_VALUE)
+                .onlyIncome(false)
+                .description("Opening balance", true);
+
+        return transactionProvider.lookup(filter)
+                .content()
+                .map(TransactionJson::fromDomain)
+                .toJava();
+    }
+
+    @SuppressWarnings({"unchecked", "rawtypes"})
     private String loadRelation(RuleColumn column, String value) {
         if (column == RuleColumn.TAGS) {
             return value;

fintrack-api/src/test/java/com/jongsoft/finance/rest/profile/ProfileExportResourceTest.java

@@ -1,18 +1,35 @@
 package com.jongsoft.finance.rest.profile;
 
+import com.jongsoft.finance.ResultPage;
+import com.jongsoft.finance.providers.TransactionProvider;
 import com.jongsoft.finance.rest.TestSetup;
+import io.micronaut.context.annotation.Replaces;
 import io.micronaut.http.HttpHeaders;
-import io.micronaut.test.extensions.junit5.annotation.MicronautTest;
+import io.micronaut.test.annotation.MockBean;
 import io.restassured.specification.RequestSpecification;
+import jakarta.inject.Inject;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
+import org.mockito.Mockito;
 
 @DisplayName("Profile export resource")
 class ProfileExportResourceTest extends TestSetup {
 
+    @Replaces
+    @MockBean
+    TransactionProvider transactionProvider() {
+        return Mockito.mock(TransactionProvider.class);
+    }
+
+    @Inject
+    private TransactionProvider transactionProvider;
+
     @Test
     @DisplayName("should export profile")
     void export(RequestSpecification spec) {
+        Mockito.when(transactionProvider.lookup(Mockito.any(TransactionProvider.FilterCommand.class)))
+                        .thenReturn(ResultPage.of());
+
         // @formatter:off
         spec.when()
                 .get("/api/profile/export")