From 953acb14cc90f94886924d44c406e8a40399315d Mon Sep 17 00:00:00 2001 From: Michael Hoennig Date: Tue, 16 Apr 2024 16:24:24 +0200 Subject: [PATCH] WIP --- build.gradle | 14 +- .../HsManagedServerController.java | 129 +++++++ .../managedserver/HsManagedServerEntity.java | 182 ++++++++++ .../HsManagedServerEntityPatcher.java | 27 ++ .../HsManagedServerRepository.java | 21 ++ .../hs-booking/hs-booking-item-schemas.yaml | 4 +- .../hs-hosting/api-mappings.yaml | 17 + .../api-definition/hs-hosting/auth.yaml | 20 ++ .../hs-hosting/error-responses.yaml | 40 +++ .../hs-hosting-managedserver-schemas.yaml | 91 +++++ .../hs-hosting-managedservers-with-uuid.yaml | 83 +++++ .../hs-hosting/hs-hosting-managedservers.yaml | 58 +++ .../api-definition/hs-hosting/hs-hosting.yaml | 17 + .../7010-hs-hosting-managedserver.sql | 24 ++ .../7013-hs-hosting-managedserver-rbac.md | 285 +++++++++++++++ .../7013-hs-hosting-managedserver-rbac.sql | 199 ++++++++++ ...018-hs-hosting-managedserver-test-data.sql | 56 +++ .../db/changelog/db.changelog-master.yaml | 6 + .../hsadminng/arch/ArchitectureTest.java | 12 +- ...ManagedServerControllerAcceptanceTest.java | 337 +++++++++++++++++ .../HsManagedServerEntityPatcherUnitTest.java | 114 ++++++ .../HsManagedServerEntityUnitTest.java | 56 +++ ...anagedServerRepositoryIntegrationTest.java | 339 ++++++++++++++++++ 23 files changed, 2126 insertions(+), 5 deletions(-) create mode 100644 src/main/java/net/hostsharing/hsadminng/hs/hosting/managedserver/HsManagedServerController.java create mode 100644 src/main/java/net/hostsharing/hsadminng/hs/hosting/managedserver/HsManagedServerEntity.java create mode 100644 src/main/java/net/hostsharing/hsadminng/hs/hosting/managedserver/HsManagedServerEntityPatcher.java create mode 100644 src/main/java/net/hostsharing/hsadminng/hs/hosting/managedserver/HsManagedServerRepository.java create mode 100644 src/main/resources/api-definition/hs-hosting/api-mappings.yaml create mode 100644 src/main/resources/api-definition/hs-hosting/auth.yaml create mode 100644 src/main/resources/api-definition/hs-hosting/error-responses.yaml create mode 100644 src/main/resources/api-definition/hs-hosting/hs-hosting-managedserver-schemas.yaml create mode 100644 src/main/resources/api-definition/hs-hosting/hs-hosting-managedservers-with-uuid.yaml create mode 100644 src/main/resources/api-definition/hs-hosting/hs-hosting-managedservers.yaml create mode 100644 src/main/resources/api-definition/hs-hosting/hs-hosting.yaml create mode 100644 src/main/resources/db/changelog/7-hs-hosting/701-hosting-managedserver/7010-hs-hosting-managedserver.sql create mode 100644 src/main/resources/db/changelog/7-hs-hosting/701-hosting-managedserver/7013-hs-hosting-managedserver-rbac.md create mode 100644 src/main/resources/db/changelog/7-hs-hosting/701-hosting-managedserver/7013-hs-hosting-managedserver-rbac.sql create mode 100644 src/main/resources/db/changelog/7-hs-hosting/701-hosting-managedserver/7018-hs-hosting-managedserver-test-data.sql create mode 100644 src/test/java/net/hostsharing/hsadminng/hs/hosting/managedserver/HsManagedServerControllerAcceptanceTest.java create mode 100644 src/test/java/net/hostsharing/hsadminng/hs/hosting/managedserver/HsManagedServerEntityPatcherUnitTest.java create mode 100644 src/test/java/net/hostsharing/hsadminng/hs/hosting/managedserver/HsManagedServerEntityUnitTest.java create mode 100644 src/test/java/net/hostsharing/hsadminng/hs/hosting/managedserver/HsManagedServerRepositoryIntegrationTest.java diff --git a/build.gradle b/build.gradle index 45b75734..332a5410 100644 --- a/build.gradle +++ b/build.gradle @@ -158,6 +158,15 @@ openapiProcessor { showWarnings true openApiNullable true } + springHsHosting { + processorName 'spring' + processor 'io.openapiprocessor:openapi-processor-spring:2022.5' + apiPath "$projectDir/src/main/resources/api-definition/hs-hosting/hs-hosting.yaml" + mapping "$projectDir/src/main/resources/api-definition/hs-hosting/api-mappings.yaml" + targetDir "$buildDir/generated/sources/openapi-javax" + showWarnings true + openApiNullable true + } } sourceSets.main.java.srcDir 'build/generated/sources/openapi' abstract class ProcessSpring extends DefaultTask {} @@ -166,7 +175,8 @@ tasks.register('processSpring', ProcessSpring) 'processSpringRbac', 'processSpringTest', 'processSpringHsOffice', - 'processSpringHsBooking' + 'processSpringHsBooking', + 'processSpringHsHosting' ].each { project.tasks.processSpring.dependsOn it } @@ -174,7 +184,7 @@ project.tasks.processResources.dependsOn processSpring project.tasks.compileJava.dependsOn processSpring // Rename javax to jakarta in OpenApi generated java files because -// io.openapiprocessor.openapi-processor 2022.2 does not yet support the openapiprocessor useSpringBoot3 config option. +// io.openapiprocessor.openapi-processor 2022.5 does not yet support the openapiprocessor useSpringBoot3 config option. // TODO.impl: Upgrade to io.openapiprocessor.openapi-processor >= 2024.2 // and use either `bean-validation: true` in api-mapping.yaml or `useSpringBoot3 true` (not sure where exactly). task openApiGenerate(type: Copy) { diff --git a/src/main/java/net/hostsharing/hsadminng/hs/hosting/managedserver/HsManagedServerController.java b/src/main/java/net/hostsharing/hsadminng/hs/hosting/managedserver/HsManagedServerController.java new file mode 100644 index 00000000..8a78d3e6 --- /dev/null +++ b/src/main/java/net/hostsharing/hsadminng/hs/hosting/managedserver/HsManagedServerController.java @@ -0,0 +1,129 @@ +package net.hostsharing.hsadminng.hs.hosting.managedserver; + +import net.hostsharing.hsadminng.hs.hosting.generated.api.v1.api.HsHostingManagedserversApi; + +import net.hostsharing.hsadminng.context.Context; +import net.hostsharing.hsadminng.mapper.KeyValueMap; +import net.hostsharing.hsadminng.mapper.Mapper; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.ResponseEntity; +import org.springframework.transaction.annotation.Transactional; +import org.springframework.web.bind.annotation.RestController; +import org.springframework.web.servlet.mvc.method.annotation.MvcUriComponentsBuilder; + +import java.util.List; +import java.util.UUID; +import java.util.function.BiConsumer; + +import static net.hostsharing.hsadminng.mapper.PostgresDateRange.toPostgresDateRange; + +@RestController +public class HsManagedServerController implements HsHostingManagedserversApi { + + @Autowired + private Context context; + + @Autowired + private Mapper mapper; + + @Autowired + private HsManagedServerRepository managedServerRepo; + + @Override + @Transactional(readOnly = true) + public ResponseEntity> listManagedServersByDebitorUuid( + final String currentUser, + final String assumedRoles, + final UUID debitorUuid) { + context.define(currentUser, assumedRoles); + + final var entities = managedServerRepo.findAllByDebitorUuid(debitorUuid); + + final var resources = mapper.mapList(entities, HsManagedServerResource.class, ENTITY_TO_RESOURCE_POSTMAPPER); + return ResponseEntity.ok(resources); + } + + @Override + @Transactional + public ResponseEntity addManagedServer( + final String currentUser, + final String assumedRoles, + final HsManagedServerInsertResource body) { + + context.define(currentUser, assumedRoles); + + final var entityToSave = mapper.map(body, net.hostsharing.hsadminng.hs.booking.item.HsManagedServerEntity.class, RESOURCE_TO_ENTITY_POSTMAPPER); + + final var saved = managedServerRepo.save(entityToSave); + + final var uri = + MvcUriComponentsBuilder.fromController(getClass()) + .path("/api/hs/booking/items/{id}") + .buildAndExpand(saved.getUuid()) + .toUri(); + final var mapped = mapper.map(saved, HsManagedServerResource.class, ENTITY_TO_RESOURCE_POSTMAPPER); + return ResponseEntity.created(uri).body(mapped); + } + + @Override + @Transactional(readOnly = true) + public ResponseEntity getManagedServerByUuid( + final String currentUser, + final String assumedRoles, + final UUID managedServerUuid) { + + context.define(currentUser, assumedRoles); + + final var result = managedServerRepo.findByUuid(managedServerUuid); + return result + .map(managedServerEntity -> ResponseEntity.ok( + mapper.map(managedServerEntity, HsManagedServerResource.class, ENTITY_TO_RESOURCE_POSTMAPPER))) + .orElseGet(() -> ResponseEntity.notFound().build()); + } + + @Override + @Transactional + public ResponseEntity deleteBookingIemByUuid( + final String currentUser, + final String assumedRoles, + final UUID managedServerUuid) { + context.define(currentUser, assumedRoles); + + final var result = managedServerRepo.deleteByUuid(managedServerUuid); + return result == 0 + ? ResponseEntity.notFound().build() + : ResponseEntity.noContent().build(); + } + + @Override + @Transactional + public ResponseEntity patchManagedServer( + final String currentUser, + final String assumedRoles, + final UUID managedServerUuid, + final HsManagedServerPatchResource body) { + + context.define(currentUser, assumedRoles); + + final var current = managedServerRepo.findByUuid(managedServerUuid).orElseThrow(); + + new net.hostsharing.hsadminng.hs.booking.item.HsManagedServerEntityPatcher(current).apply(body); + + final var saved = managedServerRepo.save(current); + final var mapped = mapper.map(saved, HsManagedServerResource.class, ENTITY_TO_RESOURCE_POSTMAPPER); + return ResponseEntity.ok(mapped); + } + + final BiConsumer ENTITY_TO_RESOURCE_POSTMAPPER = (entity, resource) -> { + resource.setValidFrom(entity.getValidity().lower()); + if (entity.getValidity().hasUpperBound()) { + resource.setValidTo(entity.getValidity().upper().minusDays(1)); + } + }; + + @SuppressWarnings("unchecked") + final BiConsumer RESOURCE_TO_ENTITY_POSTMAPPER = (resource, entity) -> { + entity.setValidity(toPostgresDateRange(resource.getValidFrom(), resource.getValidTo())); + entity.putResources(KeyValueMap.from(resource.getResources())); + }; +} diff --git a/src/main/java/net/hostsharing/hsadminng/hs/hosting/managedserver/HsManagedServerEntity.java b/src/main/java/net/hostsharing/hsadminng/hs/hosting/managedserver/HsManagedServerEntity.java new file mode 100644 index 00000000..30622a2a --- /dev/null +++ b/src/main/java/net/hostsharing/hsadminng/hs/hosting/managedserver/HsManagedServerEntity.java @@ -0,0 +1,182 @@ +package net.hostsharing.hsadminng.hs.hosting.managedserver; + +import io.hypersistence.utils.hibernate.type.json.JsonType; +import io.hypersistence.utils.hibernate.type.range.PostgreSQLRangeType; +import io.hypersistence.utils.hibernate.type.range.Range; +import lombok.AccessLevel; +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; +import net.hostsharing.hsadminng.hs.office.debitor.HsOfficeDebitorEntity; +import net.hostsharing.hsadminng.hs.office.relation.HsOfficeRelationEntity; +import net.hostsharing.hsadminng.mapper.PatchableMapWrapper; +import net.hostsharing.hsadminng.rbac.rbacdef.RbacView; +import net.hostsharing.hsadminng.rbac.rbacdef.RbacView.SQL; +import net.hostsharing.hsadminng.rbac.rbacobject.RbacObject; +import net.hostsharing.hsadminng.stringify.Stringify; +import net.hostsharing.hsadminng.stringify.Stringifyable; +import org.hibernate.annotations.Type; + +import jakarta.persistence.Column; +import jakarta.persistence.Entity; +import jakarta.persistence.GeneratedValue; +import jakarta.persistence.Id; +import jakarta.persistence.JoinColumn; +import jakarta.persistence.ManyToOne; +import jakarta.persistence.Table; +import jakarta.persistence.Transient; +import jakarta.persistence.Version; +import java.io.IOException; +import java.time.LocalDate; +import java.util.HashMap; +import java.util.Map; +import java.util.UUID; + +import static java.util.Optional.ofNullable; +import static net.hostsharing.hsadminng.mapper.PostgresDateRange.lowerInclusiveFromPostgresDateRange; +import static net.hostsharing.hsadminng.mapper.PostgresDateRange.toPostgresDateRange; +import static net.hostsharing.hsadminng.mapper.PostgresDateRange.upperInclusiveFromPostgresDateRange; +import static net.hostsharing.hsadminng.rbac.rbacdef.RbacView.Column.dependsOnColumn; +import static net.hostsharing.hsadminng.rbac.rbacdef.RbacView.Nullable.NOT_NULL; +import static net.hostsharing.hsadminng.rbac.rbacdef.RbacView.Permission.DELETE; +import static net.hostsharing.hsadminng.rbac.rbacdef.RbacView.Permission.INSERT; +import static net.hostsharing.hsadminng.rbac.rbacdef.RbacView.Permission.SELECT; +import static net.hostsharing.hsadminng.rbac.rbacdef.RbacView.Permission.UPDATE; +import static net.hostsharing.hsadminng.rbac.rbacdef.RbacView.Role.ADMIN; +import static net.hostsharing.hsadminng.rbac.rbacdef.RbacView.Role.AGENT; +import static net.hostsharing.hsadminng.rbac.rbacdef.RbacView.Role.OWNER; +import static net.hostsharing.hsadminng.rbac.rbacdef.RbacView.Role.TENANT; +import static net.hostsharing.hsadminng.rbac.rbacdef.RbacView.SQL.directlyFetchedByDependsOnColumn; +import static net.hostsharing.hsadminng.rbac.rbacdef.RbacView.SQL.fetchedBySql; +import static net.hostsharing.hsadminng.rbac.rbacdef.RbacView.rbacViewFor; +import static net.hostsharing.hsadminng.stringify.Stringify.stringify; + +@Builder +@Entity +@Table(name = "hs_booking_item_rv") +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor +public class HsManagedServerEntity implements Stringifyable, RbacObject { + + private static Stringify stringify = stringify(HsManagedServerEntity.class) + .withProp(e -> e.getDebitor().toShortString()) + .withProp(e -> e.getValidity().asString()) + .withProp(HsManagedServerEntity::getCaption) + .withProp(HsManagedServerEntity::getResources) + .quotedValues(false); + + @Id + @GeneratedValue + private UUID uuid; + + @Version + private int version; + + @ManyToOne(optional = false) + @JoinColumn(name = "debitoruuid") + private HsOfficeDebitorEntity debitor; + + @Builder.Default + @Type(PostgreSQLRangeType.class) + @Column(name = "validity", columnDefinition = "daterange") + private Range validity = Range.emptyRange(LocalDate.class); + + @Column(name = "caption") + private String caption; + + @Builder.Default + @Setter(AccessLevel.NONE) + @Type(JsonType.class) + @Column(columnDefinition = "resources") + private Map resources = new HashMap<>(); + + @Transient + private PatchableMapWrapper resourcesWrapper; + + public void setValidFrom(final LocalDate validFrom) { + setValidity(toPostgresDateRange(validFrom, getValidTo())); + } + + public void setValidTo(final LocalDate validTo) { + setValidity(toPostgresDateRange(getValidFrom(), validTo)); + } + + public LocalDate getValidFrom() { + return lowerInclusiveFromPostgresDateRange(getValidity()); + } + + public LocalDate getValidTo() { + return upperInclusiveFromPostgresDateRange(getValidity()); + } + + public PatchableMapWrapper getResources() { + if ( resourcesWrapper == null ) { + resourcesWrapper = new PatchableMapWrapper(resources); + } + return resourcesWrapper; + } + + public void putResources(Map entries) { + if ( resourcesWrapper == null ) { + resourcesWrapper = new PatchableMapWrapper(resources); + } + resourcesWrapper.assign(entries); + } + + @Override + public String toString() { + return stringify.apply(this); + } + + @Override + public String toShortString() { + return ofNullable(debitor).map(HsOfficeDebitorEntity::toShortString).orElse("D-???????") + + ":" + caption; + } + + public static RbacView rbac() { + return rbacViewFor("managedServer", HsManagedServerEntity.class) + .withIdentityView(SQL.query(""" + SELECT i.uuid as uuid, d.idName || ':' || i.caption as idName + FROM hs_booking_item i + JOIN hs_office_debitor_iv d ON d.uuid = i.debitorUuid + """)) + .withRestrictedViewOrderBy(SQL.expression("validity")) + .withUpdatableColumns("version", "validity", "resources") + + .importEntityAlias("debitor", HsOfficeDebitorEntity.class, + dependsOnColumn("debitorUuid"), + directlyFetchedByDependsOnColumn(), + NOT_NULL) + + .importEntityAlias("debitorRel", HsOfficeRelationEntity.class, + dependsOnColumn("debitorUuid"), + fetchedBySql(""" + SELECT ${columns} + FROM hs_office_relation debitorRel + JOIN hs_office_debitor debitor ON debitor.debitorRelUuid = debitorRel.uuid + WHERE debitor.uuid = ${REF}.debitorUuid + """), + NOT_NULL) + .toRole("debitorRel", ADMIN).grantPermission(INSERT) + .toRole("global", ADMIN).grantPermission(DELETE) + + .createRole(OWNER, (with) -> { + with.incomingSuperRole("debitorRel", AGENT); + with.permission(UPDATE); + }) + .createSubRole(ADMIN) + .createSubRole(TENANT, (with) -> { + with.outgoingSubRole("debitorRel", TENANT); + with.permission(SELECT); + }); + } + + public static void main(String[] args) throws IOException { + rbac().generateWithBaseFileName("6-hs-booking/701-hosting-managedserver/6013-hs-booking-managedserver-rbac"); + } +} diff --git a/src/main/java/net/hostsharing/hsadminng/hs/hosting/managedserver/HsManagedServerEntityPatcher.java b/src/main/java/net/hostsharing/hsadminng/hs/hosting/managedserver/HsManagedServerEntityPatcher.java new file mode 100644 index 00000000..c5e9cb55 --- /dev/null +++ b/src/main/java/net/hostsharing/hsadminng/hs/hosting/managedserver/HsManagedServerEntityPatcher.java @@ -0,0 +1,27 @@ +package net.hostsharing.hsadminng.hs.hosting.managedserver; + +import net.hostsharing.hsadminng.mapper.EntityPatcher; +import net.hostsharing.hsadminng.mapper.KeyValueMap; +import net.hostsharing.hsadminng.mapper.OptionalFromJson; + +import java.util.Optional; + + +public class HsManagedServerEntityPatcher implements EntityPatcher { + + private final HsManagedServerEntity entity; + + public HsManagedServerEntityPatcher(final HsManagedServerEntity entity) { + this.entity = entity; + } + + @Override + public void apply(final HsManagedServerPatchResource resource) { + OptionalFromJson.of(resource.getCaption()) + .ifPresent(entity::setCaption); + Optional.ofNullable(resource.getResources()) + .ifPresent(r -> entity.getResources().patch(KeyValueMap.from(resource.getResources()))); + OptionalFromJson.of(resource.getValidTo()) + .ifPresent(entity::setValidTo); + } +} diff --git a/src/main/java/net/hostsharing/hsadminng/hs/hosting/managedserver/HsManagedServerRepository.java b/src/main/java/net/hostsharing/hsadminng/hs/hosting/managedserver/HsManagedServerRepository.java new file mode 100644 index 00000000..21d038eb --- /dev/null +++ b/src/main/java/net/hostsharing/hsadminng/hs/hosting/managedserver/HsManagedServerRepository.java @@ -0,0 +1,21 @@ +package net.hostsharing.hsadminng.hs.hosting.managedserver; + +import org.springframework.data.repository.Repository; + +import java.util.List; +import java.util.Optional; +import java.util.UUID; + +public interface HsManagedServerRepository extends Repository { + + List findAll(); + Optional findByUuid(final UUID managedServerUuid); + + List findAllByDebitorUuid(final UUID managedServerUuid); + + HsManagedServerEntity save(HsManagedServerEntity current); + + int deleteByUuid(final UUID uuid); + + long count(); +} diff --git a/src/main/resources/api-definition/hs-booking/hs-booking-item-schemas.yaml b/src/main/resources/api-definition/hs-booking/hs-booking-item-schemas.yaml index 06f8b921..b5123684 100644 --- a/src/main/resources/api-definition/hs-booking/hs-booking-item-schemas.yaml +++ b/src/main/resources/api-definition/hs-booking/hs-booking-item-schemas.yaml @@ -48,7 +48,7 @@ components: caption: type: string minLength: 3 - maxLength: + maxLength: 80 nullable: false validFrom: type: string @@ -78,7 +78,7 @@ components: caption: type: string minLength: 3 - maxLength: + maxLength: 80 nullable: false CPU: type: integer diff --git a/src/main/resources/api-definition/hs-hosting/api-mappings.yaml b/src/main/resources/api-definition/hs-hosting/api-mappings.yaml new file mode 100644 index 00000000..465687be --- /dev/null +++ b/src/main/resources/api-definition/hs-hosting/api-mappings.yaml @@ -0,0 +1,17 @@ +openapi-processor-mapping: v2 + +options: + package-name: net.hostsharing.hsadminng.hs.hosting.generated.api.v1 + model-name-suffix: Resource + bean-validation: true + +map: + result: org.springframework.http.ResponseEntity + + types: + - type: array => java.util.List + - type: string:uuid => java.util.UUID + + paths: + /api/hs/hosting/managedservers/{managedServerUuid}: + null: org.openapitools.jackson.nullable.JsonNullable diff --git a/src/main/resources/api-definition/hs-hosting/auth.yaml b/src/main/resources/api-definition/hs-hosting/auth.yaml new file mode 100644 index 00000000..65d491fb --- /dev/null +++ b/src/main/resources/api-definition/hs-hosting/auth.yaml @@ -0,0 +1,20 @@ + +components: + + parameters: + + currentUser: + name: current-user + in: header + required: true + schema: + type: string + description: Identifying name of the currently logged in user. + + assumedRoles: + name: assumed-roles + in: header + required: false + schema: + type: string + description: Semicolon-separated list of roles to assume. The current user needs to have the right to assume these roles. diff --git a/src/main/resources/api-definition/hs-hosting/error-responses.yaml b/src/main/resources/api-definition/hs-hosting/error-responses.yaml new file mode 100644 index 00000000..83ca3dfb --- /dev/null +++ b/src/main/resources/api-definition/hs-hosting/error-responses.yaml @@ -0,0 +1,40 @@ +components: + + responses: + NotFound: + description: The specified was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + Unauthorized: + description: The current user is unknown or not authorized. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + Forbidden: + description: The current user or none of the assumed or roles is granted access to the resource. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + Conflict: + description: The request could not be completed due to a conflict with the current state of the target resource. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + + schemas: + + Error: + type: object + properties: + code: + type: string + message: + type: string + required: + - code + - message diff --git a/src/main/resources/api-definition/hs-hosting/hs-hosting-managedserver-schemas.yaml b/src/main/resources/api-definition/hs-hosting/hs-hosting-managedserver-schemas.yaml new file mode 100644 index 00000000..aa26d5c6 --- /dev/null +++ b/src/main/resources/api-definition/hs-hosting/hs-hosting-managedserver-schemas.yaml @@ -0,0 +1,91 @@ + +components: + + schemas: + + HsManagedServer: + type: object + properties: + uuid: + type: string + format: uuid + caption: + type: string + validFrom: + type: string + format: date + validTo: + type: string + format: date + config: + $ref: '#/components/schemas/ManagedServerConfiguration' + required: + - uuid + - validFrom + - validTo + - config + + HsManagedServerPatch: + type: object + properties: + caption: + type: string + nullable: true + validTo: + type: string + format: date + nullable: true + config: + $ref: '#/components/schemas/ManagedServerConfiguration' + + HsManagedServerInsert: + type: object + properties: + debitorUuid: + type: string + format: uuid + nullable: false + caption: + type: string + minLength: 3 + maxLength: 80 + nullable: false + validFrom: + type: string + format: date + nullable: false + validTo: + type: string + format: date + nullable: true + config: + $ref: '#/components/schemas/ManagedServerConfiguration' + required: + - caption + - debitorUuid + - validFrom + - config + additionalProperties: false + + ManagedServerConfiguration: + type: object + properties: + caption: + type: string + minLength: 3 + maxLength: 80 + nullable: false + CPU: + type: integer + minimum: 1 + maximum: 16 + SSD: + type: integer + minimum: 16 + maximum: 4096 + HDD: + type: integer + minimum: 16 + maximum: 4096 + additionalProperties: true + diff --git a/src/main/resources/api-definition/hs-hosting/hs-hosting-managedservers-with-uuid.yaml b/src/main/resources/api-definition/hs-hosting/hs-hosting-managedservers-with-uuid.yaml new file mode 100644 index 00000000..fefa859d --- /dev/null +++ b/src/main/resources/api-definition/hs-hosting/hs-hosting-managedservers-with-uuid.yaml @@ -0,0 +1,83 @@ +get: + tags: + - hs-hosting-managedservers + description: 'Fetch a single managed server by its uuid, if visible for the current subject.' + operationId: getManagedServerByUuid + parameters: + - $ref: 'auth.yaml#/components/parameters/currentUser' + - $ref: 'auth.yaml#/components/parameters/assumedRoles' + - name: managedServerUuid + in: path + required: true + schema: + type: string + format: uuid + description: UUID of the managed server to fetch. + responses: + "200": + description: OK + content: + 'application/json': + schema: + $ref: 'hs-hosting-managedserver-schemas.yaml#/components/schemas/HsManagedServer' + + "401": + $ref: 'error-responses.yaml#/components/responses/Unauthorized' + "403": + $ref: 'error-responses.yaml#/components/responses/Forbidden' + +patch: + tags: + - hs-hosting-managedservers + description: 'Updates a single managed server identified by its uuid, if permitted for the current subject.' + operationId: patchManagedServer + parameters: + - $ref: 'auth.yaml#/components/parameters/currentUser' + - $ref: 'auth.yaml#/components/parameters/assumedRoles' + - name: managedServerUuid + in: path + required: true + schema: + type: string + format: uuid + requestBody: + content: + 'application/json': + schema: + $ref: 'hs-hosting-managedserver-schemas.yaml#/components/schemas/HsManagedServerPatch' + responses: + "200": + description: OK + content: + 'application/json': + schema: + $ref: 'hs-hosting-managedserver-schemas.yaml#/components/schemas/HsManagedServerPatch' + "401": + $ref: 'error-responses.yaml#/components/responses/Unauthorized' + "403": + $ref: 'error-responses.yaml#/components/responses/Forbidden' + +delete: + tags: + - hs-hosting-managedservers + description: 'Delete a single managed server identified by its uuid, if permitted for the current subject.' + operationId: deleteManagedServerUuid + parameters: + - $ref: 'auth.yaml#/components/parameters/currentUser' + - $ref: 'auth.yaml#/components/parameters/assumedRoles' + - name: managedServerUuid + in: path + required: true + schema: + type: string + format: uuid + description: UUID of the managed server to delete. + responses: + "204": + description: No Content + "401": + $ref: 'error-responses.yaml#/components/responses/Unauthorized' + "403": + $ref: 'error-responses.yaml#/components/responses/Forbidden' + "404": + $ref: 'error-responses.yaml#/components/responses/NotFound' diff --git a/src/main/resources/api-definition/hs-hosting/hs-hosting-managedservers.yaml b/src/main/resources/api-definition/hs-hosting/hs-hosting-managedservers.yaml new file mode 100644 index 00000000..aaf9b10b --- /dev/null +++ b/src/main/resources/api-definition/hs-hosting/hs-hosting-managedservers.yaml @@ -0,0 +1,58 @@ +get: + summary: Returns a list of all managed servers for a specified debitor. + description: Returns the list of all managed servers for a debitor which are visible to the current user or any of it's assumed roles. + tags: + - hs-hosting-managedservers + operationId: listManagedServersByDebitorUuid + parameters: + - $ref: 'auth.yaml#/components/parameters/currentUser' + - $ref: 'auth.yaml#/components/parameters/assumedRoles' + - name: debitorUuid + in: query + required: true + schema: + type: string + format: uuid + description: The UUID of the debitor, whose managed servers are to be listed. + responses: + "200": + description: OK + content: + 'application/json': + schema: + type: array + items: + $ref: 'hs-hosting-managedserver-schemas.yaml#/components/schemas/HsManagedServer' + "401": + $ref: 'error-responses.yaml#/components/responses/Unauthorized' + "403": + $ref: 'error-responses.yaml#/components/responses/Forbidden' + +post: + summary: Adds a new managed server. + tags: + - hs-hosting-managedservers + operationId: addManagedServer + parameters: + - $ref: 'auth.yaml#/components/parameters/currentUser' + - $ref: 'auth.yaml#/components/parameters/assumedRoles' + requestBody: + description: A JSON object describing the new managed server. + required: true + content: + application/json: + schema: + $ref: 'hs-hosting-managedserver-schemas.yaml#/components/schemas/HsManagedServerInsert' + responses: + "201": + description: Created + content: + 'application/json': + schema: + $ref: 'hs-hosting-managedserver-schemas.yaml#/components/schemas/HsManagedServer' + "401": + $ref: 'error-responses.yaml#/components/responses/Unauthorized' + "403": + $ref: 'error-responses.yaml#/components/responses/Forbidden' + "409": + $ref: 'error-responses.yaml#/components/responses/Conflict' diff --git a/src/main/resources/api-definition/hs-hosting/hs-hosting.yaml b/src/main/resources/api-definition/hs-hosting/hs-hosting.yaml new file mode 100644 index 00000000..1c5c49aa --- /dev/null +++ b/src/main/resources/api-definition/hs-hosting/hs-hosting.yaml @@ -0,0 +1,17 @@ +openapi: 3.0.3 +info: + title: Hostsharing hsadmin-ng API + version: v0 +servers: + - url: http://localhost:8080 + description: Local development default URL. + +paths: + + # Items + + /api/hs/hosting/managedservers: + $ref: "hs-hosting-managedservers.yaml" + + /api/hs/hosting/managedservers/{managedServerUuid}: + $ref: "hs-hosting-managedservers-with-uuid.yaml" diff --git a/src/main/resources/db/changelog/7-hs-hosting/701-hosting-managedserver/7010-hs-hosting-managedserver.sql b/src/main/resources/db/changelog/7-hs-hosting/701-hosting-managedserver/7010-hs-hosting-managedserver.sql new file mode 100644 index 00000000..7df4305b --- /dev/null +++ b/src/main/resources/db/changelog/7-hs-hosting/701-hosting-managedserver/7010-hs-hosting-managedserver.sql @@ -0,0 +1,24 @@ +--liquibase formatted sql + +-- ============================================================================ +--changeset hosting-managedserver-MAIN-TABLE:1 endDelimiter:--// +-- ---------------------------------------------------------------------------- + +create table if not exists hs_hosting_managedserver +( + uuid uuid unique references RbacObject (uuid), + version int not null default 0, + bookingItemUuid uuid not null references hs_booking_item(uuid), + validity daterange not null, + caption varchar(80) not null, + resources jsonb not null +); +--// + + +-- ============================================================================ +--changeset hs-hosting-managedserver-MAIN-TABLE-JOURNAL:1 endDelimiter:--// +-- ---------------------------------------------------------------------------- + +call create_journal('hs_hosting_managedserver'); +--// diff --git a/src/main/resources/db/changelog/7-hs-hosting/701-hosting-managedserver/7013-hs-hosting-managedserver-rbac.md b/src/main/resources/db/changelog/7-hs-hosting/701-hosting-managedserver/7013-hs-hosting-managedserver-rbac.md new file mode 100644 index 00000000..1acb787d --- /dev/null +++ b/src/main/resources/db/changelog/7-hs-hosting/701-hosting-managedserver/7013-hs-hosting-managedserver-rbac.md @@ -0,0 +1,285 @@ +### rbac bookingItem + +This code generated was by RbacViewMermaidFlowchartGenerator, do not amend manually. + +```mermaid +%%{init:{'flowchart':{'htmlLabels':false}}}%% +flowchart TB + +subgraph debitor.debitorRel.anchorPerson["`**debitor.debitorRel.anchorPerson**`"] + direction TB + style debitor.debitorRel.anchorPerson fill:#99bcdb,stroke:#274d6e,stroke-width:8px + + subgraph debitor.debitorRel.anchorPerson:roles[ ] + style debitor.debitorRel.anchorPerson:roles fill:#99bcdb,stroke:white + + role:debitor.debitorRel.anchorPerson:OWNER[[debitor.debitorRel.anchorPerson:OWNER]] + role:debitor.debitorRel.anchorPerson:ADMIN[[debitor.debitorRel.anchorPerson:ADMIN]] + role:debitor.debitorRel.anchorPerson:REFERRER[[debitor.debitorRel.anchorPerson:REFERRER]] + end +end + +subgraph debitor.debitorRel.holderPerson["`**debitor.debitorRel.holderPerson**`"] + direction TB + style debitor.debitorRel.holderPerson fill:#99bcdb,stroke:#274d6e,stroke-width:8px + + subgraph debitor.debitorRel.holderPerson:roles[ ] + style debitor.debitorRel.holderPerson:roles fill:#99bcdb,stroke:white + + role:debitor.debitorRel.holderPerson:OWNER[[debitor.debitorRel.holderPerson:OWNER]] + role:debitor.debitorRel.holderPerson:ADMIN[[debitor.debitorRel.holderPerson:ADMIN]] + role:debitor.debitorRel.holderPerson:REFERRER[[debitor.debitorRel.holderPerson:REFERRER]] + end +end + +subgraph debitorRel.anchorPerson["`**debitorRel.anchorPerson**`"] + direction TB + style debitorRel.anchorPerson fill:#99bcdb,stroke:#274d6e,stroke-width:8px + + subgraph debitorRel.anchorPerson:roles[ ] + style debitorRel.anchorPerson:roles fill:#99bcdb,stroke:white + + role:debitorRel.anchorPerson:OWNER[[debitorRel.anchorPerson:OWNER]] + role:debitorRel.anchorPerson:ADMIN[[debitorRel.anchorPerson:ADMIN]] + role:debitorRel.anchorPerson:REFERRER[[debitorRel.anchorPerson:REFERRER]] + end +end + +subgraph debitorRel.holderPerson["`**debitorRel.holderPerson**`"] + direction TB + style debitorRel.holderPerson fill:#99bcdb,stroke:#274d6e,stroke-width:8px + + subgraph debitorRel.holderPerson:roles[ ] + style debitorRel.holderPerson:roles fill:#99bcdb,stroke:white + + role:debitorRel.holderPerson:OWNER[[debitorRel.holderPerson:OWNER]] + role:debitorRel.holderPerson:ADMIN[[debitorRel.holderPerson:ADMIN]] + role:debitorRel.holderPerson:REFERRER[[debitorRel.holderPerson:REFERRER]] + end +end + +subgraph debitor.debitorRel["`**debitor.debitorRel**`"] + direction TB + style debitor.debitorRel fill:#99bcdb,stroke:#274d6e,stroke-width:8px + + subgraph debitor.debitorRel:roles[ ] + style debitor.debitorRel:roles fill:#99bcdb,stroke:white + + role:debitor.debitorRel:OWNER[[debitor.debitorRel:OWNER]] + role:debitor.debitorRel:ADMIN[[debitor.debitorRel:ADMIN]] + role:debitor.debitorRel:AGENT[[debitor.debitorRel:AGENT]] + role:debitor.debitorRel:TENANT[[debitor.debitorRel:TENANT]] + end +end + +subgraph debitor.partnerRel["`**debitor.partnerRel**`"] + direction TB + style debitor.partnerRel fill:#99bcdb,stroke:#274d6e,stroke-width:8px + + subgraph debitor.partnerRel:roles[ ] + style debitor.partnerRel:roles fill:#99bcdb,stroke:white + + role:debitor.partnerRel:OWNER[[debitor.partnerRel:OWNER]] + role:debitor.partnerRel:ADMIN[[debitor.partnerRel:ADMIN]] + role:debitor.partnerRel:AGENT[[debitor.partnerRel:AGENT]] + role:debitor.partnerRel:TENANT[[debitor.partnerRel:TENANT]] + end +end + +subgraph bookingItem["`**bookingItem**`"] + direction TB + style bookingItem fill:#dd4901,stroke:#274d6e,stroke-width:8px + + subgraph bookingItem:roles[ ] + style bookingItem:roles fill:#dd4901,stroke:white + + role:bookingItem:OWNER[[bookingItem:OWNER]] + role:bookingItem:ADMIN[[bookingItem:ADMIN]] + role:bookingItem:TENANT[[bookingItem:TENANT]] + end + + subgraph bookingItem:permissions[ ] + style bookingItem:permissions fill:#dd4901,stroke:white + + perm:bookingItem:INSERT{{bookingItem:INSERT}} + perm:bookingItem:DELETE{{bookingItem:DELETE}} + perm:bookingItem:UPDATE{{bookingItem:UPDATE}} + perm:bookingItem:SELECT{{bookingItem:SELECT}} + end +end + +subgraph debitor.partnerRel.contact["`**debitor.partnerRel.contact**`"] + direction TB + style debitor.partnerRel.contact fill:#99bcdb,stroke:#274d6e,stroke-width:8px + + subgraph debitor.partnerRel.contact:roles[ ] + style debitor.partnerRel.contact:roles fill:#99bcdb,stroke:white + + role:debitor.partnerRel.contact:OWNER[[debitor.partnerRel.contact:OWNER]] + role:debitor.partnerRel.contact:ADMIN[[debitor.partnerRel.contact:ADMIN]] + role:debitor.partnerRel.contact:REFERRER[[debitor.partnerRel.contact:REFERRER]] + end +end + +subgraph debitor.partnerRel.holderPerson["`**debitor.partnerRel.holderPerson**`"] + direction TB + style debitor.partnerRel.holderPerson fill:#99bcdb,stroke:#274d6e,stroke-width:8px + + subgraph debitor.partnerRel.holderPerson:roles[ ] + style debitor.partnerRel.holderPerson:roles fill:#99bcdb,stroke:white + + role:debitor.partnerRel.holderPerson:OWNER[[debitor.partnerRel.holderPerson:OWNER]] + role:debitor.partnerRel.holderPerson:ADMIN[[debitor.partnerRel.holderPerson:ADMIN]] + role:debitor.partnerRel.holderPerson:REFERRER[[debitor.partnerRel.holderPerson:REFERRER]] + end +end + +subgraph debitor["`**debitor**`"] + direction TB + style debitor fill:#99bcdb,stroke:#274d6e,stroke-width:8px +end + +subgraph debitor.refundBankAccount["`**debitor.refundBankAccount**`"] + direction TB + style debitor.refundBankAccount fill:#99bcdb,stroke:#274d6e,stroke-width:8px + + subgraph debitor.refundBankAccount:roles[ ] + style debitor.refundBankAccount:roles fill:#99bcdb,stroke:white + + role:debitor.refundBankAccount:OWNER[[debitor.refundBankAccount:OWNER]] + role:debitor.refundBankAccount:ADMIN[[debitor.refundBankAccount:ADMIN]] + role:debitor.refundBankAccount:REFERRER[[debitor.refundBankAccount:REFERRER]] + end +end + +subgraph debitor.partnerRel.anchorPerson["`**debitor.partnerRel.anchorPerson**`"] + direction TB + style debitor.partnerRel.anchorPerson fill:#99bcdb,stroke:#274d6e,stroke-width:8px + + subgraph debitor.partnerRel.anchorPerson:roles[ ] + style debitor.partnerRel.anchorPerson:roles fill:#99bcdb,stroke:white + + role:debitor.partnerRel.anchorPerson:OWNER[[debitor.partnerRel.anchorPerson:OWNER]] + role:debitor.partnerRel.anchorPerson:ADMIN[[debitor.partnerRel.anchorPerson:ADMIN]] + role:debitor.partnerRel.anchorPerson:REFERRER[[debitor.partnerRel.anchorPerson:REFERRER]] + end +end + +subgraph debitorRel.contact["`**debitorRel.contact**`"] + direction TB + style debitorRel.contact fill:#99bcdb,stroke:#274d6e,stroke-width:8px + + subgraph debitorRel.contact:roles[ ] + style debitorRel.contact:roles fill:#99bcdb,stroke:white + + role:debitorRel.contact:OWNER[[debitorRel.contact:OWNER]] + role:debitorRel.contact:ADMIN[[debitorRel.contact:ADMIN]] + role:debitorRel.contact:REFERRER[[debitorRel.contact:REFERRER]] + end +end + +subgraph debitor.debitorRel.contact["`**debitor.debitorRel.contact**`"] + direction TB + style debitor.debitorRel.contact fill:#99bcdb,stroke:#274d6e,stroke-width:8px + + subgraph debitor.debitorRel.contact:roles[ ] + style debitor.debitorRel.contact:roles fill:#99bcdb,stroke:white + + role:debitor.debitorRel.contact:OWNER[[debitor.debitorRel.contact:OWNER]] + role:debitor.debitorRel.contact:ADMIN[[debitor.debitorRel.contact:ADMIN]] + role:debitor.debitorRel.contact:REFERRER[[debitor.debitorRel.contact:REFERRER]] + end +end + +subgraph debitorRel["`**debitorRel**`"] + direction TB + style debitorRel fill:#99bcdb,stroke:#274d6e,stroke-width:8px + + subgraph debitorRel:roles[ ] + style debitorRel:roles fill:#99bcdb,stroke:white + + role:debitorRel:OWNER[[debitorRel:OWNER]] + role:debitorRel:ADMIN[[debitorRel:ADMIN]] + role:debitorRel:AGENT[[debitorRel:AGENT]] + role:debitorRel:TENANT[[debitorRel:TENANT]] + end +end + +%% granting roles to roles +role:global:ADMIN -.-> role:debitor.debitorRel.anchorPerson:OWNER +role:debitor.debitorRel.anchorPerson:OWNER -.-> role:debitor.debitorRel.anchorPerson:ADMIN +role:debitor.debitorRel.anchorPerson:ADMIN -.-> role:debitor.debitorRel.anchorPerson:REFERRER +role:global:ADMIN -.-> role:debitor.debitorRel.holderPerson:OWNER +role:debitor.debitorRel.holderPerson:OWNER -.-> role:debitor.debitorRel.holderPerson:ADMIN +role:debitor.debitorRel.holderPerson:ADMIN -.-> role:debitor.debitorRel.holderPerson:REFERRER +role:global:ADMIN -.-> role:debitor.debitorRel.contact:OWNER +role:debitor.debitorRel.contact:OWNER -.-> role:debitor.debitorRel.contact:ADMIN +role:debitor.debitorRel.contact:ADMIN -.-> role:debitor.debitorRel.contact:REFERRER +role:global:ADMIN -.-> role:debitor.debitorRel:OWNER +role:debitor.debitorRel:OWNER -.-> role:debitor.debitorRel:ADMIN +role:debitor.debitorRel:ADMIN -.-> role:debitor.debitorRel:AGENT +role:debitor.debitorRel:AGENT -.-> role:debitor.debitorRel:TENANT +role:debitor.debitorRel.contact:ADMIN -.-> role:debitor.debitorRel:TENANT +role:debitor.debitorRel:TENANT -.-> role:debitor.debitorRel.anchorPerson:REFERRER +role:debitor.debitorRel:TENANT -.-> role:debitor.debitorRel.holderPerson:REFERRER +role:debitor.debitorRel:TENANT -.-> role:debitor.debitorRel.contact:REFERRER +role:debitor.debitorRel.anchorPerson:ADMIN -.-> role:debitor.debitorRel:OWNER +role:debitor.debitorRel.holderPerson:ADMIN -.-> role:debitor.debitorRel:AGENT +role:global:ADMIN -.-> role:debitor.refundBankAccount:OWNER +role:debitor.refundBankAccount:OWNER -.-> role:debitor.refundBankAccount:ADMIN +role:debitor.refundBankAccount:ADMIN -.-> role:debitor.refundBankAccount:REFERRER +role:debitor.refundBankAccount:ADMIN -.-> role:debitor.debitorRel:AGENT +role:debitor.debitorRel:AGENT -.-> role:debitor.refundBankAccount:REFERRER +role:global:ADMIN -.-> role:debitor.partnerRel.anchorPerson:OWNER +role:debitor.partnerRel.anchorPerson:OWNER -.-> role:debitor.partnerRel.anchorPerson:ADMIN +role:debitor.partnerRel.anchorPerson:ADMIN -.-> role:debitor.partnerRel.anchorPerson:REFERRER +role:global:ADMIN -.-> role:debitor.partnerRel.holderPerson:OWNER +role:debitor.partnerRel.holderPerson:OWNER -.-> role:debitor.partnerRel.holderPerson:ADMIN +role:debitor.partnerRel.holderPerson:ADMIN -.-> role:debitor.partnerRel.holderPerson:REFERRER +role:global:ADMIN -.-> role:debitor.partnerRel.contact:OWNER +role:debitor.partnerRel.contact:OWNER -.-> role:debitor.partnerRel.contact:ADMIN +role:debitor.partnerRel.contact:ADMIN -.-> role:debitor.partnerRel.contact:REFERRER +role:global:ADMIN -.-> role:debitor.partnerRel:OWNER +role:debitor.partnerRel:OWNER -.-> role:debitor.partnerRel:ADMIN +role:debitor.partnerRel:ADMIN -.-> role:debitor.partnerRel:AGENT +role:debitor.partnerRel:AGENT -.-> role:debitor.partnerRel:TENANT +role:debitor.partnerRel.contact:ADMIN -.-> role:debitor.partnerRel:TENANT +role:debitor.partnerRel:TENANT -.-> role:debitor.partnerRel.anchorPerson:REFERRER +role:debitor.partnerRel:TENANT -.-> role:debitor.partnerRel.holderPerson:REFERRER +role:debitor.partnerRel:TENANT -.-> role:debitor.partnerRel.contact:REFERRER +role:debitor.partnerRel.anchorPerson:ADMIN -.-> role:debitor.partnerRel:OWNER +role:debitor.partnerRel.holderPerson:ADMIN -.-> role:debitor.partnerRel:AGENT +role:debitor.partnerRel:ADMIN -.-> role:debitor.debitorRel:ADMIN +role:debitor.partnerRel:AGENT -.-> role:debitor.debitorRel:AGENT +role:debitor.debitorRel:AGENT -.-> role:debitor.partnerRel:TENANT +role:global:ADMIN -.-> role:debitorRel.anchorPerson:OWNER +role:debitorRel.anchorPerson:OWNER -.-> role:debitorRel.anchorPerson:ADMIN +role:debitorRel.anchorPerson:ADMIN -.-> role:debitorRel.anchorPerson:REFERRER +role:global:ADMIN -.-> role:debitorRel.holderPerson:OWNER +role:debitorRel.holderPerson:OWNER -.-> role:debitorRel.holderPerson:ADMIN +role:debitorRel.holderPerson:ADMIN -.-> role:debitorRel.holderPerson:REFERRER +role:global:ADMIN -.-> role:debitorRel.contact:OWNER +role:debitorRel.contact:OWNER -.-> role:debitorRel.contact:ADMIN +role:debitorRel.contact:ADMIN -.-> role:debitorRel.contact:REFERRER +role:global:ADMIN -.-> role:debitorRel:OWNER +role:debitorRel:OWNER -.-> role:debitorRel:ADMIN +role:debitorRel:ADMIN -.-> role:debitorRel:AGENT +role:debitorRel:AGENT -.-> role:debitorRel:TENANT +role:debitorRel.contact:ADMIN -.-> role:debitorRel:TENANT +role:debitorRel:TENANT -.-> role:debitorRel.anchorPerson:REFERRER +role:debitorRel:TENANT -.-> role:debitorRel.holderPerson:REFERRER +role:debitorRel:TENANT -.-> role:debitorRel.contact:REFERRER +role:debitorRel.anchorPerson:ADMIN -.-> role:debitorRel:OWNER +role:debitorRel.holderPerson:ADMIN -.-> role:debitorRel:AGENT +role:debitorRel:AGENT ==> role:bookingItem:OWNER +role:bookingItem:OWNER ==> role:bookingItem:ADMIN +role:bookingItem:ADMIN ==> role:bookingItem:TENANT +role:bookingItem:TENANT ==> role:debitorRel:TENANT + +%% granting permissions to roles +role:debitorRel:ADMIN ==> perm:bookingItem:INSERT +role:global:ADMIN ==> perm:bookingItem:DELETE +role:bookingItem:OWNER ==> perm:bookingItem:UPDATE +role:bookingItem:TENANT ==> perm:bookingItem:SELECT + +``` diff --git a/src/main/resources/db/changelog/7-hs-hosting/701-hosting-managedserver/7013-hs-hosting-managedserver-rbac.sql b/src/main/resources/db/changelog/7-hs-hosting/701-hosting-managedserver/7013-hs-hosting-managedserver-rbac.sql new file mode 100644 index 00000000..8fd63cf3 --- /dev/null +++ b/src/main/resources/db/changelog/7-hs-hosting/701-hosting-managedserver/7013-hs-hosting-managedserver-rbac.sql @@ -0,0 +1,199 @@ +--liquibase formatted sql +-- This code generated was by RbacViewPostgresGenerator, do not amend manually. + + +-- ============================================================================ +--changeset hs-hosting-managedserver-rbac-OBJECT:1 endDelimiter:--// +-- ---------------------------------------------------------------------------- +call generateRelatedRbacObject('hs_hosting_managedserver'); +--// + + +-- ============================================================================ +--changeset hs-hosting-managedserver-rbac-ROLE-DESCRIPTORS:1 endDelimiter:--// +-- ---------------------------------------------------------------------------- +call generateRbacRoleDescriptors('hsBookingItem', 'hs_hosting_managedserver'); +--// + + +-- ============================================================================ +--changeset hs-hosting-managedserver-rbac-insert-trigger:1 endDelimiter:--// +-- ---------------------------------------------------------------------------- + +/* + Creates the roles, grants and permission for the AFTER INSERT TRIGGER. + */ + +create or replace procedure buildRbacSystemForHsBookingItem( + NEW hs_hosting_managedserver +) + language plpgsql as $$ + +declare + newDebitor hs_office_debitor; + newDebitorRel hs_office_relation; + +begin + call enterTriggerForObjectUuid(NEW.uuid); + + SELECT * FROM hs_office_debitor WHERE uuid = NEW.debitorUuid INTO newDebitor; + assert newDebitor.uuid is not null, format('newDebitor must not be null for NEW.debitorUuid = %s', NEW.debitorUuid); + + SELECT debitorRel.* + FROM hs_office_relation debitorRel + JOIN hs_office_debitor debitor ON debitor.debitorRelUuid = debitorRel.uuid + WHERE debitor.uuid = NEW.debitorUuid + INTO newDebitorRel; + assert newDebitorRel.uuid is not null, format('newDebitorRel must not be null for NEW.debitorUuid = %s', NEW.debitorUuid); + + + perform createRoleWithGrants( + hsBookingItemOWNER(NEW), + permissions => array['UPDATE'], + incomingSuperRoles => array[hsOfficeRelationAGENT(newDebitorRel)] + ); + + perform createRoleWithGrants( + hsBookingItemADMIN(NEW), + incomingSuperRoles => array[hsBookingItemOWNER(NEW)] + ); + + perform createRoleWithGrants( + hsBookingItemTENANT(NEW), + permissions => array['SELECT'], + incomingSuperRoles => array[hsBookingItemADMIN(NEW)], + outgoingSubRoles => array[hsOfficeRelationTENANT(newDebitorRel)] + ); + + call grantPermissionToRole(createPermission(NEW.uuid, 'DELETE'), globalAdmin()); + + call leaveTriggerForObjectUuid(NEW.uuid); +end; $$; + +/* + AFTER INSERT TRIGGER to create the role+grant structure for a new hs_hosting_managedserver row. + */ + +create or replace function insertTriggerForHsBookingItem_tf() + returns trigger + language plpgsql + strict as $$ +begin + call buildRbacSystemForHsBookingItem(NEW); + return NEW; +end; $$; + +create trigger insertTriggerForHsBookingItem_tg + after insert on hs_hosting_managedserver + for each row +execute procedure insertTriggerForHsBookingItem_tf(); +--// + + +-- ============================================================================ +--changeset hs-hosting-managedserver-rbac-INSERT:1 endDelimiter:--// +-- ---------------------------------------------------------------------------- + +/* + Creates INSERT INTO hs_hosting_managedserver permissions for the related hs_office_relation rows. + */ +do language plpgsql $$ + declare + row hs_office_relation; + begin + call defineContext('create INSERT INTO hs_hosting_managedserver permissions for the related hs_office_relation rows'); + + FOR row IN SELECT * FROM hs_office_relation + WHERE type in ('DEBITOR') -- TODO.rbac: currently manually patched, needs to be generated + LOOP + call grantPermissionToRole( + createPermission(row.uuid, 'INSERT', 'hs_hosting_managedserver'), + hsOfficeRelationADMIN(row)); + END LOOP; + END; +$$; + +/** + Adds hs_hosting_managedserver INSERT permission to specified role of new hs_office_relation rows. +*/ +create or replace function hs_hosting_managedserver_hs_office_relation_insert_tf() + returns trigger + language plpgsql + strict as $$ +begin + if NEW.type = 'DEBITOR' then -- TODO.rbac: currently manually patched, needs to be generated + call grantPermissionToRole( + createPermission(NEW.uuid, 'INSERT', 'hs_hosting_managedserver'), + hsOfficeRelationADMIN(NEW)); + end if; + return NEW; +end; $$; + +-- z_... is to put it at the end of after insert triggers, to make sure the roles exist +create trigger z_hs_hosting_managedserver_hs_office_relation_insert_tg + after insert on hs_office_relation + for each row +execute procedure hs_hosting_managedserver_hs_office_relation_insert_tf(); + +/** + Checks if the user or assumed roles are allowed to insert a row to hs_hosting_managedserver, + where the check is performed by an indirect role. + + An indirect role is a role which depends on an object uuid which is not a direct foreign key + of the source entity, but needs to be fetched via joined tables. +*/ +create or replace function hs_hosting_managedserver_insert_permission_check_tf() + returns trigger + language plpgsql as $$ + +declare + superRoleObjectUuid uuid; + +begin + superRoleObjectUuid := (SELECT debitorRel.uuid + FROM hs_office_relation debitorRel + JOIN hs_office_debitor debitor ON debitor.debitorRelUuid = debitorRel.uuid + WHERE debitor.uuid = NEW.debitorUuid + ); + assert superRoleObjectUuid is not null, 'superRoleObjectUuid must not be null'; + + if ( not hasInsertPermission(superRoleObjectUuid, 'INSERT', 'hs_hosting_managedserver') ) then + raise exception + '[403] insert into hs_hosting_managedserver not allowed for current subjects % (%)', + currentSubjects(), currentSubjectsUuids(); + end if; + return NEW; +end; $$; + +create trigger hs_hosting_managedserver_insert_permission_check_tg + before insert on hs_hosting_managedserver + for each row + execute procedure hs_hosting_managedserver_insert_permission_check_tf(); +--// + +-- ============================================================================ +--changeset hs-hosting-managedserver-rbac-IDENTITY-VIEW:1 endDelimiter:--// +-- ---------------------------------------------------------------------------- + + call generateRbacIdentityViewFromQuery('hs_hosting_managedserver', + $idName$ + SELECT i.uuid as uuid, d.idName || ':' || i.caption as idName + FROM hs_hosting_managedserver i + JOIN hs_office_debitor_iv d ON d.uuid = i.debitorUuid + $idName$); +--// + +-- ============================================================================ +--changeset hs-hosting-managedserver-rbac-RESTRICTED-VIEW:1 endDelimiter:--// +-- ---------------------------------------------------------------------------- +call generateRbacRestrictedView('hs_hosting_managedserver', + $orderBy$ + validity + $orderBy$, + $updates$ + version = new.version, + validity = new.validity, + resources = new.resources + $updates$); +--// + diff --git a/src/main/resources/db/changelog/7-hs-hosting/701-hosting-managedserver/7018-hs-hosting-managedserver-test-data.sql b/src/main/resources/db/changelog/7-hs-hosting/701-hosting-managedserver/7018-hs-hosting-managedserver-test-data.sql new file mode 100644 index 00000000..46bf7d78 --- /dev/null +++ b/src/main/resources/db/changelog/7-hs-hosting/701-hosting-managedserver/7018-hs-hosting-managedserver-test-data.sql @@ -0,0 +1,56 @@ +--liquibase formatted sql + + +-- ============================================================================ +--changeset hs-hosting-managedserver-TEST-DATA-GENERATOR:1 endDelimiter:--// +-- ---------------------------------------------------------------------------- + +/* + Creates a single hs_hosting_managedserver test record. + */ +create or replace procedure createHsHostingManagedServerTestData( + givenPartnerNumber numeric, + givenDebitorSuffix char(2) + ) + language plpgsql as $$ +declare + currentTask varchar; + relatedDebitor hs_office_debitor; + relatedBookingItem hs_booking_item; +begin + currentTask := 'creating hosting-managedserver test-data ' || givenPartnerNumber::text || givenDebitorSuffix; + call defineContext(currentTask, null, 'superuser-alex@hostsharing.net', 'global#global:ADMIN'); + execute format('set local hsadminng.currentTask to %L', currentTask); + + select debitor.* into relatedDebitor + from hs_office_debitor debitor + join hs_office_relation debitorRel on debitorRel.uuid = debitor.debitorRelUuid + join hs_office_relation partnerRel on partnerRel.holderUuid = debitorRel.anchorUuid + join hs_office_partner partner on partner.partnerRelUuid = partnerRel.uuid + where partner.partnerNumber = givenPartnerNumber and debitor.debitorNumberSuffix = givenDebitorSuffix; + select item.* into relatedBookingItem + from hs_booking_item item + where item.debitoruuid = relatedDebitor.uuid; + + raise notice 'creating test hosting-managedserver: %', givenPartnerNumber::text || givenDebitorSuffix::text; + raise notice '- using debitor (%): %', relatedDebitor.uuid, relatedDebitor; + insert + into hs_hosting_managedserver (uuid, debitoruuid, caption, validity, resources) + values (uuid_generate_v4(), relatedDebitor.uuid, 'some ManagedServer', daterange('20221001', null, '[]'), '{ "CPU": 2, "SDD": 512, "extra": 42 }'::jsonb), + (uuid_generate_v4(), relatedDebitor.uuid, 'some CloudServer', daterange('20230115', '20240415', '[)'), '{ "CPU": 2, "HDD": 1024, "extra": 42 }'::jsonb), + (uuid_generate_v4(), relatedDebitor.uuid, 'some Whatever', daterange('20240401', null, '[]'), '{ "CPU": 1, "SDD": 512, "HDD": 2048, "extra": 42 }'::jsonb); +end; $$; +--// + + +-- ============================================================================ +--changeset hs-hosting-managedserver-TEST-DATA-GENERATION:1 –context=dev,tc endDelimiter:--// +-- ---------------------------------------------------------------------------- + +do language plpgsql $$ + begin + call createHsHostingManagedServerTestData(10001, '11'); + call createHsHostingManagedServerTestData(10002, '12'); + call createHsHostingManagedServerTestData(10003, '13'); + end; +$$; diff --git a/src/main/resources/db/changelog/db.changelog-master.yaml b/src/main/resources/db/changelog/db.changelog-master.yaml index fccafed2..ca62ef60 100644 --- a/src/main/resources/db/changelog/db.changelog-master.yaml +++ b/src/main/resources/db/changelog/db.changelog-master.yaml @@ -133,3 +133,9 @@ databaseChangeLog: file: db/changelog/6-hs-booking/601-booking-item/6013-hs-booking-item-rbac.sql - include: file: db/changelog/6-hs-booking/601-booking-item/6018-hs-booking-item-test-data.sql + - include: + file: db/changelog/7-hs-hosting/701-hosting-managedserver/7010-hs-hosting-managedserver.sql + - include: + file: db/changelog/7-hs-hosting/701-hosting-managedserver/7013-hs-hosting-managedserver-rbac.sql + - include: + file: db/changelog/7-hs-hosting/701-hosting-managedserver/7018-hs-hosting-managedserver-test-data.sql diff --git a/src/test/java/net/hostsharing/hsadminng/arch/ArchitectureTest.java b/src/test/java/net/hostsharing/hsadminng/arch/ArchitectureTest.java index 1523f7cf..28bc166a 100644 --- a/src/test/java/net/hostsharing/hsadminng/arch/ArchitectureTest.java +++ b/src/test/java/net/hostsharing/hsadminng/arch/ArchitectureTest.java @@ -51,6 +51,7 @@ public class ArchitectureTest { "..hs.office.relation", "..hs.office.sepamandate", "..hs.booking.item", + "..hs.hosting.managedserver", "..errors", "..mapper", "..ping", @@ -140,7 +141,16 @@ public class ArchitectureTest { .should().onlyBeAccessed().byClassesThat() .resideInAnyPackage( "..hs.booking.(*)..", - "..rbac.rbacgrant" // TODO.test: just because of RbacGrantsDiagramServiceIntegrationTest + "..hs.hosting.(*).." + ); + + @ArchTest + @SuppressWarnings("unused") + public static final ArchRule hsHostingPackageAccessRule = classes() + .that().resideInAPackage("..hs.hosting.(*)..") + .should().onlyBeAccessed().byClassesThat() + .resideInAnyPackage( + "..hs.hosting.(*).." ); @ArchTest diff --git a/src/test/java/net/hostsharing/hsadminng/hs/hosting/managedserver/HsManagedServerControllerAcceptanceTest.java b/src/test/java/net/hostsharing/hsadminng/hs/hosting/managedserver/HsManagedServerControllerAcceptanceTest.java new file mode 100644 index 00000000..4373bba9 --- /dev/null +++ b/src/test/java/net/hostsharing/hsadminng/hs/hosting/managedserver/HsManagedServerControllerAcceptanceTest.java @@ -0,0 +1,337 @@ +package net.hostsharing.hsadminng.hs.hosting.managedserver; + +import io.hypersistence.utils.hibernate.type.range.Range; +import io.restassured.RestAssured; +import io.restassured.http.ContentType; +import net.hostsharing.hsadminng.HsadminNgApplication; +import net.hostsharing.hsadminng.hs.office.debitor.HsOfficeDebitorRepository; +import net.hostsharing.hsadminng.rbac.test.ContextBasedTestWithCleanup; +import net.hostsharing.hsadminng.rbac.test.JpaAttempt; +import org.junit.jupiter.api.Nested; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.boot.test.web.server.LocalServerPort; +import org.springframework.transaction.annotation.Transactional; + +import jakarta.persistence.EntityManager; +import jakarta.persistence.PersistenceContext; +import java.time.LocalDate; +import java.util.Map; +import java.util.UUID; + +import static java.util.Map.entry; +import static net.hostsharing.hsadminng.rbac.test.JsonMatcher.lenientlyEquals; +import static org.assertj.core.api.Assertions.assertThat; +import static org.hamcrest.Matchers.matchesRegex; + +@SpringBootTest( + webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT, + classes = { HsadminNgApplication.class, JpaAttempt.class } +) +@Transactional +class HsManagedServerControllerAcceptanceTest extends ContextBasedTestWithCleanup { + + @LocalServerPort + private Integer port; + + @Autowired + HsManagedServerRepository managedServerRepo; + + @Autowired + HsOfficeDebitorRepository debitorRepo; + + @Autowired + JpaAttempt jpaAttempt; + + @Nested + class ListManagedServers { + + @Test + void globalAdmin_canViewAllManagedServersOfArbitraryDebitor() { + + // given + context("superuser-alex@hostsharing.net"); + final var givenDebitor = debitorRepo.findDebitorByDebitorNumber(1000111).get(0); + + RestAssured // @formatter:off + .given() + .header("current-user", "superuser-alex@hostsharing.net") + .port(port) + .when() + .get("http://localhost/api/hs/hosting/managedservers?debitorUuid=" + givenDebitor.getUuid()) + .then().log().all().assertThat() + .statusCode(200) + .contentType("application/json") + .body("", lenientlyEquals(""" + [ + { + "caption": "some ManagedServer", + "validFrom": "2022-10-01", + "validTo": null, + "config": { + "CPU": 2, + "SDD": 512, + "extra": 42 + } + }, + { + "caption": "some CloudServer", + "validFrom": "2023-01-15", + "validTo": "2024-04-14", + "config": { + "CPU": 2, + "HDD": 1024, + "extra": 42 + } + }, + { + "caption": "some Whatever", + "validFrom": "2024-04-01", + "validTo": null, + "config": { + "CPU": 1, + "HDD": 2048, + "SDD": 512, + "extra": 42 + } + } + ] + """)); + // @formatter:on + } + } + + @Nested + class AddManagedServer { + + @Test + void globalAdmin_canAddManagedServer() { + + context.define("superuser-alex@hostsharing.net"); + final var givenDebitor = debitorRepo.findDebitorByDebitorNumber(1000111).get(0); + + final var location = RestAssured // @formatter:off + .given() + .header("current-user", "superuser-alex@hostsharing.net") + .contentType(ContentType.JSON) + .body(""" + { + "debitorUuid": "%s", + "caption": "some new booking", + "config": { "CPU": 12, "extra": 42 }, + "validFrom": "2022-10-13" + } + """.formatted(givenDebitor.getUuid())) + .port(port) + .when() + .post("http://localhost/api/hs/hosting/managedservers") + .then().log().all().assertThat() + .statusCode(201) + .contentType(ContentType.JSON) + .body("", lenientlyEquals(""" + { + "caption": "some new booking", + "validFrom": "2022-10-13", + "validTo": null, + "config": { "CPU": 12 } + } + """)) + .header("Location", matchesRegex("http://localhost:[1-9][0-9]*/api/hs/hosting/managedservers/[^/]*")) + .extract().header("Location"); // @formatter:on + + // finally, the new managedServer can be accessed under the generated UUID + final var newUserUuid = UUID.fromString( + location.substring(location.lastIndexOf('/') + 1)); + assertThat(newUserUuid).isNotNull(); + } + } + + @Nested + class GetManagedServer { + + @Test + void globalAdmin_canGetArbitraryManagedServer() { + context.define("superuser-alex@hostsharing.net"); + final var givenManagedServerUuid = managedServerRepo.findAll().stream() + .filter(bi -> bi.getDebitor().getDebitorNumber() == 1000111) + .filter(item -> item.getCaption().equals("some CloudServer")) + .findAny().orElseThrow().getUuid(); + + RestAssured // @formatter:off + .given() + .header("current-user", "superuser-alex@hostsharing.net") + .port(port) + .when() + .get("http://localhost/api/hs/hosting/managedservers/" + givenManagedServerUuid) + .then().log().all().assertThat() + .statusCode(200) + .contentType("application/json") + .body("", lenientlyEquals(""" + { + "caption": "some CloudServer", + "validFrom": "2023-01-15", + "validTo": "2024-04-14", + "config": { CPU: 2, HDD: 1024 } + } + """)); // @formatter:on + } + + @Test + void normalUser_canNotGetUnrelatedManagedServer() { + context.define("superuser-alex@hostsharing.net"); + final var givenManagedServerUuid = managedServerRepo.findAll().stream() + .filter(bi -> bi.getDebitor().getDebitorNumber() == 1000212) + .map(HsManagedServerEntity::getUuid) + .findAny().orElseThrow(); + + RestAssured // @formatter:off + .given() + .header("current-user", "selfregistered-user-drew@hostsharing.org") + .port(port) + .when() + .get("http://localhost/api/hs/hosting/managedservers/" + givenManagedServerUuid) + .then().log().body().assertThat() + .statusCode(404); // @formatter:on + } + + @Test + void debitorAgentUser_canGetRelatedManagedServer() { + context.define("superuser-alex@hostsharing.net"); + final var givenManagedServerUuid = managedServerRepo.findAll().stream() + .filter(bi -> bi.getDebitor().getDebitorNumber() == 1000313) + .filter(item -> item.getCaption().equals("some CloudServer")) + .findAny().orElseThrow().getUuid(); + + RestAssured // @formatter:off + .given() + .header("current-user", "person-TuckerJack@example.com") + .port(port) + .when() + .get("http://localhost/api/hs/hosting/managedservers/" + givenManagedServerUuid) + .then().log().all().assertThat() + .statusCode(200) + .contentType("application/json") + .body("", lenientlyEquals(""" + { + "caption": "some CloudServer", + "validFrom": "2023-01-15", + "validTo": "2024-04-14", + "config": { CPU: 2, HDD: 1024 } + } + """)); // @formatter:on + } + } + + @Nested + class PatchManagedServer { + + @Test + void globalAdmin_canPatchAllUpdatablePropertiesOfManagedServer() { + + final var givenManagedServer = givenSomeTemporaryManagedServerForDebitorNumber(1000111, entry("something", 1)); + + RestAssured // @formatter:off + .given() + .header("current-user", "superuser-alex@hostsharing.net") + .contentType(ContentType.JSON) + .body(""" + { + "validFrom": "2020-06-05", + "validTo": "2022-12-31", + "resources": { + "CPU": "4", + "HDD": null, + "SSD": "4096" + } + } + """) + .port(port) + .when() + .patch("http://localhost/api/hs/hosting/managedservers/" + givenManagedServer.getUuid()) + .then().log().all().assertThat() + .statusCode(200) + .contentType(ContentType.JSON) + .body("", lenientlyEquals(""" + { + "caption": "some test-booking", + "validFrom": "2022-11-01", + "validTo": "2022-12-31", + "resources": { + "CPU": "4", + "SSD": "4096", + "something": 1 + } + } + """)); // @formatter:on + + // finally, the managedServer is actually updated + context.define("superuser-alex@hostsharing.net"); + assertThat(managedServerRepo.findByUuid(givenManagedServer.getUuid())).isPresent().get() + .matches(mandate -> { + assertThat(mandate.getDebitor().toString()).isEqualTo("debitor(D-1000111: rel(anchor='LP First GmbH', type='DEBITOR', holder='LP First GmbH'), fir)"); + assertThat(mandate.getValidFrom()).isEqualTo("2020-06-05"); + assertThat(mandate.getValidTo()).isEqualTo("2022-12-31"); + return true; + }); + } + } + + @Nested + class DeleteManagedServer { + + @Test + void globalAdmin_canDeleteArbitraryManagedServer() { + context.define("superuser-alex@hostsharing.net"); + final var givenManagedServer = givenSomeTemporaryManagedServerForDebitorNumber(1000111, entry("something", 1)); + + RestAssured // @formatter:off + .given() + .header("current-user", "superuser-alex@hostsharing.net") + .port(port) + .when() + .delete("http://localhost/api/hs/hosting/managedservers/" + givenManagedServer.getUuid()) + .then().log().body().assertThat() + .statusCode(204); // @formatter:on + + // then the given managedServer is gone + assertThat(managedServerRepo.findByUuid(givenManagedServer.getUuid())).isEmpty(); + } + + @Test + void normalUser_canNotDeleteUnrelatedManagedServer() { + context.define("superuser-alex@hostsharing.net"); + final var givenManagedServer = givenSomeTemporaryManagedServerForDebitorNumber(1000111, entry("something", 1)); + + RestAssured // @formatter:off + .given() + .header("current-user", "selfregistered-user-drew@hostsharing.org") + .port(port) + .when() + .delete("http://localhost/api/hs/hosting/managedservers/" + givenManagedServer.getUuid()) + .then().log().body().assertThat() + .statusCode(404); // @formatter:on + + // then the given managedServer is still there + assertThat(managedServerRepo.findByUuid(givenManagedServer.getUuid())).isNotEmpty(); + } + } + + private HsManagedServerEntity givenSomeTemporaryManagedServerForDebitorNumber(final int debitorNumber, + final Map.Entry resources) { + return jpaAttempt.transacted(() -> { + context.define("superuser-alex@hostsharing.net"); + final var givenDebitor = debitorRepo.findDebitorByDebitorNumber(debitorNumber).get(0); + final var newManagedServer = HsManagedServerEntity.builder() + .uuid(UUID.randomUUID()) + .debitor(givenDebitor) + .caption("some test-booking") + .resources(Map.ofEntries(resources)) + .validity(Range.closedOpen( + LocalDate.parse("2022-11-01"), LocalDate.parse("2023-03-31"))) + .build(); + + return managedServerRepo.save(newManagedServer); + }).assertSuccessful().returnedValue(); + } +} diff --git a/src/test/java/net/hostsharing/hsadminng/hs/hosting/managedserver/HsManagedServerEntityPatcherUnitTest.java b/src/test/java/net/hostsharing/hsadminng/hs/hosting/managedserver/HsManagedServerEntityPatcherUnitTest.java new file mode 100644 index 00000000..7d5cc2d2 --- /dev/null +++ b/src/test/java/net/hostsharing/hsadminng/hs/hosting/managedserver/HsManagedServerEntityPatcherUnitTest.java @@ -0,0 +1,114 @@ +package net.hostsharing.hsadminng.hs.hosting.managedserver; + +import io.hypersistence.utils.hibernate.type.range.Range; +import net.hostsharing.hsadminng.hs.booking.generated.api.v1.model.HsManagedServerPatchResource; +import net.hostsharing.hsadminng.hs.booking.item.HsManagedServerEntity; +import net.hostsharing.hsadminng.hs.booking.item.HsManagedServerEntityPatcher; +import net.hostsharing.hsadminng.hs.office.debitor.HsOfficeDebitorEntity; +import net.hostsharing.hsadminng.mapper.KeyValueMap; +import net.hostsharing.hsadminng.rbac.test.PatchUnitTestBase; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.TestInstance; +import org.junit.jupiter.api.extension.ExtendWith; +import org.mockito.Mock; +import org.mockito.junit.jupiter.MockitoExtension; + +import jakarta.persistence.EntityManager; +import java.time.LocalDate; +import java.util.Map; +import java.util.UUID; +import java.util.stream.Stream; + +import static net.hostsharing.hsadminng.hs.office.debitor.TestHsOfficeDebitor.TEST_DEBITOR; +import static net.hostsharing.hsadminng.mapper.PatchMap.entry; +import static net.hostsharing.hsadminng.mapper.PatchMap.patchMap; +import static org.junit.jupiter.api.TestInstance.Lifecycle.PER_CLASS; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.Mockito.lenient; + +@TestInstance(PER_CLASS) +@ExtendWith(MockitoExtension.class) +class HsManagedServerEntityPatcherUnitTest extends PatchUnitTestBase< + HsManagedServerPatchResource, + HsManagedServerEntity + > { + + private static final UUID INITIAL_BOOKING_ITEM_UUID = UUID.randomUUID(); + private static final LocalDate GIVEN_VALID_FROM = LocalDate.parse("2020-04-15"); + private static final LocalDate PATCHED_VALID_TO = LocalDate.parse("2022-12-31"); + + private static final Map INITIAL_RESOURCES = patchMap( + entry("CPU", 1), + entry("HDD", 1024), + entry("MEM", 64) + ); + private static final Map PATCH_RESOURCES = patchMap( + entry("CPU", 2), + entry("HDD", null), + entry("SDD", 256) + ); + private static final Map PATCHED_RESOURCES = patchMap( + entry("CPU", 2), + entry("SDD", 256), + entry("MEM", 64) + ); + + private static final String INITIAL_CAPTION = "initial caption"; + private static final String PATCHED_CAPTION = "patched caption"; + + @Mock + private EntityManager em; + + @BeforeEach + void initMocks() { + lenient().when(em.getReference(eq(HsOfficeDebitorEntity.class), any())).thenAnswer(invocation -> + HsOfficeDebitorEntity.builder().uuid(invocation.getArgument(1)).build()); + lenient().when(em.getReference(eq(HsManagedServerEntity.class), any())).thenAnswer(invocation -> + HsManagedServerEntity.builder().uuid(invocation.getArgument(1)).build()); + } + + @Override + protected HsManagedServerEntity newInitialEntity() { + final var entity = new HsManagedServerEntity(); + entity.setUuid(INITIAL_BOOKING_ITEM_UUID); + entity.setDebitor(TEST_DEBITOR); + entity.getResources().putAll(KeyValueMap.from(INITIAL_RESOURCES)); + entity.setCaption(INITIAL_CAPTION); + entity.setValidity(Range.closedInfinite(GIVEN_VALID_FROM)); + return entity; + } + + @Override + protected HsManagedServerPatchResource newPatchResource() { + return new HsManagedServerPatchResource(); + } + + @Override + protected HsManagedServerEntityPatcher createPatcher(final HsManagedServerEntity managedServer) { + return new HsManagedServerEntityPatcher(managedServer); + } + + @Override + protected Stream propertyTestDescriptors() { + return Stream.of( + new JsonNullableProperty<>( + "caption", + HsManagedServerPatchResource::setCaption, + PATCHED_CAPTION, + HsManagedServerEntity::setCaption), + new SimpleProperty<>( + "resources", + HsManagedServerPatchResource::setResources, + PATCH_RESOURCES, + HsManagedServerEntity::putResources, + PATCHED_RESOURCES) + .notNullable(), + new JsonNullableProperty<>( + "validto", + HsManagedServerPatchResource::setValidTo, + PATCHED_VALID_TO, + HsManagedServerEntity::setValidTo) + ); + } +} diff --git a/src/test/java/net/hostsharing/hsadminng/hs/hosting/managedserver/HsManagedServerEntityUnitTest.java b/src/test/java/net/hostsharing/hsadminng/hs/hosting/managedserver/HsManagedServerEntityUnitTest.java new file mode 100644 index 00000000..f8083888 --- /dev/null +++ b/src/test/java/net/hostsharing/hsadminng/hs/hosting/managedserver/HsManagedServerEntityUnitTest.java @@ -0,0 +1,56 @@ +package net.hostsharing.hsadminng.hs.hosting.managedserver; + +import org.junit.jupiter.api.Test; + +import java.time.LocalDate; +import java.util.Map; + +import static java.util.Map.entry; +import static net.hostsharing.hsadminng.hs.office.debitor.TestHsOfficeDebitor.TEST_DEBITOR; +import static net.hostsharing.hsadminng.mapper.PostgresDateRange.toPostgresDateRange; +import static org.assertj.core.api.Assertions.assertThat; + +class HsManagedServerEntityUnitTest { + public static final LocalDate GIVEN_VALID_FROM = LocalDate.parse("2020-01-01"); + public static final LocalDate GIVEN_VALID_TO = LocalDate.parse("2030-12-31"); + + final HsManagedServerEntity givenManagedServer = HsManagedServerEntity.builder() + .debitor(TEST_DEBITOR) + .caption("some caption") + .resources(Map.ofEntries( + entry("CPUs", 2), + entry("SSD-storage", 512), + entry("HDD-storage", 2048))) + .validity(toPostgresDateRange(GIVEN_VALID_FROM, GIVEN_VALID_TO)) + .build(); + + @Test + void toStringContainsAllPropertiesAndResourcesSortedByKey() { + final var result = givenManagedServer.toString(); + + assertThat(result).isEqualTo("HsManagedServerEntity(D-1000100, [2020-01-01,2031-01-01), some caption, { CPUs: 2, HDD-storage: 2048, SSD-storage: 512 })"); + } + + @Test + void toShortStringContainsOnlyMemberNumberAndCaption() { + final var result = givenManagedServer.toShortString(); + + assertThat(result).isEqualTo("D-1000100:some caption"); + } + + @Test + void settingValidFromKeepsValidTo() { + givenManagedServer.setValidFrom(LocalDate.parse("2023-12-31")); + assertThat(givenManagedServer.getValidFrom()).isEqualTo(LocalDate.parse("2023-12-31")); + assertThat(givenManagedServer.getValidTo()).isEqualTo(GIVEN_VALID_TO); + + } + + @Test + void settingValidToKeepsValidFrom() { + givenManagedServer.setValidTo(LocalDate.parse("2024-12-31")); + assertThat(givenManagedServer.getValidFrom()).isEqualTo(GIVEN_VALID_FROM); + assertThat(givenManagedServer.getValidTo()).isEqualTo(LocalDate.parse("2024-12-31")); + } + +} diff --git a/src/test/java/net/hostsharing/hsadminng/hs/hosting/managedserver/HsManagedServerRepositoryIntegrationTest.java b/src/test/java/net/hostsharing/hsadminng/hs/hosting/managedserver/HsManagedServerRepositoryIntegrationTest.java new file mode 100644 index 00000000..8523db66 --- /dev/null +++ b/src/test/java/net/hostsharing/hsadminng/hs/hosting/managedserver/HsManagedServerRepositoryIntegrationTest.java @@ -0,0 +1,339 @@ +package net.hostsharing.hsadminng.hs.hosting.managedserver; + +import io.hypersistence.utils.hibernate.type.range.Range; +import net.hostsharing.hsadminng.context.Context; +import net.hostsharing.hsadminng.hs.booking.item.HsManagedServerEntity; +import net.hostsharing.hsadminng.hs.booking.item.HsManagedServerRepository; +import net.hostsharing.hsadminng.hs.office.debitor.HsOfficeDebitorRepository; +import net.hostsharing.hsadminng.rbac.rbacgrant.RawRbacGrantRepository; +import net.hostsharing.hsadminng.rbac.rbacrole.RawRbacRoleRepository; +import net.hostsharing.hsadminng.rbac.test.Array; +import net.hostsharing.hsadminng.rbac.test.ContextBasedTestWithCleanup; +import net.hostsharing.hsadminng.rbac.test.JpaAttempt; +import org.junit.jupiter.api.Nested; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest; +import org.springframework.boot.test.mock.mockito.MockBean; +import org.springframework.context.annotation.Import; +import org.springframework.orm.jpa.JpaSystemException; + +import jakarta.persistence.EntityManager; +import jakarta.persistence.PersistenceContext; +import jakarta.servlet.http.HttpServletRequest; +import java.time.LocalDate; +import java.util.Arrays; +import java.util.List; +import java.util.Map; + +import static java.util.Map.entry; +import static net.hostsharing.hsadminng.rbac.rbacgrant.RawRbacGrantEntity.distinctGrantDisplaysOf; +import static net.hostsharing.hsadminng.rbac.rbacrole.RawRbacRoleEntity.distinctRoleNamesOf; +import static net.hostsharing.hsadminng.rbac.test.Array.fromFormatted; +import static net.hostsharing.hsadminng.rbac.test.JpaAttempt.attempt; +import static org.assertj.core.api.Assertions.assertThat; + +@DataJpaTest +@Import({ Context.class, JpaAttempt.class }) +class HsManagedServerRepositoryIntegrationTest extends ContextBasedTestWithCleanup { + + @Autowired + HsManagedServerRepository managedServerRepo; + + @Autowired + HsOfficeDebitorRepository debitorRepo; + + @Autowired + RawRbacRoleRepository rawRoleRepo; + + @Autowired + RawRbacGrantRepository rawGrantRepo; + + @Autowired + JpaAttempt jpaAttempt; + + @PersistenceContext + EntityManager em; + + @MockBean + HttpServletRequest request; + + @Nested + class CreateManagedServer { + + @Test + public void testHostsharingAdmin_withoutAssumedRole_canCreateNewManagedServer() { + // given + context("superuser-alex@hostsharing.net"); + final var count = managedServerRepo.count(); + final var givenDebitor = debitorRepo.findDebitorByOptionalNameLike("First").get(0); + + // when + final var result = attempt(em, () -> { + final var newManagedServer = HsManagedServerEntity.builder() + .debitor(givenDebitor) + .caption("some new booking managedserver") + .validity(Range.closedOpen( + LocalDate.parse("2020-01-01"), LocalDate.parse("2023-01-01"))) + .build(); + return toCleanup(managedServerRepo.save(newManagedServer)); + }); + + // then + result.assertSuccessful(); + assertThat(result.returnedValue()).isNotNull().extracting(HsManagedServerEntity::getUuid).isNotNull(); + assertThatManagedServerIsPersisted(result.returnedValue()); + assertThat(managedServerRepo.count()).isEqualTo(count + 1); + } + + @Test + public void createsAndGrantsRoles() { + // given + context("superuser-alex@hostsharing.net"); + final var initialRoleNames = distinctRoleNamesOf(rawRoleRepo.findAll()); + final var initialGrantNames = distinctGrantDisplaysOf(rawGrantRepo.findAll()).stream() + .map(s -> s.replace("hs_office_", "")) + .toList(); + + // when + attempt(em, () -> { + final var givenDebitor = debitorRepo.findDebitorByOptionalNameLike("First").get(0); + final var newManagedServer = HsManagedServerEntity.builder() + .debitor(givenDebitor) + .caption("some new booking managedserver") + .validity(Range.closedOpen( + LocalDate.parse("2020-01-01"), LocalDate.parse("2023-01-01"))) + .build(); + return toCleanup(managedServerRepo.save(newManagedServer)); + }); + + // then + final var all = rawRoleRepo.findAll(); + assertThat(distinctRoleNamesOf(all)).containsExactlyInAnyOrder(Array.from( + initialRoleNames, + "hs_booking_item#D-1000111:some new booking managedserver:ADMIN", + "hs_booking_item#D-1000111:some new booking managedserver:OWNER", + "hs_booking_item#D-1000111:some new booking managedserver:TENANT")); + assertThat(distinctGrantDisplaysOf(rawGrantRepo.findAll())) + .map(s -> s.replace("hs_office_", "")) + .containsExactlyInAnyOrder(fromFormatted( + initialGrantNames, + + // insert+delete + "{ grant perm:hs_booking_item#D-1000111:some new booking managedserver:DELETE to role:global#global:ADMIN by system and assume }", + + // owner + "{ grant perm:hs_booking_item#D-1000111:some new booking managedserver:UPDATE to role:hs_booking_item#D-1000111:some new booking managedserver:OWNER by system and assume }", + "{ grant role:hs_booking_item#D-1000111:some new booking managedserver:OWNER to role:relation#FirstGmbH-with-DEBITOR-FirstGmbH:AGENT by system and assume }", + + // admin + "{ grant role:hs_booking_item#D-1000111:some new booking managedserver:ADMIN to role:hs_booking_item#D-1000111:some new booking managedserver:OWNER by system and assume }", + + // tenant + "{ grant role:hs_booking_item#D-1000111:some new booking managedserver:TENANT to role:hs_booking_item#D-1000111:some new booking managedserver:ADMIN by system and assume }", + "{ grant perm:hs_booking_item#D-1000111:some new booking managedserver:SELECT to role:hs_booking_item#D-1000111:some new booking managedserver:TENANT by system and assume }", + "{ grant role:relation#FirstGmbH-with-DEBITOR-FirstGmbH:TENANT to role:hs_booking_item#D-1000111:some new booking managedserver:TENANT by system and assume }", + + null)); + } + + private void assertThatManagedServerIsPersisted(final HsManagedServerEntity saved) { + final var found = managedServerRepo.findByUuid(saved.getUuid()); + assertThat(found).isNotEmpty().map(HsManagedServerEntity::toString).get().isEqualTo(saved.toString()); + } + } + + @Nested + class FindByDebitorUuid { + + @Test + public void globalAdmin_withoutAssumedRole_canViewAllManagedServersOfArbitraryDebitor() { + // given + context("superuser-alex@hostsharing.net"); + final var debitorUuid = debitorRepo.findDebitorByDebitorNumber(1000212).stream() + .findAny().orElseThrow().getUuid(); + + // when + final var result = managedServerRepo.findAllByDebitorUuid(debitorUuid); + + // then + allTheseManagedServersAreReturned( + result, + "HsManagedServerEntity(D-1000212, [2022-10-01,), some ManagedServer, { CPU: 2, SDD: 512, extra: 42 })", + "HsManagedServerEntity(D-1000212, [2023-01-15,2024-04-15), some CloudServer, { CPU: 2, HDD: 1024, extra: 42 })", + "HsManagedServerEntity(D-1000212, [2024-04-01,), some Whatever, { CPU: 1, HDD: 2048, SDD: 512, extra: 42 })"); + } + + @Test + public void normalUser_canViewOnlyRelatedManagedServers() { + // given: + context("person-FirbySusan@example.com"); + final var debitorUuid = debitorRepo.findDebitorByDebitorNumber(1000111).stream().findAny().orElseThrow().getUuid(); + + // when: + final var result = managedServerRepo.findAllByDebitorUuid(debitorUuid); + + // then: + exactlyTheseManagedServersAreReturned( + result, + "HsManagedServerEntity(D-1000111, [2022-10-01,), some ManagedServer, { CPU: 2, SDD: 512, extra: 42 })", + "HsManagedServerEntity(D-1000111, [2023-01-15,2024-04-15), some CloudServer, { CPU: 2, HDD: 1024, extra: 42 })", + "HsManagedServerEntity(D-1000111, [2024-04-01,), some Whatever, { CPU: 1, HDD: 2048, SDD: 512, extra: 42 })"); + } + } + + @Nested + class UpdateManagedServer { + + @Test + public void hostsharingAdmin_canUpdateArbitraryManagedServer() { + // given + final var givenManagedServerUuid = givenSomeTemporaryManagedServer(1000111).getUuid(); + + // when + final var result = jpaAttempt.transacted(() -> { + context("superuser-alex@hostsharing.net"); + final var foundManagedServer = em.find(HsManagedServerEntity.class, givenManagedServerUuid); + foundManagedServer.getResources().put("CPUs", 2); + foundManagedServer.getResources().remove("SSD-storage"); + foundManagedServer.getResources().put("HSD-storage", 2048); + foundManagedServer.setValidity(Range.closedOpen( + LocalDate.parse("2019-05-17"), LocalDate.parse("2023-01-01"))); + return toCleanup(managedServerRepo.save(foundManagedServer)); + }); + + // then + result.assertSuccessful(); + jpaAttempt.transacted(() -> { + context("superuser-alex@hostsharing.net"); + assertThatManagedServerActuallyInDatabase(result.returnedValue()); + }).assertSuccessful(); + } + + private void assertThatManagedServerActuallyInDatabase(final HsManagedServerEntity saved) { + final var found = managedServerRepo.findByUuid(saved.getUuid()); + assertThat(found).isNotEmpty().get().isNotSameAs(saved) + .extracting(Object::toString).isEqualTo(saved.toString()); + } + } + + @Nested + class DeleteByUuid { + + @Test + public void globalAdmin_withoutAssumedRole_canDeleteAnyManagedServer() { + // given + context("superuser-alex@hostsharing.net", null); + final var givenManagedServer = givenSomeTemporaryManagedServer(1000111); + + // when + final var result = jpaAttempt.transacted(() -> { + context("superuser-alex@hostsharing.net"); + managedServerRepo.deleteByUuid(givenManagedServer.getUuid()); + }); + + // then + result.assertSuccessful(); + assertThat(jpaAttempt.transacted(() -> { + context("superuser-fran@hostsharing.net", null); + return managedServerRepo.findByUuid(givenManagedServer.getUuid()); + }).assertSuccessful().returnedValue()).isEmpty(); + } + + @Test + public void nonGlobalAdmin_canNotDeleteTheirRelatedManagedServer() { + // given + context("superuser-alex@hostsharing.net", null); + final var givenManagedServer = givenSomeTemporaryManagedServer(1000111); + + // when + final var result = jpaAttempt.transacted(() -> { + context("person-FirbySusan@example.com"); + assertThat(managedServerRepo.findByUuid(givenManagedServer.getUuid())).isPresent(); + + managedServerRepo.deleteByUuid(givenManagedServer.getUuid()); + }); + + // then + result.assertExceptionWithRootCauseMessage( + JpaSystemException.class, + "[403] Subject ", " is not allowed to delete hs_booking_item"); + assertThat(jpaAttempt.transacted(() -> { + context("superuser-alex@hostsharing.net"); + return managedServerRepo.findByUuid(givenManagedServer.getUuid()); + }).assertSuccessful().returnedValue()).isPresent(); // still there + } + + @Test + public void deletingAManagedServerAlsoDeletesRelatedRolesAndGrants() { + // given + context("superuser-alex@hostsharing.net"); + final var initialRoleNames = Array.from(distinctRoleNamesOf(rawRoleRepo.findAll())); + final var initialGrantNames = Array.from(distinctGrantDisplaysOf(rawGrantRepo.findAll())); + final var givenManagedServer = givenSomeTemporaryManagedServer(1000111); + + // when + final var result = jpaAttempt.transacted(() -> { + context("superuser-alex@hostsharing.net"); + return managedServerRepo.deleteByUuid(givenManagedServer.getUuid()); + }); + + // then + result.assertSuccessful(); + assertThat(result.returnedValue()).isEqualTo(1); + assertThat(distinctRoleNamesOf(rawRoleRepo.findAll())).containsExactlyInAnyOrder(initialRoleNames); + assertThat(distinctGrantDisplaysOf(rawGrantRepo.findAll())).containsExactlyInAnyOrder(initialGrantNames); + } + } + + @Test + public void auditJournalLogIsAvailable() { + // given + final var query = em.createNativeQuery(""" + select currentTask, targetTable, targetOp + from tx_journal_v + where targettable = 'hs_booking_item'; + """); + + // when + @SuppressWarnings("unchecked") final List customerLogEntries = query.getResultList(); + + // then + assertThat(customerLogEntries).map(Arrays::toString).contains( + "[creating booking-managedserver test-data 1000111, hs_booking_item, INSERT]", + "[creating booking-managedserver test-data 1000212, hs_booking_item, INSERT]", + "[creating booking-managedserver test-data 1000313, hs_booking_item, INSERT]"); + } + + private HsManagedServerEntity givenSomeTemporaryManagedServer(final int debitorNumber) { + return jpaAttempt.transacted(() -> { + context("superuser-alex@hostsharing.net"); + final var givenDebitor = debitorRepo.findDebitorByDebitorNumber(debitorNumber).get(0); + final var newManagedServer = HsManagedServerEntity.builder() + .debitor(givenDebitor) + .caption("some temp booking managedserver") + .validity(Range.closedOpen( + LocalDate.parse("2020-01-01"), LocalDate.parse("2023-01-01"))) + .resources(Map.ofEntries( + entry("CPUs", 1), + entry("SSD-storage", 256))) + .build(); + + return toCleanup(managedServerRepo.save(newManagedServer)); + }).assertSuccessful().returnedValue(); + } + + void exactlyTheseManagedServersAreReturned( + final List actualResult, + final String... managedServerNames) { + assertThat(actualResult) + .extracting(managedServerEntity -> managedServerEntity.toString()) + .containsExactlyInAnyOrder(managedServerNames); + } + + void allTheseManagedServersAreReturned(final List actualResult, final String... managedServerNames) { + assertThat(actualResult) + .extracting(managedServerEntity -> managedServerEntity.toString()) + .contains(managedServerNames); + } +}