From 82cd5a9ac6f7b99698f926cd4a823a13e2aab87f Mon Sep 17 00:00:00 2001 From: Michael Hoennig Date: Tue, 9 Apr 2024 10:07:46 +0200 Subject: [PATCH] coop assets transaction with reverse entry --- ...OfficeCoopAssetsTransactionController.java | 18 +++-- .../HsOfficeCoopAssetsTransactionEntity.java | 2 +- .../office/debitor/HsOfficeDebitorEntity.java | 1 + .../hs-office-coopassets-schemas.yaml | 27 +++++++ .../5120-hs-office-coopassets.sql | 2 +- .../5128-hs-office-coopassets-test-data.sql | 18 +++-- ...tsTransactionControllerAcceptanceTest.java | 72 ++++++++++++++++++- ...sTransactionRepositoryIntegrationTest.java | 21 +++--- .../hs/office/migration/ImportOfficeData.java | 21 +++--- 9 files changed, 150 insertions(+), 32 deletions(-) diff --git a/src/main/java/net/hostsharing/hsadminng/hs/office/coopassets/HsOfficeCoopAssetsTransactionController.java b/src/main/java/net/hostsharing/hsadminng/hs/office/coopassets/HsOfficeCoopAssetsTransactionController.java index add8333c..f72a855d 100644 --- a/src/main/java/net/hostsharing/hsadminng/hs/office/coopassets/HsOfficeCoopAssetsTransactionController.java +++ b/src/main/java/net/hostsharing/hsadminng/hs/office/coopassets/HsOfficeCoopAssetsTransactionController.java @@ -2,8 +2,7 @@ package net.hostsharing.hsadminng.hs.office.coopassets; import net.hostsharing.hsadminng.context.Context; import net.hostsharing.hsadminng.hs.office.generated.api.v1.api.HsOfficeCoopAssetsApi; -import net.hostsharing.hsadminng.hs.office.generated.api.v1.model.HsOfficeCoopAssetsTransactionInsertResource; -import net.hostsharing.hsadminng.hs.office.generated.api.v1.model.HsOfficeCoopAssetsTransactionResource; +import net.hostsharing.hsadminng.hs.office.generated.api.v1.model.*; import net.hostsharing.hsadminng.mapper.Mapper; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.format.annotation.DateTimeFormat; @@ -13,11 +12,13 @@ import org.springframework.transaction.annotation.Transactional; import org.springframework.web.bind.annotation.RestController; import org.springframework.web.servlet.mvc.method.annotation.MvcUriComponentsBuilder; +import jakarta.persistence.EntityNotFoundException; import jakarta.validation.ValidationException; import java.time.LocalDate; import java.util.ArrayList; import java.util.List; import java.util.UUID; +import java.util.function.BiConsumer; import static java.lang.String.join; import static net.hostsharing.hsadminng.hs.office.generated.api.v1.model.HsOfficeCoopAssetsTransactionTypeResource.*; @@ -63,8 +64,11 @@ public class HsOfficeCoopAssetsTransactionController implements HsOfficeCoopAsse context.define(currentUser, assumedRoles); validate(requestBody); - final var entityToSave = mapper.map(requestBody, HsOfficeCoopAssetsTransactionEntity.class); + final var entityToSave = mapper.map(requestBody, HsOfficeCoopAssetsTransactionEntity.class, RESOURCE_TO_ENTITY_POSTMAPPER); + if (entityToSave.getReverseEntry() != null) { + entityToSave.getReverseEntry().setReverseEntry(entityToSave); + } final var saved = coopAssetsTransactionRepo.save(entityToSave); final var uri = @@ -131,4 +135,10 @@ public class HsOfficeCoopAssetsTransactionController implements HsOfficeCoopAsse } } -} + final BiConsumer RESOURCE_TO_ENTITY_POSTMAPPER = (resource, entity) -> { + if ( resource.getReverseEntryUuid() != null ) { + entity.setReverseEntry(coopAssetsTransactionRepo.findByUuid(resource.getReverseEntryUuid()) + .orElseThrow(() -> new EntityNotFoundException("ERROR: [400] reverseEntityUuid %s not found".formatted(resource.getReverseEntryUuid())))); + } + }; +}; diff --git a/src/main/java/net/hostsharing/hsadminng/hs/office/coopassets/HsOfficeCoopAssetsTransactionEntity.java b/src/main/java/net/hostsharing/hsadminng/hs/office/coopassets/HsOfficeCoopAssetsTransactionEntity.java index 8959c962..18e1f886 100644 --- a/src/main/java/net/hostsharing/hsadminng/hs/office/coopassets/HsOfficeCoopAssetsTransactionEntity.java +++ b/src/main/java/net/hostsharing/hsadminng/hs/office/coopassets/HsOfficeCoopAssetsTransactionEntity.java @@ -95,7 +95,7 @@ public class HsOfficeCoopAssetsTransactionEntity implements Stringifyable, RbacO private String comment; /** - * Optionally, the corresponding transaction for an adjustment transaction, + * Optionally, the UUID of the corresponding transaction for an adjustment transaction, * linked in both directions. */ @OneToOne diff --git a/src/main/java/net/hostsharing/hsadminng/hs/office/debitor/HsOfficeDebitorEntity.java b/src/main/java/net/hostsharing/hsadminng/hs/office/debitor/HsOfficeDebitorEntity.java index 7a2cb1ec..51df906f 100644 --- a/src/main/java/net/hostsharing/hsadminng/hs/office/debitor/HsOfficeDebitorEntity.java +++ b/src/main/java/net/hostsharing/hsadminng/hs/office/debitor/HsOfficeDebitorEntity.java @@ -26,6 +26,7 @@ import jakarta.persistence.Id; import jakarta.persistence.JoinColumn; import jakarta.persistence.ManyToOne; import jakarta.persistence.Table; +import jakarta.persistence.Version; import jakarta.validation.constraints.Pattern; import java.io.IOException; import java.util.UUID; diff --git a/src/main/resources/api-definition/hs-office/hs-office-coopassets-schemas.yaml b/src/main/resources/api-definition/hs-office/hs-office-coopassets-schemas.yaml index adfcc9e8..a11e11ef 100644 --- a/src/main/resources/api-definition/hs-office/hs-office-coopassets-schemas.yaml +++ b/src/main/resources/api-definition/hs-office/hs-office-coopassets-schemas.yaml @@ -32,6 +32,30 @@ components: type: string comment: type: string + reverseEntry: + $ref: '#/components/schemas/HsOfficeCoopAssetsTransactionReverse' + + HsOfficeCoopAssetsTransactionReverse: + description: + Similar to `HsOfficeCoopAssetsTransaction` but without the `reverseEntry`, + otherwise the JSON would be recursive. + type: object + properties: + uuid: + type: string + format: uuid + transactionType: + $ref: '#/components/schemas/HsOfficeCoopAssetsTransactionType' + assetValue: + type: number + format: currency + valueDate: + type: string + format: date + reference: + type: string + comment: + type: string HsOfficeCoopAssetsTransactionInsert: type: object @@ -54,6 +78,9 @@ components: maxLength: 48 comment: type: string + reverseEntryUuid: + type: string + format: uuid required: - membershipUuid - transactionType diff --git a/src/main/resources/db/changelog/5-hs-office/512-coopassets/5120-hs-office-coopassets.sql b/src/main/resources/db/changelog/5-hs-office/512-coopassets/5120-hs-office-coopassets.sql index 29ac74f8..587eb641 100644 --- a/src/main/resources/db/changelog/5-hs-office/512-coopassets/5120-hs-office-coopassets.sql +++ b/src/main/resources/db/changelog/5-hs-office/512-coopassets/5120-hs-office-coopassets.sql @@ -24,7 +24,7 @@ create table if not exists hs_office_coopassetstransaction valueDate date not null, assetValue money not null, reference varchar(48) not null, - reverseEntryUuid uuid references hs_office_coopassetstransaction (uuid), + reverseEntryUuid uuid references hs_office_coopassetstransaction (uuid) deferrable , comment varchar(512) ); --// diff --git a/src/main/resources/db/changelog/5-hs-office/512-coopassets/5128-hs-office-coopassets-test-data.sql b/src/main/resources/db/changelog/5-hs-office/512-coopassets/5128-hs-office-coopassets-test-data.sql index d54e77ca..7bedc7c5 100644 --- a/src/main/resources/db/changelog/5-hs-office/512-coopassets/5128-hs-office-coopassets-test-data.sql +++ b/src/main/resources/db/changelog/5-hs-office/512-coopassets/5128-hs-office-coopassets-test-data.sql @@ -14,11 +14,14 @@ create or replace procedure createHsOfficeCoopAssetsTransactionTestData( ) language plpgsql as $$ declare - currentTask varchar; - membership hs_office_membership; + currentTask varchar; + membership hs_office_membership; + lossEntryUuid uuid; + adjustmentEntryUuid uuid; begin currentTask = 'creating coopAssetsTransaction test-data ' || givenPartnerNumber || givenMemberNumberSuffix; execute format('set local hsadminng.currentTask to %L', currentTask); + SET CONSTRAINTS ALL DEFERRED; call defineContext(currentTask); select m.uuid @@ -29,12 +32,15 @@ begin into membership; raise notice 'creating test coopAssetsTransaction: %', givenPartnerNumber || givenMemberNumberSuffix; + lossEntryUuid := uuid_generate_v4(); + adjustmentEntryUuid := uuid_generate_v4(); insert - into hs_office_coopassetstransaction(uuid, membershipuuid, transactiontype, valuedate, assetvalue, reference, comment) + into hs_office_coopassetstransaction(uuid, membershipuuid, transactiontype, valuedate, assetvalue, reference, comment, reverseEntryUuid) values - (uuid_generate_v4(), membership.uuid, 'DEPOSIT', '2010-03-15', 320.00, 'ref '||givenPartnerNumber || givenMemberNumberSuffix||'-1', 'initial deposit'), - (uuid_generate_v4(), membership.uuid, 'DISBURSAL', '2021-09-01', -128.00, 'ref '||givenPartnerNumber || givenMemberNumberSuffix||'-2', 'partial disbursal'), - (uuid_generate_v4(), membership.uuid, 'ADJUSTMENT', '2022-10-20', 128.00, 'ref '||givenPartnerNumber || givenMemberNumberSuffix||'-3', 'some adjustment'); + (uuid_generate_v4(), membership.uuid, 'DEPOSIT', '2010-03-15', 320.00, 'ref '||givenPartnerNumber || givenMemberNumberSuffix||'-1', 'initial deposit', null), + (uuid_generate_v4(), membership.uuid, 'DISBURSAL', '2021-09-01', -128.00, 'ref '||givenPartnerNumber || givenMemberNumberSuffix||'-2', 'partial disbursal', null), + (lossEntryUuid, membership.uuid, 'LOSS', '2022-10-20', -128.00, 'ref '||givenPartnerNumber || givenMemberNumberSuffix||'-3', 'some loss', adjustmentEntryUuid), + (adjustmentEntryUuid, membership.uuid, 'ADJUSTMENT', '2022-10-21', 128.00, 'ref '||givenPartnerNumber || givenMemberNumberSuffix||'-3', 'some adjustment', lossEntryUuid); end; $$; --// diff --git a/src/test/java/net/hostsharing/hsadminng/hs/office/coopassets/HsOfficeCoopAssetsTransactionControllerAcceptanceTest.java b/src/test/java/net/hostsharing/hsadminng/hs/office/coopassets/HsOfficeCoopAssetsTransactionControllerAcceptanceTest.java index 2c9a811d..64393d52 100644 --- a/src/test/java/net/hostsharing/hsadminng/hs/office/coopassets/HsOfficeCoopAssetsTransactionControllerAcceptanceTest.java +++ b/src/test/java/net/hostsharing/hsadminng/hs/office/coopassets/HsOfficeCoopAssetsTransactionControllerAcceptanceTest.java @@ -22,6 +22,7 @@ import jakarta.persistence.PersistenceContext; import java.time.LocalDate; import java.util.UUID; +import static net.hostsharing.hsadminng.hs.office.coopassets.HsOfficeCoopAssetsTransactionType.LOSS; import static net.hostsharing.test.IsValidUuidMatcher.isUuidValid; import static net.hostsharing.test.JsonMatcher.lenientlyEquals; import static org.assertj.core.api.Assertions.assertThat; @@ -69,7 +70,7 @@ class HsOfficeCoopAssetsTransactionControllerAcceptanceTest extends ContextBased .then().log().all().assertThat() .statusCode(200) .contentType("application/json") - .body("", hasSize(9)); // @formatter:on + .body("", hasSize(12)); // @formatter:on } @Test @@ -103,10 +104,17 @@ class HsOfficeCoopAssetsTransactionControllerAcceptanceTest extends ContextBased "reference": "ref 1000202-2", "comment": "partial disbursal" }, + { + "transactionType": "LOSS", + "assetValue": -128.00, + "valueDate": "2022-10-20", + "reference": "ref 1000202-3", + "comment": "some loss" + }, { "transactionType": "ADJUSTMENT", "assetValue": 128.00, - "valueDate": "2022-10-20", + "valueDate": "2022-10-21", "reference": "ref 1000202-3", "comment": "some adjustment" } @@ -193,6 +201,66 @@ class HsOfficeCoopAssetsTransactionControllerAcceptanceTest extends ContextBased assertThat(newUserUuid).isNotNull(); } + @Test + void globalAdmin_canAddCoopAssetsAdjustmentTransaction() { + + context.define("superuser-alex@hostsharing.net"); + final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000101); + final var givenTransaction = coopAssetsTransactionRepo.findCoopAssetsTransactionByOptionalMembershipUuidAndDateRange(givenMembership.getUuid(), null, null) + .stream().filter(at -> at.getTransactionType() == LOSS) + .findFirst() + .orElseThrow(); + + final var location = RestAssured // @formatter:off + .given() + .header("current-user", "superuser-alex@hostsharing.net") + .contentType(ContentType.JSON) + .body(""" + { + "membershipUuid": "%s", + "transactionType": "ADJUSTMENT", + "assetValue": %s, + "valueDate": "2022-10-30", + "reference": "temp ref A", + "comment": "some coop assets adjustment transaction", + "reverseEntryUuid": "%s" + } + """.formatted( + givenMembership.getUuid(), + givenTransaction.getAssetValue().negate().toString(), + givenTransaction.getUuid())) + .port(port) + .when() + .post("http://localhost/api/hs/office/coopassetstransactions") + .then().log().all().assertThat() + .statusCode(201) + .contentType(ContentType.JSON) + .body("uuid", isUuidValid()) + .body("", lenientlyEquals(""" + { + "transactionType": "ADJUSTMENT", + "assetValue": 128.00, + "valueDate": "2022-10-30", + "reference": "temp ref A", + "comment": "some coop assets adjustment transaction", + "reverseEntry": { + "transactionType": "LOSS", + "assetValue": -128.00, + "valueDate": "2022-10-20", + "reference": "ref 1000101-3", + "comment": "some loss" + } + } + """.formatted(givenTransaction.getUuid()))) + .header("Location", startsWith("http://localhost")) + .extract().header("Location"); // @formatter:on + + // finally, the new coopAssetsTransaction can be accessed under the generated UUID + final var newUserUuid = UUID.fromString( + location.substring(location.lastIndexOf('/') + 1)); + assertThat(newUserUuid).isNotNull(); + } + @Test void globalAdmin_canNotCancelMoreAssetsThanCurrentlySubscribed() { diff --git a/src/test/java/net/hostsharing/hsadminng/hs/office/coopassets/HsOfficeCoopAssetsTransactionRepositoryIntegrationTest.java b/src/test/java/net/hostsharing/hsadminng/hs/office/coopassets/HsOfficeCoopAssetsTransactionRepositoryIntegrationTest.java index 978e2081..4f8c20b5 100644 --- a/src/test/java/net/hostsharing/hsadminng/hs/office/coopassets/HsOfficeCoopAssetsTransactionRepositoryIntegrationTest.java +++ b/src/test/java/net/hostsharing/hsadminng/hs/office/coopassets/HsOfficeCoopAssetsTransactionRepositoryIntegrationTest.java @@ -127,7 +127,7 @@ class HsOfficeCoopAssetsTransactionRepositoryIntegrationTest extends ContextBase class FindAllCoopAssetsTransactions { @Test - public void globalAdmin_anViewAllCoopAssetsTransactions() { + public void globalAdmin_canViewAllCoopAssetsTransactions() { // given context("superuser-alex@hostsharing.net"); @@ -138,19 +138,22 @@ class HsOfficeCoopAssetsTransactionRepositoryIntegrationTest extends ContextBase null); // then - allTheseCoopAssetsTransactionsAreReturned( + exactlyTheseCoopAssetsTransactionsAreReturned( result, "CoopAssetsTransaction(M-1000101: 2010-03-15, DEPOSIT, 320.00, ref 1000101-1, initial deposit)", "CoopAssetsTransaction(M-1000101: 2021-09-01, DISBURSAL, -128.00, ref 1000101-2, partial disbursal)", - "CoopAssetsTransaction(M-1000101: 2022-10-20, ADJUSTMENT, 128.00, ref 1000101-3, some adjustment)", + "CoopAssetsTransaction(M-1000101: 2022-10-20, LOSS, -128.00, ref 1000101-3, some loss, M-1000101:+128.00)", + "CoopAssetsTransaction(M-1000101: 2022-10-21, ADJUSTMENT, 128.00, ref 1000101-3, some adjustment, M-1000101:-128.00)", "CoopAssetsTransaction(M-1000202: 2010-03-15, DEPOSIT, 320.00, ref 1000202-1, initial deposit)", "CoopAssetsTransaction(M-1000202: 2021-09-01, DISBURSAL, -128.00, ref 1000202-2, partial disbursal)", - "CoopAssetsTransaction(M-1000202: 2022-10-20, ADJUSTMENT, 128.00, ref 1000202-3, some adjustment)", + "CoopAssetsTransaction(M-1000202: 2022-10-20, LOSS, -128.00, ref 1000202-3, some loss, M-1000202:+128.00)", + "CoopAssetsTransaction(M-1000202: 2022-10-21, ADJUSTMENT, 128.00, ref 1000202-3, some adjustment, M-1000202:-128.00)", "CoopAssetsTransaction(M-1000303: 2010-03-15, DEPOSIT, 320.00, ref 1000303-1, initial deposit)", "CoopAssetsTransaction(M-1000303: 2021-09-01, DISBURSAL, -128.00, ref 1000303-2, partial disbursal)", - "CoopAssetsTransaction(M-1000303: 2022-10-20, ADJUSTMENT, 128.00, ref 1000303-3, some adjustment)"); + "CoopAssetsTransaction(M-1000303: 2022-10-20, LOSS, -128.00, ref 1000303-3, some loss, M-1000303:+128.00)", + "CoopAssetsTransaction(M-1000303: 2022-10-21, ADJUSTMENT, 128.00, ref 1000303-3, some adjustment, M-1000303:-128.00)"); } @Test @@ -166,11 +169,12 @@ class HsOfficeCoopAssetsTransactionRepositoryIntegrationTest extends ContextBase null); // then - allTheseCoopAssetsTransactionsAreReturned( + exactlyTheseCoopAssetsTransactionsAreReturned( result, "CoopAssetsTransaction(M-1000202: 2010-03-15, DEPOSIT, 320.00, ref 1000202-1, initial deposit)", "CoopAssetsTransaction(M-1000202: 2021-09-01, DISBURSAL, -128.00, ref 1000202-2, partial disbursal)", - "CoopAssetsTransaction(M-1000202: 2022-10-20, ADJUSTMENT, 128.00, ref 1000202-3, some adjustment)"); + "CoopAssetsTransaction(M-1000202: 2022-10-20, LOSS, -128.00, ref 1000202-3, some loss, M-1000202:+128.00)", + "CoopAssetsTransaction(M-1000202: 2022-10-21, ADJUSTMENT, 128.00, ref 1000202-3, some adjustment, M-1000202:-128.00)"); } @Test @@ -207,7 +211,8 @@ class HsOfficeCoopAssetsTransactionRepositoryIntegrationTest extends ContextBase result, "CoopAssetsTransaction(M-1000101: 2010-03-15, DEPOSIT, 320.00, ref 1000101-1, initial deposit)", "CoopAssetsTransaction(M-1000101: 2021-09-01, DISBURSAL, -128.00, ref 1000101-2, partial disbursal)", - "CoopAssetsTransaction(M-1000101: 2022-10-20, ADJUSTMENT, 128.00, ref 1000101-3, some adjustment)"); + "CoopAssetsTransaction(M-1000101: 2022-10-20, LOSS, -128.00, ref 1000101-3, some loss, M-1000101:+128.00)", + "CoopAssetsTransaction(M-1000101: 2022-10-21, ADJUSTMENT, 128.00, ref 1000101-3, some adjustment, M-1000101:-128.00)"); } } diff --git a/src/test/java/net/hostsharing/hsadminng/hs/office/migration/ImportOfficeData.java b/src/test/java/net/hostsharing/hsadminng/hs/office/migration/ImportOfficeData.java index fb51e8c8..47e5a6ba 100644 --- a/src/test/java/net/hostsharing/hsadminng/hs/office/migration/ImportOfficeData.java +++ b/src/test/java/net/hostsharing/hsadminng/hs/office/migration/ImportOfficeData.java @@ -387,16 +387,16 @@ public class ImportOfficeData extends ContextBasedTest { assertThat(toFormattedString(coopAssets)).isEqualToIgnoringWhitespace(""" { - 30000=CoopAssetsTransaction(M-1001700: 2000-12-06, DEPOSIT, 1280.00, for subscription A), - 31000=CoopAssetsTransaction(M-1002000: 2000-12-06, DEPOSIT, 128.00, for subscription B), - 32000=CoopAssetsTransaction(M-1001700: 2005-01-10, DEPOSIT, 2560.00, for subscription C), - 33001=CoopAssetsTransaction(M-1001700: 2005-01-10, TRANSFER, -512.00, for transfer to 10), - 33002=CoopAssetsTransaction(M-1002000: 2005-01-10, ADOPTION, 512.00, for transfer from 7), - 34001=CoopAssetsTransaction(M-1002000: 2016-12-31, CLEARING, -8.00, for cancellation D), - 34002=CoopAssetsTransaction(M-1002000: 2016-12-31, DISBURSAL, -100.00, for cancellation D), - 34003=CoopAssetsTransaction(M-1002000: 2016-12-31, LOSS, -20.00, for cancellation D), - 35001=CoopAssetsTransaction(M-1909000: 2024-01-15, DEPOSIT, 128.00, for subscription E), - 35002=CoopAssetsTransaction(M-1909000: 2024-01-20, ADJUSTMENT, -128.00, chargeback for subscription E) + 30000=CoopAssetsTransaction(M-1001700: 2000-12-06, DEPOSIT, 1280.00, legacy data import, for subscription A), + 31000=CoopAssetsTransaction(M-1002000: 2000-12-06, DEPOSIT, 128.00, legacy data import, for subscription B), + 32000=CoopAssetsTransaction(M-1001700: 2005-01-10, DEPOSIT, 2560.00, legacy data import, for subscription C), + 33001=CoopAssetsTransaction(M-1001700: 2005-01-10, TRANSFER, -512.00, legacy data import, for transfer to 10), + 33002=CoopAssetsTransaction(M-1002000: 2005-01-10, ADOPTION, 512.00, legacy data import, for transfer from 7), + 34001=CoopAssetsTransaction(M-1002000: 2016-12-31, CLEARING, -8.00, legacy data import, for cancellation D), + 34002=CoopAssetsTransaction(M-1002000: 2016-12-31, DISBURSAL, -100.00, legacy data import, for cancellation D), + 34003=CoopAssetsTransaction(M-1002000: 2016-12-31, LOSS, -20.00, legacy data import, for cancellation D), + 35001=CoopAssetsTransaction(M-1909000: 2024-01-15, DEPOSIT, 128.00, legacy data import, for subscription E), + 35002=CoopAssetsTransaction(M-1909000: 2024-01-20, ADJUSTMENT, -128.00, legacy data import, chargeback for subscription E) } """); } @@ -849,6 +849,7 @@ public class ImportOfficeData extends ContextBasedTest { .transactionType(assetTypeMapping.get(rec.getString("action"))) .assetValue(rec.getBigDecimal("amount")) .comment(rec.getString("comment")) + .reference("legacy data import") // TODO.spec: or use value from comment column? .build(); coopAssets.put(rec.getInteger("member_asset_id"), assetTransaction);