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>

src/main/java/net/hostsharing/hsadminng/config/JsonObjectMapperConfiguration.java

@@ -1,6 +1,7 @@
 package net.hostsharing.hsadminng.config;
 
 import com.fasterxml.jackson.core.JsonParser;
+import com.fasterxml.jackson.databind.DeserializationFeature;
 import com.fasterxml.jackson.databind.SerializationFeature;
 import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
 import org.openapitools.jackson.nullable.JsonNullableModule;
@@ -9,15 +10,20 @@ import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Primary;
 import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder;
 
+
 @Configuration
 public class JsonObjectMapperConfiguration {
 
     @Bean
     @Primary
     public Jackson2ObjectMapperBuilder customObjectMapper() {
+        // HOWTO: add JSON converters and specify other JSON mapping configurations
         return new Jackson2ObjectMapperBuilder()
                 .modules(new JsonNullableModule(), new JavaTimeModule())
-                .featuresToEnable(JsonParser.Feature.ALLOW_COMMENTS, JsonParser.Feature.ALLOW_COMMENTS)
+                .featuresToEnable(
+                        JsonParser.Feature.ALLOW_COMMENTS,
+                        DeserializationFeature.USE_BIG_DECIMAL_FOR_FLOATS
+                )
                 .featuresToDisable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
     }
 }

src/main/java/net/hostsharing/hsadminng/errors/CustomErrorResponse.java

@@ -46,6 +46,7 @@ public class CustomErrorResponse {
         this.path = path;
         this.statusCode = status.value();
         this.statusPhrase = status.getReasonPhrase();
+        // HOWTO: debug serverside error response - set a breakpoint here
         this.message = message.startsWith("ERROR: [") ? message : "ERROR: [" + statusCode + "] " + message;
     }
 }

src/main/java/net/hostsharing/hsadminng/hs/office/coopassets/HsOfficeCoopAssetsTransactionController.java

@@ -36,7 +36,7 @@ public class HsOfficeCoopAssetsTransactionController implements HsOfficeCoopAsse
 
     @Override
     @Transactional(readOnly = true)
-    public ResponseEntity<List<HsOfficeCoopAssetsTransactionResource>> listCoopAssets(
+    public ResponseEntity<List<HsOfficeCoopAssetsTransactionResource>> getListOfCoopAssets(
             final String currentSubject,
             final String assumedRoles,
             final UUID membershipUuid,
@@ -55,7 +55,7 @@ public class HsOfficeCoopAssetsTransactionController implements HsOfficeCoopAsse
 
     @Override
     @Transactional
-    public ResponseEntity<HsOfficeCoopAssetsTransactionResource> addCoopAssetsTransaction(
+    public ResponseEntity<HsOfficeCoopAssetsTransactionResource> postNewCoopAssetTransaction(
             final String currentSubject,
             final String assumedRoles,
             final HsOfficeCoopAssetsTransactionInsertResource requestBody) {
@@ -77,7 +77,7 @@ public class HsOfficeCoopAssetsTransactionController implements HsOfficeCoopAsse
 
     @Override
     @Transactional(readOnly = true)
-    public ResponseEntity<HsOfficeCoopAssetsTransactionResource> getCoopAssetTransactionByUuid(
+    public ResponseEntity<HsOfficeCoopAssetsTransactionResource> getSingleCoopAssetTransactionByUuid(
         final String currentSubject, final String assumedRoles, final UUID assetTransactionUuid) {
 
         context.define(currentSubject, assumedRoles);
@@ -128,9 +128,9 @@ public class HsOfficeCoopAssetsTransactionController implements HsOfficeCoopAsse
     }
 
     final BiConsumer<HsOfficeCoopAssetsTransactionInsertResource, HsOfficeCoopAssetsTransactionEntity> RESOURCE_TO_ENTITY_POSTMAPPER = (resource, entity) -> {
-        if ( resource.getReverseEntryUuid() != null ) {
-            entity.setAdjustedAssetTx(coopAssetsTransactionRepo.findByUuid(resource.getReverseEntryUuid())
-                    .orElseThrow(() -> new EntityNotFoundException("ERROR: [400] reverseEntityUuid %s not found".formatted(resource.getReverseEntryUuid()))));
+        if ( resource.getRevertedAssetTxUuid() != null ) {
+            entity.setRevertedAssetTx(coopAssetsTransactionRepo.findByUuid(resource.getRevertedAssetTxUuid())
+                    .orElseThrow(() -> new EntityNotFoundException("ERROR: [400] reverseEntityUuid %s not found".formatted(resource.getRevertedAssetTxUuid()))));
         }
     };
 };

src/main/java/net/hostsharing/hsadminng/hs/office/coopassets/HsOfficeCoopAssetsTransactionEntity.java

@@ -50,8 +50,8 @@ public class HsOfficeCoopAssetsTransactionEntity implements Stringifyable, BaseE
             .withProp(HsOfficeCoopAssetsTransactionEntity::getAssetValue)
             .withProp(HsOfficeCoopAssetsTransactionEntity::getReference)
             .withProp(HsOfficeCoopAssetsTransactionEntity::getComment)
-            .withProp(at -> ofNullable(at.getAdjustedAssetTx()).map(HsOfficeCoopAssetsTransactionEntity::toShortString).orElse(null))
-            .withProp(at -> ofNullable(at.getAdjustmentAssetTx()).map(HsOfficeCoopAssetsTransactionEntity::toShortString).orElse(null))
+            .withProp(at -> ofNullable(at.getRevertedAssetTx()).map(HsOfficeCoopAssetsTransactionEntity::toShortString).orElse(null))
+            .withProp(at -> ofNullable(at.getReversalAssetTx()).map(HsOfficeCoopAssetsTransactionEntity::toShortString).orElse(null))
             .quotedValues(false);
 
     @Id
@@ -77,7 +77,7 @@ public class HsOfficeCoopAssetsTransactionEntity implements Stringifyable, BaseE
      * The signed value which directly affects the booking balance.
      *
      * <p>This means, that a DEPOSIT is always positive, a DISBURSAL is always negative,
-     * but an ADJUSTMENT can bei either positive or negative.
+     * but an REVERSAL can bei either positive or negative.
      * See {@link HsOfficeCoopAssetsTransactionType} for</p> more information.
      */
     @Column(name = "assetvalue")
@@ -96,14 +96,14 @@ public class HsOfficeCoopAssetsTransactionEntity implements Stringifyable, BaseE
     private String comment;
 
     /**
-     * Optionally, the UUID of the corresponding transaction for an adjustment transaction.
+     * Optionally, the UUID of the corresponding transaction for an reversal transaction.
      */
     @OneToOne
-    @JoinColumn(name = "adjustedassettxuuid")
-    private HsOfficeCoopAssetsTransactionEntity adjustedAssetTx;
+    @JoinColumn(name = "revertedassettxuuid")
+    private HsOfficeCoopAssetsTransactionEntity revertedAssetTx;
 
-    @OneToOne(mappedBy = "adjustedAssetTx")
-    private HsOfficeCoopAssetsTransactionEntity adjustmentAssetTx;
+    @OneToOne(mappedBy = "revertedAssetTx")
+    private HsOfficeCoopAssetsTransactionEntity reversalAssetTx;
 
     @Override
     public HsOfficeCoopAssetsTransactionEntity load() {

src/main/java/net/hostsharing/hsadminng/hs/office/coopassets/HsOfficeCoopAssetsTransactionType.java

@@ -4,7 +4,7 @@ public enum HsOfficeCoopAssetsTransactionType {
     /**
      * correction of wrong bookings, value can be positive or negative
      */
-    ADJUSTMENT,
+    REVERSAL,
 
     /**
      * payment received from member after signing shares, value >0

src/main/java/net/hostsharing/hsadminng/hs/office/coopshares/HsOfficeCoopSharesTransactionController.java

@@ -38,7 +38,7 @@ public class HsOfficeCoopSharesTransactionController implements HsOfficeCoopShar
 
     @Override
     @Transactional(readOnly = true)
-    public ResponseEntity<List<HsOfficeCoopSharesTransactionResource>> listCoopShares(
+    public ResponseEntity<List<HsOfficeCoopSharesTransactionResource>> getListOfCoopShares(
             final String currentSubject,
             final String assumedRoles,
             final UUID membershipUuid,
@@ -57,7 +57,7 @@ public class HsOfficeCoopSharesTransactionController implements HsOfficeCoopShar
 
     @Override
     @Transactional
-    public ResponseEntity<HsOfficeCoopSharesTransactionResource> addCoopSharesTransaction(
+    public ResponseEntity<HsOfficeCoopSharesTransactionResource> postNewCoopSharesTransaction(
             final String currentSubject,
             final String assumedRoles,
             final HsOfficeCoopSharesTransactionInsertResource requestBody) {
@@ -80,7 +80,7 @@ public class HsOfficeCoopSharesTransactionController implements HsOfficeCoopShar
 
     @Override
     @Transactional(readOnly = true)
-    public ResponseEntity<HsOfficeCoopSharesTransactionResource> getCoopShareTransactionByUuid(
+    public ResponseEntity<HsOfficeCoopSharesTransactionResource> getSingleCoopShareTransactionByUuid(
         final String currentSubject, final String assumedRoles, final UUID shareTransactionUuid) {
 
             context.define(currentSubject, assumedRoles);
@@ -131,9 +131,9 @@ public class HsOfficeCoopSharesTransactionController implements HsOfficeCoopShar
     }
 
     final BiConsumer<HsOfficeCoopSharesTransactionInsertResource, HsOfficeCoopSharesTransactionEntity> RESOURCE_TO_ENTITY_POSTMAPPER = (resource, entity) -> {
-        if ( resource.getAdjustedShareTxUuid() != null ) {
-            entity.setAdjustedShareTx(coopSharesTransactionRepo.findByUuid(resource.getAdjustedShareTxUuid())
-                .orElseThrow(() -> new EntityNotFoundException("ERROR: [400] adjustedShareTxUuid %s not found".formatted(resource.getAdjustedShareTxUuid()))));
+        if ( resource.getRevertedShareTxUuid() != null ) {
+            entity.setRevertedShareTx(coopSharesTransactionRepo.findByUuid(resource.getRevertedShareTxUuid())
+                .orElseThrow(() -> new EntityNotFoundException("ERROR: [400] revertedShareTxUuid %s not found".formatted(resource.getRevertedShareTxUuid()))));
         }
     };
 }

src/main/java/net/hostsharing/hsadminng/hs/office/coopshares/HsOfficeCoopSharesTransactionEntity.java

@@ -48,8 +48,8 @@ public class HsOfficeCoopSharesTransactionEntity implements Stringifyable, BaseE
             .withProp(HsOfficeCoopSharesTransactionEntity::getShareCount)
             .withProp(HsOfficeCoopSharesTransactionEntity::getReference)
             .withProp(HsOfficeCoopSharesTransactionEntity::getComment)
-            .withProp(at -> ofNullable(at.getAdjustedShareTx()).map(HsOfficeCoopSharesTransactionEntity::toShortString).orElse(null))
-            .withProp(at -> ofNullable(at.getAdjustmentShareTx()).map(HsOfficeCoopSharesTransactionEntity::toShortString).orElse(null))
+            .withProp(at -> ofNullable(at.getRevertedShareTx()).map(HsOfficeCoopSharesTransactionEntity::toShortString).orElse(null))
+            .withProp(at -> ofNullable(at.getReversalShareTx()).map(HsOfficeCoopSharesTransactionEntity::toShortString).orElse(null))
         .quotedValues(false);
 
     @Id
@@ -71,7 +71,7 @@ public class HsOfficeCoopSharesTransactionEntity implements Stringifyable, BaseE
      * The signed value which directly affects the booking balance.
      *
      * <p>This means, that a SUBSCRIPTION is always positive, a CANCELLATION is always negative,
-     * but an ADJUSTMENT can bei either positive or negative.
+     * but an REVERSAL can bei either positive or negative.
      * See {@link HsOfficeCoopSharesTransactionType} for</p> more information.
      */
     @Column(name = "valuedate")
@@ -93,14 +93,14 @@ public class HsOfficeCoopSharesTransactionEntity implements Stringifyable, BaseE
     private String comment;
 
     /**
-     * Optionally, the UUID of the corresponding transaction for an adjustment transaction.
+     * Optionally, the UUID of the corresponding transaction for a REVERSAL transaction.
      */
     @OneToOne
-    @JoinColumn(name = "adjustedsharetxuuid")
-    private HsOfficeCoopSharesTransactionEntity adjustedShareTx;
+    @JoinColumn(name = "revertedsharetxuuid")
+    private HsOfficeCoopSharesTransactionEntity revertedShareTx;
 
-    @OneToOne(mappedBy = "adjustedShareTx")
-    private HsOfficeCoopSharesTransactionEntity adjustmentShareTx;
+    @OneToOne(mappedBy = "revertedShareTx")
+    private HsOfficeCoopSharesTransactionEntity reversalShareTx;
 
     @Override
     public HsOfficeCoopSharesTransactionEntity load() {

src/main/java/net/hostsharing/hsadminng/hs/office/coopshares/HsOfficeCoopSharesTransactionType.java

@@ -2,9 +2,9 @@ package net.hostsharing.hsadminng.hs.office.coopshares;
 
 public enum HsOfficeCoopSharesTransactionType {
     /**
-     * correction of wrong bookings, with either positive or negative value
+     * reversal of wrong bookings, with either positive or negative value identical to reversed transaction
      */
-    ADJUSTMENT,
+    REVERSAL,
 
     /**
      * shares signed, e.g. with the declaration of accession, value >0

src/main/java/net/hostsharing/hsadminng/hs/office/membership/HsOfficeMembershipController.java

@@ -16,6 +16,8 @@ import java.util.List;
 import java.util.UUID;
 import java.util.function.BiConsumer;
 
+import static java.util.Optional.ofNullable;
+
 @RestController
 
 public class HsOfficeMembershipController implements HsOfficeMembershipsApi {
@@ -39,7 +41,7 @@ public class HsOfficeMembershipController implements HsOfficeMembershipsApi {
         context.define(currentSubject, assumedRoles);
 
         final var entities = ( memberNumber != null)
-                    ? List.of(membershipRepo.findMembershipByMemberNumber(memberNumber))
+                    ? ofNullable(membershipRepo.findMembershipByMemberNumber(memberNumber)).stream().toList()
                     : membershipRepo.findMembershipsByOptionalPartnerUuid(partnerUuid);
 
         final var resources = mapper.mapList(entities, HsOfficeMembershipResource.class,

src/main/java/net/hostsharing/hsadminng/hs/office/membership/HsOfficeMembershipRepository.java

@@ -14,14 +14,16 @@ public interface HsOfficeMembershipRepository extends Repository<HsOfficeMembers
 
     HsOfficeMembershipEntity save(final HsOfficeMembershipEntity entity);
 
+    List<HsOfficeMembershipEntity> findAll();
 
     @Query("""
             SELECT membership FROM HsOfficeMembershipEntity membership
                 WHERE ( CAST(:partnerUuid as org.hibernate.type.UUIDCharType) IS NULL
                         OR membership.partner.uuid = :partnerUuid )
                 ORDER BY membership.partner.partnerNumber, membership.memberNumberSuffix
-               """)
+            """)
     List<HsOfficeMembershipEntity> findMembershipsByOptionalPartnerUuid(UUID partnerUuid);
+
     @Query("""
             SELECT membership FROM HsOfficeMembershipEntity membership
                 WHERE (:partnerNumber = membership.partner.partnerNumber) 
@@ -31,10 +33,12 @@ public interface HsOfficeMembershipRepository extends Repository<HsOfficeMembers
     HsOfficeMembershipEntity findMembershipByPartnerNumberAndSuffix(
             @NotNull Integer partnerNumber,
             @NotNull String suffix);
+
     default HsOfficeMembershipEntity findMembershipByMemberNumber(Integer memberNumber) {
         final var partnerNumber = memberNumber / 100;
-        final var suffix = memberNumber % 100;
-        return findMembershipByPartnerNumberAndSuffix(partnerNumber, String.format("%02d", suffix));
+        final String suffix = String.format("%02d", memberNumber % 100);
+        final var result = findMembershipByPartnerNumberAndSuffix(partnerNumber, suffix);
+        return result;
     }
 
     long count();

src/main/java/net/hostsharing/hsadminng/hs/office/partner/HsOfficePartnerController.java

@@ -143,6 +143,7 @@ public class HsOfficePartnerController implements HsOfficePartnersApi {
 
     private void optionallyCreateExPartnerRelation(final HsOfficePartnerEntity saved, final HsOfficeRelationRealEntity previousPartnerRel) {
         if (!saved.getPartnerRel().getUuid().equals(previousPartnerRel.getUuid())) {
+            // TODO.impl: we also need to use the new partner-person as the anchor
             relationRepo.save(previousPartnerRel.toBuilder().uuid(null).type(EX_PARTNER).build());
         }
     }

src/main/java/net/hostsharing/hsadminng/hs/office/person/HsOfficePersonTypeConverter.java

@@ -4,6 +4,7 @@ import jakarta.persistence.AttributeConverter;
 import jakarta.persistence.Converter;
 import java.util.stream.Stream;
 
+// HOWTO: convert data types for exchange between PostgreSQL and Java/Hibernate/JPA-Entities
 @Converter(autoApply = true)
 public class HsOfficePersonTypeConverter implements AttributeConverter<HsOfficePersonType, String> {
 

src/main/java/net/hostsharing/hsadminng/system/SystemProcess.java

@@ -14,6 +14,7 @@ public class SystemProcess {
 
     @Getter
     private String stdOut;
+
     @Getter
     private String stdErr;
 
@@ -21,7 +22,6 @@ public class SystemProcess {
         this.processBuilder = new ProcessBuilder(command);
     }
 
-
     public String getCommand() {
         return processBuilder.command().toString();
     }