From c7b17ee546229648e697c7f37280df3f07cc919f Mon Sep 17 00:00:00 2001 From: Michael Hoennig Date: Wed, 11 Dec 2024 10:55:15 +0100 Subject: [PATCH 1/3] bugfix: permit access to Swagger UI (#134) Co-authored-by: Michael Hoennig Reviewed-on: https://dev.hostsharing.net/hostsharing/hs.hsadmin.ng/pulls/134 Reviewed-by: Marc Sandlus --- .../hsadminng/config/WebSecurityConfig.java | 3 ++- .../config/WebSecurityConfigIntegrationTest.java | 14 ++++++++++++++ 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/src/main/java/net/hostsharing/hsadminng/config/WebSecurityConfig.java b/src/main/java/net/hostsharing/hsadminng/config/WebSecurityConfig.java index 3585dd8c..6da383ab 100644 --- a/src/main/java/net/hostsharing/hsadminng/config/WebSecurityConfig.java +++ b/src/main/java/net/hostsharing/hsadminng/config/WebSecurityConfig.java @@ -17,10 +17,11 @@ public class WebSecurityConfig { return http .authorizeHttpRequests(authorize -> authorize .requestMatchers("/api/**").permitAll() // TODO.impl: implement authentication + .requestMatchers("/swagger-ui/**").permitAll() + .requestMatchers("/v3/api-docs/**").permitAll() .requestMatchers("/actuator/**").permitAll() .anyRequest().authenticated() ) .build(); } - } diff --git a/src/test/java/net/hostsharing/hsadminng/config/WebSecurityConfigIntegrationTest.java b/src/test/java/net/hostsharing/hsadminng/config/WebSecurityConfigIntegrationTest.java index 8b2bf3a0..a69ca9f4 100644 --- a/src/test/java/net/hostsharing/hsadminng/config/WebSecurityConfigIntegrationTest.java +++ b/src/test/java/net/hostsharing/hsadminng/config/WebSecurityConfigIntegrationTest.java @@ -42,6 +42,20 @@ class WebSecurityConfigIntegrationTest { assertThat(result.getStatusCode()).isEqualTo(HttpStatus.OK); } + @Test + public void shouldSupportSwaggerUi() { + final var result = this.restTemplate.getForEntity( + "http://localhost:" + this.managementPort + "/swagger-ui/index.html", String.class); + assertThat(result.getStatusCode()).isEqualTo(HttpStatus.OK); + } + + @Test + public void shouldSupportApiDocs() { + final var result = this.restTemplate.getForEntity( + "http://localhost:" + this.managementPort + "/v3/api-docs/swagger-config", String.class); + assertThat(result.getStatusCode()).isEqualTo(HttpStatus.NOT_FOUND); // permitted but not configured + } + @Test public void shouldSupportHealthEndpoint() { final var result = this.restTemplate.getForEntity( From 19fac6b5e128e7a05d0dddeec10dce44e56f5482 Mon Sep 17 00:00:00 2001 From: Michael Hoennig Date: Wed, 11 Dec 2024 11:35:51 +0100 Subject: [PATCH 2/3] http-get endpoints for partner, debitor and memberhip-number (#135) Co-authored-by: Michael Hoennig Reviewed-on: https://dev.hostsharing.net/hostsharing/hs.hsadmin.ng/pulls/135 Reviewed-by: Marc Sandlus --- .../hsadminng/errors/Validate.java | 23 +++ ...OfficeCoopAssetsTransactionController.java | 9 +- .../debitor/HsOfficeDebitorController.java | 28 +++- .../debitor/HsOfficeDebitorRepository.java | 19 ++- .../HsOfficeMembershipController.java | 46 ++++-- .../HsOfficeMembershipRepository.java | 19 ++- .../partner/HsOfficePartnerController.java | 17 ++ .../partner/HsOfficePartnerRepository.java | 2 +- .../hs-office/api-mappings.yaml | 1 + .../hs-office-coopassets-schemas.yaml | 6 - .../hs-office/hs-office-debitor-schemas.yaml | 2 - ...hs-office-debitors-with-debitorNumber.yaml | 29 ++++ .../hs-office/hs-office-debitors.yaml | 15 +- .../hs-office-membership-schemas.yaml | 10 +- ...ice-memberships-with-membershipNumber.yaml | 29 ++++ .../hs-office/hs-office-memberships.yaml | 8 +- .../hs-office/hs-office-partner-schemas.yaml | 4 - ...hs-office-partners-with-partnerNumber.yaml | 28 ++++ .../api-definition/hs-office/hs-office.yaml | 9 + .../hsadminng/errors/ValidateUnitTest.java | 31 ++++ ...sBookingItemRepositoryIntegrationTest.java | 4 +- ...tsTransactionControllerAcceptanceTest.java | 10 +- ...opAssetsTransactionControllerRestTest.java | 2 +- ...sTransactionRepositoryIntegrationTest.java | 8 +- ...esTransactionControllerAcceptanceTest.java | 10 +- ...sTransactionRepositoryIntegrationTest.java | 8 +- ...OfficeDebitorControllerAcceptanceTest.java | 106 +++++++++--- ...fficeDebitorRepositoryIntegrationTest.java | 41 +++-- ...iceMembershipControllerAcceptanceTest.java | 52 +++--- .../HsOfficeMembershipControllerRestTest.java | 155 +++++++++++++++++- ...ceMembershipRepositoryIntegrationTest.java | 36 +++- .../HsOfficePartnerControllerRestTest.java | 39 +++++ ...fficePartnerRepositoryIntegrationTest.java | 2 +- .../debitor/CreateSepaMandateForDebitor.java | 4 +- .../membership/CancelMembership.java | 5 +- .../CreateCoopAssetsTransaction.java | 6 +- .../CreateCoopSharesTransaction.java | 6 +- ...ceSepaMandateControllerAcceptanceTest.java | 8 +- ...eSepaMandateRepositoryIntegrationTest.java | 6 +- 39 files changed, 672 insertions(+), 171 deletions(-) create mode 100644 src/main/java/net/hostsharing/hsadminng/errors/Validate.java create mode 100644 src/main/resources/api-definition/hs-office/hs-office-debitors-with-debitorNumber.yaml create mode 100644 src/main/resources/api-definition/hs-office/hs-office-memberships-with-membershipNumber.yaml create mode 100644 src/main/resources/api-definition/hs-office/hs-office-partners-with-partnerNumber.yaml create mode 100644 src/test/java/net/hostsharing/hsadminng/errors/ValidateUnitTest.java diff --git a/src/main/java/net/hostsharing/hsadminng/errors/Validate.java b/src/main/java/net/hostsharing/hsadminng/errors/Validate.java new file mode 100644 index 00000000..3ce68fe9 --- /dev/null +++ b/src/main/java/net/hostsharing/hsadminng/errors/Validate.java @@ -0,0 +1,23 @@ +package net.hostsharing.hsadminng.errors; + +import lombok.AllArgsConstructor; + +import jakarta.validation.ValidationException; + +@AllArgsConstructor +public class Validate { + + final String variableNames; + + public static Validate validate(final String variableNames) { + return new Validate(variableNames); + } + + public final void atMaxOneNonNull(final Object var1, final Object var2) { + if (var1 != null && var2 != null) { + throw new ValidationException( + "Exactly one of (" + variableNames + ") must be non-null, " + + "but are (" + var1 + ", " + var2 + ")"); + } + } +} 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 fbb59788..9073e564 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 @@ -290,11 +290,10 @@ public class HsOfficeCoopAssetsTransactionController implements HsOfficeCoopAsse if (adoptingMembershipMemberNumber != null) { final var adoptingMemberNumber = Integer.valueOf(adoptingMembershipMemberNumber.substring("M-".length())); final var adoptingMembership = membershipRepo.findMembershipByMemberNumber(adoptingMemberNumber); - if (adoptingMembership != null) { - return adoptingMembership; - } - throw new ValidationException("adoptingMembership.memberNumber='" + adoptingMembershipMemberNumber - + "' not found or not accessible"); + return adoptingMembership.orElseThrow( () -> + new ValidationException("adoptingMembership.memberNumber='" + adoptingMembershipMemberNumber + + "' not found or not accessible") + ); } throw new ValidationException( diff --git a/src/main/java/net/hostsharing/hsadminng/hs/office/debitor/HsOfficeDebitorController.java b/src/main/java/net/hostsharing/hsadminng/hs/office/debitor/HsOfficeDebitorController.java index 1792acdb..1e82b848 100644 --- a/src/main/java/net/hostsharing/hsadminng/hs/office/debitor/HsOfficeDebitorController.java +++ b/src/main/java/net/hostsharing/hsadminng/hs/office/debitor/HsOfficeDebitorController.java @@ -57,12 +57,15 @@ public class HsOfficeDebitorController implements HsOfficeDebitorsApi { final String currentSubject, final String assumedRoles, final String name, - final String debitorNumber) { + final UUID partnerUuid, + final String partnerNumber) { context.define(currentSubject, assumedRoles); - final var entities = debitorNumber != null - ? debitorRepo.findDebitorByDebitorNumber(cropTag("D-", debitorNumber)) - : debitorRepo.findDebitorByOptionalNameLike(name); + final var entities = partnerNumber != null + ? debitorRepo.findDebitorsByPartnerNumber(cropTag("P-", partnerNumber)) + : partnerUuid != null + ? debitorRepo.findDebitorsByPartnerUuid(partnerUuid) + : debitorRepo.findDebitorsByOptionalNameLike(name); final var resources = mapper.mapList(entities, HsOfficeDebitorResource.class, ENTITY_TO_RESOURCE_POSTMAPPER); return ResponseEntity.ok(resources); @@ -133,6 +136,23 @@ public class HsOfficeDebitorController implements HsOfficeDebitorsApi { return ResponseEntity.ok(mapper.map(result.get(), HsOfficeDebitorResource.class, ENTITY_TO_RESOURCE_POSTMAPPER)); } + @Override + @Transactional(readOnly = true) + @Timed("app.office.debitors.api.getSingleDebitorByDebitorNumber") + public ResponseEntity getSingleDebitorByDebitorNumber( + final String currentSubject, + final String assumedRoles, + final Integer debitorNumber) { + + context.define(currentSubject, assumedRoles); + + final var result = debitorRepo.findDebitorByDebitorNumber(debitorNumber); + if (result.isEmpty()) { + return ResponseEntity.notFound().build(); + } + return ResponseEntity.ok(mapper.map(result.get(), HsOfficeDebitorResource.class, ENTITY_TO_RESOURCE_POSTMAPPER)); + } + @Override @Transactional @Timed("app.office.debitors.api.deleteDebitorByUuid") diff --git a/src/main/java/net/hostsharing/hsadminng/hs/office/debitor/HsOfficeDebitorRepository.java b/src/main/java/net/hostsharing/hsadminng/hs/office/debitor/HsOfficeDebitorRepository.java index a62d1c42..fa02053b 100644 --- a/src/main/java/net/hostsharing/hsadminng/hs/office/debitor/HsOfficeDebitorRepository.java +++ b/src/main/java/net/hostsharing/hsadminng/hs/office/debitor/HsOfficeDebitorRepository.java @@ -1,6 +1,7 @@ package net.hostsharing.hsadminng.hs.office.debitor; import io.micrometer.core.annotation.Timed; +import net.hostsharing.hsadminng.lambda.Reducer; import org.springframework.data.jpa.repository.Query; import org.springframework.data.repository.Repository; @@ -13,21 +14,29 @@ public interface HsOfficeDebitorRepository extends Repository findByUuid(UUID id); + @Timed("app.office.debitors.repo.findDebitorByPartnerUuid") + List findDebitorsByPartnerUuid(UUID partnerUuid); + @Query(""" SELECT debitor FROM HsOfficeDebitorEntity debitor JOIN HsOfficePartnerEntity partner ON partner.partnerRel.holder = debitor.debitorRel.anchor AND partner.partnerRel.type = 'PARTNER' AND debitor.debitorRel.type = 'DEBITOR' WHERE partner.partnerNumber = :partnerNumber - AND debitor.debitorNumberSuffix = :debitorNumberSuffix + AND (:debitorNumberSuffix IS NULL OR debitor.debitorNumberSuffix = :debitorNumberSuffix) """) @Timed("app.office.debitors.repo.findDebitorByPartnerNumberAndDebitorNumberSuffix") - List findDebitorByPartnerNumberAndDebitorNumberSuffix(int partnerNumber, String debitorNumberSuffix); + List findDebitorByPartnerNumberAndOptionalDebitorNumberSuffix(int partnerNumber, String debitorNumberSuffix); - default List findDebitorByDebitorNumber(int debitorNumber) { + default Optional findDebitorByDebitorNumber(int debitorNumber) { final var partnerNumber = debitorNumber / 100; final String suffix = String.format("%02d", debitorNumber % 100); - final var result = findDebitorByPartnerNumberAndDebitorNumberSuffix(partnerNumber, suffix); + final var result = findDebitorByPartnerNumberAndOptionalDebitorNumberSuffix(partnerNumber, suffix); + return result.stream().reduce(Reducer::toSingleElement); + } + + default List findDebitorsByPartnerNumber(int partnerNumber) { + final var result = findDebitorByPartnerNumberAndOptionalDebitorNumberSuffix(partnerNumber, null); return result; } @@ -50,7 +59,7 @@ public interface HsOfficeDebitorRepository extends Repository findDebitorByOptionalNameLike(String name); + List findDebitorsByOptionalNameLike(String name); @Timed("app.office.debitors.repo.save") HsOfficeDebitorEntity save(final HsOfficeDebitorEntity entity); diff --git a/src/main/java/net/hostsharing/hsadminng/hs/office/membership/HsOfficeMembershipController.java b/src/main/java/net/hostsharing/hsadminng/hs/office/membership/HsOfficeMembershipController.java index 3ba36f5c..84994ceb 100644 --- a/src/main/java/net/hostsharing/hsadminng/hs/office/membership/HsOfficeMembershipController.java +++ b/src/main/java/net/hostsharing/hsadminng/hs/office/membership/HsOfficeMembershipController.java @@ -6,6 +6,7 @@ import net.hostsharing.hsadminng.hs.office.generated.api.v1.api.HsOfficeMembersh import net.hostsharing.hsadminng.hs.office.generated.api.v1.model.HsOfficeMembershipInsertResource; import net.hostsharing.hsadminng.hs.office.generated.api.v1.model.HsOfficeMembershipPatchResource; import net.hostsharing.hsadminng.hs.office.generated.api.v1.model.HsOfficeMembershipResource; +import net.hostsharing.hsadminng.hs.office.partner.HsOfficePartnerEntity; import net.hostsharing.hsadminng.mapper.StandardMapper; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.http.ResponseEntity; @@ -17,7 +18,7 @@ import java.util.List; import java.util.UUID; import java.util.function.BiConsumer; -import static java.util.Optional.ofNullable; +import static net.hostsharing.hsadminng.errors.Validate.validate; import static net.hostsharing.hsadminng.repr.TaggedNumber.cropTag; @RestController @@ -39,16 +40,20 @@ public class HsOfficeMembershipController implements HsOfficeMembershipsApi { final String currentSubject, final String assumedRoles, final UUID partnerUuid, - final String memberNumber) { + final String partnerNumber) { context.define(currentSubject, assumedRoles); - final var entities = (memberNumber != null) - ? ofNullable(membershipRepo.findMembershipByMemberNumber( - cropTag(HsOfficeMembershipEntity.MEMBER_NUMBER_TAG, memberNumber))).stream() - .toList() - : membershipRepo.findMembershipsByOptionalPartnerUuid(partnerUuid); + validate("partnerUuid, partnerNumber").atMaxOneNonNull(partnerUuid, partnerNumber); - final var resources = mapper.mapList(entities, HsOfficeMembershipResource.class, + final var entities = partnerNumber != null + ? membershipRepo.findMembershipsByPartnerNumber( + cropTag(HsOfficePartnerEntity.PARTNER_NUMBER_TAG, partnerNumber)) + : partnerUuid != null + ? membershipRepo.findMembershipsByPartnerUuid(partnerUuid) + : membershipRepo.findAll(); + + final var resources = mapper.mapList( + entities, HsOfficeMembershipResource.class, SEPA_MANDATE_ENTITY_TO_RESOURCE_POSTMAPPER); return ResponseEntity.ok(resources); } @@ -72,7 +77,8 @@ public class HsOfficeMembershipController implements HsOfficeMembershipsApi { .path("/api/hs/office/memberships/{id}") .buildAndExpand(saved.getUuid()) .toUri(); - final var mapped = mapper.map(saved, HsOfficeMembershipResource.class, + final var mapped = mapper.map( + saved, HsOfficeMembershipResource.class, SEPA_MANDATE_ENTITY_TO_RESOURCE_POSTMAPPER); return ResponseEntity.created(uri).body(mapped); } @@ -91,7 +97,27 @@ public class HsOfficeMembershipController implements HsOfficeMembershipsApi { if (result.isEmpty()) { return ResponseEntity.notFound().build(); } - return ResponseEntity.ok(mapper.map(result.get(), HsOfficeMembershipResource.class, + return ResponseEntity.ok(mapper.map( + result.get(), HsOfficeMembershipResource.class, + SEPA_MANDATE_ENTITY_TO_RESOURCE_POSTMAPPER)); + } + + @Override + @Transactional(readOnly = true) + @Timed("app.office.membership.api.getSingleMembershipByMembershipNumber") + public ResponseEntity getSingleMembershipByMembershipNumber( + final String currentSubject, + final String assumedRoles, + final Integer membershipNumber) { + + context.define(currentSubject, assumedRoles); + + final var result = membershipRepo.findMembershipByMemberNumber(membershipNumber); + if (result.isEmpty()) { + return ResponseEntity.notFound().build(); + } + return ResponseEntity.ok(mapper.map( + result.get(), HsOfficeMembershipResource.class, SEPA_MANDATE_ENTITY_TO_RESOURCE_POSTMAPPER)); } diff --git a/src/main/java/net/hostsharing/hsadminng/hs/office/membership/HsOfficeMembershipRepository.java b/src/main/java/net/hostsharing/hsadminng/hs/office/membership/HsOfficeMembershipRepository.java index 5a537b26..47a3608e 100644 --- a/src/main/java/net/hostsharing/hsadminng/hs/office/membership/HsOfficeMembershipRepository.java +++ b/src/main/java/net/hostsharing/hsadminng/hs/office/membership/HsOfficeMembershipRepository.java @@ -22,12 +22,19 @@ public interface HsOfficeMembershipRepository extends Repository findMembershipsByOptionalPartnerUuid(UUID partnerUuid); + List findMembershipsByPartnerUuid(UUID partnerUuid); + + @Query(""" + SELECT membership FROM HsOfficeMembershipEntity membership + WHERE membership.partner.partnerNumber = :partnerNumber + ORDER BY membership.partner.partnerNumber, membership.memberNumberSuffix + """) + @Timed("app.office.membership.repo.findMembershipsByPartnerNumber") + List findMembershipsByPartnerNumber(Integer partnerNumber); @Query(""" SELECT membership FROM HsOfficeMembershipEntity membership @@ -35,12 +42,12 @@ public interface HsOfficeMembershipRepository extends Repository findMembershipByPartnerNumberAndSuffix( @NotNull Integer partnerNumber, @NotNull String suffix); - default HsOfficeMembershipEntity findMembershipByMemberNumber(Integer memberNumber) { + default Optional findMembershipByMemberNumber(final Integer memberNumber) { final var partnerNumber = memberNumber / 100; final String suffix = String.format("%02d", memberNumber % 100); final var result = findMembershipByPartnerNumberAndSuffix(partnerNumber, suffix); diff --git a/src/main/java/net/hostsharing/hsadminng/hs/office/partner/HsOfficePartnerController.java b/src/main/java/net/hostsharing/hsadminng/hs/office/partner/HsOfficePartnerController.java index a375174b..f3c25bd5 100644 --- a/src/main/java/net/hostsharing/hsadminng/hs/office/partner/HsOfficePartnerController.java +++ b/src/main/java/net/hostsharing/hsadminng/hs/office/partner/HsOfficePartnerController.java @@ -104,6 +104,23 @@ public class HsOfficePartnerController implements HsOfficePartnersApi { return ResponseEntity.ok(mapper.map(result.get(), HsOfficePartnerResource.class)); } + @Override + @Transactional(readOnly = true) + @Timed("app.office.partners.api.getSinglePartnerByPartnerNumber") + public ResponseEntity getSinglePartnerByPartnerNumber( + final String currentSubject, + final String assumedRoles, + final Integer partnerNumber) { + + context.define(currentSubject, assumedRoles); + + final var result = partnerRepo.findPartnerByPartnerNumber(partnerNumber); + if (result.isEmpty()) { + return ResponseEntity.notFound().build(); + } + return ResponseEntity.ok(mapper.map(result.get(), HsOfficePartnerResource.class)); + } + @Override @Transactional @Timed("app.office.partners.api.deletePartnerByUuid") diff --git a/src/main/java/net/hostsharing/hsadminng/hs/office/partner/HsOfficePartnerRepository.java b/src/main/java/net/hostsharing/hsadminng/hs/office/partner/HsOfficePartnerRepository.java index 282d3db3..3ae4a26a 100644 --- a/src/main/java/net/hostsharing/hsadminng/hs/office/partner/HsOfficePartnerRepository.java +++ b/src/main/java/net/hostsharing/hsadminng/hs/office/partner/HsOfficePartnerRepository.java @@ -32,7 +32,7 @@ public interface HsOfficePartnerRepository extends Repository findPartnerByOptionalNameLike(String name); @Timed("app.office.partners.repo.findPartnerByPartnerNumber") - HsOfficePartnerEntity findPartnerByPartnerNumber(Integer partnerNumber); + Optional findPartnerByPartnerNumber(Integer partnerNumber); @Timed("app.office.partners.repo.save") HsOfficePartnerEntity save(final HsOfficePartnerEntity entity); diff --git a/src/main/resources/api-definition/hs-office/api-mappings.yaml b/src/main/resources/api-definition/hs-office/api-mappings.yaml index 2403e1e4..3a13afd4 100644 --- a/src/main/resources/api-definition/hs-office/api-mappings.yaml +++ b/src/main/resources/api-definition/hs-office/api-mappings.yaml @@ -13,6 +13,7 @@ map: - type: string:uuid => java.util.UUID - type: string:format => java.lang.String - type: number:currency => java.math.BigDecimal + - type: number:integer => java.lang.Integer paths: /api/hs/office/partners/{partnerUUID}: 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 a666229d..e84e733c 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 @@ -27,8 +27,6 @@ components: nullable: false membership.memberNumber: type: string - minLength: 9 - maxLength: 9 pattern: 'M-[0-9]{7}' transactionType: $ref: '#/components/schemas/HsOfficeCoopAssetsTransactionType' @@ -69,8 +67,6 @@ components: nullable: false membership.memberNumber: type: string - minLength: 9 - maxLength: 9 pattern: 'M-[0-9]{7}' transactionType: $ref: '#/components/schemas/HsOfficeCoopAssetsTransactionType' @@ -130,8 +126,6 @@ components: format: uuid adoptingMembership.memberNumber: type: string - minLength: 9 - maxLength: 9 pattern: 'M-[0-9]{7}' required: - membership.uuid diff --git a/src/main/resources/api-definition/hs-office/hs-office-debitor-schemas.yaml b/src/main/resources/api-definition/hs-office/hs-office-debitor-schemas.yaml index bca2f0a2..c868a459 100644 --- a/src/main/resources/api-definition/hs-office/hs-office-debitor-schemas.yaml +++ b/src/main/resources/api-definition/hs-office/hs-office-debitor-schemas.yaml @@ -13,8 +13,6 @@ components: $ref: 'hs-office-relation-schemas.yaml#/components/schemas/HsOfficeRelation' debitorNumber: type: string - minLength: 9 - maxLength: 9 pattern: 'D-[0-9]{7}' debitorNumberSuffix: type: string diff --git a/src/main/resources/api-definition/hs-office/hs-office-debitors-with-debitorNumber.yaml b/src/main/resources/api-definition/hs-office/hs-office-debitors-with-debitorNumber.yaml new file mode 100644 index 00000000..9e34b758 --- /dev/null +++ b/src/main/resources/api-definition/hs-office/hs-office-debitors-with-debitorNumber.yaml @@ -0,0 +1,29 @@ +get: + tags: + - hs-office-debitors + description: 'Fetch a single debitor by its debitorNumber, if visible for the current subject.' + operationId: getSingleDebitorByDebitorNumber + parameters: + - $ref: 'auth.yaml#/components/parameters/currentSubject' + - $ref: 'auth.yaml#/components/parameters/assumedRoles' + - name: debitorNumber + in: path + required: true + schema: + type: number + format: integer + minimum: 1000000 + maximum: 9999999 + description: debitor-number of the debitor to fetch. + responses: + "200": + description: OK + content: + 'application/json': + schema: + $ref: 'hs-office-debitor-schemas.yaml#/components/schemas/HsOfficeDebitor' + + "401": + $ref: 'error-responses.yaml#/components/responses/Unauthorized' + "403": + $ref: 'error-responses.yaml#/components/responses/Forbidden' diff --git a/src/main/resources/api-definition/hs-office/hs-office-debitors.yaml b/src/main/resources/api-definition/hs-office/hs-office-debitors.yaml index c825817f..20ceb02c 100644 --- a/src/main/resources/api-definition/hs-office/hs-office-debitors.yaml +++ b/src/main/resources/api-definition/hs-office/hs-office-debitors.yaml @@ -13,15 +13,20 @@ get: schema: type: string description: Prefix of name properties from person or contact to filter the results. - - name: debitorNumber + - name: partnerUuid in: query required: false schema: type: string - minLength: 9 - maxLength: 9 - pattern: 'D-[0-9]{7}' - description: Debitor number of the requested debitor. + format: uuid + description: UUID of the business partner, exclusive to `memberNumber`. + - name: partnerNumber + in: query + required: false + schema: + type: string + pattern: 'P-[0-9]{5}' + description: Partner number of the requested debitor. responses: "200": description: OK diff --git a/src/main/resources/api-definition/hs-office/hs-office-membership-schemas.yaml b/src/main/resources/api-definition/hs-office/hs-office-membership-schemas.yaml index cc723a41..f7263700 100644 --- a/src/main/resources/api-definition/hs-office/hs-office-membership-schemas.yaml +++ b/src/main/resources/api-definition/hs-office/hs-office-membership-schemas.yaml @@ -27,14 +27,10 @@ components: $ref: 'hs-office-debitor-schemas.yaml#/components/schemas/HsOfficeDebitor' memberNumber: type: string - minLength: 9 - maxLength: 9 pattern: 'M-[0-9]{7}' memberNumberSuffix: type: string - minLength: 2 - maxLength: 2 - pattern: '[0-9]+' + pattern: '[0-9]{2}' validFrom: type: string format: date @@ -69,9 +65,7 @@ components: nullable: false memberNumberSuffix: type: string - minLength: 2 - maxLength: 2 - pattern: '[0-9]+' + pattern: '[0-9]{2}' nullable: false validFrom: type: string diff --git a/src/main/resources/api-definition/hs-office/hs-office-memberships-with-membershipNumber.yaml b/src/main/resources/api-definition/hs-office/hs-office-memberships-with-membershipNumber.yaml new file mode 100644 index 00000000..8e0f8a64 --- /dev/null +++ b/src/main/resources/api-definition/hs-office/hs-office-memberships-with-membershipNumber.yaml @@ -0,0 +1,29 @@ +get: + tags: + - hs-office-memberships + description: 'Fetch a single membership by its membershipNumber, if visible for the current subject.' + operationId: getSingleMembershipByMembershipNumber + parameters: + - $ref: 'auth.yaml#/components/parameters/currentSubject' + - $ref: 'auth.yaml#/components/parameters/assumedRoles' + - name: membershipNumber + in: path + required: true + schema: + type: number + format: integer + minimum: 1000000 + maximum: 9999999 + description: membershipNumber of the membership to fetch. + responses: + "200": + description: OK + content: + 'application/json': + schema: + $ref: 'hs-office-membership-schemas.yaml#/components/schemas/HsOfficeMembership' + + "401": + $ref: 'error-responses.yaml#/components/responses/Unauthorized' + "403": + $ref: 'error-responses.yaml#/components/responses/Forbidden' diff --git a/src/main/resources/api-definition/hs-office/hs-office-memberships.yaml b/src/main/resources/api-definition/hs-office/hs-office-memberships.yaml index 9b2c27b4..1be0fd23 100644 --- a/src/main/resources/api-definition/hs-office/hs-office-memberships.yaml +++ b/src/main/resources/api-definition/hs-office/hs-office-memberships.yaml @@ -15,15 +15,13 @@ get: type: string format: uuid description: UUID of the business partner, exclusive to `memberNumber`. - - name: memberNumber + - name: partnerNumber in: query required: false schema: type: string - minLength: 9 - maxLength: 9 - pattern: 'M-[0-9]{7}' - description: Member number, exclusive to `partnerUuid`. + pattern: 'P-[0-9]{5}' + description: partnerNumber of the partner the memberships belong to responses: "200": description: OK diff --git a/src/main/resources/api-definition/hs-office/hs-office-partner-schemas.yaml b/src/main/resources/api-definition/hs-office/hs-office-partner-schemas.yaml index 2fd3d39b..727c5b61 100644 --- a/src/main/resources/api-definition/hs-office/hs-office-partner-schemas.yaml +++ b/src/main/resources/api-definition/hs-office/hs-office-partner-schemas.yaml @@ -11,8 +11,6 @@ components: format: uuid partnerNumber: type: string - minLength: 7 - maxLength: 7 pattern: 'P-[0-9]{5}' partnerRel: $ref: 'hs-office-relation-schemas.yaml#/components/schemas/HsOfficeRelation' @@ -87,8 +85,6 @@ components: properties: partnerNumber: type: string - minLength: 7 - maxLength: 7 pattern: 'P-[0-9]{5}' partnerRel: $ref: '#/components/schemas/HsOfficePartnerRelInsert' diff --git a/src/main/resources/api-definition/hs-office/hs-office-partners-with-partnerNumber.yaml b/src/main/resources/api-definition/hs-office/hs-office-partners-with-partnerNumber.yaml new file mode 100644 index 00000000..b402048f --- /dev/null +++ b/src/main/resources/api-definition/hs-office/hs-office-partners-with-partnerNumber.yaml @@ -0,0 +1,28 @@ +get: + tags: + - hs-office-partners + description: 'Fetch a single business partner by its partner-number (prefixed with "P-"), if visible for the current subject.' + operationId: getSinglePartnerByPartnerNumber + parameters: + - $ref: 'auth.yaml#/components/parameters/currentSubject' + - $ref: 'auth.yaml#/components/parameters/assumedRoles' + - name: partnerNumber + in: path + required: true + schema: + type: integer + minimum: 10000 + maximum: 99999 + description: partner-number (prefixed with "P-") of the partner to fetch. + responses: + "200": + description: OK + content: + 'application/json': + schema: + $ref: 'hs-office-partner-schemas.yaml#/components/schemas/HsOfficePartner' + + "401": + $ref: 'error-responses.yaml#/components/responses/Unauthorized' + "403": + $ref: 'error-responses.yaml#/components/responses/Forbidden' diff --git a/src/main/resources/api-definition/hs-office/hs-office.yaml b/src/main/resources/api-definition/hs-office/hs-office.yaml index e8e7816d..40c0ce93 100644 --- a/src/main/resources/api-definition/hs-office/hs-office.yaml +++ b/src/main/resources/api-definition/hs-office/hs-office.yaml @@ -13,6 +13,9 @@ paths: /api/hs/office/partners: $ref: "hs-office-partners.yaml" + /api/hs/office/partners/P-{partnerNumber}: + $ref: "hs-office-partners-with-partnerNumber.yaml" + /api/hs/office/partners/{partnerUUID}: $ref: "hs-office-partners-with-uuid.yaml" @@ -58,6 +61,9 @@ paths: /api/hs/office/debitors: $ref: "hs-office-debitors.yaml" + /api/hs/office/debitors/D-{debitorNumber}: + $ref: "hs-office-debitors-with-debitorNumber.yaml" + /api/hs/office/debitors/{debitorUUID}: $ref: "hs-office-debitors-with-uuid.yaml" @@ -76,6 +82,9 @@ paths: /api/hs/office/memberships: $ref: "hs-office-memberships.yaml" + /api/hs/office/memberships/M-{membershipNumber}: + $ref: "hs-office-memberships-with-membershipNumber.yaml" + /api/hs/office/memberships/{membershipUUID}: $ref: "hs-office-memberships-with-uuid.yaml" diff --git a/src/test/java/net/hostsharing/hsadminng/errors/ValidateUnitTest.java b/src/test/java/net/hostsharing/hsadminng/errors/ValidateUnitTest.java new file mode 100644 index 00000000..0d212c90 --- /dev/null +++ b/src/test/java/net/hostsharing/hsadminng/errors/ValidateUnitTest.java @@ -0,0 +1,31 @@ +package net.hostsharing.hsadminng.errors; + +import org.junit.jupiter.api.Test; + +import jakarta.validation.ValidationException; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.catchThrowable; + +class ValidateUnitTest { + + @Test + void shouldFailValidationIfBothParametersAreNotNull() { + final var throwable = catchThrowable(() -> + Validate.validate("var1, var2").atMaxOneNonNull("val1", "val2") + ); + assertThat(throwable).isInstanceOf(ValidationException.class) + .hasMessage("Exactly one of (var1, var2) must be non-null, but are (val1, val2)"); + } + + @Test + void shouldNotFailValidationIfBothParametersAreull() { + Validate.validate("var1, var2").atMaxOneNonNull(null, null); + } + + @Test + void shouldNotFailValidationIfExactlyOneParameterIsNonNull() { + Validate.validate("var1, var2").atMaxOneNonNull("val1", null); + Validate.validate("var1, var2").atMaxOneNonNull(null, "val2"); + } +} diff --git a/src/test/java/net/hostsharing/hsadminng/hs/booking/item/HsBookingItemRepositoryIntegrationTest.java b/src/test/java/net/hostsharing/hsadminng/hs/booking/item/HsBookingItemRepositoryIntegrationTest.java index 091c2c62..b6c8d757 100644 --- a/src/test/java/net/hostsharing/hsadminng/hs/booking/item/HsBookingItemRepositoryIntegrationTest.java +++ b/src/test/java/net/hostsharing/hsadminng/hs/booking/item/HsBookingItemRepositoryIntegrationTest.java @@ -120,7 +120,7 @@ class HsBookingItemRepositoryIntegrationTest extends ContextBasedTestWithCleanup // given context("superuser-alex@hostsharing.net"); final var count = rbacBookingItemRepo.count(); - final var givenDebitor = debitorRepo.findDebitorByOptionalNameLike("First").get(0); + final var givenDebitor = debitorRepo.findDebitorsByOptionalNameLike("First").get(0); final var givenProject = realProjectRepo.findAllByDebitorUuid(givenDebitor.getUuid()).get(0); // when @@ -151,7 +151,7 @@ class HsBookingItemRepositoryIntegrationTest extends ContextBasedTestWithCleanup // when attempt(em, () -> { - final var givenDebitor = debitorRepo.findDebitorByOptionalNameLike("First").get(0); + final var givenDebitor = debitorRepo.findDebitorsByOptionalNameLike("First").get(0); final var givenProject = realProjectRepo.findAllByDebitorUuid(givenDebitor.getUuid()).get(0); final var newBookingItem = HsBookingItemRbacEntity.builder() .project(givenProject) 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 6e54acfa..1239c2a4 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 @@ -79,7 +79,7 @@ class HsOfficeCoopAssetsTransactionControllerAcceptanceTest extends ContextBased void globalAdmin_canFindCoopAssetsTransactionsByMemberNumber() { context.define("superuser-alex@hostsharing.net"); - final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000202); + final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000202).orElseThrow(); RestAssured // @formatter:off .given() @@ -202,7 +202,7 @@ class HsOfficeCoopAssetsTransactionControllerAcceptanceTest extends ContextBased void globalAdmin_canFindCoopAssetsTransactionsByMembershipUuidAndDateRange() { context.define("superuser-alex@hostsharing.net"); - final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000202); + final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000202).orElseThrow(); RestAssured // @formatter:off .given() @@ -235,7 +235,7 @@ class HsOfficeCoopAssetsTransactionControllerAcceptanceTest extends ContextBased void globalAdmin_canPostNewCoopAssetTransaction() { context.define("superuser-alex@hostsharing.net"); - final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000101); + final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000101).orElseThrow(); final var location = RestAssured // @formatter:off .given() @@ -280,7 +280,7 @@ class HsOfficeCoopAssetsTransactionControllerAcceptanceTest extends ContextBased void globalAdmin_canAddCoopAssetsReversalTransaction() { context.define("superuser-alex@hostsharing.net"); - final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000101); + final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000101).orElseThrow(); final var givenTransaction = jpaAttempt.transacted(() -> { // TODO.impl: introduce something like transactedAsSuperuser / transactedAs("...", ...) context.define("superuser-alex@hostsharing.net"); @@ -348,7 +348,7 @@ class HsOfficeCoopAssetsTransactionControllerAcceptanceTest extends ContextBased void globalAdmin_canNotCancelMoreAssetsThanCurrentlySubscribed() { context.define("superuser-alex@hostsharing.net"); - final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000101); + final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000101).orElseThrow(); RestAssured // @formatter:off .given() diff --git a/src/test/java/net/hostsharing/hsadminng/hs/office/coopassets/HsOfficeCoopAssetsTransactionControllerRestTest.java b/src/test/java/net/hostsharing/hsadminng/hs/office/coopassets/HsOfficeCoopAssetsTransactionControllerRestTest.java index 9409b856..c064a848 100644 --- a/src/test/java/net/hostsharing/hsadminng/hs/office/coopassets/HsOfficeCoopAssetsTransactionControllerRestTest.java +++ b/src/test/java/net/hostsharing/hsadminng/hs/office/coopassets/HsOfficeCoopAssetsTransactionControllerRestTest.java @@ -915,7 +915,7 @@ class HsOfficeCoopAssetsTransactionControllerRestTest { AVAILABLE_MEMBER_ENTITY); final var availableMemberNumber = Integer.valueOf(AVAILABLE_TARGET_MEMBER_NUMBER.substring("M-".length())); - when(membershipRepo.findMembershipByMemberNumber(eq(availableMemberNumber))).thenReturn(AVAILABLE_MEMBER_ENTITY); + when(membershipRepo.findMembershipByMemberNumber(eq(availableMemberNumber))).thenReturn(Optional.of(AVAILABLE_MEMBER_ENTITY)); when(membershipRepo.findByUuid(eq(ORIGIN_MEMBERSHIP_UUID))).thenReturn(Optional.of(ORIGIN_TARGET_MEMBER_ENTITY)); when(membershipRepo.findByUuid(eq(AVAILABLE_TARGET_MEMBERSHIP_UUID))).thenReturn(Optional.of(AVAILABLE_MEMBER_ENTITY)); 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 40f9d0a7..01248496 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 @@ -62,7 +62,7 @@ class HsOfficeCoopAssetsTransactionRepositoryIntegrationTest extends ContextBase // given context("superuser-alex@hostsharing.net"); final var count = coopAssetsTransactionRepo.count(); - final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000101).load(); + final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000101).orElseThrow().load(); // when final var result = attempt(em, () -> { @@ -94,7 +94,7 @@ class HsOfficeCoopAssetsTransactionRepositoryIntegrationTest extends ContextBase // when attempt(em, () -> { - final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000101); + final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000101).orElseThrow(); final var newCoopAssetsTransaction = HsOfficeCoopAssetsTransactionEntity.builder() .membership(givenMembership) .transactionType(HsOfficeCoopAssetsTransactionType.DEPOSIT) @@ -166,7 +166,7 @@ class HsOfficeCoopAssetsTransactionRepositoryIntegrationTest extends ContextBase public void globalAdmin_canViewCoopAssetsTransactions_filteredByMembershipUuid() { // given context("superuser-alex@hostsharing.net"); - final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000202); + final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000202).orElseThrow(); // when final var result = coopAssetsTransactionRepo.findCoopAssetsTransactionByOptionalMembershipUuidAndDateRange( @@ -189,7 +189,7 @@ class HsOfficeCoopAssetsTransactionRepositoryIntegrationTest extends ContextBase public void globalAdmin_canViewCoopAssetsTransactions_filteredByMembershipUuidAndValueDateRange() { // given context("superuser-alex@hostsharing.net"); - final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000202); + final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000202).orElseThrow(); // when final var result = coopAssetsTransactionRepo.findCoopAssetsTransactionByOptionalMembershipUuidAndDateRange( diff --git a/src/test/java/net/hostsharing/hsadminng/hs/office/coopshares/HsOfficeCoopSharesTransactionControllerAcceptanceTest.java b/src/test/java/net/hostsharing/hsadminng/hs/office/coopshares/HsOfficeCoopSharesTransactionControllerAcceptanceTest.java index e7b1e52f..844e8db5 100644 --- a/src/test/java/net/hostsharing/hsadminng/hs/office/coopshares/HsOfficeCoopSharesTransactionControllerAcceptanceTest.java +++ b/src/test/java/net/hostsharing/hsadminng/hs/office/coopshares/HsOfficeCoopSharesTransactionControllerAcceptanceTest.java @@ -87,7 +87,7 @@ class HsOfficeCoopSharesTransactionControllerAcceptanceTest extends ContextBased void globalAdmin_canFindCoopSharesTransactionsByMemberNumber() { context.define("superuser-alex@hostsharing.net"); - final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000202); + final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000202).orElseThrow(); RestAssured // @formatter:off .given().header("current-subject", "superuser-alex@hostsharing.net").port(port).when().get("http://localhost/api/hs/office/coopsharestransactions?membershipUuid=" + givenMembership.getUuid()).then().log().all().assertThat().statusCode(200).contentType("application/json").body("", lenientlyEquals(""" @@ -142,7 +142,7 @@ class HsOfficeCoopSharesTransactionControllerAcceptanceTest extends ContextBased void globalAdmin_canFindCoopSharesTransactionsByMembershipUuidAndDateRange() { context.define("superuser-alex@hostsharing.net"); - final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000202); + final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000202).orElseThrow(); RestAssured // @formatter:off .given().header("current-subject", "superuser-alex@hostsharing.net").port(port).when() @@ -167,7 +167,7 @@ class HsOfficeCoopSharesTransactionControllerAcceptanceTest extends ContextBased void globalAdmin_canAddCoopSharesTransaction() { context.define("superuser-alex@hostsharing.net"); - final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000101); + final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000101).orElseThrow(); final var location = RestAssured // @formatter:off .given().header("current-subject", "superuser-alex@hostsharing.net").contentType(ContentType.JSON).body(""" @@ -198,7 +198,7 @@ class HsOfficeCoopSharesTransactionControllerAcceptanceTest extends ContextBased void globalAdmin_canAddCoopSharesReversalTransaction() { context.define("superuser-alex@hostsharing.net"); - final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000101); + final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000101).orElseThrow(); final var givenTransaction = jpaAttempt.transacted(() -> { // TODO.impl: introduce something like transactedAsSuperuser / transactedAs("...", ...) context.define("superuser-alex@hostsharing.net"); @@ -266,7 +266,7 @@ class HsOfficeCoopSharesTransactionControllerAcceptanceTest extends ContextBased void globalAdmin_canNotCancelMoreSharesThanCurrentlySubscribed() { context.define("superuser-alex@hostsharing.net"); - final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000101); + final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000101).orElseThrow(); RestAssured // @formatter:off .given().header("current-subject", "superuser-alex@hostsharing.net").contentType(ContentType.JSON).body(""" diff --git a/src/test/java/net/hostsharing/hsadminng/hs/office/coopshares/HsOfficeCoopSharesTransactionRepositoryIntegrationTest.java b/src/test/java/net/hostsharing/hsadminng/hs/office/coopshares/HsOfficeCoopSharesTransactionRepositoryIntegrationTest.java index 613ccc2b..d428a9d7 100644 --- a/src/test/java/net/hostsharing/hsadminng/hs/office/coopshares/HsOfficeCoopSharesTransactionRepositoryIntegrationTest.java +++ b/src/test/java/net/hostsharing/hsadminng/hs/office/coopshares/HsOfficeCoopSharesTransactionRepositoryIntegrationTest.java @@ -61,7 +61,7 @@ class HsOfficeCoopSharesTransactionRepositoryIntegrationTest extends ContextBase // given context("superuser-alex@hostsharing.net"); final var count = coopSharesTransactionRepo.count(); - final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000101).load(); + final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000101).orElseThrow().load(); // when final var result = attempt(em, () -> { @@ -93,7 +93,7 @@ class HsOfficeCoopSharesTransactionRepositoryIntegrationTest extends ContextBase // when attempt(em, () -> { - final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000101); + final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000101).orElseThrow(); final var newCoopSharesTransaction = HsOfficeCoopSharesTransactionEntity.builder() .membership(givenMembership) .transactionType(HsOfficeCoopSharesTransactionType.SUBSCRIPTION) @@ -159,7 +159,7 @@ class HsOfficeCoopSharesTransactionRepositoryIntegrationTest extends ContextBase public void globalAdmin_canViewCoopSharesTransactions_filteredByMembershipUuid() { // given context("superuser-alex@hostsharing.net"); - final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000202); + final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000202).orElseThrow(); // when final var result = coopSharesTransactionRepo.findCoopSharesTransactionByOptionalMembershipUuidAndDateRange( @@ -180,7 +180,7 @@ class HsOfficeCoopSharesTransactionRepositoryIntegrationTest extends ContextBase public void globalAdmin_canViewCoopSharesTransactions_filteredByMembershipUuidAndValueDateRange() { // given context("superuser-alex@hostsharing.net"); - final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000202); + final var givenMembership = membershipRepo.findMembershipByMemberNumber(1000202).orElseThrow(); // when final var result = coopSharesTransactionRepo.findCoopSharesTransactionByOptionalMembershipUuidAndDateRange( diff --git a/src/test/java/net/hostsharing/hsadminng/hs/office/debitor/HsOfficeDebitorControllerAcceptanceTest.java b/src/test/java/net/hostsharing/hsadminng/hs/office/debitor/HsOfficeDebitorControllerAcceptanceTest.java index d0b56745..a05687e4 100644 --- a/src/test/java/net/hostsharing/hsadminng/hs/office/debitor/HsOfficeDebitorControllerAcceptanceTest.java +++ b/src/test/java/net/hostsharing/hsadminng/hs/office/debitor/HsOfficeDebitorControllerAcceptanceTest.java @@ -31,7 +31,10 @@ import static net.hostsharing.hsadminng.hs.office.relation.HsOfficeRelationType. import static net.hostsharing.hsadminng.rbac.test.IsValidUuidMatcher.isUuidValid; import static net.hostsharing.hsadminng.rbac.test.JsonMatcher.lenientlyEquals; import static org.assertj.core.api.Assertions.assertThat; -import static org.hamcrest.Matchers.*; +import static org.hamcrest.Matchers.containsString; +import static org.hamcrest.Matchers.equalTo; +import static org.hamcrest.Matchers.is; +import static org.hamcrest.Matchers.startsWith; @SpringBootTest( webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT, @@ -74,6 +77,69 @@ class HsOfficeDebitorControllerAcceptanceTest extends ContextBasedTestWithCleanu @PersistenceContext EntityManager em; + @Nested + class GetSingleDebitor { + + @Test + void globalAdmin_withoutAssumedRoles_canGetDebitorByDebitorUuid() { + + final var givenDebitor = jpaAttempt.transacted(() -> { + context("superuser-alex@hostsharing.net"); + return debitorRepo.findDebitorByDebitorNumber(1000212).orElseThrow(); + }).assertSuccessful().returnedValue(); + + RestAssured // @formatter:off + .given() + .header("current-subject", "superuser-alex@hostsharing.net") + .port(port) + .when() + .get("http://localhost/api/hs/office/debitors/" + givenDebitor.getUuid()) + .then().log().all().assertThat() + .statusCode(200) + .contentType("application/json") + .body("", lenientlyEquals(""" + { + "debitorNumber": "D-1000212", + "partner": { "partnerNumber": "P-10002" }, + "debitorRel": { + "contact": { "caption": "second contact" } + }, + "vatId": null, + "vatCountryCode": null, + "vatBusiness": true + } + """)); + // @formatter:on + } + + @Test + void globalAdmin_withoutAssumedRoles_canGetDebitorByDebitorNumber() { + + RestAssured // @formatter:off + .given() + .header("current-subject", "superuser-alex@hostsharing.net") + .port(port) + .when() + .get("http://localhost/api/hs/office/debitors/D-1000212") + .then().log().all().assertThat() + .statusCode(200) + .contentType("application/json") + .body("", lenientlyEquals(""" + { + "debitorNumber": "D-1000212", + "partner": { "partnerNumber": "P-10002" }, + "debitorRel": { + "contact": { "caption": "second contact" } + }, + "vatId": null, + "vatCountryCode": null, + "vatBusiness": true + } + """)); + // @formatter:on + } + } + @Nested class GetListOfDebitors { @@ -233,32 +299,28 @@ class HsOfficeDebitorControllerAcceptanceTest extends ContextBasedTestWithCleanu } @Test - void globalAdmin_withoutAssumedRoles_canFindDebitorDebitorByDebitorNumber() { + void globalAdmin_withoutAssumedRoles_canFindDebitorsByPartnerNumber() { RestAssured // @formatter:off - .given() + .given() .header("current-subject", "superuser-alex@hostsharing.net") .port(port) - .when() - .get("http://localhost/api/hs/office/debitors?debitorNumber=D-1000212") - .then().log().all().assertThat() + .when() + .get("http://localhost/api/hs/office/debitors?partnerNumber=P-10002") + .then().log().all().assertThat() .statusCode(200) .contentType("application/json") .body("", lenientlyEquals(""" - [ - { - "debitorNumber": "D-1000212", - "partner": { "partnerNumber": "P-10002" }, - "debitorRel": { - "contact": { "caption": "second contact" } - }, - "vatId": null, - "vatCountryCode": null, - "vatBusiness": true - } - ] + [ + { + "debitorNumber": "D-1000212", + "partner": { + "partnerNumber": "P-10002" + } + } + ] """)); - // @formatter:on + // @formatter:on } } @@ -444,7 +506,7 @@ class HsOfficeDebitorControllerAcceptanceTest extends ContextBasedTestWithCleanu @Test void globalAdmin_withoutAssumedRole_canGetArbitraryDebitor() { context.define("superuser-alex@hostsharing.net"); - final var givenDebitorUuid = debitorRepo.findDebitorByOptionalNameLike("First").get(0).getUuid(); + final var givenDebitorUuid = debitorRepo.findDebitorsByOptionalNameLike("First").get(0).getUuid(); RestAssured // @formatter:off .given() @@ -509,7 +571,7 @@ class HsOfficeDebitorControllerAcceptanceTest extends ContextBasedTestWithCleanu @Test void normalUser_canNotGetUnrelatedDebitor() { context.define("superuser-alex@hostsharing.net"); - final var givenDebitorUuid = debitorRepo.findDebitorByOptionalNameLike("First").get(0).getUuid(); + final var givenDebitorUuid = debitorRepo.findDebitorsByOptionalNameLike("First").get(0).getUuid(); RestAssured // @formatter:off .given() @@ -524,7 +586,7 @@ class HsOfficeDebitorControllerAcceptanceTest extends ContextBasedTestWithCleanu @Test void contactAdminUser_canGetRelatedDebitorExceptRefundBankAccount() { context.define("superuser-alex@hostsharing.net"); - final var givenDebitorUuid = debitorRepo.findDebitorByOptionalNameLike("first contact").get(0).getUuid(); + final var givenDebitorUuid = debitorRepo.findDebitorsByOptionalNameLike("first contact").get(0).getUuid(); RestAssured // @formatter:off .given() diff --git a/src/test/java/net/hostsharing/hsadminng/hs/office/debitor/HsOfficeDebitorRepositoryIntegrationTest.java b/src/test/java/net/hostsharing/hsadminng/hs/office/debitor/HsOfficeDebitorRepositoryIntegrationTest.java index 781077cb..0be9d9ca 100644 --- a/src/test/java/net/hostsharing/hsadminng/hs/office/debitor/HsOfficeDebitorRepositoryIntegrationTest.java +++ b/src/test/java/net/hostsharing/hsadminng/hs/office/debitor/HsOfficeDebitorRepositoryIntegrationTest.java @@ -50,7 +50,7 @@ class HsOfficeDebitorRepositoryIntegrationTest extends ContextBasedTestWithClean HsOfficePartnerRepository partnerRepo; @Autowired - HsOfficeContactRealRepository contactrealRepo; + HsOfficeContactRealRepository contactRealRepo; @Autowired HsOfficePersonRealRepository personRepo; @@ -83,9 +83,9 @@ class HsOfficeDebitorRepositoryIntegrationTest extends ContextBasedTestWithClean // given context("superuser-alex@hostsharing.net"); final var count = debitorRepo.count(); - final var givenPartner = partnerRepo.findPartnerByPartnerNumber(10001); + final var givenPartner = partnerRepo.findPartnerByPartnerNumber(10001).orElseThrow(); final var givenPartnerPerson = one(personRepo.findPersonByOptionalNameLike("First GmbH")); - final var givenContact = one(contactrealRepo.findContactByOptionalCaptionLike("first contact")); + final var givenContact = one(contactRealRepo.findContactByOptionalCaptionLike("first contact")); // when final var result = attempt(em, () -> { @@ -119,7 +119,7 @@ class HsOfficeDebitorRepositoryIntegrationTest extends ContextBasedTestWithClean // given context("superuser-alex@hostsharing.net"); final var givenPartnerPerson = one(personRepo.findPersonByOptionalNameLike("First GmbH")); - final var givenContact = one(contactrealRepo.findContactByOptionalCaptionLike("first contact")); + final var givenContact = one(contactRealRepo.findContactByOptionalCaptionLike("first contact")); // when final var result = attempt(em, () -> { @@ -158,7 +158,7 @@ class HsOfficeDebitorRepositoryIntegrationTest extends ContextBasedTestWithClean attempt(em, () -> { final var givenPartnerPerson = one(personRepo.findPersonByOptionalNameLike("First GmbH")); final var givenDebitorPerson = one(personRepo.findPersonByOptionalNameLike("Fourth eG")); - final var givenContact = one(contactrealRepo.findContactByOptionalCaptionLike("fourth contact")); + final var givenContact = one(contactRealRepo.findContactByOptionalCaptionLike("fourth contact")); final var newDebitor = HsOfficeDebitorEntity.builder() .debitorNumberSuffix("22") .debitorRel(HsOfficeRelationRealEntity.builder() @@ -234,7 +234,7 @@ class HsOfficeDebitorRepositoryIntegrationTest extends ContextBasedTestWithClean context("superuser-alex@hostsharing.net"); // when - final var result = debitorRepo.findDebitorByOptionalNameLike(null); + final var result = debitorRepo.findDebitorsByOptionalNameLike(null); // then allTheseDebitorsAreReturned( @@ -256,7 +256,7 @@ class HsOfficeDebitorRepositoryIntegrationTest extends ContextBasedTestWithClean context("superuser-alex@hostsharing.net", assumedRole); // when: - final var result = debitorRepo.findDebitorByOptionalNameLike(""); + final var result = debitorRepo.findDebitorsByOptionalNameLike(""); // then: exactlyTheseDebitorsAreReturned(result, @@ -270,7 +270,7 @@ class HsOfficeDebitorRepositoryIntegrationTest extends ContextBasedTestWithClean context("selfregistered-test-user@hostsharing.org"); // when: - final var result = debitorRepo.findDebitorByOptionalNameLike(null); + final var result = debitorRepo.findDebitorsByOptionalNameLike(null); // then: assertThat(result).isEmpty(); @@ -278,7 +278,7 @@ class HsOfficeDebitorRepositoryIntegrationTest extends ContextBasedTestWithClean } @Nested - class FindByDebitorNumberLike { + class FindByDebitorNumber { @Test public void globalAdmin_canViewAllDebitors() { @@ -288,6 +288,23 @@ class HsOfficeDebitorRepositoryIntegrationTest extends ContextBasedTestWithClean // when final var result = debitorRepo.findDebitorByDebitorNumber(1000313); + // then + assertThat(result).map(Object::toString).contains( + "debitor(D-1000313: rel(anchor='IF Third OHG', type='DEBITOR', holder='IF Third OHG'), thi)"); + } + } + + @Nested + class FindByPartnerNumber { + + @Test + public void globalAdmin_canViewAllDebitors() { + // given + context("superuser-alex@hostsharing.net"); + + // when + final var result = debitorRepo.findDebitorsByPartnerNumber(10003); + // then exactlyTheseDebitorsAreReturned(result, "debitor(D-1000313: rel(anchor='IF Third OHG', type='DEBITOR', holder='IF Third OHG'), thi)"); @@ -303,7 +320,7 @@ class HsOfficeDebitorRepositoryIntegrationTest extends ContextBasedTestWithClean context("superuser-alex@hostsharing.net"); // when - final var result = debitorRepo.findDebitorByOptionalNameLike("third contact"); + final var result = debitorRepo.findDebitorsByOptionalNameLike("third contact"); // then exactlyTheseDebitorsAreReturned(result, "debitor(D-1000313: rel(anchor='IF Third OHG', type='DEBITOR', holder='IF Third OHG'), thi)"); @@ -324,7 +341,7 @@ class HsOfficeDebitorRepositoryIntegrationTest extends ContextBasedTestWithClean "hs_office.relation#FourtheG-with-DEBITOR-FourtheG:ADMIN", true); final var givenNewPartnerPerson = one(personRepo.findPersonByOptionalNameLike("First")); final var givenNewBillingPerson = one(personRepo.findPersonByOptionalNameLike("Firby")); - final var givenNewContact = one(contactrealRepo.findContactByOptionalCaptionLike("sixth contact")); + final var givenNewContact = one(contactRealRepo.findContactByOptionalCaptionLike("sixth contact")); final var givenNewBankAccount = one(bankAccountRepo.findByOptionalHolderLike("first")); final String givenNewVatId = "NEW-VAT-ID"; final String givenNewVatCountryCode = "NC"; @@ -613,7 +630,7 @@ class HsOfficeDebitorRepositoryIntegrationTest extends ContextBasedTestWithClean context("superuser-alex@hostsharing.net"); final var givenPartner = one(partnerRepo.findPartnerByOptionalNameLike(partnerName)); final var givenPartnerPerson = givenPartner.getPartnerRel().getHolder(); - final var givenContact = one(contactrealRepo.findContactByOptionalCaptionLike(contactCaption)); + final var givenContact = one(contactRealRepo.findContactByOptionalCaptionLike(contactCaption)); final var givenBankAccount = bankAccountHolder != null ? one(bankAccountRepo.findByOptionalHolderLike(bankAccountHolder)) : null; final var newDebitor = HsOfficeDebitorEntity.builder() diff --git a/src/test/java/net/hostsharing/hsadminng/hs/office/membership/HsOfficeMembershipControllerAcceptanceTest.java b/src/test/java/net/hostsharing/hsadminng/hs/office/membership/HsOfficeMembershipControllerAcceptanceTest.java index c2dd44c1..b0f99593 100644 --- a/src/test/java/net/hostsharing/hsadminng/hs/office/membership/HsOfficeMembershipControllerAcceptanceTest.java +++ b/src/test/java/net/hostsharing/hsadminng/hs/office/membership/HsOfficeMembershipControllerAcceptanceTest.java @@ -112,16 +112,16 @@ class HsOfficeMembershipControllerAcceptanceTest extends ContextBasedTestWithCle void globalAdmin_canViewMembershipsByPartnerUuid() { context.define("superuser-alex@hostsharing.net"); - final var partner = partnerRepo.findPartnerByPartnerNumber(10001); + final var partner = partnerRepo.findPartnerByPartnerNumber(10001).orElseThrow(); RestAssured // @formatter:off - .given() + .given() .header("current-subject", "superuser-alex@hostsharing.net") .port(port) - .when() + .when() .queryParam("partnerUuid", partner.getUuid() ) .get("http://localhost/api/hs/office/memberships") - .then().log().all().assertThat() + .then().log().all().assertThat() .statusCode(200) .contentType("application/json") .body("", lenientlyEquals(""" @@ -140,30 +140,30 @@ class HsOfficeMembershipControllerAcceptanceTest extends ContextBasedTestWithCle } @Test - void globalAdmin_canViewMembershipsByMemberNumber() { + void globalAdmin_canViewMembershipsByPartnerNumber() { RestAssured // @formatter:off .given() - .header("current-subject", "superuser-alex@hostsharing.net") - .port(port) + .header("current-subject", "superuser-alex@hostsharing.net") + .port(port) .when() - .queryParam("memberNumber", "M-1000202" ) - .get("http://localhost/api/hs/office/memberships") + .queryParam("partnerNumber", "P-10002" ) + .get("http://localhost/api/hs/office/memberships") .then().log().all().assertThat() - .statusCode(200) - .contentType("application/json") - .body("", lenientlyEquals(""" - [ - { - "partner": { "partnerNumber": "P-10002" }, - "memberNumber": "M-1000202", - "memberNumberSuffix": "02", - "validFrom": "2022-10-01", - "validTo": null, - "status": "ACTIVE" - } - ] - """)); + .statusCode(200) + .contentType("application/json") + .body("", lenientlyEquals(""" + [ + { + "partner": { "partnerNumber": "P-10002" }, + "memberNumber": "M-1000202", + "memberNumberSuffix": "02", + "validFrom": "2022-10-01", + "validTo": null, + "status": "ACTIVE" + } + ] + """)); // @formatter:on } } @@ -220,7 +220,7 @@ class HsOfficeMembershipControllerAcceptanceTest extends ContextBasedTestWithCle @Test void globalAdmin_canGetArbitraryMembership() { context.define("superuser-alex@hostsharing.net"); - final var givenMembershipUuid = membershipRepo.findMembershipByMemberNumber(1000101).getUuid(); + final var givenMembershipUuid = membershipRepo.findMembershipByMemberNumber(1000101).orElseThrow().getUuid(); RestAssured // @formatter:off .given() @@ -246,7 +246,7 @@ class HsOfficeMembershipControllerAcceptanceTest extends ContextBasedTestWithCle @Test void normalUser_canNotGetUnrelatedMembership() { context.define("superuser-alex@hostsharing.net"); - final var givenMembershipUuid = membershipRepo.findMembershipByMemberNumber(1000101).getUuid(); + final var givenMembershipUuid = membershipRepo.findMembershipByMemberNumber(1000101).orElseThrow().getUuid(); RestAssured // @formatter:off .given() @@ -261,7 +261,7 @@ class HsOfficeMembershipControllerAcceptanceTest extends ContextBasedTestWithCle @Test void partnerRelAgent_canGetRelatedMembership() { context.define("superuser-alex@hostsharing.net"); - final var givenMembershipUuid = membershipRepo.findMembershipByMemberNumber(1000303).getUuid(); + final var givenMembershipUuid = membershipRepo.findMembershipByMemberNumber(1000303).orElseThrow().getUuid(); RestAssured // @formatter:off .given() diff --git a/src/test/java/net/hostsharing/hsadminng/hs/office/membership/HsOfficeMembershipControllerRestTest.java b/src/test/java/net/hostsharing/hsadminng/hs/office/membership/HsOfficeMembershipControllerRestTest.java index 432a38e6..39af92bc 100644 --- a/src/test/java/net/hostsharing/hsadminng/hs/office/membership/HsOfficeMembershipControllerRestTest.java +++ b/src/test/java/net/hostsharing/hsadminng/hs/office/membership/HsOfficeMembershipControllerRestTest.java @@ -19,11 +19,16 @@ import org.springframework.test.context.ActiveProfiles; import org.springframework.test.web.servlet.MockMvc; import org.springframework.test.web.servlet.request.MockMvcRequestBuilders; +import java.util.List; +import java.util.Optional; import java.util.UUID; +import static io.hypersistence.utils.hibernate.type.range.Range.localDateRange; +import static net.hostsharing.hsadminng.rbac.test.JsonMatcher.lenientlyEquals; import static org.hamcrest.Matchers.containsString; import static org.hamcrest.Matchers.hasSize; import static org.hamcrest.Matchers.is; +import static org.mockito.ArgumentMatchers.any; import static org.mockito.Mockito.when; import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath; import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; @@ -33,6 +38,34 @@ import static org.springframework.test.web.servlet.result.MockMvcResultMatchers. @ActiveProfiles("test") public class HsOfficeMembershipControllerRestTest { + private static final HsOfficePartnerEntity PARTNER_12345 = HsOfficePartnerEntity.builder() + .partnerNumber(12345) + .build(); + public static final HsOfficeMembershipEntity MEMBERSHIP_1234501 = HsOfficeMembershipEntity.builder() + .partner(PARTNER_12345) + .memberNumberSuffix("01") + .validity(localDateRange("[2013-10-01,]")) + .status(HsOfficeMembershipStatus.ACTIVE) + .build(); + public static final HsOfficeMembershipEntity MEMBERSHIP_1234500 = HsOfficeMembershipEntity.builder() + .partner(PARTNER_12345) + .memberNumberSuffix("00") + .validity(localDateRange("[2011-04-01,2016-12-31]")) + .status(HsOfficeMembershipStatus.CANCELLED) + .build(); + public static final String MEMBERSHIP_1234501_JSON = """ + { + "partner": { + "partnerNumber":"P-12345" + }, + "memberNumber": "M-1234500", + "memberNumberSuffix": "00", + "validFrom": "2011-04-01", + "validTo": "2016-12-30", + "status":"CANCELLED" + } + """; + @Autowired MockMvc mockMvc; @@ -52,11 +85,11 @@ public class HsOfficeMembershipControllerRestTest { class GetListOfMemberships { @Test - void findMembershipByNonExistingMemberNumberReturnsEmptyList() throws Exception { + void findMembershipByNonExistingPartnerNumberReturnsEmptyList() throws Exception { // when mockMvc.perform(MockMvcRequestBuilders - .get("/api/hs/office/memberships?memberNumber=M-1234501") + .get("/api/hs/office/memberships?partnerNumber=P-12345") .header("current-subject", "superuser-alex@hostsharing.net") .contentType(MediaType.APPLICATION_JSON) .content(""" @@ -73,6 +106,116 @@ public class HsOfficeMembershipControllerRestTest { .andExpect(status().is2xxSuccessful()) .andExpect(jsonPath("$", hasSize(0))); } + + @Test + void findMembershipByExistingPartnerNumberReturnsAllRelatedMemberships() throws Exception { + + // given + when(membershipRepo.findMembershipsByPartnerNumber(12345)) + .thenReturn(List.of( + MEMBERSHIP_1234500, + MEMBERSHIP_1234501 + )); + + // when + mockMvc.perform(MockMvcRequestBuilders + .get("/api/hs/office/memberships?partnerNumber=P-12345") + .header("current-subject", "superuser-alex@hostsharing.net") + .contentType(MediaType.APPLICATION_JSON) + .content(""" + { + "partner.uuid": null, + "memberNumberSuffix": "01", + "validFrom": "2022-10-13", + "membershipFeeBillable": "true" + } + """) + .accept(MediaType.APPLICATION_JSON)) + + // then + .andExpect(status().is2xxSuccessful()) + .andExpect(jsonPath("$", hasSize(2))); + } + } + + @Nested + class GetSingleMembership { + + @Test + void byUuid() throws Exception { + + // given + final var givenUuid = UUID.randomUUID(); + when(membershipRepo.findByUuid(givenUuid)).thenReturn( + Optional.of(MEMBERSHIP_1234500) + ); + + // when + mockMvc.perform(MockMvcRequestBuilders + .get("/api/hs/office/memberships/" + givenUuid) + .header("current-subject", "superuser-alex@hostsharing.net") + .accept(MediaType.APPLICATION_JSON)) + + // then + .andExpect(status().is2xxSuccessful()) + .andExpect(jsonPath("$", lenientlyEquals(MEMBERSHIP_1234501_JSON))); + } + + @Test + void byUnavailableUuid() throws Exception { + + // given + when(membershipRepo.findByUuid(any(UUID.class))).thenReturn( + Optional.empty() + ); + + // when + mockMvc.perform(MockMvcRequestBuilders + .get("/api/hs/office/memberships/" + UUID.randomUUID()) + .header("current-subject", "superuser-alex@hostsharing.net") + .accept(MediaType.APPLICATION_JSON)) + + // then + .andExpect(status().isNotFound()); + } + + @Test + void byMemberNumber() throws Exception { + + // given + when(membershipRepo.findMembershipByMemberNumber(1234501)).thenReturn( + Optional.of(MEMBERSHIP_1234500) + ); + + // when + mockMvc.perform(MockMvcRequestBuilders + .get("/api/hs/office/memberships/M-1234501") + .header("current-subject", "superuser-alex@hostsharing.net") + .accept(MediaType.APPLICATION_JSON)) + + // then + .andExpect(status().is2xxSuccessful()) + .andExpect(jsonPath("$", lenientlyEquals(MEMBERSHIP_1234501_JSON))); + } + + @Test + void byUnavailableMemberNumber() throws Exception { + + // given + when(membershipRepo.findMembershipByMemberNumber(any(Integer.class))).thenReturn( + Optional.empty() + ); + + // when + mockMvc.perform(MockMvcRequestBuilders + .get("/api/hs/office/memberships/M-0000000") + .header("current-subject", "superuser-alex@hostsharing.net") + .accept(MediaType.APPLICATION_JSON)) + + // then + .andExpect(status().isNotFound()); + } + } @Nested @@ -163,10 +306,10 @@ public class HsOfficeMembershipControllerRestTest { public enum InvalidMemberSuffixVariants { MISSING("", "[memberNumberSuffix must not be null but is \"null\"]"), - TOO_SMALL("\"memberNumberSuffix\": \"9\",", "memberNumberSuffix size must be between 2 and 2 but is \"9\""), - TOO_LARGE("\"memberNumberSuffix\": \"100\",", "memberNumberSuffix size must be between 2 and 2 but is \"100\""), - NOT_NUMERIC("\"memberNumberSuffix\": \"AA\",", "memberNumberSuffix must match \"[0-9]+\" but is \"AA\""), - EMPTY("\"memberNumberSuffix\": \"\",", "memberNumberSuffix size must be between 2 and 2 but is \"\""); + TOO_SMALL("\"memberNumberSuffix\": \"9\",", "memberNumberSuffix must match \"[0-9]{2}\" but is \"9\""), + TOO_LARGE("\"memberNumberSuffix\": \"100\",", "memberNumberSuffix must match \"[0-9]{2}\" but is \"100\""), + NOT_NUMERIC("\"memberNumberSuffix\": \"AA\",", "memberNumberSuffix must match \"[0-9]{2}\" but is \"AA\""), + EMPTY("\"memberNumberSuffix\": \"\",", "memberNumberSuffix must match \"[0-9]{2}\" but is \"\""); private final String memberNumberSuffixEntry; private final String expectedErrorMessage; diff --git a/src/test/java/net/hostsharing/hsadminng/hs/office/membership/HsOfficeMembershipRepositoryIntegrationTest.java b/src/test/java/net/hostsharing/hsadminng/hs/office/membership/HsOfficeMembershipRepositoryIntegrationTest.java index 0929f370..fc3599d2 100644 --- a/src/test/java/net/hostsharing/hsadminng/hs/office/membership/HsOfficeMembershipRepositoryIntegrationTest.java +++ b/src/test/java/net/hostsharing/hsadminng/hs/office/membership/HsOfficeMembershipRepositoryIntegrationTest.java @@ -156,7 +156,7 @@ class HsOfficeMembershipRepositoryIntegrationTest extends ContextBasedTestWithCl context("superuser-alex@hostsharing.net"); // when - final var result = membershipRepo.findMembershipsByOptionalPartnerUuid(null); + final var result = membershipRepo.findAll(); // then exactlyTheseMembershipsAreReturned( @@ -173,7 +173,7 @@ class HsOfficeMembershipRepositoryIntegrationTest extends ContextBasedTestWithCl final var givenPartner = partnerRepo.findPartnerByOptionalNameLike("First").get(0); // when - final var result = membershipRepo.findMembershipsByOptionalPartnerUuid(givenPartner.getUuid()); + final var result = membershipRepo.findMembershipsByPartnerUuid(givenPartner.getUuid()); // then exactlyTheseMembershipsAreReturned(result, @@ -186,7 +186,7 @@ class HsOfficeMembershipRepositoryIntegrationTest extends ContextBasedTestWithCl context("superuser-alex@hostsharing.net"); // when - final var result = membershipRepo.findMembershipByMemberNumber(1000202); + final var result = membershipRepo.findMembershipByMemberNumber(1000202).orElseThrow(); // then assertThat(result) @@ -194,6 +194,34 @@ class HsOfficeMembershipRepositoryIntegrationTest extends ContextBasedTestWithCl .extracting(Object::toString) .isEqualTo("Membership(M-1000202, P-10002, [2022-10-01,), ACTIVE)"); } + + @Test + public void globalAdmin_withoutAssumedRole_canFindAllMembershipsByPartnerNumberAndSuffix() { + // given + context("superuser-alex@hostsharing.net"); + + // when + final var result = membershipRepo.findMembershipByPartnerNumberAndSuffix(10002, "02").orElseThrow(); + + // then + assertThat(result) + .isNotNull() + .extracting(Object::toString) + .isEqualTo("Membership(M-1000202, P-10002, [2022-10-01,), ACTIVE)"); + } + + @Test + public void globalAdmin_withoutAssumedRole_canFindAllMembershipsByPartnerNumber() { + // given + context("superuser-alex@hostsharing.net"); + + // when + final var result = membershipRepo.findMembershipsByPartnerNumber(10002); + + // then + exactlyTheseMembershipsAreReturned(result, + "Membership(M-1000202, P-10002, [2022-10-01,), ACTIVE)"); + } } @Nested @@ -339,7 +367,7 @@ class HsOfficeMembershipRepositoryIntegrationTest extends ContextBasedTestWithCl select currentTask, targetTable, targetOp, targetdelta->>'membernumbersuffix' from base.tx_journal_v where targettable = 'hs_office.membership'; - """); + """); // when @SuppressWarnings("unchecked") final List customerLogEntries = query.getResultList(); diff --git a/src/test/java/net/hostsharing/hsadminng/hs/office/partner/HsOfficePartnerControllerRestTest.java b/src/test/java/net/hostsharing/hsadminng/hs/office/partner/HsOfficePartnerControllerRestTest.java index dbc6081b..4d016725 100644 --- a/src/test/java/net/hostsharing/hsadminng/hs/office/partner/HsOfficePartnerControllerRestTest.java +++ b/src/test/java/net/hostsharing/hsadminng/hs/office/partner/HsOfficePartnerControllerRestTest.java @@ -168,6 +168,45 @@ class HsOfficePartnerControllerRestTest { } } + @Nested + class GetSinglePartnerByPartnerNumber { + + @Test + void respondWithPartner_ifPartnerNumberIsAvailable() throws Exception { + // given + when(partnerRepo.findPartnerByPartnerNumber(12345)).thenReturn(Optional.of(HsOfficePartnerEntity.builder() + .partnerNumber(12345) + .build())); + + // when + mockMvc.perform(MockMvcRequestBuilders + .get("/api/hs/office/partners/P-12345") + .header("current-subject", "superuser-alex@hostsharing.net") + .contentType(MediaType.APPLICATION_JSON) + .accept(MediaType.APPLICATION_JSON)) + + // then + .andExpect(status().isOk()) + .andExpect(jsonPath("partnerNumber", is("P-12345"))); + } + + @Test + void respondNotFound_ifPartnerNumberIsNotAvailable() throws Exception { + // given + when(partnerRepo.findPartnerByPartnerNumber(12345)).thenReturn(Optional.empty()); + + // when + mockMvc.perform(MockMvcRequestBuilders + .get("/api/hs/office/partners/P-12345") + .header("current-subject", "superuser-alex@hostsharing.net") + .contentType(MediaType.APPLICATION_JSON) + .accept(MediaType.APPLICATION_JSON)) + + // then + .andExpect(status().isNotFound()); + } + } + @Nested class DeletePartner { diff --git a/src/test/java/net/hostsharing/hsadminng/hs/office/partner/HsOfficePartnerRepositoryIntegrationTest.java b/src/test/java/net/hostsharing/hsadminng/hs/office/partner/HsOfficePartnerRepositoryIntegrationTest.java index 79ff449d..92683a6b 100644 --- a/src/test/java/net/hostsharing/hsadminng/hs/office/partner/HsOfficePartnerRepositoryIntegrationTest.java +++ b/src/test/java/net/hostsharing/hsadminng/hs/office/partner/HsOfficePartnerRepositoryIntegrationTest.java @@ -243,7 +243,7 @@ class HsOfficePartnerRepositoryIntegrationTest extends ContextBasedTestWithClean context("superuser-alex@hostsharing.net"); // when - final var result = partnerRepo.findPartnerByPartnerNumber(10001); + final var result = partnerRepo.findPartnerByPartnerNumber(10001).orElseThrow(); // then assertThat(result) diff --git a/src/test/java/net/hostsharing/hsadminng/hs/office/scenarios/debitor/CreateSepaMandateForDebitor.java b/src/test/java/net/hostsharing/hsadminng/hs/office/scenarios/debitor/CreateSepaMandateForDebitor.java index b50cc7c9..62ae5b54 100644 --- a/src/test/java/net/hostsharing/hsadminng/hs/office/scenarios/debitor/CreateSepaMandateForDebitor.java +++ b/src/test/java/net/hostsharing/hsadminng/hs/office/scenarios/debitor/CreateSepaMandateForDebitor.java @@ -17,9 +17,9 @@ public class CreateSepaMandateForDebitor extends UseCase - httpGet("/api/hs/office/debitors?debitorNumber=&{debitorNumber}") + httpGet("/api/hs/office/debitors/%{debitorNumber}") .expecting(OK).expecting(JSON), - response -> response.expectArrayElements(1).getFromBody("[0].uuid") + response -> response.getFromBody("uuid") ); obtain("BankAccount: Test AG - debit bank account", () -> diff --git a/src/test/java/net/hostsharing/hsadminng/hs/office/scenarios/membership/CancelMembership.java b/src/test/java/net/hostsharing/hsadminng/hs/office/scenarios/membership/CancelMembership.java index d5d00900..5f3c3196 100644 --- a/src/test/java/net/hostsharing/hsadminng/hs/office/scenarios/membership/CancelMembership.java +++ b/src/test/java/net/hostsharing/hsadminng/hs/office/scenarios/membership/CancelMembership.java @@ -18,9 +18,8 @@ public class CancelMembership extends UseCase { protected HttpResponse run() { obtain("Membership: %{memberNumber}", () -> - httpGet("/api/hs/office/memberships?memberNumber=%{memberNumber}") - .expectArrayElements(1), - response -> response.expectArrayElements(1).getFromBody("[0].uuid") + httpGet("/api/hs/office/memberships/%{memberNumber}"), + response -> response.getFromBody("uuid") ); return withTitle("Patch the New Status Into the Membership", () -> diff --git a/src/test/java/net/hostsharing/hsadminng/hs/office/scenarios/membership/coopassets/CreateCoopAssetsTransaction.java b/src/test/java/net/hostsharing/hsadminng/hs/office/scenarios/membership/coopassets/CreateCoopAssetsTransaction.java index beb78b52..1052db28 100644 --- a/src/test/java/net/hostsharing/hsadminng/hs/office/scenarios/membership/coopassets/CreateCoopAssetsTransaction.java +++ b/src/test/java/net/hostsharing/hsadminng/hs/office/scenarios/membership/coopassets/CreateCoopAssetsTransaction.java @@ -18,9 +18,9 @@ public abstract class CreateCoopAssetsTransaction extends UseCase - httpGet("/api/hs/office/memberships?memberNumber=&{memberNumber}") - .expecting(OK).expecting(JSON).expectArrayElements(1), - response -> response.getFromBody("$[0].uuid") + httpGet("/api/hs/office/memberships/%{memberNumber}") + .expecting(OK).expecting(JSON), + response -> response.getFromBody("uuid") ); return withTitle("Create the Coop-Assets-%{transactionType} Transaction", () -> diff --git a/src/test/java/net/hostsharing/hsadminng/hs/office/scenarios/membership/coopshares/CreateCoopSharesTransaction.java b/src/test/java/net/hostsharing/hsadminng/hs/office/scenarios/membership/coopshares/CreateCoopSharesTransaction.java index a70cbdf5..6c215b5d 100644 --- a/src/test/java/net/hostsharing/hsadminng/hs/office/scenarios/membership/coopshares/CreateCoopSharesTransaction.java +++ b/src/test/java/net/hostsharing/hsadminng/hs/office/scenarios/membership/coopshares/CreateCoopSharesTransaction.java @@ -18,9 +18,9 @@ public abstract class CreateCoopSharesTransaction extends UseCase - httpGet("/api/hs/office/memberships?memberNumber=&{memberNumber}") - .expecting(OK).expecting(JSON).expectArrayElements(1), - response -> response.getFromBody("$[0].uuid") + httpGet("/api/hs/office/memberships/%{memberNumber}") + .expecting(OK).expecting(JSON), + response -> response.getFromBody("uuid") ); return withTitle("Create the Coop-Shares-%{transactionType} Transaction", () -> diff --git a/src/test/java/net/hostsharing/hsadminng/hs/office/sepamandate/HsOfficeSepaMandateControllerAcceptanceTest.java b/src/test/java/net/hostsharing/hsadminng/hs/office/sepamandate/HsOfficeSepaMandateControllerAcceptanceTest.java index 63cce53f..ff5c4e46 100644 --- a/src/test/java/net/hostsharing/hsadminng/hs/office/sepamandate/HsOfficeSepaMandateControllerAcceptanceTest.java +++ b/src/test/java/net/hostsharing/hsadminng/hs/office/sepamandate/HsOfficeSepaMandateControllerAcceptanceTest.java @@ -138,7 +138,7 @@ class HsOfficeSepaMandateControllerAcceptanceTest extends ContextBasedTestWithCl void globalAdmin_canPostNewSepaMandate() { context.define("superuser-alex@hostsharing.net"); - final var givenDebitor = debitorRepo.findDebitorByOptionalNameLike("Third").get(0); + final var givenDebitor = debitorRepo.findDebitorsByOptionalNameLike("Third").get(0); final var givenBankAccount = bankAccountRepo.findByIbanOrderByIbanAsc("DE02200505501015871393").get(0); final var location = RestAssured // @formatter:off @@ -180,7 +180,7 @@ class HsOfficeSepaMandateControllerAcceptanceTest extends ContextBasedTestWithCl void globalAdmin_canNotPostNewSepaMandateWhenDebitorUuidIsMissing() { context.define("superuser-alex@hostsharing.net"); - final var givenDebitor = debitorRepo.findDebitorByOptionalNameLike("Third").get(0); + final var givenDebitor = debitorRepo.findDebitorsByOptionalNameLike("Third").get(0); final var givenBankAccount = bankAccountRepo.findByIbanOrderByIbanAsc("DE02200505501015871393").get(0); final var location = RestAssured // @formatter:off @@ -205,7 +205,7 @@ class HsOfficeSepaMandateControllerAcceptanceTest extends ContextBasedTestWithCl void globalAdmin_canNotPostNewSepaMandate_ifBankAccountDoesNotExist() { context.define("superuser-alex@hostsharing.net"); - final var givenDebitor = debitorRepo.findDebitorByOptionalNameLike("Third").get(0); + final var givenDebitor = debitorRepo.findDebitorsByOptionalNameLike("Third").get(0); final var givenBankAccountUuid = UUID.fromString("00000000-0000-0000-0000-000000000000"); final var location = RestAssured // @formatter:off @@ -524,7 +524,7 @@ class HsOfficeSepaMandateControllerAcceptanceTest extends ContextBasedTestWithCl private HsOfficeSepaMandateEntity givenSomeTemporarySepaMandateForDebitorNumber(final int debitorNumber) { return jpaAttempt.transacted(() -> { context.define("superuser-alex@hostsharing.net"); - final var givenDebitor = debitorRepo.findDebitorByDebitorNumber(debitorNumber).get(0); + final var givenDebitor = debitorRepo.findDebitorByDebitorNumber(debitorNumber).orElseThrow(); final var bankAccountHolder = ofNullable(givenDebitor.getPartner().getPartnerRel().getHolder().getTradeName()) .orElse(givenDebitor.getPartner().getPartnerRel().getHolder().getFamilyName()); final var givenBankAccount = bankAccountRepo.findByOptionalHolderLike(bankAccountHolder).get(0); diff --git a/src/test/java/net/hostsharing/hsadminng/hs/office/sepamandate/HsOfficeSepaMandateRepositoryIntegrationTest.java b/src/test/java/net/hostsharing/hsadminng/hs/office/sepamandate/HsOfficeSepaMandateRepositoryIntegrationTest.java index 8046fc68..8e7512c3 100644 --- a/src/test/java/net/hostsharing/hsadminng/hs/office/sepamandate/HsOfficeSepaMandateRepositoryIntegrationTest.java +++ b/src/test/java/net/hostsharing/hsadminng/hs/office/sepamandate/HsOfficeSepaMandateRepositoryIntegrationTest.java @@ -66,7 +66,7 @@ class HsOfficeSepaMandateRepositoryIntegrationTest extends ContextBasedTestWithC // given context("superuser-alex@hostsharing.net"); final var count = sepaMandateRepo.count(); - final var givenDebitor = debitorRepo.findDebitorByOptionalNameLike("First").get(0); + final var givenDebitor = debitorRepo.findDebitorsByOptionalNameLike("First").get(0); final var givenBankAccount = bankAccountRepo.findByOptionalHolderLike("Paul Winkler").get(0); // when @@ -100,7 +100,7 @@ class HsOfficeSepaMandateRepositoryIntegrationTest extends ContextBasedTestWithC // when attempt(em, () -> { - final var givenDebitor = debitorRepo.findDebitorByOptionalNameLike("First").get(0); + final var givenDebitor = debitorRepo.findDebitorsByOptionalNameLike("First").get(0); final var givenBankAccount = bankAccountRepo.findByOptionalHolderLike("Paul Winkler").get(0); final var newSepaMandate = HsOfficeSepaMandateEntity.builder() .debitor(givenDebitor) @@ -397,7 +397,7 @@ class HsOfficeSepaMandateRepositoryIntegrationTest extends ContextBasedTestWithC private HsOfficeSepaMandateEntity givenSomeTemporarySepaMandate(final String iban) { return jpaAttempt.transacted(() -> { context("superuser-alex@hostsharing.net"); - final var givenDebitor = debitorRepo.findDebitorByOptionalNameLike("First").get(0); + final var givenDebitor = debitorRepo.findDebitorsByOptionalNameLike("First").get(0); final var givenBankAccount = bankAccountRepo.findByIbanOrderByIbanAsc(iban).get(0); final var newSepaMandate = HsOfficeSepaMandateEntity.builder() .debitor(givenDebitor) From 20fa27194bafbe4ddd8f0d4a2bc695d132960c58 Mon Sep 17 00:00:00 2001 From: Michael Hoennig Date: Fri, 13 Dec 2024 14:09:01 +0100 Subject: [PATCH 3/3] create relation with holder- and contact-data, and search for contact emailAddress + relation mark (#136) Co-authored-by: Michael Hoennig Reviewed-on: https://dev.hostsharing.net/hostsharing/hs.hsadmin.ng/pulls/136 Reviewed-by: Marc Sandlus --- .../hsadminng/errors/Validate.java | 10 ++- .../contact/HsOfficeContactController.java | 9 ++- .../HsOfficeContactRbacRepository.java | 10 +++ .../HsOfficeMembershipController.java | 2 +- .../person/HsOfficePersonController.java | 4 +- .../relation/HsOfficeRelationController.java | 61 +++++++++++++----- .../HsOfficeRelationRbacRepository.java | 16 +++-- .../hs-office/hs-office-contacts.yaml | 11 +++- .../hs-office/hs-office-relation-schemas.yaml | 16 +++-- .../hs-office/hs-office-relations.yaml | 8 ++- .../hsadminng/errors/ValidateUnitTest.java | 61 +++++++++++++----- ...eContactRbacRepositoryIntegrationTest.java | 18 +++++- ...fficeRelationControllerAcceptanceTest.java | 61 +++++++++++++++++- ...ficeRelationRepositoryIntegrationTest.java | 2 +- .../scenarios/HsOfficeScenarioTests.java | 22 ++++++- ...ExistingPersonAndContactToMailinglist.java | 54 ++++++++++++++++ ...cribeNewPersonAndContactToMailinglist.java | 46 ++++++++++++++ .../subscription/SubscribeToMailinglist.java | 62 ------------------- 18 files changed, 354 insertions(+), 119 deletions(-) create mode 100644 src/test/java/net/hostsharing/hsadminng/hs/office/scenarios/subscription/SubscribeExistingPersonAndContactToMailinglist.java create mode 100644 src/test/java/net/hostsharing/hsadminng/hs/office/scenarios/subscription/SubscribeNewPersonAndContactToMailinglist.java delete mode 100644 src/test/java/net/hostsharing/hsadminng/hs/office/scenarios/subscription/SubscribeToMailinglist.java diff --git a/src/main/java/net/hostsharing/hsadminng/errors/Validate.java b/src/main/java/net/hostsharing/hsadminng/errors/Validate.java index 3ce68fe9..73f02e89 100644 --- a/src/main/java/net/hostsharing/hsadminng/errors/Validate.java +++ b/src/main/java/net/hostsharing/hsadminng/errors/Validate.java @@ -13,8 +13,16 @@ public class Validate { return new Validate(variableNames); } - public final void atMaxOneNonNull(final Object var1, final Object var2) { + public final void atMaxOne(final Object var1, final Object var2) { if (var1 != null && var2 != null) { + throw new ValidationException( + "At maximum one of (" + variableNames + ") must be non-null, " + + "but are (" + var1 + ", " + var2 + ")"); + } + } + + public final void exactlyOne(final Object var1, final Object var2) { + if ((var1 != null) == (var2 != null)) { throw new ValidationException( "Exactly one of (" + variableNames + ") must be non-null, " + "but are (" + var1 + ", " + var2 + ")"); diff --git a/src/main/java/net/hostsharing/hsadminng/hs/office/contact/HsOfficeContactController.java b/src/main/java/net/hostsharing/hsadminng/hs/office/contact/HsOfficeContactController.java index fe08bd4f..572a0ce8 100644 --- a/src/main/java/net/hostsharing/hsadminng/hs/office/contact/HsOfficeContactController.java +++ b/src/main/java/net/hostsharing/hsadminng/hs/office/contact/HsOfficeContactController.java @@ -17,6 +17,7 @@ import java.util.List; import java.util.UUID; import java.util.function.BiConsumer; +import static net.hostsharing.hsadminng.errors.Validate.validate; import static net.hostsharing.hsadminng.mapper.KeyValueMap.from; @RestController @@ -38,10 +39,14 @@ public class HsOfficeContactController implements HsOfficeContactsApi { public ResponseEntity> getListOfContacts( final String currentSubject, final String assumedRoles, - final String caption) { + final String caption, + final String emailAddress) { context.define(currentSubject, assumedRoles); - final var entities = contactRepo.findContactByOptionalCaptionLike(caption); + validate("caption, emailAddress").atMaxOne(caption, emailAddress); + final var entities = emailAddress != null + ? contactRepo.findContactByEmailAddress(emailAddress) + : contactRepo.findContactByOptionalCaptionLike(caption); final var resources = mapper.mapList(entities, HsOfficeContactResource.class); return ResponseEntity.ok(resources); diff --git a/src/main/java/net/hostsharing/hsadminng/hs/office/contact/HsOfficeContactRbacRepository.java b/src/main/java/net/hostsharing/hsadminng/hs/office/contact/HsOfficeContactRbacRepository.java index f3a88bc0..4576ef58 100644 --- a/src/main/java/net/hostsharing/hsadminng/hs/office/contact/HsOfficeContactRbacRepository.java +++ b/src/main/java/net/hostsharing/hsadminng/hs/office/contact/HsOfficeContactRbacRepository.java @@ -21,6 +21,16 @@ public interface HsOfficeContactRbacRepository extends Repository findContactByOptionalCaptionLike(String caption); + @Query(value = """ + select c.* from hs_office.contact_rv c + where exists ( + SELECT 1 FROM jsonb_each_text(c.emailAddresses) AS kv(key, value) + WHERE kv.value LIKE :emailAddressRegEx + ) + """, nativeQuery = true) + @Timed("app.office.contacts.repo.findContactByEmailAddress.rbac") + List findContactByEmailAddress(final String emailAddressRegEx); + @Timed("app.office.contacts.repo.save.rbac") HsOfficeContactRbacEntity save(final HsOfficeContactRbacEntity entity); diff --git a/src/main/java/net/hostsharing/hsadminng/hs/office/membership/HsOfficeMembershipController.java b/src/main/java/net/hostsharing/hsadminng/hs/office/membership/HsOfficeMembershipController.java index 84994ceb..43cc292d 100644 --- a/src/main/java/net/hostsharing/hsadminng/hs/office/membership/HsOfficeMembershipController.java +++ b/src/main/java/net/hostsharing/hsadminng/hs/office/membership/HsOfficeMembershipController.java @@ -43,7 +43,7 @@ public class HsOfficeMembershipController implements HsOfficeMembershipsApi { final String partnerNumber) { context.define(currentSubject, assumedRoles); - validate("partnerUuid, partnerNumber").atMaxOneNonNull(partnerUuid, partnerNumber); + validate("partnerUuid, partnerNumber").atMaxOne(partnerUuid, partnerNumber); final var entities = partnerNumber != null ? membershipRepo.findMembershipsByPartnerNumber( diff --git a/src/main/java/net/hostsharing/hsadminng/hs/office/person/HsOfficePersonController.java b/src/main/java/net/hostsharing/hsadminng/hs/office/person/HsOfficePersonController.java index 3c39c616..02012820 100644 --- a/src/main/java/net/hostsharing/hsadminng/hs/office/person/HsOfficePersonController.java +++ b/src/main/java/net/hostsharing/hsadminng/hs/office/person/HsOfficePersonController.java @@ -35,10 +35,10 @@ public class HsOfficePersonController implements HsOfficePersonsApi { public ResponseEntity> getListOfPersons( final String currentSubject, final String assumedRoles, - final String caption) { + final String name) { context.define(currentSubject, assumedRoles); - final var entities = personRepo.findPersonByOptionalNameLike(caption); + final var entities = personRepo.findPersonByOptionalNameLike(name); final var resources = mapper.mapList(entities, HsOfficePersonResource.class); return ResponseEntity.ok(resources); diff --git a/src/main/java/net/hostsharing/hsadminng/hs/office/relation/HsOfficeRelationController.java b/src/main/java/net/hostsharing/hsadminng/hs/office/relation/HsOfficeRelationController.java index d543e81e..a4f17edf 100644 --- a/src/main/java/net/hostsharing/hsadminng/hs/office/relation/HsOfficeRelationController.java +++ b/src/main/java/net/hostsharing/hsadminng/hs/office/relation/HsOfficeRelationController.java @@ -2,9 +2,12 @@ package net.hostsharing.hsadminng.hs.office.relation; import io.micrometer.core.annotation.Timed; import net.hostsharing.hsadminng.context.Context; +import net.hostsharing.hsadminng.errors.Validate; +import net.hostsharing.hsadminng.hs.office.contact.HsOfficeContactRealEntity; import net.hostsharing.hsadminng.hs.office.contact.HsOfficeContactRealRepository; import net.hostsharing.hsadminng.hs.office.generated.api.v1.api.HsOfficeRelationsApi; import net.hostsharing.hsadminng.hs.office.generated.api.v1.model.*; +import net.hostsharing.hsadminng.hs.office.person.HsOfficePersonRealEntity; import net.hostsharing.hsadminng.hs.office.person.HsOfficePersonRealRepository; import net.hostsharing.hsadminng.mapper.StandardMapper; import org.springframework.beans.factory.annotation.Autowired; @@ -20,6 +23,7 @@ import java.util.NoSuchElementException; import java.util.UUID; import java.util.function.BiConsumer; +import static net.hostsharing.hsadminng.mapper.KeyValueMap.from; @RestController public class HsOfficeRelationController implements HsOfficeRelationsApi { @@ -31,10 +35,10 @@ public class HsOfficeRelationController implements HsOfficeRelationsApi { private StandardMapper mapper; @Autowired - private HsOfficeRelationRbacRepository relationRbacRepo; + private HsOfficeRelationRbacRepository rbacRelationRepo; @Autowired - private HsOfficePersonRealRepository personRepo; + private HsOfficePersonRealRepository realPersonRepo; @Autowired private HsOfficeContactRealRepository realContactRepo; @@ -50,15 +54,16 @@ public class HsOfficeRelationController implements HsOfficeRelationsApi { final String assumedRoles, final UUID personUuid, final HsOfficeRelationTypeResource relationType, + final String mark, final String personData, final String contactData) { context.define(currentSubject, assumedRoles); final List entities = - relationRbacRepo.findRelationRelatedToPersonUuidRelationTypePersonAndContactData( + rbacRelationRepo.findRelationRelatedToPersonUuidRelationTypeMarkPersonAndContactData( personUuid, relationType == null ? null : HsOfficeRelationType.valueOf(relationType.name()), - personData, contactData); + mark, personData, contactData); final var resources = mapper.mapList(entities, HsOfficeRelationResource.class, RELATION_ENTITY_TO_RESOURCE_POSTMAPPER); @@ -78,17 +83,34 @@ public class HsOfficeRelationController implements HsOfficeRelationsApi { final var entityToSave = new HsOfficeRelationRbacEntity(); entityToSave.setType(HsOfficeRelationType.valueOf(body.getType())); entityToSave.setMark(body.getMark()); - entityToSave.setAnchor(personRepo.findByUuid(body.getAnchorUuid()).orElseThrow( + + entityToSave.setAnchor(realPersonRepo.findByUuid(body.getAnchorUuid()).orElseThrow( () -> new NoSuchElementException("cannot find Person by anchorUuid: " + body.getAnchorUuid()) )); - entityToSave.setHolder(personRepo.findByUuid(body.getHolderUuid()).orElseThrow( - () -> new NoSuchElementException("cannot find Person by holderUuid: " + body.getHolderUuid()) - )); - entityToSave.setContact(realContactRepo.findByUuid(body.getContactUuid()).orElseThrow( - () -> new NoSuchElementException("cannot find Contact by contactUuid: " + body.getContactUuid()) - )); - final var saved = relationRbacRepo.save(entityToSave); + Validate.validate("anchor, anchor.uuid").exactlyOne(body.getHolder(), body.getHolderUuid()); + if ( body.getHolderUuid() != null) { + entityToSave.setHolder(realPersonRepo.findByUuid(body.getHolderUuid()).orElseThrow( + () -> new NoSuchElementException("cannot find Person by holderUuid: " + body.getHolderUuid()) + )); + } else { + entityToSave.setHolder(realPersonRepo.save( + mapper.map(body.getHolder(), HsOfficePersonRealEntity.class) + ) ); + } + + Validate.validate("contact, contact.uuid").exactlyOne(body.getContact(), body.getContactUuid()); + if ( body.getContactUuid() != null) { + entityToSave.setContact(realContactRepo.findByUuid(body.getContactUuid()).orElseThrow( + () -> new NoSuchElementException("cannot find Contact by contactUuid: " + body.getContactUuid()) + )); + } else { + entityToSave.setContact(realContactRepo.save( + mapper.map(body.getContact(), HsOfficeContactRealEntity.class, CONTACT_RESOURCE_TO_ENTITY_POSTMAPPER) + ) ); + } + + final var saved = rbacRelationRepo.save(entityToSave); final var uri = MvcUriComponentsBuilder.fromController(getClass()) @@ -110,7 +132,7 @@ public class HsOfficeRelationController implements HsOfficeRelationsApi { context.define(currentSubject, assumedRoles); - final var result = relationRbacRepo.findByUuid(relationUuid); + final var result = rbacRelationRepo.findByUuid(relationUuid); if (result.isEmpty()) { return ResponseEntity.notFound().build(); } @@ -126,7 +148,7 @@ public class HsOfficeRelationController implements HsOfficeRelationsApi { final UUID relationUuid) { context.define(currentSubject, assumedRoles); - final var result = relationRbacRepo.deleteByUuid(relationUuid); + final var result = rbacRelationRepo.deleteByUuid(relationUuid); if (result == 0) { return ResponseEntity.notFound().build(); } @@ -145,11 +167,11 @@ public class HsOfficeRelationController implements HsOfficeRelationsApi { context.define(currentSubject, assumedRoles); - final var current = relationRbacRepo.findByUuid(relationUuid).orElseThrow(); + final var current = rbacRelationRepo.findByUuid(relationUuid).orElseThrow(); new HsOfficeRelationEntityPatcher(em, current).apply(body); - final var saved = relationRbacRepo.save(current); + final var saved = rbacRelationRepo.save(current); final var mapped = mapper.map(saved, HsOfficeRelationResource.class); return ResponseEntity.ok(mapped); } @@ -159,4 +181,11 @@ public class HsOfficeRelationController implements HsOfficeRelationsApi { resource.setHolder(mapper.map(entity.getHolder(), HsOfficePersonResource.class)); resource.setContact(mapper.map(entity.getContact(), HsOfficeContactResource.class)); }; + + + @SuppressWarnings("unchecked") + final BiConsumer CONTACT_RESOURCE_TO_ENTITY_POSTMAPPER = (resource, entity) -> { + entity.putEmailAddresses(from(resource.getEmailAddresses())); + entity.putPhoneNumbers(from(resource.getPhoneNumbers())); + }; } diff --git a/src/main/java/net/hostsharing/hsadminng/hs/office/relation/HsOfficeRelationRbacRepository.java b/src/main/java/net/hostsharing/hsadminng/hs/office/relation/HsOfficeRelationRbacRepository.java index 0443bc00..82e245ae 100644 --- a/src/main/java/net/hostsharing/hsadminng/hs/office/relation/HsOfficeRelationRbacRepository.java +++ b/src/main/java/net/hostsharing/hsadminng/hs/office/relation/HsOfficeRelationRbacRepository.java @@ -26,24 +26,29 @@ public interface HsOfficeRelationRbacRepository extends Repository findRelationRelatedToPersonUuidRelationTypePersonAndContactData( + default List findRelationRelatedToPersonUuidRelationTypeMarkPersonAndContactData( final UUID personUuid, final HsOfficeRelationType relationType, + final String mark, final String personData, final String contactData) { - return findRelationRelatedToPersonUuidRelationTypePersonAndContactDataImpl( - personUuid, toStringOrNull(relationType), toSqlLikeOperand(personData), toSqlLikeOperand(contactData)); + return findRelationRelatedToPersonUuidRelationByTypeMarkPersonAndContactDataImpl( + personUuid, toStringOrNull(relationType), + toSqlLikeOperand(mark), toSqlLikeOperand(personData), toSqlLikeOperand(contactData)); } + // TODO: use ELIKE instead of lower(...) LIKE ...? Or use jsonb_path with RegEx like emailAddressRegEx in ContactRepo? @Query(value = """ SELECT rel FROM HsOfficeRelationRbacEntity AS rel WHERE (:relationType IS NULL OR CAST(rel.type AS String) = :relationType) AND ( :personUuid IS NULL OR rel.anchor.uuid = :personUuid OR rel.holder.uuid = :personUuid ) + AND ( :mark IS NULL OR lower(rel.mark) LIKE :mark ) AND ( :personData IS NULL OR lower(rel.anchor.tradeName) LIKE :personData OR lower(rel.holder.tradeName) LIKE :personData OR lower(rel.anchor.familyName) LIKE :personData OR lower(rel.holder.familyName) LIKE :personData @@ -54,10 +59,11 @@ public interface HsOfficeRelationRbacRepository extends Repository findRelationRelatedToPersonUuidRelationTypePersonAndContactDataImpl( + @Timed("app.office.relations.repo.findRelationRelatedToPersonUuidRelationByTypeMarkPersonAndContactDataImpl.rbac") + List findRelationRelatedToPersonUuidRelationByTypeMarkPersonAndContactDataImpl( final UUID personUuid, final String relationType, + final String mark, final String personData, final String contactData); diff --git a/src/main/resources/api-definition/hs-office/hs-office-contacts.yaml b/src/main/resources/api-definition/hs-office/hs-office-contacts.yaml index f7412ddf..d6ca9db5 100644 --- a/src/main/resources/api-definition/hs-office/hs-office-contacts.yaml +++ b/src/main/resources/api-definition/hs-office/hs-office-contacts.yaml @@ -7,12 +7,19 @@ get: parameters: - $ref: 'auth.yaml#/components/parameters/currentSubject' - $ref: 'auth.yaml#/components/parameters/assumedRoles' - - name: name + - name: caption in: query required: false schema: type: string - description: Prefix of caption to filter the results. + description: Beginning of caption to filter the results. + - name: emailAddress + in: query + required: false + schema: + type: string + description: + Email-address to filter the results, use '%' as wildcard. responses: "200": description: OK diff --git a/src/main/resources/api-definition/hs-office/hs-office-relation-schemas.yaml b/src/main/resources/api-definition/hs-office/hs-office-relation-schemas.yaml index 8cf1f03f..9b8d2e46 100644 --- a/src/main/resources/api-definition/hs-office/hs-office-relation-schemas.yaml +++ b/src/main/resources/api-definition/hs-office/hs-office-relation-schemas.yaml @@ -52,6 +52,8 @@ components: holder.uuid: type: string format: uuid + holder: + $ref: 'hs-office-person-schemas.yaml#/components/schemas/HsOfficePersonInsert' type: type: string nullable: true @@ -61,11 +63,17 @@ components: contact.uuid: type: string format: uuid + contact: + $ref: 'hs-office-contact-schemas.yaml#/components/schemas/HsOfficeContactInsert' required: - - anchor.uuid - - holder.uuid - - type - - contact.uuid + - anchor.uuid + - type + # soon we might need to be able to use this: + # https://community.smartbear.com/discussions/swaggerostools/defining-conditional-attributes-in-openapi/222410 + # For now we just describe the conditionally required properties: + description: + Additionally to `type` and `anchor.uuid`, either `anchor.uuid` or `anchor` + and either `contact` or `contact.uuid` need to be given. # relation created as a sub-element with implicitly known type HsOfficeRelationSubInsert: diff --git a/src/main/resources/api-definition/hs-office/hs-office-relations.yaml b/src/main/resources/api-definition/hs-office/hs-office-relations.yaml index 70218c00..93d5fdc5 100644 --- a/src/main/resources/api-definition/hs-office/hs-office-relations.yaml +++ b/src/main/resources/api-definition/hs-office/hs-office-relations.yaml @@ -21,7 +21,13 @@ get: required: false schema: $ref: 'hs-office-relation-schemas.yaml#/components/schemas/HsOfficeRelationType' - description: Prefix of name properties from holder or contact to filter the results. + description: Beginning of name properties from holder or contact to filter the results. + - name: mark + in: query + required: false + schema: + type: string + description: - name: personData in: query required: false diff --git a/src/test/java/net/hostsharing/hsadminng/errors/ValidateUnitTest.java b/src/test/java/net/hostsharing/hsadminng/errors/ValidateUnitTest.java index 0d212c90..97e73ec1 100644 --- a/src/test/java/net/hostsharing/hsadminng/errors/ValidateUnitTest.java +++ b/src/test/java/net/hostsharing/hsadminng/errors/ValidateUnitTest.java @@ -1,5 +1,6 @@ package net.hostsharing.hsadminng.errors; +import org.junit.jupiter.api.Nested; import org.junit.jupiter.api.Test; import jakarta.validation.ValidationException; @@ -9,23 +10,53 @@ import static org.assertj.core.api.Assertions.catchThrowable; class ValidateUnitTest { - @Test - void shouldFailValidationIfBothParametersAreNotNull() { - final var throwable = catchThrowable(() -> - Validate.validate("var1, var2").atMaxOneNonNull("val1", "val2") - ); - assertThat(throwable).isInstanceOf(ValidationException.class) - .hasMessage("Exactly one of (var1, var2) must be non-null, but are (val1, val2)"); + @Nested + class AtMaxOne { + @Test + void shouldFailValidationIfBothParametersAreNotNull() { + final var throwable = catchThrowable(() -> + Validate.validate("var1, var2").atMaxOne("val1", "val2") + ); + assertThat(throwable).isInstanceOf(ValidationException.class) + .hasMessage("At maximum one of (var1, var2) must be non-null, but are (val1, val2)"); + } + + @Test + void shouldNotFailValidationIfBothParametersAreNull() { + Validate.validate("var1, var2").atMaxOne(null, null); + } + + @Test + void shouldNotFailValidationIfExactlyOneParameterIsNonNull() { + Validate.validate("var1, var2").atMaxOne("val1", null); + Validate.validate("var1, var2").atMaxOne(null, "val2"); + } } - @Test - void shouldNotFailValidationIfBothParametersAreull() { - Validate.validate("var1, var2").atMaxOneNonNull(null, null); - } + @Nested + class ExactlyOne { + @Test + void shouldFailValidationIfBothParametersAreNotNull() { + final var throwable = catchThrowable(() -> + Validate.validate("var1, var2").exactlyOne("val1", "val2") + ); + assertThat(throwable).isInstanceOf(ValidationException.class) + .hasMessage("Exactly one of (var1, var2) must be non-null, but are (val1, val2)"); + } - @Test - void shouldNotFailValidationIfExactlyOneParameterIsNonNull() { - Validate.validate("var1, var2").atMaxOneNonNull("val1", null); - Validate.validate("var1, var2").atMaxOneNonNull(null, "val2"); + @Test + void shouldFailValidationIfBothParametersAreNull() { + final var throwable = catchThrowable(() -> + Validate.validate("var1, var2").exactlyOne(null, null) + ); + assertThat(throwable).isInstanceOf(ValidationException.class) + .hasMessage("Exactly one of (var1, var2) must be non-null, but are (null, null)"); + } + + @Test + void shouldNotFailValidationIfExactlyOneParameterIsNonNull() { + Validate.validate("var1, var2").exactlyOne("val1", null); + Validate.validate("var1, var2").exactlyOne(null, "val2"); + } } } diff --git a/src/test/java/net/hostsharing/hsadminng/hs/office/contact/HsOfficeContactRbacRepositoryIntegrationTest.java b/src/test/java/net/hostsharing/hsadminng/hs/office/contact/HsOfficeContactRbacRepositoryIntegrationTest.java index b05b6da7..5b59f3b6 100644 --- a/src/test/java/net/hostsharing/hsadminng/hs/office/contact/HsOfficeContactRbacRepositoryIntegrationTest.java +++ b/src/test/java/net/hostsharing/hsadminng/hs/office/contact/HsOfficeContactRbacRepositoryIntegrationTest.java @@ -127,7 +127,7 @@ class HsOfficeContactRbacRepositoryIntegrationTest extends ContextBasedTestWithC } @Nested - class FindAllContacts { + class FindContacts { @Test public void globalAdmin_withoutAssumedRole_canViewAllContacts() { @@ -184,6 +184,22 @@ class HsOfficeContactRbacRepositoryIntegrationTest extends ContextBasedTestWithC } } + @Nested + class FindByEmailAddress { + + @Test + public void globalAdmin_withoutAssumedRole_canFindContactsByEmailAddress() { + // given + context("superuser-alex@hostsharing.net", null); + + // when + final var result = contactRepo.findContactByEmailAddress("%@secondcontact.example.com"); + + // then + exactlyTheseContactsAreReturned(result, "second contact"); + } + } + @Nested class DeleteByUuid { diff --git a/src/test/java/net/hostsharing/hsadminng/hs/office/relation/HsOfficeRelationControllerAcceptanceTest.java b/src/test/java/net/hostsharing/hsadminng/hs/office/relation/HsOfficeRelationControllerAcceptanceTest.java index 53e1f591..d79ddbfa 100644 --- a/src/test/java/net/hostsharing/hsadminng/hs/office/relation/HsOfficeRelationControllerAcceptanceTest.java +++ b/src/test/java/net/hostsharing/hsadminng/hs/office/relation/HsOfficeRelationControllerAcceptanceTest.java @@ -223,7 +223,7 @@ class HsOfficeRelationControllerAcceptanceTest extends ContextBasedTestWithClean class AddRelation { @Test - void globalAdmin_withoutAssumedRole_canAddRelation() { + void globalAdmin_withoutAssumedRole_canAddRelationWithHolderUuidAndContactUuid() { context.define("superuser-alex@hostsharing.net"); final var givenAnchorPerson = personRepo.findPersonByOptionalNameLike("Third").get(0); @@ -261,7 +261,62 @@ class HsOfficeRelationControllerAcceptanceTest extends ContextBasedTestWithClean .body("holder.givenName", is("Paul")) .body("contact.caption", is("second contact")) .header("Location", startsWith("http://localhost")) - .extract().header("Location"); // @formatter:on + .extract().header("Location"); // @formatter:on + + // finally, the new relation can be accessed under the generated UUID + final var newSubjectUuid = toCleanup(HsOfficeRelationRealEntity.class, UUID.fromString( + location.substring(location.lastIndexOf('/') + 1))); + assertThat(newSubjectUuid).isNotNull(); + } + + @Test + void globalAdmin_withoutAssumedRole_canAddRelationWithHolderAndContactData() { + + context.define("superuser-alex@hostsharing.net"); + final var givenAnchorPerson = personRepo.findPersonByOptionalNameLike("Third").get(0); + + final var location = RestAssured // @formatter:off + .given() + .header("current-subject", "superuser-alex@hostsharing.net") + .contentType(ContentType.JSON) + .body(""" + { + "type": "%s", + "mark": "%s", + "anchor.uuid": "%s", + "holder": { + "personType": "NATURAL_PERSON", + "familyName": "Person", + "givenName": "Temp" + }, + "contact": { + "caption": "Temp Contact", + "emailAddresses": { + "main": "test@example.org" + } + } + } + """.formatted( + HsOfficeRelationTypeResource.SUBSCRIBER, + "operations-discuss", + givenAnchorPerson.getUuid() + ) + ) + .port(port) + .when() + .post("http://localhost/api/hs/office/relations") + .then().log().all().assertThat() + .statusCode(201) + .contentType(ContentType.JSON) + .body("uuid", isUuidValid()) + .body("type", is("SUBSCRIBER")) + .body("mark", is("operations-discuss")) + .body("anchor.tradeName", is("Third OHG")) + .body("holder.givenName", is("Temp")) + .body("holder.familyName", is("Person")) + .body("contact.caption", is("Temp Contact")) + .header("Location", startsWith("http://localhost")) + .extract().header("Location"); // @formatter:on // finally, the new relation can be accessed under the generated UUID final var newSubjectUuid = toCleanup(HsOfficeRelationRealEntity.class, UUID.fromString( @@ -277,7 +332,7 @@ class HsOfficeRelationControllerAcceptanceTest extends ContextBasedTestWithClean final var givenHolderPerson = personRepo.findPersonByOptionalNameLike("Smith").get(0); final var givenContact = contactrealRepo.findContactByOptionalCaptionLike("fourth").get(0); - final var location = RestAssured // @formatter:off + RestAssured // @formatter:off .given() .header("current-subject", "superuser-alex@hostsharing.net") .contentType(ContentType.JSON) diff --git a/src/test/java/net/hostsharing/hsadminng/hs/office/relation/HsOfficeRelationRepositoryIntegrationTest.java b/src/test/java/net/hostsharing/hsadminng/hs/office/relation/HsOfficeRelationRepositoryIntegrationTest.java index b2f50977..e55959c7 100644 --- a/src/test/java/net/hostsharing/hsadminng/hs/office/relation/HsOfficeRelationRepositoryIntegrationTest.java +++ b/src/test/java/net/hostsharing/hsadminng/hs/office/relation/HsOfficeRelationRepositoryIntegrationTest.java @@ -193,7 +193,7 @@ class HsOfficeRelationRepositoryIntegrationTest extends ContextBasedTestWithClea .findFirst().orElseThrow(); // when: - final var result = relationRbacRepo.findRelationRelatedToPersonUuidRelationTypePersonAndContactData(person.getUuid(), null, null, null); + final var result = relationRbacRepo.findRelationRelatedToPersonUuidRelationTypeMarkPersonAndContactData(person.getUuid(), null, null, null, null); // then: exactlyTheseRelationsAreReturned( diff --git a/src/test/java/net/hostsharing/hsadminng/hs/office/scenarios/HsOfficeScenarioTests.java b/src/test/java/net/hostsharing/hsadminng/hs/office/scenarios/HsOfficeScenarioTests.java index 9f957472..d23a4250 100644 --- a/src/test/java/net/hostsharing/hsadminng/hs/office/scenarios/HsOfficeScenarioTests.java +++ b/src/test/java/net/hostsharing/hsadminng/hs/office/scenarios/HsOfficeScenarioTests.java @@ -31,7 +31,8 @@ import net.hostsharing.hsadminng.hs.office.scenarios.partner.CreatePartner; import net.hostsharing.hsadminng.hs.office.scenarios.partner.DeletePartner; import net.hostsharing.hsadminng.hs.office.scenarios.person.ShouldUpdatePersonData; import net.hostsharing.hsadminng.hs.office.scenarios.subscription.RemoveOperationsContactFromPartner; -import net.hostsharing.hsadminng.hs.office.scenarios.subscription.SubscribeToMailinglist; +import net.hostsharing.hsadminng.hs.office.scenarios.subscription.SubscribeExistingPersonAndContactToMailinglist; +import net.hostsharing.hsadminng.hs.office.scenarios.subscription.SubscribeNewPersonAndContactToMailinglist; import net.hostsharing.hsadminng.hs.office.scenarios.subscription.UnsubscribeFromMailinglist; import net.hostsharing.hsadminng.hs.scenarios.Produces; import net.hostsharing.hsadminng.hs.scenarios.Requires; @@ -564,7 +565,7 @@ class HsOfficeScenarioTests extends ScenarioTest { @Requires("Person: Test AG") @Produces("Subscription: Michael Miller to operations-announce") void shouldSubscribeNewPersonAndContactToMailinglist() { - new SubscribeToMailinglist(scenarioTest) + new SubscribeNewPersonAndContactToMailinglist(scenarioTest) // TODO.spec: do we need the personType? or is an operational contact always a natural person? what about distribution lists? .given("partnerPersonTradeName", "Test AG") .given("subscriberFamilyName", "Miller") @@ -578,7 +579,22 @@ class HsOfficeScenarioTests extends ScenarioTest { @Test @Order(5001) @Requires("Subscription: Michael Miller to operations-announce") - void shouldUnsubscribeNewPersonAndContactToMailinglist() { + @Produces("Subscription: Michael Miller to operations-discussion") + void shouldSubscribeExistingPersonAndContactToMailinglist() { + new SubscribeExistingPersonAndContactToMailinglist(scenarioTest) + .given("partnerPersonTradeName", "Test AG") + .given("subscriberFamilyName", "Miller") + .given("subscriberGivenName", "Michael") + .given("subscriberEMailAddress", "michael.miller@example.org") + .given("mailingList", "operations-discussion") + .doRun() + .keep(); + } + + @Test + @Order(5002) + @Requires("Subscription: Michael Miller to operations-announce") + void shouldUnsubscribePersonAndContactFromMailinglist() { new UnsubscribeFromMailinglist(scenarioTest) .given("mailingList", "operations-announce") .given("subscriberEMailAddress", "michael.miller@example.org") diff --git a/src/test/java/net/hostsharing/hsadminng/hs/office/scenarios/subscription/SubscribeExistingPersonAndContactToMailinglist.java b/src/test/java/net/hostsharing/hsadminng/hs/office/scenarios/subscription/SubscribeExistingPersonAndContactToMailinglist.java new file mode 100644 index 00000000..f018c454 --- /dev/null +++ b/src/test/java/net/hostsharing/hsadminng/hs/office/scenarios/subscription/SubscribeExistingPersonAndContactToMailinglist.java @@ -0,0 +1,54 @@ +package net.hostsharing.hsadminng.hs.office.scenarios.subscription; + +import io.restassured.http.ContentType; +import net.hostsharing.hsadminng.hs.scenarios.ScenarioTest; +import net.hostsharing.hsadminng.hs.scenarios.UseCase; +import org.springframework.http.HttpStatus; + +import static io.restassured.http.ContentType.JSON; +import static org.springframework.http.HttpStatus.CREATED; +import static org.springframework.http.HttpStatus.OK; + +public class SubscribeExistingPersonAndContactToMailinglist extends UseCase { + + public SubscribeExistingPersonAndContactToMailinglist(final ScenarioTest testSuite) { + super(testSuite); + } + + @Override + protected HttpResponse run() { + + obtain("Person: %{partnerPersonTradeName}", () -> + httpGet("/api/hs/office/persons?name=" + uriEncoded("%{partnerPersonTradeName}")) + .expecting(OK).expecting(JSON), + response -> response.expectArrayElements(1).getFromBody("[0].uuid"), + "In production, data this query could result in multiple outputs. In that case, you have to find out which is the right one." + ); + + obtain( + "Person: %{subscriberGivenName} %{subscriberFamilyName}", () -> + httpGet("/api/hs/office/persons?name=%{subscriberFamilyName}") + .expecting(HttpStatus.OK).expecting(ContentType.JSON), + response -> response.expectArrayElements(1).getFromBody("[0].uuid"), + "In real scenarios there are most likely multiple results and you have to choose the right one." + ); + + obtain("Contact: %{subscriberEMailAddress}", () -> + httpGet("/api/hs/office/contacts?emailAddress=%{subscriberEMailAddress}") + .expecting(HttpStatus.OK).expecting(ContentType.JSON), + response -> response.expectArrayElements(1).getFromBody("[0].uuid"), + "In real scenarios there are most likely multiple results and you have to choose the right one." + ); + + return httpPost("/api/hs/office/relations", usingJsonBody(""" + { + "type": "SUBSCRIBER", + "mark": ${mailingList}, + "anchor.uuid": ${Person: %{partnerPersonTradeName}}, + "holder.uuid": ${Person: %{subscriberGivenName} %{subscriberFamilyName}}, + "contact.uuid": ${Contact: %{subscriberEMailAddress}} + } + """)) + .expecting(CREATED).expecting(JSON); + } +} diff --git a/src/test/java/net/hostsharing/hsadminng/hs/office/scenarios/subscription/SubscribeNewPersonAndContactToMailinglist.java b/src/test/java/net/hostsharing/hsadminng/hs/office/scenarios/subscription/SubscribeNewPersonAndContactToMailinglist.java new file mode 100644 index 00000000..5638e440 --- /dev/null +++ b/src/test/java/net/hostsharing/hsadminng/hs/office/scenarios/subscription/SubscribeNewPersonAndContactToMailinglist.java @@ -0,0 +1,46 @@ +package net.hostsharing.hsadminng.hs.office.scenarios.subscription; + +import net.hostsharing.hsadminng.hs.scenarios.UseCase; +import net.hostsharing.hsadminng.hs.scenarios.ScenarioTest; + +import static io.restassured.http.ContentType.JSON; +import static org.springframework.http.HttpStatus.CREATED; +import static org.springframework.http.HttpStatus.OK; + +public class SubscribeNewPersonAndContactToMailinglist extends UseCase { + + public SubscribeNewPersonAndContactToMailinglist(final ScenarioTest testSuite) { + super(testSuite); + } + + @Override + protected HttpResponse run() { + + obtain("Person: %{partnerPersonTradeName}", () -> + httpGet("/api/hs/office/persons?name=" + uriEncoded("%{partnerPersonTradeName}")) + .expecting(OK).expecting(JSON), + response -> response.expectArrayElements(1).getFromBody("[0].uuid"), + "In production, data this query could result in multiple outputs. In that case, you have to find out which is the right one." + ); + + return httpPost("/api/hs/office/relations", usingJsonBody(""" + { + "type": "SUBSCRIBER", + "mark": ${mailingList}, + "anchor.uuid": ${Person: %{partnerPersonTradeName}}, + "holder": { + "personType": "NATURAL_PERSON", + "familyName": ${subscriberFamilyName}, + "givenName": ${subscriberGivenName} + }, + "contact": { + "caption": "%{subscriberGivenName} %{subscriberFamilyName}", + "emailAddresses": { + "main": ${subscriberEMailAddress} + } + } + } + """)) + .expecting(CREATED).expecting(JSON); + } +} diff --git a/src/test/java/net/hostsharing/hsadminng/hs/office/scenarios/subscription/SubscribeToMailinglist.java b/src/test/java/net/hostsharing/hsadminng/hs/office/scenarios/subscription/SubscribeToMailinglist.java deleted file mode 100644 index c524fb18..00000000 --- a/src/test/java/net/hostsharing/hsadminng/hs/office/scenarios/subscription/SubscribeToMailinglist.java +++ /dev/null @@ -1,62 +0,0 @@ -package net.hostsharing.hsadminng.hs.office.scenarios.subscription; - -import io.restassured.http.ContentType; -import net.hostsharing.hsadminng.hs.scenarios.UseCase; -import net.hostsharing.hsadminng.hs.scenarios.ScenarioTest; -import org.springframework.http.HttpStatus; - -import static io.restassured.http.ContentType.JSON; -import static org.springframework.http.HttpStatus.CREATED; -import static org.springframework.http.HttpStatus.OK; - -public class SubscribeToMailinglist extends UseCase { - - public SubscribeToMailinglist(final ScenarioTest testSuite) { - super(testSuite); - } - - @Override - protected HttpResponse run() { - - obtain("Person: %{partnerPersonTradeName}", () -> - httpGet("/api/hs/office/persons?name=" + uriEncoded("%{partnerPersonTradeName}")) - .expecting(OK).expecting(JSON), - response -> response.expectArrayElements(1).getFromBody("[0].uuid"), - "In production, data this query could result in multiple outputs. In that case, you have to find out which is the right one." - ); - - obtain("Person: %{subscriberGivenName} %{subscriberFamilyName}", () -> - httpPost("/api/hs/office/persons", usingJsonBody(""" - { - "personType": "NATURAL_PERSON", - "familyName": ${subscriberFamilyName}, - "givenName": ${subscriberGivenName} - } - """)) - .expecting(HttpStatus.CREATED).expecting(ContentType.JSON) - ); - - obtain("Contact: %{subscriberGivenName} %{subscriberFamilyName}", () -> - httpPost("/api/hs/office/contacts", usingJsonBody(""" - { - "caption": "%{subscriberGivenName} %{subscriberFamilyName}", - "emailAddresses": { - "main": ${subscriberEMailAddress} - } - } - """)) - .expecting(CREATED).expecting(JSON) - ); - - return httpPost("/api/hs/office/relations", usingJsonBody(""" - { - "type": "SUBSCRIBER", - "mark": ${mailingList}, - "anchor.uuid": ${Person: %{partnerPersonTradeName}}, - "holder.uuid": ${Person: %{subscriberGivenName} %{subscriberFamilyName}}, - "contact.uuid": ${Contact: %{subscriberGivenName} %{subscriberFamilyName}} - } - """)) - .expecting(CREATED).expecting(JSON); - } -}