OfficeScenarioTests CoopShares+Assets (#121)

Co-authored-by: Michael Hoennig <michael@hoennig.de> Reviewed-on: https://dev.hostsharing.net/hostsharing/hs.hsadmin.ng/pulls/121 Reviewed-by: Marc Sandlus <marc.sandlus@hostsharing.net>
2024-11-15 11:54:18 +01:00
parent 8f410198e9
commit c98a5acb38
56 changed files with 836 additions and 247 deletions
--- 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
@@ -6,7 +6,7 @@ components:
        HsOfficeCoopAssetsTransactionType:
            type: string
            enum:
-                - ADJUSTMENT
+                - REVERSAL
                - DEPOSIT
                - DISBURSAL
                - TRANSFER
@@ -32,15 +32,15 @@ components:
                    type: string
                comment:
                    type: string
-                adjustedAssetTx:
+                revertedAssetTx:
                    $ref: '#/components/schemas/HsOfficeReferencedCoopAssetsTransaction'
-                adjustmentAssetTx:
+                reversalAssetTx:
                    $ref: '#/components/schemas/HsOfficeReferencedCoopAssetsTransaction'

        HsOfficeReferencedCoopAssetsTransaction:
            description:
                Similar to `HsOfficeCoopAssetsTransaction` but without the self-referencing properties 
-                (`adjustedAssetTx` and `adjustmentAssetTx`), to avoid recursive JSON.
+                (`revertedAssetTx` and `reversalAssetTx`), to avoid recursive JSON.
            type: object
            properties:
                uuid:
@@ -80,7 +80,7 @@ components:
                    maxLength: 48
                comment:
                    type: string
-                reverseEntry.uuid:
+                revertedAssetTx.uuid:
                    type: string
                    format: uuid
            required:
--- a/src/main/resources/api-definition/hs-office/hs-office-coopassets-with-uuid.yaml
+++ b/src/main/resources/api-definition/hs-office/hs-office-coopassets-with-uuid.yaml
@@ -2,7 +2,7 @@ get:
    tags:
        - hs-office-coopAssets
    description: 'Fetch a single asset transaction by its uuid, if visible for the current subject.'
-    operationId: getCoopAssetTransactionByUuid
+    operationId: getSingleCoopAssetTransactionByUuid
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
--- a/src/main/resources/api-definition/hs-office/hs-office-coopassets.yaml
+++ b/src/main/resources/api-definition/hs-office/hs-office-coopassets.yaml
@@ -3,7 +3,7 @@ get:
  description: Returns the list of (optionally filtered) cooperative asset transactions which are visible to the current subject or any of it's assumed roles.
  tags:
    - hs-office-coopAssets
-  operationId: listCoopAssets
+  operationId: getListOfCoopAssets
  parameters:
    - $ref: 'auth.yaml#/components/parameters/currentSubject'
    - $ref: 'auth.yaml#/components/parameters/assumedRoles'
@@ -46,7 +46,7 @@ post:
  summary: Adds a new cooperative asset transaction.
  tags:
    - hs-office-coopAssets
-  operationId: addCoopAssetsTransaction
+  operationId: postNewCoopAssetTransaction
  parameters:
    - $ref: 'auth.yaml#/components/parameters/currentSubject'
    - $ref: 'auth.yaml#/components/parameters/assumedRoles'
--- a/src/main/resources/api-definition/hs-office/hs-office-coopshares-schemas.yaml
+++ b/src/main/resources/api-definition/hs-office/hs-office-coopshares-schemas.yaml
@@ -6,7 +6,7 @@ components:
        HsOfficeCoopSharesTransactionType:
            type: string
            enum:
-                - ADJUSTMENT
+                - REVERSAL
                - SUBSCRIPTION
                - CANCELLATION

@@ -27,15 +27,15 @@ components:
                    type: string
                comment:
                    type: string
-                adjustedShareTx:
+                revertedShareTx:
                    $ref: '#/components/schemas/HsOfficeReferencedCoopSharesTransaction'
-                adjustmentShareTx:
+                reversalShareTx:
                    $ref: '#/components/schemas/HsOfficeReferencedCoopSharesTransaction'

        HsOfficeReferencedCoopSharesTransaction:
            description:
                Similar to `HsOfficeCoopSharesTransaction` but without the self-referencing properties
-                (`adjustedShareTx` and `adjustmentShareTx`), to avoid recursive JSON.
+                (`revertedShareTx` and `reversalShareTx`), to avoid recursive JSON.
            type: object
            properties:
                uuid:
@@ -73,7 +73,7 @@ components:
                    maxLength: 48
                comment:
                    type: string
-                adjustedShareTx.uuid:
+                revertedShareTx.uuid:
                    type: string
                    format: uuid
            required:
--- a/src/main/resources/api-definition/hs-office/hs-office-coopshares-with-uuid.yaml
+++ b/src/main/resources/api-definition/hs-office/hs-office-coopshares-with-uuid.yaml
@@ -2,7 +2,7 @@ get:
    tags:
        - hs-office-coopShares
    description: 'Fetch a single share transaction by its uuid, if visible for the current subject.'
-    operationId: getCoopShareTransactionByUuid
+    operationId: getSingleCoopShareTransactionByUuid
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
--- a/src/main/resources/api-definition/hs-office/hs-office-coopshares.yaml
+++ b/src/main/resources/api-definition/hs-office/hs-office-coopshares.yaml
@@ -3,7 +3,7 @@ get:
  description: Returns the list of (optionally filtered) cooperative share transactions which are visible to the current subject or any of it's assumed roles.
  tags:
    - hs-office-coopShares
-  operationId: listCoopShares
+  operationId: getListOfCoopShares
  parameters:
    - $ref: 'auth.yaml#/components/parameters/currentSubject'
    - $ref: 'auth.yaml#/components/parameters/assumedRoles'
@@ -46,7 +46,7 @@ post:
  summary: Adds a new cooperative share transaction.
  tags:
    - hs-office-coopShares
-  operationId: addCoopSharesTransaction
+  operationId: postNewCoopSharesTransaction
  parameters:
    - $ref: 'auth.yaml#/components/parameters/currentSubject'
    - $ref: 'auth.yaml#/components/parameters/assumedRoles'
--- a/src/main/resources/db/changelog/5-hs-office/503-relation/5030-hs-office-relation.sql
+++ b/src/main/resources/db/changelog/5-hs-office/503-relation/5030-hs-office-relation.sql
@@ -28,6 +28,9 @@ create table if not exists hs_office.relation
 );
 --//

+-- TODO.impl: unique constraint, to prevent using the same person multiple times as a partner, or better:
+--          ( anchorUuid,  holderUuid, type)
+

 -- ============================================================================
 --changeset michael.hoennig:hs-office-relation-MAIN-TABLE-JOURNAL endDelimiter:--//
--- a/src/main/resources/db/changelog/5-hs-office/511-coopshares/5110-hs-office-coopshares.sql
+++ b/src/main/resources/db/changelog/5-hs-office/511-coopshares/5110-hs-office-coopshares.sql
@@ -4,7 +4,7 @@
 --changeset michael.hoennig:hs-office-coopshares-MAIN-TABLE endDelimiter:--//
 -- ----------------------------------------------------------------------------

-CREATE TYPE hs_office.CoopSharesTransactionType AS ENUM ('ADJUSTMENT', 'SUBSCRIPTION', 'CANCELLATION');
+CREATE TYPE hs_office.CoopSharesTransactionType AS ENUM ('REVERSAL', 'SUBSCRIPTION', 'CANCELLATION');

 CREATE CAST (character varying as hs_office.CoopSharesTransactionType) WITH INOUT AS IMPLICIT;

@@ -17,7 +17,7 @@ create table if not exists hs_office.coopsharetx
    valueDate       date not null,
    shareCount      integer not null,
    reference       varchar(48) not null,
-    adjustedShareTxUuid uuid unique REFERENCES hs_office.coopsharetx(uuid) DEFERRABLE INITIALLY DEFERRED,
+    revertedShareTxUuid uuid unique REFERENCES hs_office.coopsharetx(uuid) DEFERRABLE INITIALLY DEFERRED,
    comment         varchar(512)
 );
 --//
@@ -28,8 +28,8 @@ create table if not exists hs_office.coopsharetx

 alter table hs_office.coopsharetx
    add constraint reverse_entry_missing
-        check ( transactionType = 'ADJUSTMENT' and adjustedShareTxUuid is not null
-             or transactionType <> 'ADJUSTMENT' and adjustedShareTxUuid is null);
+        check ( transactionType = 'REVERSAL' and revertedShareTxUuid is not null
+             or transactionType <> 'REVERSAL' and revertedShareTxUuid is null);
 --//

 -- ============================================================================
--- a/src/main/resources/db/changelog/5-hs-office/511-coopshares/5118-hs-office-coopshares-test-data.sql
+++ b/src/main/resources/db/changelog/5-hs-office/511-coopshares/5118-hs-office-coopshares-test-data.sql
@@ -27,12 +27,12 @@ begin
    raise notice 'creating test coopSharesTransaction: %', givenPartnerNumber::text || givenMemberNumberSuffix;
    subscriptionEntryUuid := uuid_generate_v4();
    insert
-        into hs_office.coopsharetx(uuid, membershipuuid, transactiontype, valuedate, sharecount, reference, comment, adjustedShareTxUuid)
+        into hs_office.coopsharetx(uuid, membershipuuid, transactiontype, valuedate, sharecount, reference, comment, revertedShareTxUuid)
        values
            (uuid_generate_v4(), membership.uuid, 'SUBSCRIPTION', '2010-03-15', 4, 'ref '||givenPartnerNumber::text || givenMemberNumberSuffix||'-1', 'initial subscription', null),
            (uuid_generate_v4(), membership.uuid, 'CANCELLATION', '2021-09-01', -2, 'ref '||givenPartnerNumber::text || givenMemberNumberSuffix||'-2', 'cancelling some', null),
            (subscriptionEntryUuid,       membership.uuid, 'SUBSCRIPTION',    '2022-10-20',  2, 'ref '||givenPartnerNumber::text || givenMemberNumberSuffix||'-3', 'some subscription', null),
-            (uuid_generate_v4(), membership.uuid, 'ADJUSTMENT', '2022-10-21', -2, 'ref '||givenPartnerNumber::text || givenMemberNumberSuffix||'-4', 'some adjustment', subscriptionEntryUuid);
+            (uuid_generate_v4(), membership.uuid, 'REVERSAL', '2022-10-21', -2, 'ref '||givenPartnerNumber::text || givenMemberNumberSuffix||'-4', 'some reversal', subscriptionEntryUuid);
 end; $$;
 --//

--- 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
@@ -4,7 +4,7 @@
 --changeset michael.hoennig:hs-office-coopassets-MAIN-TABLE endDelimiter:--//
 -- ----------------------------------------------------------------------------

-CREATE TYPE hs_office.CoopAssetsTransactionType AS ENUM ('ADJUSTMENT',
+CREATE TYPE hs_office.CoopAssetsTransactionType AS ENUM ('REVERSAL',
                                                       'DEPOSIT',
                                                       'DISBURSAL',
                                                       'TRANSFER',
@@ -22,9 +22,9 @@ create table if not exists hs_office.coopassettx
    membershipUuid      uuid not null references hs_office.membership(uuid),
    transactionType     hs_office.CoopAssetsTransactionType not null,
    valueDate           date not null,
-    assetValue          money not null,
+    assetValue          numeric(12,2) not null, -- https://wiki.postgresql.org/wiki/Don't_Do_This#Don.27t_use_money
    reference           varchar(48) not null,
-    adjustedAssetTxUuid uuid unique REFERENCES hs_office.coopassettx(uuid) DEFERRABLE INITIALLY DEFERRED,
+    revertedAssetTxUuid uuid unique REFERENCES hs_office.coopassettx(uuid) DEFERRABLE INITIALLY DEFERRED,
    comment             varchar(512)
 );
 --//
@@ -36,20 +36,20 @@ create table if not exists hs_office.coopassettx

 alter table hs_office.coopassettx
    add constraint reverse_entry_missing
-        check ( transactionType = 'ADJUSTMENT' and adjustedAssetTxUuid is not null
-             or transactionType <> 'ADJUSTMENT' and adjustedAssetTxUuid is null);
+        check ( transactionType = 'REVERSAL' and revertedAssetTxUuid is not null
+             or transactionType <> 'REVERSAL' and revertedAssetTxUuid is null);
 --//

 -- ============================================================================
 --changeset michael.hoennig:hs-office-coopassets-ASSET-VALUE-CONSTRAINT endDelimiter:--//
 -- ----------------------------------------------------------------------------

-create or replace function hs_office.coopassetstx_check_positive_total(forMembershipUuid UUID, newAssetValue money)
+create or replace function hs_office.coopassetstx_check_positive_total(forMembershipUuid UUID, newAssetValue numeric(12, 5))
 returns boolean
 language plpgsql as $$
 declare
-    currentAssetValue money;
-    totalAssetValue money;
+    currentAssetValue numeric(12,2);
+    totalAssetValue numeric(12,2);
 begin
    select sum(cat.assetValue)
        from hs_office.coopassettx cat
--- 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
@@ -27,12 +27,12 @@ begin
    raise notice 'creating test coopAssetsTransaction: %', givenPartnerNumber || givenMemberNumberSuffix;
    lossEntryUuid := uuid_generate_v4();
    insert
-        into hs_office.coopassettx(uuid, membershipuuid, transactiontype, valuedate, assetvalue, reference, comment, adjustedAssetTxUuid)
+        into hs_office.coopassettx(uuid, membershipuuid, transactiontype, valuedate, assetvalue, reference, comment, revertedAssetTxUuid)
        values
            (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, 'DEPOSIT',    '2022-10-20',  128.00, 'ref '||givenPartnerNumber || givenMemberNumberSuffix||'-3', 'some loss', null),
-            (uuid_generate_v4(),  membership.uuid, 'ADJUSTMENT', '2022-10-21', -128.00, 'ref '||givenPartnerNumber || givenMemberNumberSuffix||'-3', 'some adjustment', lossEntryUuid);
+            (uuid_generate_v4(),  membership.uuid, 'REVERSAL', '2022-10-21', -128.00, 'ref '||givenPartnerNumber || givenMemberNumberSuffix||'-3', 'some reversal', lossEntryUuid);
 end; $$;
 --//