Compare commits

...

3 Commits

Author SHA1 Message Date
Michael Hoennig
5605e8a8c1 use AnnotationFinder to determine alias name from @Produces 2024-10-23 10:24:56 +02:00
Michael Hoennig
87c9205fc7 fix typo 2024-10-23 09:06:16 +02:00
Michael Hoennig
2507ad4542 sepa-mandate tests 2024-10-22 17:27:46 +02:00
9 changed files with 240 additions and 44 deletions

View File

@ -0,0 +1,47 @@
package net.hostsharing.hsadminng.reflection;
import lombok.experimental.UtilityClass;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.Optional;
import static java.util.Optional.empty;
@UtilityClass
public class AnnotationFinder {
public static <T extends Annotation> Optional<T> findCallerAnnotation(
final Class<T> annotationClassToFind,
final Class<? extends Annotation> annotationClassToStopLookup
) {
for (var element : Thread.currentThread().getStackTrace()) {
try {
final var clazz = Class.forName(element.getClassName());
final var method = getMethodFromStackElement(clazz, element);
// Check if the method is annotated with the desired annotation
if (method != null) {
if (method.isAnnotationPresent(annotationClassToFind)) {
return Optional.of(method.getAnnotation(annotationClassToFind));
} else if (method.isAnnotationPresent(annotationClassToStopLookup)) {
return empty();
}
}
} catch (final ClassNotFoundException | NoSuchMethodException e) {
throw new RuntimeException(e); // FIXME: when does this happen?
}
}
return empty();
}
private static Method getMethodFromStackElement(Class<?> clazz, StackTraceElement element)
throws NoSuchMethodException {
for (var method : clazz.getDeclaredMethods()) {
if (method.getName().equals(element.getMethodName())) {
return method;
}
}
return null;
}
}

View File

@ -3,6 +3,9 @@ package net.hostsharing.hsadminng.hs.office.usecases;
import net.hostsharing.hsadminng.HsadminNgApplication; import net.hostsharing.hsadminng.HsadminNgApplication;
import net.hostsharing.hsadminng.hs.office.usecases.debitor.CreateExternalDebitorForPartner; import net.hostsharing.hsadminng.hs.office.usecases.debitor.CreateExternalDebitorForPartner;
import net.hostsharing.hsadminng.hs.office.usecases.debitor.CreateSelfDebitorForPartner; import net.hostsharing.hsadminng.hs.office.usecases.debitor.CreateSelfDebitorForPartner;
import net.hostsharing.hsadminng.hs.office.usecases.debitor.CreateSepaMandataForDebitor;
import net.hostsharing.hsadminng.hs.office.usecases.debitor.DeleteSepaMandataForDebitor;
import net.hostsharing.hsadminng.hs.office.usecases.debitor.InvalidateSepaMandateForDebitor;
import net.hostsharing.hsadminng.hs.office.usecases.membership.CreateMembership; import net.hostsharing.hsadminng.hs.office.usecases.membership.CreateMembership;
import net.hostsharing.hsadminng.hs.office.usecases.partner.CreatePartner; import net.hostsharing.hsadminng.hs.office.usecases.partner.CreatePartner;
import net.hostsharing.hsadminng.hs.office.usecases.debitor.DeleteDebitor; import net.hostsharing.hsadminng.hs.office.usecases.debitor.DeleteDebitor;
@ -27,7 +30,7 @@ class HsOfficeUseCasesTest extends UseCaseTest {
@Order(1010) @Order(1010)
@Produces(explicitly = "Partner: Test AG", implicitly = "Person: Test AG") @Produces(explicitly = "Partner: Test AG", implicitly = "Person: Test AG")
void shouldCreatePartner() { void shouldCreatePartner() {
new CreatePartner(this, "Partner: Test AG") new CreatePartner(this)
.given("partnerNumber", 31010) .given("partnerNumber", 31010)
.given("personType", "LEGAL_PERSON") .given("personType", "LEGAL_PERSON")
.given("tradeName", "Test AG") .given("tradeName", "Test AG")
@ -48,6 +51,7 @@ class HsOfficeUseCasesTest extends UseCaseTest {
@Test @Test
@Order(2010) @Order(2010)
@Requires("Partner: Test AG") @Requires("Partner: Test AG")
@Produces("Debitor: Test AG - main debitor")
void shouldCreateSelfDebitorForPartner() { void shouldCreateSelfDebitorForPartner() {
new CreateSelfDebitorForPartner(this, "Debitor: Test AG - main debitor") new CreateSelfDebitorForPartner(this, "Debitor: Test AG - main debitor")
.given("partnerPersonUuid", "%{Person: Test AG}") .given("partnerPersonUuid", "%{Person: Test AG}")
@ -69,7 +73,7 @@ class HsOfficeUseCasesTest extends UseCaseTest {
@Requires("Person: Test AG") @Requires("Person: Test AG")
@Produces("Debitor: Billing GmbH") @Produces("Debitor: Billing GmbH")
void shouldCreateExternalDebitorForPartner() { void shouldCreateExternalDebitorForPartner() {
new CreateExternalDebitorForPartner(this, "Debitor: Billing GmbH") new CreateExternalDebitorForPartner(this)
.given("partnerPersonUuid", "%{Person: Test AG}") .given("partnerPersonUuid", "%{Person: Test AG}")
.given("billingContactCaption", "Billing GmbH - billing department") .given("billingContactCaption", "Billing GmbH - billing department")
.given("billingContactEmailAddress", "billing@test-ag.example.org") .given("billingContactEmailAddress", "billing@test-ag.example.org")
@ -94,6 +98,39 @@ class HsOfficeUseCasesTest extends UseCaseTest {
.doRun(); .doRun();
} }
@Test
@Order(3100)
@Requires("Debitor: Test AG - main debitor")
@Produces("SEPA-Mandate: Test AG")
void shouldCreateSepaMandateForDebitor() {
new CreateSepaMandataForDebitor(this)
.given("debitor", "Test AG")
.given("memberNumberSuffix", "00")
.given("validFrom", "2024-10-15")
.given("membershipFeeBillable", "true")
.doRun()
.keep();
}
@Test
@Order(3108)
@Requires("SEPA-Mandate: Test AG")
void shouldInvalidateSepaMandateForDebitor() {
new InvalidateSepaMandateForDebitor(this)
.given("sepaMandateUuid", "%{SEPA-Mandate: Test AG}")
.given("validUntil", "2025-09-30")
.doRun();
}
@Test
@Order(3109)
@Requires("SEPA-Mandate: Test AG")
void shouldDeleteSepaMandateForDebitor() {
new DeleteSepaMandataForDebitor(this)
.given("sepaMandateUuid", "%{SEPA-Mandate: Test AG}")
.doRun();
}
@Test @Test
@Order(3000) @Order(3000)
@Requires("Partner: Test AG") @Requires("Partner: Test AG")

View File

@ -4,7 +4,11 @@ import io.restassured.RestAssured;
import io.restassured.http.ContentType; import io.restassured.http.ContentType;
import io.restassured.response.Response; import io.restassured.response.Response;
import io.restassured.response.ValidatableResponse; import io.restassured.response.ValidatableResponse;
import net.hostsharing.hsadminng.reflection.AnnotationFinder;
import org.apache.commons.collections4.map.LinkedMap; import org.apache.commons.collections4.map.LinkedMap;
import org.hibernate.AssertionFailure;
import org.jetbrains.annotations.Nullable;
import org.junit.jupiter.api.Test;
import org.springframework.http.HttpMethod; import org.springframework.http.HttpMethod;
import org.springframework.http.HttpStatus; import org.springframework.http.HttpStatus;
@ -14,7 +18,10 @@ import java.util.UUID;
import java.util.function.Function; import java.util.function.Function;
import java.util.function.Supplier; import java.util.function.Supplier;
import static org.assertj.core.api.Assertions.assertThat;
import static org.hamcrest.Matchers.startsWith; import static org.hamcrest.Matchers.startsWith;
import static org.junit.platform.commons.util.StringUtils.isBlank;
import static org.junit.platform.commons.util.StringUtils.isNotBlank;
public abstract class UseCase<T extends UseCase<?>> { public abstract class UseCase<T extends UseCase<?>> {
@ -25,7 +32,7 @@ public abstract class UseCase<T extends UseCase<?>> {
private String nextTitle; // FIXME: ugly private String nextTitle; // FIXME: ugly
public UseCase(final UseCaseTest testSuite) { public UseCase(final UseCaseTest testSuite) {
this(testSuite, null); this(testSuite, getResultAliasFromProducesAnnotationInCallStack());
} }
public UseCase(final UseCaseTest testSuite, final String resultAlias) { public UseCase(final UseCaseTest testSuite, final String resultAlias) {
@ -87,6 +94,18 @@ public abstract class UseCase<T extends UseCase<?>> {
return new HttpResponse(HttpMethod.POST, uriPath, body, response); return new HttpResponse(HttpMethod.POST, uriPath, body, response);
} }
public final HttpResponse httpPatch(final String uriPath, final JsonTemplate bodyJsonTemplate) {
final var body = bodyJsonTemplate.resolvePlaceholders();
final var uri = "http://localhost" + uriPath;
final var response = RestAssured.given()
.header("current-subject", UseCaseTest.RUN_AS_USER)
.contentType(ContentType.JSON)
.body(body)
.port(testSuite.port)
.when().patch(uri);
return new HttpResponse(HttpMethod.PATCH, uriPath, body, response);
}
public final HttpResponse httpDelete(final String uriPath) { public final HttpResponse httpDelete(final String uriPath) {
final var response = RestAssured.given() final var response = RestAssured.given()
.header("current-subject", UseCaseTest.RUN_AS_USER) .header("current-subject", UseCaseTest.RUN_AS_USER)
@ -99,7 +118,7 @@ public abstract class UseCase<T extends UseCase<?>> {
return UseCaseTest.getAlias(alias).uuid(); return UseCaseTest.getAlias(alias).uuid();
} }
static class JsonTemplate { public static class JsonTemplate {
private final String template; private final String template;
@ -160,8 +179,10 @@ public abstract class UseCase<T extends UseCase<?>> {
} }
public void keep() { public void keep() {
final var alias = nextTitle != null ? nextTitle : resultAlias;
assertThat(alias).as("cannot keep result, no alias found").isNotNull();
UseCaseTest.putAlias( UseCaseTest.putAlias(
nextTitle != null ? nextTitle : resultAlias, alias,
new UseCaseTest.Alias<>(UseCase.this.getClass(), locationUuid)); new UseCaseTest.Alias<>(UseCase.this.getClass(), locationUuid));
} }
} }
@ -174,4 +195,19 @@ public abstract class UseCase<T extends UseCase<?>> {
//noinspection unchecked //noinspection unchecked
return (T) this; return (T) this;
} }
private static @Nullable String getResultAliasFromProducesAnnotationInCallStack() {
return AnnotationFinder.findCallerAnnotation(Produces.class, Test.class)
.map(produces -> oneOf(produces.value(), produces.explicitly()))
.orElse(null);
}
private static String oneOf(final String one, final String another) {
if (isNotBlank(one) && isBlank(another)) {
return one;
} else if ( isBlank(one) && isNotBlank(another)) {
return another;
}
throw new AssertionFailure("exactly one value required, but got '" + one + "' and '" + another + "'");
}
} }

View File

@ -8,7 +8,6 @@ import net.hostsharing.hsadminng.lambda.Reducer;
import net.hostsharing.hsadminng.rbac.context.ContextBasedTest; import net.hostsharing.hsadminng.rbac.context.ContextBasedTest;
import net.hostsharing.hsadminng.rbac.test.JpaAttempt; import net.hostsharing.hsadminng.rbac.test.JpaAttempt;
import org.apache.commons.collections4.SetUtils; import org.apache.commons.collections4.SetUtils;
import org.hibernate.AssertionFailure;
import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Order; import org.junit.jupiter.api.Order;
@ -19,12 +18,12 @@ import org.springframework.boot.test.web.server.LocalServerPort;
import java.io.FileWriter; import java.io.FileWriter;
import java.io.IOException; import java.io.IOException;
import java.io.PrintWriter; import java.io.PrintWriter;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method; import java.lang.reflect.Method;
import java.util.HashMap; import java.util.HashMap;
import java.util.HashSet; import java.util.HashSet;
import java.util.LinkedHashMap; import java.util.LinkedHashMap;
import java.util.Map; import java.util.Map;
import java.util.Optional;
import java.util.Set; import java.util.Set;
import java.util.UUID; import java.util.UUID;
import java.util.stream.Collectors; import java.util.stream.Collectors;
@ -35,9 +34,10 @@ import static org.assertj.core.api.Assertions.assertThat;
public abstract class UseCaseTest extends ContextBasedTest { public abstract class UseCaseTest extends ContextBasedTest {
final static String RUN_AS_USER = "superuser-alex@hostsharing.net"; // TODO.test: use global:AGENT when implemented final static String RUN_AS_USER = "superuser-alex@hostsharing.net"; // TODO.test: use global:AGENT when implemented
//String producesAlias;
// @Getter // @Getter
// public static TestInfo currentTestInfo; // public static TestInfo currentTestInfo;
@Getter @Getter
private PrintWriter markdownFile; private PrintWriter markdownFile;
@ -60,7 +60,7 @@ public abstract class UseCaseTest extends ContextBasedTest {
@BeforeEach @BeforeEach
void init(final TestInfo testInfo) { void init(final TestInfo testInfo) {
createHostsharingPerson(); createHostsharingPerson();
callRequiredProducers(testInfo); testInfo.getTestMethod().ifPresent(this::callRequiredProducers);
createTestLogMarkdownFile(testInfo); createTestLogMarkdownFile(testInfo);
} }
@ -98,40 +98,41 @@ public abstract class UseCaseTest extends ContextBasedTest {
private void createTestLogMarkdownFile(final TestInfo testInfo) throws IOException { private void createTestLogMarkdownFile(final TestInfo testInfo) throws IOException {
final var testMethodName = testInfo.getTestMethod().map(Method::getName).orElseThrow(); final var testMethodName = testInfo.getTestMethod().map(Method::getName).orElseThrow();
final var testMethodOrder = testInfo.getTestMethod().map(m -> m.getAnnotation(Order.class).value()).orElseThrow(); final var testMethodOrder = testInfo.getTestMethod().map(m -> m.getAnnotation(Order.class).value()).orElseThrow();
markdownFile = new PrintWriter(new FileWriter( testMethodOrder + "-" + testMethodName + ".md")); markdownFile = new PrintWriter(new FileWriter(testMethodOrder + "-" + testMethodName + ".md"));
log("## Testcase " + testMethodName.replaceAll("([a-z])([A-Z]+)", "$1 $2")); log("## Testcase " + testMethodName.replaceAll("([a-z])([A-Z]+)", "$1 $2"));
} }
private void callRequiredProducers(final TestInfo testInfo) throws IllegalAccessException, InvocationTargetException { @SneakyThrows
final var testMethodRequired = testInfo.getTestMethod() private void callRequiredProducers(final Method currentTestMethod) {
final var testMethodRequired = Optional.of(currentTestMethod)
.map(m -> m.getAnnotation(Requires.class)) .map(m -> m.getAnnotation(Requires.class))
.map(Requires::value) .map(Requires::value)
.orElse(null); .orElse(null);
if (testMethodRequired != null) { if (testMethodRequired != null) {
for (Method testMethod : getClass().getDeclaredMethods()) { for (Method potentialProducerMethod : getClass().getDeclaredMethods()) {
final var producesAnnot = testMethod.getAnnotation(Produces.class); final var producesAnnot = potentialProducerMethod.getAnnotation(Produces.class);
if (producesAnnot != null) { if (producesAnnot != null) {
final var testMethodProduces = allOf(producesAnnot.value(), producesAnnot.explicitly(), producesAnnot.implicitly()); final var testMethodProduces = allOf(
producesAnnot.value(),
producesAnnot.explicitly(),
producesAnnot.implicitly());
// @formatter:off
if ( // that method can produce something required if ( // that method can produce something required
testMethodProduces.contains(testMethodRequired) && testMethodProduces.contains(testMethodRequired) &&
// and it does not produce anything we already have (would cause errors) // and it does not produce anything we already have (would cause errors)
SetUtils.intersection(testMethodProduces, knowVariables().keySet()).isEmpty()) SetUtils.intersection(testMethodProduces, knowVariables().keySet()).isEmpty()
) {
// then we recursively produce the pre-requisites of the producer method
callRequiredProducers(potentialProducerMethod);
// then we call the producer method // and finally we call the producer method
testMethod.invoke(this); potentialProducerMethod.invoke(this);
}
// @formatter:on
} }
} }
} }
// public void requires(final String alias) {
// assumeThat(UseCaseTest.containsAlias(alias))
// .as("skipping because alias '" + alias + "' not found, @Produces(...) missing?")
// .isTrue();
// log("depends on [" + alias + "](" + UseCaseTest.getAlias(alias).useCase().getSimpleName() + ".md)");
// }
} }
private Set<String> allOf(final String value, final String explicitly, final String[] implicitly) { private Set<String> allOf(final String value, final String explicitly, final String[] implicitly) {
@ -146,15 +147,6 @@ public abstract class UseCaseTest extends ContextBasedTest {
return all; return all;
} }
private String oneOf(final String one, final String another) {
if (one != null && another == null) {
return one;
} else if (one == null && another != null) {
return another;
}
throw new AssertionFailure("excactly one value required");
}
static boolean containsAlias(final String alias) { static boolean containsAlias(final String alias) {
return aliases.containsKey(alias); return aliases.containsKey(alias);
} }
@ -175,10 +167,6 @@ public abstract class UseCaseTest extends ContextBasedTest {
properties.put(name, (value instanceof String string) ? resolve(string) : value); properties.put(name, (value instanceof String string) ? resolve(string) : value);
} }
static LinkedHashMap<String, Object> properties() {
return new LinkedHashMap<>(properties);
}
static Map<String, Object> knowVariables() { static Map<String, Object> knowVariables() {
final var map = new LinkedHashMap<String, Object>(); final var map = new LinkedHashMap<String, Object>();
UseCaseTest.aliases.forEach((key, value) -> map.put(key, value.uuid())); UseCaseTest.aliases.forEach((key, value) -> map.put(key, value.uuid()));

View File

@ -9,8 +9,8 @@ import static org.springframework.http.HttpStatus.CREATED;
public class CreateExternalDebitorForPartner extends UseCase<CreateExternalDebitorForPartner> { public class CreateExternalDebitorForPartner extends UseCase<CreateExternalDebitorForPartner> {
public CreateExternalDebitorForPartner(final UseCaseTest testSuite, final String resultAlias) { public CreateExternalDebitorForPartner(final UseCaseTest testSuite) {
super(testSuite, resultAlias); super(testSuite);
requires("Person: Billing GmbH", alias -> new CreatePerson(testSuite, alias) requires("Person: Billing GmbH", alias -> new CreatePerson(testSuite, alias)
.given("personType", "LEGAL_PERSON") .given("personType", "LEGAL_PERSON")

View File

@ -0,0 +1,39 @@
package net.hostsharing.hsadminng.hs.office.usecases.debitor;
import net.hostsharing.hsadminng.hs.office.usecases.UseCase;
import net.hostsharing.hsadminng.hs.office.usecases.UseCaseTest;
import static io.restassured.http.ContentType.JSON;
import static org.springframework.http.HttpStatus.CREATED;
public class CreateSepaMandataForDebitor extends UseCase<CreateSepaMandataForDebitor> {
public CreateSepaMandataForDebitor(final UseCaseTest testSuite) {
super(testSuite);
}
@Override
protected HttpResponse run() {
keep("BankAccount: Test AG - debit bank account", () ->
httpPost("/api/hs/office/bankaccounts", usingJsonBody("""
{
"holder": "Test AG - debit bank account",
"iban": "DE02701500000000594937",
"bic": "SSKMDEMM"
}
"""))
.expecting(CREATED).expecting(JSON)
);
return httpPost("/api/hs/office/sepamandates", usingJsonBody("""
{
"debitorUuid": ${Debitor: Test AG - main debitor},
"bankAccountUuid": ${BankAccount: Test AG - debit bank account},
"reference": "Test AG - main debitor",
"agreement": "2022-10-12",
"validFrom": "2022-10-13"
}
"""))
.expecting(CREATED).expecting(JSON);
}
}

View File

@ -0,0 +1,20 @@
package net.hostsharing.hsadminng.hs.office.usecases.debitor;
import net.hostsharing.hsadminng.hs.office.usecases.UseCase;
import net.hostsharing.hsadminng.hs.office.usecases.UseCaseTest;
import org.springframework.http.HttpStatus;
public class DeleteSepaMandataForDebitor extends UseCase<DeleteSepaMandataForDebitor> {
public DeleteSepaMandataForDebitor(final UseCaseTest testSuite) {
super(testSuite);
}
@Override
protected HttpResponse run() {
httpDelete("/api/hs/office/sepamandates/" + uuid("SEPA-Mandate: Test AG"))
.expecting(HttpStatus.NO_CONTENT);
return null;
}
}

View File

@ -0,0 +1,25 @@
package net.hostsharing.hsadminng.hs.office.usecases.debitor;
import net.hostsharing.hsadminng.hs.office.usecases.UseCase;
import net.hostsharing.hsadminng.hs.office.usecases.UseCaseTest;
import static io.restassured.http.ContentType.JSON;
import static org.springframework.http.HttpStatus.OK;
public class InvalidateSepaMandateForDebitor extends UseCase<InvalidateSepaMandateForDebitor> {
public InvalidateSepaMandateForDebitor(final UseCaseTest testSuite) {
super(testSuite);
}
@Override
protected HttpResponse run() {
return httpPatch("/api/hs/office/sepamandates/" + uuid("SEPA-Mandate: Test AG"), usingJsonBody("""
{
"validUntil": ${validUntil}
}
"""))
.expecting(OK).expecting(JSON);
}
}

View File

@ -11,6 +11,10 @@ public class CreatePartner extends UseCase<CreatePartner> {
super(testSuite, resultAlias); super(testSuite, resultAlias);
} }
public CreatePartner(final UseCaseTest testSuite) {
super(testSuite);
}
@Override @Override
protected HttpResponse run() { protected HttpResponse run() {