This is an automated email from the ASF dual-hosted git repository.
ahuber pushed a commit to branch v4
in repository https://gitbox.apache.org/repos/asf/causeway.git
The following commit(s) were added to refs/heads/v4 by this push:
new 066b628c087 CAUSEWAY-3897: start migrating RestfulClient to Spring's
RestClient (RO)
066b628c087 is described below
commit 066b628c087b8a7b1035e656794037ea5db93be2
Author: Andi Huber <[email protected]>
AuthorDate: Tue Jul 8 16:54:05 2025 +0200
CAUSEWAY-3897: start migrating RestfulClient to Spring's RestClient (RO)
---
.../transaction/TransactionServiceSpring.java | 6 -
.../applib/src/main/java/module-info.java | 2 +-
.../restfulobjects/applib/JsonRepresentation.java | 37 +--
.../applib/client/ActionParameterModel.java | 68 ++++++
.../applib/client/ActionParameterModelRecord.java | 218 +++++++++++++++++
.../applib/client/ConversationLogger.java | 149 ++++++++++++
.../client/ActionParameterModelRecord.java | 214 +++++++++++++++++
...sewayViewerRestfulObjectsIntegTestAbstract.java | 64 +++++
.../test/scenarios/Abstract_IntegTest.java | 3 +-
.../test/scenarios/dept/Department_IntegTest.java | 56 ++---
.../test/scenarios/home/HomePage_IntegTest.java | 15 +-
...Photo.DEPARTMENT_BOOKMARK_AS_MAP.approved.json} | 0
...oto.DEPARTMENT_BOOKMARK_AS_VALUE.approved.json} | 0
...rWithPhoto.DEPARTMENT_KEY_AS_MAP.approved.json} | 0
...ithPhoto.DEPARTMENT_KEY_AS_VALUE.approved.json} | 0
.../scenarios/staff/Staff_hilevel_IntegTest.java | 261 ++++++---------------
16 files changed, 815 insertions(+), 278 deletions(-)
diff --git
a/core/runtimeservices/src/main/java/org/apache/causeway/core/runtimeservices/transaction/TransactionServiceSpring.java
b/core/runtimeservices/src/main/java/org/apache/causeway/core/runtimeservices/transaction/TransactionServiceSpring.java
index 3027d3c7f02..db52ec055e8 100644
---
a/core/runtimeservices/src/main/java/org/apache/causeway/core/runtimeservices/transaction/TransactionServiceSpring.java
+++
b/core/runtimeservices/src/main/java/org/apache/causeway/core/runtimeservices/transaction/TransactionServiceSpring.java
@@ -20,7 +20,6 @@
import java.util.List;
import java.util.Optional;
-import java.util.UUID;
import java.util.concurrent.Callable;
import java.util.concurrent.atomic.LongAdder;
@@ -55,7 +54,6 @@
import org.apache.causeway.commons.functional.Try;
import org.apache.causeway.commons.internal.base._NullSafe;
import org.apache.causeway.commons.internal.collections._Lists;
-import org.apache.causeway.commons.internal.debug._Debug;
import org.apache.causeway.commons.internal.debug._Probe;
import org.apache.causeway.commons.internal.exceptions._Exceptions;
import org.apache.causeway.core.interaction.session.CausewayInteraction;
@@ -118,9 +116,6 @@ public <T> Try<T> callTransactional(final
TransactionDefinition def, final Calla
Try<T> result = null;
- var uuid = UUID.randomUUID();
- _Debug.log("tx START %s (%d)
-----------------------------------------------------------", uuid,
def.getPropagationBehavior());
-
try {
TransactionStatus txStatus =
platformTransactionManager.getTransaction(def);
registerTransactionSynchronizations(txStatus);
@@ -161,7 +156,6 @@ public <T> Try<T> callTransactional(final
TransactionDefinition def, final Calla
return Try.failure(translateExceptionIfPossible(ex,
platformTransactionManager));
}
- _Debug.log("tx END %s
----------------------------------------------------------", uuid);
return result;
}
diff --git a/viewers/restfulobjects/applib/src/main/java/module-info.java
b/viewers/restfulobjects/applib/src/main/java/module-info.java
index 5ca6cfeac9c..ccc5b76f788 100644
--- a/viewers/restfulobjects/applib/src/main/java/module-info.java
+++ b/viewers/restfulobjects/applib/src/main/java/module-info.java
@@ -19,6 +19,7 @@
module org.apache.causeway.viewer.restfulobjects.applib {
exports org.apache.causeway.viewer.restfulobjects.applib;
exports org.apache.causeway.viewer.restfulobjects.applib.boot;
+ exports org.apache.causeway.viewer.restfulobjects.applib.client;
exports org.apache.causeway.viewer.restfulobjects.applib.domaintypes;
exports org.apache.causeway.viewer.restfulobjects.applib.domainobjects;
exports org.apache.causeway.viewer.restfulobjects.applib.dtos;
@@ -35,7 +36,6 @@
requires com.fasterxml.jackson.annotation;
requires com.fasterxml.jackson.core;
requires com.fasterxml.jackson.databind;
- //requires jakarta.ws.rs;
requires org.apache.causeway.applib;
requires org.apache.causeway.commons;
requires spring.context;
diff --git
a/viewers/restfulobjects/applib/src/main/java/org/apache/causeway/viewer/restfulobjects/applib/JsonRepresentation.java
b/viewers/restfulobjects/applib/src/main/java/org/apache/causeway/viewer/restfulobjects/applib/JsonRepresentation.java
index d1f10d49b9a..b459166d68e 100644
---
a/viewers/restfulobjects/applib/src/main/java/org/apache/causeway/viewer/restfulobjects/applib/JsonRepresentation.java
+++
b/viewers/restfulobjects/applib/src/main/java/org/apache/causeway/viewer/restfulobjects/applib/JsonRepresentation.java
@@ -28,7 +28,6 @@
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
-import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
@@ -84,8 +83,9 @@ public interface HasExtensions {
public JsonRepresentation getExtensions();
}
- private static <T> Function<JsonNode, ?>
representationInstantiatorFor(final Class<T> representationType) {
- return
REPRESENTATION_INSTANTIATORS.computeIfAbsent(representationType, __->t -> {
+ @SuppressWarnings("unchecked")
+ private static <T> Function<JsonNode, T>
representationInstantiatorFor(final Class<T> representationType) {
+ return (Function<JsonNode, T>)
REPRESENTATION_INSTANTIATORS.computeIfAbsent(representationType, __->t -> {
try {
return
representationType.getConstructor(JsonNode.class).newInstance(t);
} catch (final Exception e) {
@@ -834,11 +834,7 @@ public boolean isLink(final JsonNode node) {
return false;
}
- final LinkRepresentation link = new LinkRepresentation(node);
- if (link.getHref() == null) {
- return false;
- }
- return true;
+ return new LinkRepresentation(node).getHref() != null;
}
/**
@@ -901,8 +897,7 @@ private Boolean isNull(final JsonNode node) {
* {@link JsonRepresentation#isNull()}), or returns <tt>null</tt> if there
* was no node with the provided path.
*
- * <p>
- * Use {@link #isNull(String)} to check first, if required.
+ * <p>Use {@link #isNull(String)} to check first, if required.
*/
public JsonRepresentation getNull(final String path) {
return getNull(path, getNode(path));
@@ -914,8 +909,7 @@ public JsonRepresentation getNull(final String path) {
* {@link JsonRepresentation#isNull()}), or returns <tt>null</tt> if there
* was no node with the provided path.
*
- * <p>
- * Use {@link #isNull()} to check first, if required.
+ * <p>Use {@link #isNull()} to check first, if required.
*/
public JsonRepresentation asNull() {
return getNull(null, asJsonNode());
@@ -973,10 +967,9 @@ protected ObjectNode asObjectNode() {
}
/**
- * Convenience to simply "downcast".
+ * Convenience to simply 'downcast'.
*
- * <p>
- * In fact, the method creates a new instance of the specified type, which
+ * <p>In fact, the method creates a new instance of the specified type,
which
* shares the underlying {@link #jsonNode jsonNode}.
*/
public <T extends JsonRepresentation> T as(final Class<T> cls) {
@@ -1072,18 +1065,8 @@ public Stream<JsonRepresentation> streamArrayElements() {
public <T> Stream<T> streamArrayElements(final Class<T> requiredType) {
ensureIsAnArrayAtLeastAsLargeAs(0);
- final Function<JsonNode, ?> transformer =
representationInstantiatorFor(requiredType);
- final ArrayNode arrayNode = (ArrayNode) jsonNode;
- final Iterator<JsonNode> iterator = arrayNode.iterator();
- // necessary to do in two steps
- final Function<JsonNode, T> typedTransformer = asT(transformer);
- return _NullSafe.stream(iterator)
- .map(typedTransformer);
- }
-
- @SuppressWarnings("unchecked")
- private static <T> Function<JsonNode, T> asT(final Function<JsonNode, ?>
transformer) {
- return (Function<JsonNode, T>) transformer;
+ return _NullSafe.stream(jsonNode.iterator())
+ .map(representationInstantiatorFor(requiredType));
}
public JsonRepresentation arrayGet(final int i) {
diff --git
a/viewers/restfulobjects/applib/src/main/java/org/apache/causeway/viewer/restfulobjects/applib/client/ActionParameterModel.java
b/viewers/restfulobjects/applib/src/main/java/org/apache/causeway/viewer/restfulobjects/applib/client/ActionParameterModel.java
new file mode 100644
index 00000000000..d55adafe628
--- /dev/null
+++
b/viewers/restfulobjects/applib/src/main/java/org/apache/causeway/viewer/restfulobjects/applib/client/ActionParameterModel.java
@@ -0,0 +1,68 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.causeway.viewer.restfulobjects.applib.client;
+
+import java.util.LinkedHashMap;
+import java.util.Map;
+
+import org.apache.causeway.applib.services.bookmark.Bookmark;
+import org.apache.causeway.applib.value.Blob;
+import org.apache.causeway.applib.value.Clob;
+import org.apache.causeway.applib.value.semantics.ValueDecomposition;
+
+public interface ActionParameterModel {
+ Map<String, Class<?>> getActionParameterTypes();
+
+ ActionParameterModel addActionParameter(String parameterName, String
parameterValue);
+
+ ActionParameterModel addActionParameter(String parameterName, int
parameterValue);
+
+ ActionParameterModel addActionParameter(String parameterName, long
parameterValue);
+
+ ActionParameterModel addActionParameter(String parameterName, byte
parameterValue);
+
+ ActionParameterModel addActionParameter(String parameterName, short
parameterValue);
+
+ ActionParameterModel addActionParameter(String parameterName, double
parameterValue);
+
+ ActionParameterModel addActionParameter(String parameterName, float
parameterValue);
+
+ ActionParameterModel addActionParameter(String parameterName, boolean
parameterValue);
+
+ ActionParameterModel addActionParameter(String parameterName, Blob blob);
+
+ ActionParameterModel addActionParameter(String parameterName, Clob clob);
+
+ ActionParameterModel addActionParameter(String parameterName, Map<String,
Object> map);
+
+ ActionParameterModel addActionParameter(String parameterName, Bookmark
bookmark);
+
+ <T> ActionParameterModel addActionParameter(String parameterName, Class<T>
type, T object);
+
+ /**
+ * For transport of {@link ValueDecomposition} over REST.
+ */
+ ActionParameterModel addActionParameter(String parameterName,
ValueDecomposition decomposition);
+
+ static ActionParameterModel create(String baseUrl) {
+ return new ActionParameterModelRecord(baseUrl, new LinkedHashMap<>(),
new LinkedHashMap<>());
+ }
+
+ String toJson();
+}
\ No newline at end of file
diff --git
a/viewers/restfulobjects/applib/src/main/java/org/apache/causeway/viewer/restfulobjects/applib/client/ActionParameterModelRecord.java
b/viewers/restfulobjects/applib/src/main/java/org/apache/causeway/viewer/restfulobjects/applib/client/ActionParameterModelRecord.java
new file mode 100644
index 00000000000..47849cfec4e
--- /dev/null
+++
b/viewers/restfulobjects/applib/src/main/java/org/apache/causeway/viewer/restfulobjects/applib/client/ActionParameterModelRecord.java
@@ -0,0 +1,218 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.causeway.viewer.restfulobjects.applib.client;
+
+import java.util.Collections;
+import java.util.Map;
+import java.util.stream.Collectors;
+
+import org.jspecify.annotations.NonNull;
+import org.jspecify.annotations.Nullable;
+
+import org.apache.causeway.applib.services.bookmark.Bookmark;
+import org.apache.causeway.applib.util.schema.CommonDtoUtils;
+import org.apache.causeway.applib.value.Blob;
+import org.apache.causeway.applib.value.Clob;
+import org.apache.causeway.applib.value.semantics.ValueDecomposition;
+import org.apache.causeway.commons.io.JsonUtils;
+import org.apache.causeway.schema.common.v2.BlobDto;
+import org.apache.causeway.schema.common.v2.ClobDto;
+import org.apache.causeway.schema.common.v2.ValueType;
+import org.apache.causeway.schema.common.v2.ValueWithTypeDto;
+
+record ActionParameterModelRecord(
+ String restfulBaseUrl,
+ Map<String, String> actionParameters,
+ Map<String, Class<?>> actionParameterTypes) implements
ActionParameterModel {
+
+ @Override
+ public String toJson() {
+ return new StringBuilder()
+ .append("{\n")
+ .append(actionParameters.entrySet().stream()
+ .map(this::toJson)
+ .collect(Collectors.joining(",\n")))
+ .append("\n}")
+ .toString();
+ }
+
+ public String toJson2() {
+ return """
+ {
+ "name": {"value" : "Fred Smith"},
+ "departmentSecondaryKey": {"value" : {"name":"Classics"}},
+ "photo": {"value" :
{"name":"StaffMember-photo-Bar.pdf","mimeType":"application/pdf","bytes":"JVBERi0xLjcNCiW1tbW1DQoxIDAgb2JqDQo8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAwIFIvTGFuZyhlbi1HQikgL1N0cnVjdFRyZWVSb290IDEyIDAgUi9NYXJrSW5mbzw8L01hcmtlZCB0cnVlPj4vTWV0YWRhdGEgMzIgMCBSL1ZpZXdlclByZWZlcmVuY2VzIDMzIDAgUj4+DQplbmRvYmoNCjIgMCBvYmoNCjw8L1R5cGUvUGFnZXMvQ291bnQgMS9LaWRzWyAzIDAgUl0gPj4NCmVuZG9iag0KMyAwIG9iag0KPDwvVHlwZS9QYWdlL1BhcmVudCAyIDAgUi9SZXNvdXJjZXM8PC9Gb250PDwvRjEgNSAwIFIvRjI
[...]
+ }""";
+ }
+
+ @Override
+ public Map<String, Class<?>> getActionParameterTypes() {
+ return Collections.unmodifiableMap(actionParameterTypes);
+ }
+
+ @Override
+ public ActionParameterModelRecord addActionParameter(final String
parameterName, final String parameterValue) {
+ actionParameters.put(parameterName, parameterValue != null
+ ? value("\"" + parameterValue + "\"")
+ : value(JSON_NULL_LITERAL));
+ actionParameterTypes.put(parameterName, String.class);
+ return this;
+ }
+
+ @Override
+ public ActionParameterModelRecord addActionParameter(final String
parameterName, final int parameterValue) {
+ actionParameters.put(parameterName, value(""+parameterValue));
+ actionParameterTypes.put(parameterName, int.class);
+ return this;
+ }
+
+ @Override
+ public ActionParameterModelRecord addActionParameter(final String
parameterName, final long parameterValue) {
+ actionParameters.put(parameterName, value(""+parameterValue));
+ actionParameterTypes.put(parameterName, long.class);
+ return this;
+ }
+
+ @Override
+ public ActionParameterModelRecord addActionParameter(final String
parameterName, final byte parameterValue) {
+ actionParameters.put(parameterName, value(""+parameterValue));
+ actionParameterTypes.put(parameterName, byte.class);
+ return this;
+ }
+
+ @Override
+ public ActionParameterModelRecord addActionParameter(final String
parameterName, final short parameterValue) {
+ actionParameters.put(parameterName, value(""+parameterValue));
+ actionParameterTypes.put(parameterName, short.class);
+ return this;
+ }
+
+ @Override
+ public ActionParameterModelRecord addActionParameter(final String
parameterName, final double parameterValue) {
+ actionParameters.put(parameterName, value(""+parameterValue));
+ actionParameterTypes.put(parameterName, double.class);
+ return this;
+ }
+
+ @Override
+ public ActionParameterModelRecord addActionParameter(final String
parameterName, final float parameterValue) {
+ actionParameters.put(parameterName, value(""+parameterValue));
+ actionParameterTypes.put(parameterName, float.class);
+ return this;
+ }
+
+ @Override
+ public ActionParameterModelRecord addActionParameter(final String
parameterName, final boolean parameterValue) {
+ actionParameters.put(parameterName, value(""+parameterValue));
+ actionParameterTypes.put(parameterName, boolean.class);
+ return this;
+ }
+
+ @Override
+ public ActionParameterModelRecord addActionParameter(final String
parameterName, final Blob blob) {
+ var blobDto = new BlobDto();
+ blobDto.setName(blob.name());
+ blobDto.setMimeType(blob.mimeType().getBaseType());
+ blobDto.setBytes(blob.bytes());
+ var fundamentalTypeDto = new ValueWithTypeDto();
+ fundamentalTypeDto.setType(ValueType.BLOB);
+ fundamentalTypeDto.setBlob(blobDto);
+ actionParameters.put(parameterName,
value(CommonDtoUtils.getFundamentalValueAsJson(fundamentalTypeDto)));
+ actionParameterTypes.put(parameterName, Blob.class);
+ return this;
+ }
+
+ @Override
+ public ActionParameterModelRecord addActionParameter(final String
parameterName, final Clob clob) {
+ var clobDto = new ClobDto();
+ clobDto.setName(clob.name());
+ clobDto.setMimeType(clob.mimeType().getBaseType());
+ clobDto.setChars(clob.asString());
+ var fundamentalTypeDto = new ValueWithTypeDto();
+ fundamentalTypeDto.setType(ValueType.CLOB);
+ fundamentalTypeDto.setClob(clobDto);
+ actionParameters.put(parameterName,
value(CommonDtoUtils.getFundamentalValueAsJson(fundamentalTypeDto)));
+ actionParameterTypes.put(parameterName, Blob.class);
+ return this;
+ }
+
+ @Override
+ public ActionParameterModelRecord addActionParameter(final String
parameterName,
+ final @NonNull Map<String, Object> map) {
+ var nestedJson = JsonUtils.toStringUtf8(map);
+ actionParameters.put(parameterName, value(nestedJson));
+ actionParameterTypes.put(parameterName, Map.class);
+ return this;
+ }
+
+ @Override
+ public ActionParameterModelRecord addActionParameter(
+ final @NonNull String parameterName,
+ final @NonNull Bookmark bookmark) {
+ actionParameters.put(parameterName, valueHref( bookmark) );
+ actionParameterTypes.put(parameterName, Map.class);
+ return this;
+ }
+
+ @Override
+ public <T> ActionParameterModelRecord addActionParameter(
+ final String parameterName,
+ final @NonNull Class<T> type,
+ final @Nullable T object) {
+ var nestedJson = object!=null
+ ? JsonUtils.toStringUtf8(object)
+ : "NULL"; // see ValueSerializerDefault.ENCODED_NULL
+ actionParameters.put(parameterName, value(nestedJson));
+ actionParameterTypes.put(parameterName, type);
+ return this;
+ }
+
+ @Override
+ public ActionParameterModelRecord addActionParameter(final String
parameterName, final ValueDecomposition decomposition) {
+ return addActionParameter(parameterName, decomposition.stringify());
+ }
+
+ // -- HELPER
+
+ private String valueHref(Bookmark bookmark) {
+ String hrefValue = asAbsoluteHref(bookmark);
+// String hrefValue = "\"" + asAbsoluteHref(bookmark) + "\"";
+ Map<String, String> map = Map.of("href", hrefValue);
+ return value(JsonUtils.toStringUtf8(map));
+ }
+
+ private String asAbsoluteHref(Bookmark bookmark) {
+ return String.format("%s%s", restfulBaseUrl, asRelativeHref(bookmark));
+ }
+
+ private String asRelativeHref(Bookmark bookmark) {
+ return String.format("objects/%s/%s", bookmark.logicalTypeName(),
bookmark.identifier());
+ }
+
+ private static final String JSON_NULL_LITERAL = "null";
+
+ private String value(final String valueLiteral) {
+ return "{\"value\" : " + valueLiteral + "}";
+ }
+
+ private String toJson(final Map.Entry<String, String> entry) {
+ return " \""+entry.getKey()+"\": "+entry.getValue();
+ }
+
+}
diff --git
a/viewers/restfulobjects/applib/src/main/java/org/apache/causeway/viewer/restfulobjects/applib/client/ConversationLogger.java
b/viewers/restfulobjects/applib/src/main/java/org/apache/causeway/viewer/restfulobjects/applib/client/ConversationLogger.java
new file mode 100644
index 00000000000..faf2d4a2ccd
--- /dev/null
+++
b/viewers/restfulobjects/applib/src/main/java/org/apache/causeway/viewer/restfulobjects/applib/client/ConversationLogger.java
@@ -0,0 +1,149 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.causeway.viewer.restfulobjects.applib.client;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.charset.StandardCharsets;
+import java.util.Map;
+import java.util.function.BiPredicate;
+import java.util.function.Consumer;
+import java.util.stream.Collectors;
+
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpRequest;
+import org.springframework.http.HttpStatusCode;
+import org.springframework.http.client.ClientHttpRequestExecution;
+import org.springframework.http.client.ClientHttpRequestInterceptor;
+import org.springframework.http.client.ClientHttpResponse;
+import org.springframework.util.function.ThrowingSupplier;
+import org.springframework.web.client.RestClient;
+
+import org.apache.causeway.commons.functional.Try;
+import org.apache.causeway.commons.internal.base._NullSafe;
+import org.apache.causeway.commons.internal.base._Strings;
+import org.apache.causeway.commons.io.DataSource;
+
+/**
+ * Provides conversation logging for the {@link RestClient}.
+ *
+ * <p><strong>Note:</strong> buffering must be enabled through
+ * {@link
org.springframework.web.client.RestClient.Builder#bufferContent(BiPredicate)}.
+ *
+ * @since 4.0
+ */
+public record ConversationLogger(Consumer<String> logAppender)
+implements ClientHttpRequestInterceptor {
+
+ @Override
+ public ClientHttpResponse intercept(
+ final HttpRequest request,
+ final byte[] body,
+ final ClientHttpRequestExecution execution) throws IOException {
+ return onResponse(execution.execute(onRequest(request, body), body));
+ }
+
+ // -- HELPER
+
+ private HttpRequest onRequest(final HttpRequest request, final byte[]
body) {
+
+ var uri = request.getURI();
+ var headers = request.getHeaders();
+ var headersAsText = headersAsText(headers);
+ var method = request.getMethod().name();
+
+ var sb = new StringBuilder().append("\n")
+ .append("---------- REST REQUEST -------------\n")
+ .append("uri: ").append(uri).append("\n")
+ .append("method: ").append(method).append("\n")
+ .append("headers: \n\t").append(headersAsText).append("\n")
+ .append("body-size: ").append(_NullSafe.size(body)).append("
bytes\n")
+ .append("request-body: ").append(bodyAsText(body)).append("\n")
+ .append("----------------------------------------\n");
+
+ logAppender.accept(sb.toString());
+
+ return request;
+ }
+
+ private ClientHttpResponse onResponse(final ClientHttpResponse response) {
+
+ var headersAsText = headersAsText(response.getHeaders());
+ var statusCode = Try.call(()->response.getStatusCode())
+ .getValue()
+ .map(HttpStatusCode::toString)
+ .orElse("failure retrieving status code");
+ var body = bodyAsBytes(response::getBody);
+
+ var sb = new StringBuilder().append("\n")
+ .append("---------- REST RESPONSE -------------\n")
+ .append("http-return-code: \n\t").append(statusCode).append("\n")
+ .append("headers: \n\t").append(headersAsText).append("\n")
+ .append("body-size: ").append(_NullSafe.size(body)).append("
bytes\n")
+ .append("response-body: ").append(bodyAsText(body)).append("\n")
+ .append("----------------------------------------\n");
+
+ logAppender.accept(sb.toString());
+
+ return response;
+ }
+
+ private byte[] bodyAsBytes(final ThrowingSupplier<InputStream>
bodySupplier) {
+ try {
+ return DataSource.ofInputStreamEagerly(bodySupplier.get()).bytes();
+ } catch (Exception e) {
+ return "failed to read response
body".getBytes(StandardCharsets.UTF_8);
+ }
+ }
+
+ private String bodyAsText(final byte[] body) {
+ if(_NullSafe.isEmpty(body)) return "";
+ try {
+ var raw = new String(body, StandardCharsets.UTF_8);
+ return _Strings.ellipsifyAtEnd(raw, 4*1024, "...truncated");
+ } catch (Exception e) {
+ return "failed to interpret response body as String";
+ }
+ }
+
+ private String headersAsText(final HttpHeaders headers) {
+ return headers.toSingleValueMap().entrySet().stream()
+ .map(this::toKeyValueString)
+ .map(this::obscureAuthHeader)
+ .collect(Collectors.joining(",\n\t"));
+ }
+
+ private final static String BASIC_AUTH_MAGIC = "Authorization: Basic ";
+
+ private String toKeyValueString(final Map.Entry<?, ?> entry) {
+ return "" + entry.getKey() + ": " + entry.getValue();
+ }
+
+ private String obscureAuthHeader(final String keyValueLiteral) {
+ if(_Strings.isEmpty(keyValueLiteral)) {
+ return keyValueLiteral;
+ }
+ if(keyValueLiteral.startsWith(BASIC_AUTH_MAGIC)) {
+ final String obscured = _Strings.padEnd(BASIC_AUTH_MAGIC,
keyValueLiteral.length() - 1, '*');
+ return obscured;
+ }
+ return keyValueLiteral;
+ }
+
+}
diff --git
a/viewers/restfulobjects/client/src/main/java/org/apache/causeway/viewer/restfulobjects/client/ActionParameterModelRecord.java
b/viewers/restfulobjects/client/src/main/java/org/apache/causeway/viewer/restfulobjects/client/ActionParameterModelRecord.java
new file mode 100644
index 00000000000..10ceb669f72
--- /dev/null
+++
b/viewers/restfulobjects/client/src/main/java/org/apache/causeway/viewer/restfulobjects/client/ActionParameterModelRecord.java
@@ -0,0 +1,214 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.causeway.viewer.restfulobjects.client;
+
+import java.util.LinkedHashMap;
+import java.util.Map;
+import java.util.stream.Collectors;
+
+import jakarta.ws.rs.client.Entity;
+
+import org.apache.causeway.applib.services.bookmark.Bookmark;
+
+import org.jspecify.annotations.Nullable;
+
+import org.apache.causeway.applib.util.schema.CommonDtoUtils;
+import org.apache.causeway.applib.value.Blob;
+import org.apache.causeway.applib.value.Clob;
+import org.apache.causeway.applib.value.semantics.ValueDecomposition;
+import org.apache.causeway.commons.io.JsonUtils;
+import org.apache.causeway.schema.common.v2.BlobDto;
+import org.apache.causeway.schema.common.v2.ClobDto;
+import org.apache.causeway.schema.common.v2.ValueType;
+import org.apache.causeway.schema.common.v2.ValueWithTypeDto;
+
+import lombok.Getter;
+import org.jspecify.annotations.NonNull;
+
+/**
+ * Use {@link RestfulClient#arguments()} to get an instance.
+ * @since 2.0 {@index}
+ */
+public class ActionParameterModelRecord {
+
+ private final Map<String, String> actionParameters = new LinkedHashMap<>();
+
+ @Getter
+ private final Map<String, Class<?>> actionParameterTypes = new
LinkedHashMap<>();
+
+ private final RestfulClient restfulClient;
+
+ public ActionParameterModelRecord(RestfulClient restfulClient) {
+ this.restfulClient = restfulClient;
+ }
+
+ public ActionParameterModelRecord addActionParameter(final String
parameterName, final String parameterValue) {
+ actionParameters.put(parameterName, parameterValue != null
+ ? value("\"" + parameterValue + "\"")
+ : value(JSON_NULL_LITERAL));
+ actionParameterTypes.put(parameterName, String.class);
+ return this;
+ }
+
+ public ActionParameterModelRecord addActionParameter(final String
parameterName, final int parameterValue) {
+ actionParameters.put(parameterName, value(""+parameterValue));
+ actionParameterTypes.put(parameterName, int.class);
+ return this;
+ }
+
+ public ActionParameterModelRecord addActionParameter(final String
parameterName, final long parameterValue) {
+ actionParameters.put(parameterName, value(""+parameterValue));
+ actionParameterTypes.put(parameterName, long.class);
+ return this;
+ }
+
+ public ActionParameterModelRecord addActionParameter(final String
parameterName, final byte parameterValue) {
+ actionParameters.put(parameterName, value(""+parameterValue));
+ actionParameterTypes.put(parameterName, byte.class);
+ return this;
+ }
+
+ public ActionParameterModelRecord addActionParameter(final String
parameterName, final short parameterValue) {
+ actionParameters.put(parameterName, value(""+parameterValue));
+ actionParameterTypes.put(parameterName, short.class);
+ return this;
+ }
+
+ public ActionParameterModelRecord addActionParameter(final String
parameterName, final double parameterValue) {
+ actionParameters.put(parameterName, value(""+parameterValue));
+ actionParameterTypes.put(parameterName, double.class);
+ return this;
+ }
+
+ public ActionParameterModelRecord addActionParameter(final String
parameterName, final float parameterValue) {
+ actionParameters.put(parameterName, value(""+parameterValue));
+ actionParameterTypes.put(parameterName, float.class);
+ return this;
+ }
+
+ public ActionParameterModelRecord addActionParameter(final String
parameterName, final boolean parameterValue) {
+ actionParameters.put(parameterName, value(""+parameterValue));
+ actionParameterTypes.put(parameterName, boolean.class);
+ return this;
+ }
+
+ public ActionParameterModelRecord addActionParameter(final String
parameterName, final Blob blob) {
+ var blobDto = new BlobDto();
+ blobDto.setName(blob.name());
+ blobDto.setMimeType(blob.mimeType().getBaseType());
+ blobDto.setBytes(blob.bytes());
+ var fundamentalTypeDto = new ValueWithTypeDto();
+ fundamentalTypeDto.setType(ValueType.BLOB);
+ fundamentalTypeDto.setBlob(blobDto);
+ actionParameters.put(parameterName,
value(CommonDtoUtils.getFundamentalValueAsJson(fundamentalTypeDto)));
+ actionParameterTypes.put(parameterName, Blob.class);
+ return this;
+ }
+
+ public ActionParameterModelRecord addActionParameter(final String
parameterName, final Clob clob) {
+ var clobDto = new ClobDto();
+ clobDto.setName(clob.name());
+ clobDto.setMimeType(clob.mimeType().getBaseType());
+ clobDto.setChars(clob.asString());
+ var fundamentalTypeDto = new ValueWithTypeDto();
+ fundamentalTypeDto.setType(ValueType.CLOB);
+ fundamentalTypeDto.setClob(clobDto);
+ actionParameters.put(parameterName,
value(CommonDtoUtils.getFundamentalValueAsJson(fundamentalTypeDto)));
+ actionParameterTypes.put(parameterName, Blob.class);
+ return this;
+ }
+
+ public ActionParameterModelRecord addActionParameter(final String
parameterName,
+ final @NonNull Map<String, Object> map) {
+ var nestedJson = JsonUtils.toStringUtf8(map);
+ actionParameters.put(parameterName, value(nestedJson));
+ actionParameterTypes.put(parameterName, Map.class);
+ return this;
+ }
+
+ public ActionParameterModelRecord addActionParameter(
+ final @NonNull String parameterName,
+ final @NonNull Bookmark bookmark) {
+ if (this.restfulClient == null) {
+ throw new IllegalStateException("Use RestfulClient#arguments() to
create this builder");
+ }
+ actionParameters.put(parameterName, valueHref( bookmark) );
+ actionParameterTypes.put(parameterName, Map.class);
+ return this;
+ }
+
+ private String valueHref(Bookmark bookmark) {
+ String hrefValue = asAbsoluteHref(bookmark);
+// String hrefValue = "\"" + asAbsoluteHref(bookmark) + "\"";
+ Map<String, String> map = Map.of("href", hrefValue);
+ return value(JsonUtils.toStringUtf8(map));
+ }
+
+ private String asAbsoluteHref(Bookmark bookmark) {
+ return String.format("%s%s",
restfulClient.getConfig().getRestfulBaseUrl(), asRelativeHref(bookmark));
+ }
+
+ private String asRelativeHref(Bookmark bookmark) {
+ return String.format("objects/%s/%s", bookmark.logicalTypeName(),
bookmark.identifier());
+ }
+
+ public <T> ActionParameterModelRecord addActionParameter(
+ final String parameterName,
+ final @NonNull Class<T> type,
+ final @Nullable T object) {
+ var nestedJson = object!=null
+ ? JsonUtils.toStringUtf8(object)
+ : "NULL"; // see ValueSerializerDefault.ENCODED_NULL
+ actionParameters.put(parameterName, value(nestedJson));
+ actionParameterTypes.put(parameterName, type);
+ return this;
+ }
+
+ /**
+ * For transport of {@link ValueDecomposition} over REST.
+ * @see RestfulClient#digestValue(jakarta.ws.rs.core.Response,
org.apache.causeway.applib.value.semantics.ValueSemanticsProvider)
+ */
+ public ActionParameterModelRecord addActionParameter(final String
parameterName, final ValueDecomposition decomposition) {
+ return addActionParameter(parameterName, decomposition.stringify());
+ }
+
+ public Entity<String> build() {
+ final StringBuilder sb = new StringBuilder();
+ sb.append("{\n")
+ .append(actionParameters.entrySet().stream()
+ .map(this::toJson)
+ .collect(Collectors.joining(",\n")))
+ .append("\n}");
+
+ return Entity.json(sb.toString());
+ }
+
+ // -- HELPER
+
+ private static final String JSON_NULL_LITERAL = "null";
+
+ private String value(final String valueLiteral) {
+ return "{\"value\" : " + valueLiteral + "}";
+ }
+
+ private String toJson(final Map.Entry<String, String> entry) {
+ return " \""+entry.getKey()+"\": "+entry.getValue();
+ }
+
+}
diff --git
a/viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/CausewayViewerRestfulObjectsIntegTestAbstract.java
b/viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/CausewayViewerRestfulObjectsIntegTestAbstract.java
index 7308a7af306..b9bc60f26b5 100644
---
a/viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/CausewayViewerRestfulObjectsIntegTestAbstract.java
+++
b/viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/CausewayViewerRestfulObjectsIntegTestAbstract.java
@@ -19,7 +19,9 @@
package org.apache.causeway.viewer.restfulobjects.test;
import java.io.ByteArrayOutputStream;
+import java.io.IOException;
import java.io.InputStream;
+import java.net.URI;
import jakarta.inject.Inject;
@@ -34,17 +36,28 @@
import org.junit.jupiter.api.TestInfo;
import org.junit.jupiter.api.TestInstance;
import org.junit.jupiter.api.TestMethodOrder;
+import org.opentest4j.AssertionFailedError;
+import org.slf4j.Logger;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.web.server.test.LocalServerPort;
import org.springframework.context.annotation.Import;
import org.springframework.core.io.ClassPathResource;
+import org.springframework.http.HttpMethod;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.MediaType;
+import org.springframework.http.client.ClientHttpResponse;
import org.springframework.test.context.ActiveProfiles;
+import org.springframework.web.client.ResponseErrorHandler;
+import org.springframework.web.client.RestClient;
+import org.springframework.web.client.RestClient.Builder;
+import org.springframework.web.client.RestClient.ResponseSpec;
import org.apache.causeway.applib.services.xactn.TransactionService;
import org.apache.causeway.applib.value.Blob;
import org.apache.causeway.core.config.environment.CausewaySystemEnvironment;
import org.apache.causeway.core.metamodel.specloader.SpecificationLoader;
+import
org.apache.causeway.viewer.restfulobjects.applib.client.ConversationLogger;
import org.apache.causeway.viewer.restfulobjects.client.AuthenticationMode;
import org.apache.causeway.viewer.restfulobjects.client.RestfulClient;
import org.apache.causeway.viewer.restfulobjects.client.RestfulClientConfig;
@@ -110,6 +123,57 @@ void init(final TestInfo testInfo) {
private ObjectMapper objectMapper = new ObjectMapper();
+ protected String baseUrl() {
+ return "http://0.0.0.0:%d/restful/".formatted(port);
+ }
+
+ protected Builder restClient() {
+ return RestClient.builder()
+ .baseUrl(baseUrl())
+ .defaultHeaders(headers -> headers.setBasicAuth("usr", "pass"));
+ }
+ protected Builder restClient(final Logger logger) {
+ return restClient()
+ .bufferContent((uri, method)->true)
+ .requestInterceptor(new ConversationLogger(msg->logger.info(msg)));
+ }
+ protected ResponseSpec restGetJson(final String uri, final Logger logger) {
+ return restClient(logger).build()
+ .get()
+ .uri(uri)
+ .accept(MediaType.APPLICATION_JSON)
+ .retrieve()
+ .onStatus(assertStatusOkResponseErrorHandler());
+ }
+
+ protected ResponseErrorHandler assertStatusOkResponseErrorHandler() {
+ return new ResponseErrorHandler() {
+ @Override
+ public boolean hasError(final ClientHttpResponse response) throws
IOException {
+ return !response.getStatusCode().equals(HttpStatus.OK);
+ }
+ @Override
+ public void handleError(final URI url, final HttpMethod method,
final ClientHttpResponse response) throws IOException {
+ throw new AssertionFailedError("StatusCode not OK: " +
response.getStatusCode());
+ }
+ };
+ }
+
+ protected ResponseErrorHandler assertStatusNotFoundResponseErrorHandler() {
+ return new ResponseErrorHandler() {
+ @Override
+ public boolean hasError(final ClientHttpResponse response) throws
IOException {
+ return true; //handle any status
+ }
+ @Override
+ public void handleError(final URI url, final HttpMethod method,
final ClientHttpResponse response) throws IOException {
+ if(!response.getStatusCode().equals(HttpStatus.NOT_FOUND))
+ throw new AssertionFailedError("StatusCode NOT_FOUND
expected, but got: " + response.getStatusCode());
+ }
+ };
+ }
+
+ @Deprecated
protected RestfulClient restfulClient() {
var clientConfig = RestfulClientConfig.builder()
.restfulBaseUrl(String.format("http://0.0.0.0:%d/restful/";,
port))
diff --git
a/viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/scenarios/Abstract_IntegTest.java
b/viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/scenarios/Abstract_IntegTest.java
index cf906afbc10..1cb87a5ad41 100644
---
a/viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/scenarios/Abstract_IntegTest.java
+++
b/viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/scenarios/Abstract_IntegTest.java
@@ -32,7 +32,6 @@
import org.springframework.test.annotation.DirtiesContext;
import org.springframework.test.context.TestPropertySource;
import org.springframework.transaction.annotation.Propagation;
-
import org.apache.causeway.applib.services.bookmark.BookmarkService;
import
org.apache.causeway.persistence.jpa.eclipselink.CausewayModulePersistenceJpaEclipselink;
import org.apache.causeway.viewer.restfulobjects.client.RestfulClient;
@@ -58,7 +57,7 @@ public abstract class Abstract_IntegTest extends
CausewayViewerRestfulObjectsInt
@Inject protected StaffMemberRepository staffMemberRepository;
@Inject protected BookmarkService bookmarkService;
- protected RestfulClient restfulClient;
+ @Deprecated protected RestfulClient restfulClient;
protected Abstract_IntegTest(final Class<?> resourceBaseClazz) {
super(resourceBaseClazz);
diff --git
a/viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/scenarios/dept/Department_IntegTest.java
b/viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/scenarios/dept/Department_IntegTest.java
index e238f0be153..20400e249b9 100644
---
a/viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/scenarios/dept/Department_IntegTest.java
+++
b/viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/scenarios/dept/Department_IntegTest.java
@@ -18,22 +18,21 @@
*/
package org.apache.causeway.viewer.restfulobjects.test.scenarios.dept;
-import jakarta.ws.rs.client.Invocation;
-import jakarta.ws.rs.core.Response;
-
import org.approvaltests.Approvals;
import org.approvaltests.reporters.DiffReporter;
import org.approvaltests.reporters.UseReporter;
import org.junit.jupiter.api.Test;
-import static org.assertj.core.api.Assertions.assertThat;
-
+import org.springframework.http.MediaType;
import org.springframework.transaction.annotation.Propagation;
import org.apache.causeway.applib.services.bookmark.Bookmark;
import org.apache.causeway.viewer.restfulobjects.test.domain.dom.Department;
import
org.apache.causeway.viewer.restfulobjects.test.scenarios.Abstract_IntegTest;
+import lombok.extern.slf4j.Slf4j;
+
+@Slf4j
class Department_IntegTest extends Abstract_IntegTest {
@Test
@@ -46,17 +45,11 @@ void exists() {
return bookmarkService.bookmarkFor(classics).orElseThrow();
}).valueAsNonNullElseFail();
- Invocation.Builder request =
restfulClient.request(String.format("/objects/%s/%s",
bookmark.logicalTypeName(), bookmark.identifier()));
-
// when
- var response = request.get();
+ var response =
restGetJson("/objects/%s/%s".formatted(bookmark.logicalTypeName(),
bookmark.identifier()), log);
// then
- var entity = response.readEntity(String.class);
-
- assertThat(response)
- .extracting(Response::getStatus)
- .isEqualTo(Response.Status.OK.getStatusCode());
+ var entity = response.body(String.class);
Approvals.verify(entity, jsonOptions());
}
@@ -70,17 +63,11 @@ void collection_with_staff_members() {
return bookmarkService.bookmarkFor(classics).orElseThrow();
}).valueAsNonNullElseFail();
- Invocation.Builder request =
restfulClient.request(String.format("/objects/%s/%s/collections/staffMembers",
bookmark.logicalTypeName(), bookmark.identifier()));
-
// when
- var response = request.get();
+ var response =
restGetJson("/objects/%s/%s/collections/staffMembers".formatted(bookmark.logicalTypeName(),
bookmark.identifier()), log);
// then
- var entity = response.readEntity(String.class);
-
- assertThat(response)
- .extracting(Response::getStatus)
- .isEqualTo(Response.Status.OK.getStatusCode());
+ var entity = response.body(String.class);
Approvals.verify(entity, jsonOptions());
}
@@ -94,17 +81,11 @@ void collection_with_no_staff_members() {
return bookmarkService.bookmarkFor(classics).orElseThrow();
}).valueAsNonNullElseFail();
- Invocation.Builder request =
restfulClient.request(String.format("/objects/%s/%s/collections/staffMembers",
bookmark.logicalTypeName(), bookmark.identifier()));
-
// when
- var response = request.get();
+ var response =
restGetJson("/objects/%s/%s/collections/staffMembers".formatted(bookmark.logicalTypeName(),
bookmark.identifier()), log);
// then
- var entity = response.readEntity(String.class);
-
- assertThat(response)
- .extracting(Response::getStatus)
- .isEqualTo(Response.Status.OK.getStatusCode());
+ var entity = response.body(String.class);
Approvals.verify(entity, jsonOptions());
}
@@ -112,20 +93,17 @@ void collection_with_no_staff_members() {
@UseReporter(DiffReporter.class)
void does_not_exist() {
- // given
- Invocation.Builder request =
restfulClient.request("/objects/university.dept.Department/9999999");
-
// when
- var response = request.get();
+ var response = restClient(log).build()
+ .get()
+ .uri("/objects/university.dept.Department/9999999")
+ .accept(MediaType.APPLICATION_JSON)
+ .retrieve()
+ .onStatus(assertStatusNotFoundResponseErrorHandler());
// then
- var entity = response.readEntity(String.class);
-
- assertThat(response)
- .extracting(Response::getStatus)
- .isEqualTo(Response.Status.NOT_FOUND.getStatusCode());
+ var entity = response.body(String.class);
Approvals.verify(entity, jsonOptions());
-
}
}
diff --git
a/viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/scenarios/home/HomePage_IntegTest.java
b/viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/scenarios/home/HomePage_IntegTest.java
index 833fa3de35b..06b64735e19 100644
---
a/viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/scenarios/home/HomePage_IntegTest.java
+++
b/viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/scenarios/home/HomePage_IntegTest.java
@@ -18,8 +18,6 @@
*/
package org.apache.causeway.viewer.restfulobjects.test.scenarios.home;
-import jakarta.ws.rs.client.Invocation;
-
import org.approvaltests.Approvals;
import org.approvaltests.reporters.DiffReporter;
import org.approvaltests.reporters.UseReporter;
@@ -27,6 +25,9 @@
import
org.apache.causeway.viewer.restfulobjects.test.scenarios.Abstract_IntegTest;
+import lombok.extern.slf4j.Slf4j;
+
+@Slf4j
class HomePage_IntegTest extends Abstract_IntegTest {
@Test
@@ -34,16 +35,14 @@ class HomePage_IntegTest extends Abstract_IntegTest {
void homePage() {
// given
- Invocation.Builder request = restfulClient.request("/");
+ var response = restGetJson("/", log);
// when
- var response = request.get();
+ var entity = response
+ .body(String.class);
// then
- assertResponseOK(response);
-
- var entity = response.readEntity(String.class);
-
Approvals.verify(entity, jsonOptions());
}
+
}
diff --git
a/viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/scenarios/staff/Staff_hilevel_IntegTest.createStaffMemberWithPhoto2.approved.json
b/viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/scenarios/staff/Staff_hilevel_IntegTest.createStaffMemberWithPhoto.DEPARTMENT_BOOKMARK_AS_MAP.approved.json
similarity index 100%
rename from
viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/scenarios/staff/Staff_hilevel_IntegTest.createStaffMemberWithPhoto2.approved.json
rename to
viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/scenarios/staff/Staff_hilevel_IntegTest.createStaffMemberWithPhoto.DEPARTMENT_BOOKMARK_AS_MAP.approved.json
diff --git
a/viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/scenarios/staff/Staff_hilevel_IntegTest.createStaffMemberWithPhoto2_using_map.approved.json
b/viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/scenarios/staff/Staff_hilevel_IntegTest.createStaffMemberWithPhoto.DEPARTMENT_BOOKMARK_AS_VALUE.approved.json
similarity index 100%
rename from
viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/scenarios/staff/Staff_hilevel_IntegTest.createStaffMemberWithPhoto2_using_map.approved.json
rename to
viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/scenarios/staff/Staff_hilevel_IntegTest.createStaffMemberWithPhoto.DEPARTMENT_BOOKMARK_AS_VALUE.approved.json
diff --git
a/viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/scenarios/staff/Staff_hilevel_IntegTest.createStaffMemberWithPhoto.approved.json
b/viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/scenarios/staff/Staff_hilevel_IntegTest.createStaffMemberWithPhoto.DEPARTMENT_KEY_AS_MAP.approved.json
similarity index 100%
rename from
viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/scenarios/staff/Staff_hilevel_IntegTest.createStaffMemberWithPhoto.approved.json
rename to
viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/scenarios/staff/Staff_hilevel_IntegTest.createStaffMemberWithPhoto.DEPARTMENT_KEY_AS_MAP.approved.json
diff --git
a/viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/scenarios/staff/Staff_hilevel_IntegTest.createStaffMemberWithPhoto_using_map.approved.json
b/viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/scenarios/staff/Staff_hilevel_IntegTest.createStaffMemberWithPhoto.DEPARTMENT_KEY_AS_VALUE.approved.json
similarity index 100%
rename from
viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/scenarios/staff/Staff_hilevel_IntegTest.createStaffMemberWithPhoto_using_map.approved.json
rename to
viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/scenarios/staff/Staff_hilevel_IntegTest.createStaffMemberWithPhoto.DEPARTMENT_KEY_AS_VALUE.approved.json
diff --git
a/viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/scenarios/staff/Staff_hilevel_IntegTest.java
b/viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/scenarios/staff/Staff_hilevel_IntegTest.java
index ae7aed2fb9e..94f01274006 100644
---
a/viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/scenarios/staff/Staff_hilevel_IntegTest.java
+++
b/viewers/restfulobjects/test/src/test/java/org/apache/causeway/viewer/restfulobjects/test/scenarios/staff/Staff_hilevel_IntegTest.java
@@ -20,12 +20,12 @@
import java.util.Map;
-import jakarta.ws.rs.core.Response;
-
import org.approvaltests.Approvals;
import org.approvaltests.reporters.DiffReporter;
import org.approvaltests.reporters.UseReporter;
-import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.EnumSource;
+import org.junit.jupiter.params.provider.EnumSources;
import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertNotNull;
@@ -35,169 +35,102 @@
import org.apache.causeway.applib.services.bookmark.Bookmark;
import org.apache.causeway.applib.value.Blob;
import org.apache.causeway.applib.value.NamedWithMimeType.CommonMimeType;
-import org.apache.causeway.commons.internal.debug._Debug;
import org.apache.causeway.commons.io.DataSource;
+import
org.apache.causeway.viewer.restfulobjects.applib.client.ActionParameterModel;
import org.apache.causeway.viewer.restfulobjects.test.domain.dom.Department;
import
org.apache.causeway.viewer.restfulobjects.test.scenarios.Abstract_IntegTest;
+import lombok.RequiredArgsConstructor;
import lombok.SneakyThrows;
+import lombok.extern.slf4j.Slf4j;
+@Slf4j
class Staff_hilevel_IntegTest extends Abstract_IntegTest {
- @Test
- @UseReporter(DiffReporter.class)
- @SneakyThrows
- void createStaffMemberWithPhoto() {
-
- // given
- final var staffName = "Fred Smith";
-
- final var bookmarkBeforeIfAny =
transactionService.callTransactional(Propagation.REQUIRED, () -> {
- final var staffMember =
staffMemberRepository.findByName(staffName);
- return bookmarkService.bookmarkFor(staffMember);
- }).valueAsNonNullElseFail();
-
- assertThat(bookmarkBeforeIfAny).isEmpty();
-
- final Blob photo = readFileAsBlob("StaffMember-photo-Bar.pdf");
- final var requestBuilder =
restfulClient.request("services/university.dept.Staff/actions/createStaffMemberWithPhoto/invoke");
-
- /*
- * String name,
- * Department.SecondaryKey departmentSecondaryKey,
- * Blob photo
- */
- var args = restfulClient.arguments()
- .addActionParameter("name", staffName)
- .addActionParameter("departmentSecondaryKey",
Department.SecondaryKey.class, new Department.SecondaryKey("Classics"))
- .addActionParameter("photo", photo)
- .build();
+ final String staffName = "Fred Smith";
- Approvals.verify(args.getEntity(), jsonOptions());
-
- // when
- var response = requestBuilder.post(args);
-
- // then
-
assertThat(response.getStatusInfo().getFamily()).isEqualTo(Response.Status.Family.SUCCESSFUL);
-
assertThat(response.getStatus()).isEqualTo(Response.Status.OK.getStatusCode());
+ interface Scenario {
+ String uri();
+ }
- // and also JSON response
- assertResponseOK(response);
- var entity = response.readEntity(String.class);
- assertNotNull(entity);
+ @RequiredArgsConstructor
+ enum Basic implements Scenario {
+ DEPARTMENT_KEY_AS_VALUE,
+ DEPARTMENT_KEY_AS_MAP;
+ @Override public String uri() { return
"services/university.dept.Staff/actions/createStaffMemberWithPhoto/invoke"; }
+ }
- // and also object is created in database
- final var bookmarkAfterIfAny =
transactionService.callTransactional(Propagation.REQUIRED, () -> {
- final var staffMember =
staffMemberRepository.findByName(staffName);
- return bookmarkService.bookmarkFor(staffMember);
- }).valueAsNonNullElseFail();
- assertThat(bookmarkAfterIfAny).isNotEmpty();
+ enum Bookmarked implements Scenario {
+ DEPARTMENT_BOOKMARK_AS_VALUE,
+ DEPARTMENT_BOOKMARK_AS_MAP;
+ @Override public String uri() { return
"services/university.dept.Staff/actions/createStaffMemberWithPhoto2/invoke"; }
}
- @Test
+ @ParameterizedTest
+ @EnumSources({
+ @EnumSource(Basic.class),
+ @EnumSource(Bookmarked.class)
+ })
@UseReporter(DiffReporter.class)
@SneakyThrows
- void createStaffMemberWithPhoto_using_map() {
+ void createStaffMemberWithPhoto(final Scenario scenario) {
- // given
- final var staffName = "Fred Smith";
-
- final var bookmarkBeforeIfAny =
transactionService.callTransactional(Propagation.REQUIRED, () -> {
- final var staffMember =
staffMemberRepository.findByName(staffName);
- return bookmarkService.bookmarkFor(staffMember);
- }).valueAsNonNullElseFail();
-
- assertThat(bookmarkBeforeIfAny).isEmpty();
+ prolog();
+ // given
final Blob photo = readFileAsBlob("StaffMember-photo-Bar.pdf");
- final var requestBuilder =
restfulClient.request("services/university.dept.Staff/actions/createStaffMemberWithPhoto/invoke");
-
- var args = restfulClient.arguments()
- .addActionParameter("name", staffName)
- .addActionParameter("departmentSecondaryKey", Map.of("name",
"Classics"))
- .addActionParameter("photo", photo)
- .build();
- Approvals.verify(args.getEntity(), jsonOptions());
+ var argModel = ActionParameterModel.create(baseUrl())
+ .addActionParameter("name", staffName);
+
+ if(scenario instanceof Basic basic) {
+ argModel = switch(basic) {
+ case DEPARTMENT_KEY_AS_VALUE->
+ argModel.addActionParameter("departmentSecondaryKey",
Department.SecondaryKey.class, new Department.SecondaryKey("Classics"));
+ case DEPARTMENT_KEY_AS_MAP->
+ argModel.addActionParameter("departmentSecondaryKey",
Map.of("name", "Classics"));
+ };
+ } else if(scenario instanceof Bookmarked bookmarked) {
+ var bookmark = departmentBookmark("Classics");
+ argModel = switch(bookmarked) {
+ case DEPARTMENT_BOOKMARK_AS_VALUE->
+ argModel.addActionParameter("department", bookmark);
+ case DEPARTMENT_BOOKMARK_AS_MAP->
+ argModel.addActionParameter("department", Map.of("href",
asAbsoluteHref(bookmark)));
+ };
+ }
+ argModel = argModel.addActionParameter("photo", photo);
+
+ Approvals.settings().allowMultipleVerifyCallsForThisMethod();
+ Approvals.verify(argModel.toJson(),
jsonOptions(Approvals.NAMES.withParameters(scenario.toString())));
// when
- var response = requestBuilder.post(args);
+ final var response = restClient(log).build()
+ .post()
+ .uri(scenario.uri())
+ .body(argModel.toJson())
+ .retrieve()
+ .onStatus(assertStatusOkResponseErrorHandler());
// then
-
assertThat(response.getStatusInfo().getFamily()).isEqualTo(Response.Status.Family.SUCCESSFUL);
-
assertThat(response.getStatus()).isEqualTo(Response.Status.OK.getStatusCode());
-
- // and also json response
- assertResponseOK(response);
- var entity = response.readEntity(String.class);
+ var entity = response.body(String.class);
assertNotNull(entity);
- // and also object is created in database
- final var bookmarkAfterIfAny =
transactionService.callTransactional(Propagation.REQUIRED, () -> {
- final var staffMember =
staffMemberRepository.findByName(staffName);
- return bookmarkService.bookmarkFor(staffMember);
- }).valueAsNonNullElseFail();
- assertThat(bookmarkAfterIfAny).isNotEmpty();
+ epilog();
}
- @Test
- @UseReporter(DiffReporter.class)
- @SneakyThrows
- void createStaffMemberWithPhoto2() {
-
- // given
- final var staffName = "Fred Smith";
-
- _Debug.log("PHASE 1
-----------------------------------------------------------");
+ // -- HELPER
+ void prolog() {
final var bookmarkBeforeIfAny =
transactionService.callTransactional(Propagation.REQUIRED, () -> {
final var staffMember =
staffMemberRepository.findByName(staffName);
return bookmarkService.bookmarkFor(staffMember);
}).valueAsNonNullElseFail();
assertThat(bookmarkBeforeIfAny).isEmpty();
+ }
- _Debug.log("PHASE 2
-----------------------------------------------------------");
-
- // and given
- final var departmentName = "Classics";
- final var departmentBookmark =
transactionService.callTransactional(Propagation.REQUIRED, () -> {
- final var staffMember =
departmentRepository.findByName(departmentName);
- return bookmarkService.bookmarkFor(staffMember).orElseThrow();
- }).valueAsNonNullElseFail();
-
-
- _Debug.log("PHASE 3
-----------------------------------------------------------");
-
- // and given
- final Blob photo = readFileAsBlob("StaffMember-photo-Bar.pdf");
- final var requestBuilder =
restfulClient.request("services/university.dept.Staff/actions/createStaffMemberWithPhoto2/invoke");
-
- var args = restfulClient.arguments()
- .addActionParameter("name", staffName)
- .addActionParameter("department", departmentBookmark)
- .addActionParameter("photo", photo)
- .build();
-
- Approvals.verify(args.getEntity(), jsonOptions());
-
- _Debug.log("PHASE 4
-----------------------------------------------------------");
-
- // when
- var response = requestBuilder.post(args);
-
- // then
-
assertThat(response.getStatusInfo().getFamily()).isEqualTo(Response.Status.Family.SUCCESSFUL);
-
assertThat(response.getStatus()).isEqualTo(Response.Status.OK.getStatusCode());
-
- // and also json response
- assertResponseOK(response);
- var entity = response.readEntity(String.class);
- assertNotNull(entity);
-
- _Debug.log("PHASE 5
-----------------------------------------------------------");
-
+ void epilog() {
// and also object is created in database
final var bookmarkAfterIfAny =
transactionService.callTransactional(Propagation.REQUIRED, () -> {
final var staffMember =
staffMemberRepository.findByName(staffName);
@@ -206,73 +139,11 @@ void createStaffMemberWithPhoto2() {
assertThat(bookmarkAfterIfAny).isNotEmpty();
}
- @Test
- @UseReporter(DiffReporter.class)
- @SneakyThrows
- void createStaffMemberWithPhoto2_using_map() {
-
- // given
- final var staffName = "Fred Smith";
-
- _Debug.log("PHASE 1
-----------------------------------------------------------");
-
- final var bookmarkBeforeIfAny =
transactionService.callTransactional(Propagation.REQUIRED, () -> {
- final var staffMember =
staffMemberRepository.findByName(staffName);
- return bookmarkService.bookmarkFor(staffMember);
- }).valueAsNonNullElseFail();
-
- assertThat(bookmarkBeforeIfAny).isEmpty();
-
- _Debug.log("PHASE 2
-----------------------------------------------------------");
-
- // and given
- final var departmentName = "Classics";
- final var departmentBookmark =
transactionService.callTransactional(Propagation.REQUIRED, () -> {
+ Bookmark departmentBookmark(final String departmentName) {
+ return transactionService.callTransactional(Propagation.REQUIRED, ()
-> {
final var staffMember =
departmentRepository.findByName(departmentName);
return bookmarkService.bookmarkFor(staffMember).orElseThrow();
}).valueAsNonNullElseFail();
-
- _Debug.log("PHASE 3
-----------------------------------------------------------");
-
- // and given
- final Blob photo = readFileAsBlob("StaffMember-photo-Bar.pdf");
- final var requestBuilder =
restfulClient.request("services/university.dept.Staff/actions/createStaffMemberWithPhoto2/invoke");
-
- /*
- * String name,
- * Department.SecondaryKey departmentSecondaryKey,
- * Blob photo
- */
- var args = restfulClient.arguments()
- .addActionParameter("name", staffName)
- .addActionParameter("department", Map.of("href",
asAbsoluteHref(departmentBookmark)))
- .addActionParameter("photo", photo)
- .build();
-
- Approvals.verify(args.getEntity(), jsonOptions());
-
- _Debug.log("PHASE 4
-----------------------------------------------------------");
-
- // when
- var response = requestBuilder.post(args);
-
- // then
-
assertThat(response.getStatusInfo().getFamily()).isEqualTo(Response.Status.Family.SUCCESSFUL);
-
assertThat(response.getStatus()).isEqualTo(Response.Status.OK.getStatusCode());
-
- // and also json response
- assertResponseOK(response);
- var entity = response.readEntity(String.class);
- assertNotNull(entity);
-
- _Debug.log("PHASE 5
-----------------------------------------------------------");
-
- // and also object is created in database
- final var bookmarkAfterIfAny =
transactionService.callTransactional(Propagation.REQUIRED, () -> {
- final var staffMember =
staffMemberRepository.findByName(staffName);
- return bookmarkService.bookmarkFor(staffMember);
- }).valueAsNonNullElseFail();
- assertThat(bookmarkAfterIfAny).isNotEmpty();
}
private Blob readFileAsBlob(final String fileName) {
