From ab718d73ce25edf2c8a92d10cea13d594be46e62 Mon Sep 17 00:00:00 2001 From: Piotr Jaszczyk Date: Wed, 20 Mar 2019 14:49:13 +0100 Subject: Create an evolution of HTTP Client * simplify the API * use new http client in old one for compatibility * deprecate old one Issue-ID: DCAEGEN2-1010 Change-Id: Ief681ba536a37b29c10d133c61a1326a003ed308 Signed-off-by: Piotr Jaszczyk --- .../services/adapters/http/CloudHttpClient.java | 171 ++++++++------------- .../rest/services/adapters/http/HttpMethod.java | 48 ++++++ .../rest/services/adapters/http/HttpRequest.java | 68 ++++++++ .../rest/services/adapters/http/HttpResponse.java | 77 ++++++++++ .../services/adapters/http/NettyHttpResponse.java | 73 +++++++++ .../rest/services/adapters/http/RequestBody.java | 53 +++++++ .../rest/services/adapters/http/RxHttpClient.java | 91 +++++++++++ .../adapters/http/exceptions/HttpException.java | 45 ++++++ .../adapters/http/test/DummyHttpServer.java | 88 +++++++++++ .../services/adapters/http/CloudHttpClientIT.java | 82 +++++----- .../services/adapters/http/RxHttpClientIT.java | 110 +++++++++++++ 11 files changed, 764 insertions(+), 142 deletions(-) create mode 100644 rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/HttpMethod.java create mode 100644 rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/HttpRequest.java create mode 100644 rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/HttpResponse.java create mode 100644 rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/NettyHttpResponse.java create mode 100644 rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/RequestBody.java create mode 100644 rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/RxHttpClient.java create mode 100644 rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/exceptions/HttpException.java create mode 100644 rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/test/DummyHttpServer.java create mode 100644 rest-services/common-dependency/src/test/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/RxHttpClientIT.java (limited to 'rest-services/common-dependency/src') diff --git a/rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/CloudHttpClient.java b/rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/CloudHttpClient.java index ac790cb2..e83a069e 100644 --- a/rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/CloudHttpClient.java +++ b/rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/CloudHttpClient.java @@ -21,139 +21,102 @@ package org.onap.dcaegen2.services.sdk.rest.services.adapters.http; import com.google.gson.Gson; -import io.netty.handler.codec.http.HttpStatusClass; import io.netty.handler.ssl.SslContext; -import io.vavr.collection.Stream; -import java.io.IOException; +import io.vavr.collection.HashMap; import java.util.Collections; import java.util.Map; -import java.util.function.BiConsumer; -import java.util.stream.Collectors; import org.onap.dcaegen2.services.sdk.rest.services.model.ClientModel; import org.onap.dcaegen2.services.sdk.rest.services.model.JsonBodyBuilder; import org.onap.dcaegen2.services.sdk.rest.services.model.logging.RequestDiagnosticContext; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; import reactor.core.publisher.Mono; -import reactor.netty.ByteBufFlux; import reactor.netty.http.client.HttpClient; -import reactor.netty.http.client.HttpClientRequest; import reactor.netty.http.client.HttpClientResponse; /** * @author Przemysław Wąsala on 11/15/18 + * @deprecated use {@link RxHttpClient} instead */ - +@Deprecated public class CloudHttpClient { - private static final Logger LOGGER = LoggerFactory.getLogger(CloudHttpClient.class); private final Gson gson = new Gson(); - private final HttpClient httpClient; - - public CloudHttpClient() { - this(HttpClient.create()); - } + private final RxHttpClient httpClient; - public CloudHttpClient(SslContext sslContext) { - this(HttpClient.create().secure(sslContextSpec -> sslContextSpec.sslContext(sslContext))); - } - - CloudHttpClient(HttpClient httpClient) { + CloudHttpClient(RxHttpClient httpClient) { this.httpClient = httpClient; - } - - - @Deprecated - public Mono get(String url, RequestDiagnosticContext context, Class bodyClass) { - return get(url, context, Collections.EMPTY_MAP, bodyClass); + public CloudHttpClient() { + this(RxHttpClient.create()); } - @Deprecated - public Mono get(String url, RequestDiagnosticContext context, Map customHeaders, - Class bodyClass) { - final HttpClient clientWithHeaders = getHttpClientWithHeaders(context, customHeaders); - return callHttpGet(clientWithHeaders, url, bodyClass); + public CloudHttpClient(SslContext sslContext) { + this(RxHttpClient.create(sslContext)); } public Mono get(String url, Class bodyClass) { - return callHttpGet(httpClient, url, bodyClass); - } - - public Mono post(String url, RequestDiagnosticContext context, Map customHeaders, - JsonBodyBuilder jsonBodyBuilder, ClientModel clientModel) { - final HttpClient clientWithHeaders = getHttpClientWithHeaders(context, customHeaders); - return callHttpPost(clientWithHeaders, url, jsonBodyBuilder, clientModel); + return get(url, RequestDiagnosticContext.create(), bodyClass); } - public Mono patch(String url, RequestDiagnosticContext context, Map customHeaders, - JsonBodyBuilder jsonBodyBuilder, ClientModel clientModel) { - final HttpClient clientWithHeaders = getHttpClientWithHeaders(context, customHeaders); - return callHttpPatch(clientWithHeaders, url, jsonBodyBuilder, clientModel); - } - - private HttpClient getHttpClientWithHeaders(RequestDiagnosticContext context, Map customHeaders) { - final HttpClient clientWithHeaders = httpClient - .doOnRequest((req, conn) -> logRequest(context, req)) - .doOnResponse((rsp, conn) -> logResponse(context, rsp)) - .headers(hdrs -> context.remoteCallHttpHeaders().forEach((BiConsumer) hdrs::set)) - .headers(hdrs -> customHeaders.forEach(hdrs::set)); - return clientWithHeaders; - } - - private Mono callHttpGet(HttpClient client, String url, Class bodyClass) { - return client.get() - .uri(url) - .responseSingle((resp, content) -> HttpStatusClass.SUCCESS.contains(resp.status().code()) - ? content.asString() - : Mono.error(createException(url, resp))) - .map(body -> parseJson(body, bodyClass)); - } - - private Mono callHttpPost(HttpClient client, String url, - JsonBodyBuilder jsonBodyBuilder, T clientModel) { - return client.baseUrl(url).post() - .send(ByteBufFlux.fromString(Mono.just(jsonBodyBuilder.createJsonBody(clientModel)))) - .responseSingle((httpClientResponse, byteBufMono) -> Mono.just(httpClientResponse)); - } - - private Mono callHttpPatch(HttpClient client, String url, - JsonBodyBuilder jsonBodyBuilder, T clientModel) { - String jsonBodyRequest = jsonBodyBuilder.createJsonBody(clientModel); - LOGGER.debug( String.format("Json body request: %s ",jsonBodyRequest)); - return client.baseUrl(url).patch() - .send(ByteBufFlux.fromString(Mono.just(jsonBodyRequest))) - .responseSingle((httpClientResponse, byteBufMono) -> Mono.just(httpClientResponse)); - } - - private Exception createException(String url, HttpClientResponse response) { - return new IOException(String.format("Request failed for URL '%s'. Response code: %s", - url, - response.status())); - } - - private T parseJson(String body, Class bodyClass) { - return gson.fromJson(body, bodyClass); - } - - private void logRequest(RequestDiagnosticContext context, HttpClientRequest httpClientRequest) { - context.withSlf4jMdc(LOGGER.isDebugEnabled(), () -> { - LOGGER.debug("Request: {} {} {}", httpClientRequest.method(), httpClientRequest.uri(), httpClientRequest.requestHeaders()); - if (LOGGER.isTraceEnabled()) { - final String headers = Stream.ofAll(httpClientRequest.requestHeaders()) - .map(entry -> entry.getKey() + "=" + entry.getValue()) - .collect(Collectors.joining("\n")); - LOGGER.trace(headers); - } - }); + public Mono get(String url, RequestDiagnosticContext context, Class bodyClass) { + return get(url, context, Collections.emptyMap(), bodyClass); + } + + public Mono get( + String url, + RequestDiagnosticContext context, + Map customHeaders, + Class bodyClass) { + return httpClient.call( + ImmutableHttpRequest.builder() + .method(HttpMethod.GET) + .url(url) + .customHeaders(HashMap.ofAll(customHeaders)) + .diagnosticContext(context) + .build()) + .doOnNext(HttpResponse::throwIfUnsuccessful) + .map(HttpResponse::bodyAsString) + .map(body -> gson.fromJson(body, bodyClass)); + } + + + public Mono post( + String url, + RequestDiagnosticContext context, + Map customHeaders, + JsonBodyBuilder jsonBodyBuilder, + ClientModel clientModel) { + return callForRawResponse(url, context, customHeaders, jsonBodyBuilder, clientModel, HttpMethod.POST); + } + + public Mono patch( + String url, + RequestDiagnosticContext context, + Map customHeaders, + JsonBodyBuilder jsonBodyBuilder, + ClientModel clientModel) { + return callForRawResponse(url, context, customHeaders, jsonBodyBuilder, clientModel, HttpMethod.PATCH); + } + + + private Mono callForRawResponse( + String url, + RequestDiagnosticContext context, + Map customHeaders, + JsonBodyBuilder jsonBodyBuilder, + ClientModel clientModel, + HttpMethod method) { + return httpClient.prepareRequest( + ImmutableHttpRequest.builder() + .url(url) + .customHeaders(HashMap.ofAll(customHeaders)) + .diagnosticContext(context) + .body(RequestBody.fromString(jsonBodyBuilder.createJsonBody(clientModel))) + .method(method) + .build()) + .responseSingle((httpClientResponse, byteBufMono) -> Mono.just(httpClientResponse)); } - private void logResponse(RequestDiagnosticContext context, HttpClientResponse httpClientResponse) { - context.withSlf4jMdc(LOGGER.isDebugEnabled(), () -> { - LOGGER.debug("Response status: {}", httpClientResponse.status()); - }); - } } diff --git a/rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/HttpMethod.java b/rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/HttpMethod.java new file mode 100644 index 00000000..78e6789e --- /dev/null +++ b/rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/HttpMethod.java @@ -0,0 +1,48 @@ +/* + * ============LICENSE_START==================================== + * DCAEGEN2-SERVICES-SDK + * ========================================================= + * Copyright (C) 2019 Nokia. All rights reserved. + * ========================================================= + * Licensed 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. + * ============LICENSE_END===================================== + */ + +package org.onap.dcaegen2.services.sdk.rest.services.adapters.http; + +/** + * @author Piotr Jaszczyk + * @since March 2019 + */ +public enum HttpMethod { + + CONNECT(io.netty.handler.codec.http.HttpMethod.CONNECT), + DELETE(io.netty.handler.codec.http.HttpMethod.DELETE), + GET(io.netty.handler.codec.http.HttpMethod.GET), + HEAD(io.netty.handler.codec.http.HttpMethod.HEAD), + OPTIONS(io.netty.handler.codec.http.HttpMethod.OPTIONS), + POST(io.netty.handler.codec.http.HttpMethod.POST), + PATCH(io.netty.handler.codec.http.HttpMethod.PATCH), + PUT(io.netty.handler.codec.http.HttpMethod.PUT), + TRACE(io.netty.handler.codec.http.HttpMethod.TRACE); + + private final io.netty.handler.codec.http.HttpMethod nettyMethod; + + HttpMethod(io.netty.handler.codec.http.HttpMethod nettyMethod) { + this.nettyMethod = nettyMethod; + } + + io.netty.handler.codec.http.HttpMethod asNetty() { + return nettyMethod; + } +} diff --git a/rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/HttpRequest.java b/rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/HttpRequest.java new file mode 100644 index 00000000..78660833 --- /dev/null +++ b/rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/HttpRequest.java @@ -0,0 +1,68 @@ +/* + * ============LICENSE_START==================================== + * DCAEGEN2-SERVICES-SDK + * ========================================================= + * Copyright (C) 2019 Nokia. All rights reserved. + * ========================================================= + * Licensed 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. + * ============LICENSE_END===================================== + */ + +package org.onap.dcaegen2.services.sdk.rest.services.adapters.http; + +import io.netty.buffer.ByteBuf; +import io.vavr.collection.HashMap; +import io.vavr.collection.Map; +import java.util.function.BiFunction; +import org.immutables.value.Value; +import org.jetbrains.annotations.Nullable; +import org.onap.dcaegen2.services.sdk.rest.services.model.logging.RequestDiagnosticContext; +import org.reactivestreams.Publisher; +import reactor.core.publisher.Mono; +import reactor.netty.NettyOutbound; +import reactor.netty.http.client.HttpClientRequest; + +/** + * @author Piotr Jaszczyk + * @since March 2019 + */ +@Value.Immutable +public interface HttpRequest { + + String url(); + + HttpMethod method(); + + @Value.Default + default RequestDiagnosticContext diagnosticContext() { + return RequestDiagnosticContext.create(); + } + + @Value.Default + default Map customHeaders() { + return HashMap.empty(); + } + + @Value.Default + default Publisher body() { + return Mono.empty(); + } + + @Value.Derived + default Map headers() { + final RequestDiagnosticContext ctx = diagnosticContext(); + return ctx == null + ? customHeaders() + : customHeaders().merge(ctx.remoteCallHttpHeaders()); + } +} diff --git a/rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/HttpResponse.java b/rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/HttpResponse.java new file mode 100644 index 00000000..ce100478 --- /dev/null +++ b/rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/HttpResponse.java @@ -0,0 +1,77 @@ +/* + * ============LICENSE_START==================================== + * DCAEGEN2-SERVICES-SDK + * ========================================================= + * Copyright (C) 2019 Nokia. All rights reserved. + * ========================================================= + * Licensed 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. + * ============LICENSE_END===================================== + */ + +package org.onap.dcaegen2.services.sdk.rest.services.adapters.http; + +import com.google.gson.Gson; +import java.nio.charset.Charset; +import java.nio.charset.StandardCharsets; +import org.immutables.value.Value; +import org.onap.dcaegen2.services.sdk.rest.services.adapters.http.exceptions.HttpException; + +/** + * @author Piotr Jaszczyk + * @since March 2019 + */ +@Value.Immutable +public interface HttpResponse { + + String url(); + + int statusCode(); + + byte[] rawBody(); + + @Value.Default + default String statusReason() { + return ""; + } + + @Value.Derived + default boolean successful() { + return statusCode() >= 200 && statusCode() < 300; + } + + @Value.Derived + default String bodyAsString() { + return bodyAsString(StandardCharsets.UTF_8); + } + + @Value.Derived + default String bodyAsString(Charset charset) { + return new String(rawBody(), charset); + } + + @Value.Derived + default T bodyAsJson(Class clazz) { + return bodyAsJson(StandardCharsets.UTF_8, new Gson(), clazz); + } + + @Value.Derived + default T bodyAsJson(Charset charset, Gson gson, Class clazz) { + return gson.fromJson(bodyAsString(charset), clazz); + } + + default void throwIfUnsuccessful() { + if (!successful()) { + throw new HttpException(url(), statusCode(), statusReason()); + } + } +} diff --git a/rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/NettyHttpResponse.java b/rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/NettyHttpResponse.java new file mode 100644 index 00000000..3dcd7098 --- /dev/null +++ b/rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/NettyHttpResponse.java @@ -0,0 +1,73 @@ +/* + * ============LICENSE_START==================================== + * DCAEGEN2-SERVICES-SDK + * ========================================================= + * Copyright (C) 2019 Nokia. All rights reserved. + * ========================================================= + * Licensed 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. + * ============LICENSE_END===================================== + */ + +package org.onap.dcaegen2.services.sdk.rest.services.adapters.http; + +import io.netty.handler.codec.http.HttpResponseStatus; +import io.netty.handler.codec.http.HttpStatusClass; +import java.nio.charset.Charset; + +/** + * @author Piotr Jaszczyk + * @since March 2019 + */ +class NettyHttpResponse implements HttpResponse { + + private final String url; + private final HttpResponseStatus status; + private final byte[] body; + + NettyHttpResponse(String url, HttpResponseStatus status, byte[] body) { + this.url = url; + this.status = status; + this.body = body; + } + + @Override + public String url() { + return url; + } + + @Override + public boolean successful() { + return status.codeClass() == HttpStatusClass.SUCCESS; + } + + @Override + public int statusCode() { + return status.code(); + } + + @Override + public String statusReason() { + return status.reasonPhrase(); + } + + @Override + public byte[] rawBody() { + return new byte[0]; + } + + @Override + public String bodyAsString(Charset charset) { + return new String(body, charset); + } + +} diff --git a/rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/RequestBody.java b/rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/RequestBody.java new file mode 100644 index 00000000..514ea0bf --- /dev/null +++ b/rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/RequestBody.java @@ -0,0 +1,53 @@ +/* + * ============LICENSE_START==================================== + * DCAEGEN2-SERVICES-SDK + * ========================================================= + * Copyright (C) 2019 Nokia. All rights reserved. + * ========================================================= + * Licensed 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. + * ============LICENSE_END===================================== + */ + +package org.onap.dcaegen2.services.sdk.rest.services.adapters.http; + +import com.google.gson.JsonElement; +import io.netty.buffer.ByteBuf; +import io.netty.buffer.ByteBufAllocator; +import java.nio.charset.Charset; +import java.nio.charset.StandardCharsets; +import org.reactivestreams.Publisher; +import reactor.core.publisher.Mono; +import reactor.netty.ByteBufFlux; + +/** + * @author Piotr Jaszczyk + * @since March 2019 + */ +public final class RequestBody { + + private RequestBody() { + } + + public static Publisher fromString(String contents) { + return fromString(contents, StandardCharsets.UTF_8); + } + + public static Publisher fromString(String contents, Charset charset) { + return ByteBufFlux.fromString(Mono.just(contents), charset, ByteBufAllocator.DEFAULT); + } + + public static Publisher fromJson(JsonElement contents) { + return fromString(contents.toString()); + } + +} diff --git a/rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/RxHttpClient.java b/rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/RxHttpClient.java new file mode 100644 index 00000000..f384c1c1 --- /dev/null +++ b/rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/RxHttpClient.java @@ -0,0 +1,91 @@ +/* + * ============LICENSE_START==================================== + * DCAEGEN2-SERVICES-SDK + * ========================================================= + * Copyright (C) 2019 Nokia. All rights reserved. + * ========================================================= + * Licensed 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. + * ============LICENSE_END===================================== + */ +package org.onap.dcaegen2.services.sdk.rest.services.adapters.http; + +import io.netty.handler.ssl.SslContext; +import io.vavr.collection.Stream; +import java.util.stream.Collectors; +import org.onap.dcaegen2.services.sdk.rest.services.model.logging.RequestDiagnosticContext; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import reactor.core.publisher.Mono; +import reactor.netty.http.client.HttpClient; +import reactor.netty.http.client.HttpClient.ResponseReceiver; +import reactor.netty.http.client.HttpClientRequest; +import reactor.netty.http.client.HttpClientResponse; + +/** + * @since 1.1.4 + */ +public class RxHttpClient { + + private static final Logger LOGGER = LoggerFactory.getLogger(RxHttpClient.class); + private final HttpClient httpClient; + + public static RxHttpClient create() { + return new RxHttpClient(HttpClient.create()); + } + + // TODO: hide netty from public api (io.netty.handler.ssl.SslContext) + public static RxHttpClient create(SslContext sslContext) { + return new RxHttpClient(HttpClient.create().secure(sslContextSpec -> sslContextSpec.sslContext(sslContext))); + } + + RxHttpClient(HttpClient httpClient) { + this.httpClient = httpClient; + } + + public Mono call(HttpRequest request) { + return prepareRequest(request) + .responseSingle((resp, content) -> + content.asByteArray() + .defaultIfEmpty(new byte[0]) + .map(bytes -> new NettyHttpResponse(request.url(), resp.status(), bytes))); + } + + ResponseReceiver prepareRequest(HttpRequest request) { + return httpClient + .doOnRequest((req, conn) -> logRequest(request.diagnosticContext(), req)) + .doOnResponse((rsp, conn) -> logResponse(request.diagnosticContext(), rsp)) + .headers(hdrs -> request.headers().forEach(hdr -> hdrs.set(hdr._1, hdr._2))) + .request(request.method().asNetty()) + .send(request.body()) + .uri(request.url()); + + } + + private void logRequest(RequestDiagnosticContext context, HttpClientRequest httpClientRequest) { + context.withSlf4jMdc(LOGGER.isDebugEnabled(), () -> { + LOGGER.debug("Request: {} {} {}", httpClientRequest.method(), httpClientRequest.uri(), + httpClientRequest.requestHeaders()); + if (LOGGER.isTraceEnabled()) { + final String headers = Stream.ofAll(httpClientRequest.requestHeaders()) + .map(entry -> entry.getKey() + "=" + entry.getValue()) + .collect(Collectors.joining("\n")); + LOGGER.trace(headers); + } + }); + } + + private void logResponse(RequestDiagnosticContext context, HttpClientResponse httpClientResponse) { + context.withSlf4jMdc(LOGGER.isDebugEnabled(), + () -> LOGGER.debug("Response status: {}", httpClientResponse.status())); + } +} diff --git a/rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/exceptions/HttpException.java b/rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/exceptions/HttpException.java new file mode 100644 index 00000000..9631f4c5 --- /dev/null +++ b/rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/exceptions/HttpException.java @@ -0,0 +1,45 @@ +/* + * ============LICENSE_START==================================== + * DCAEGEN2-SERVICES-SDK + * ========================================================= + * Copyright (C) 2019 Nokia. All rights reserved. + * ========================================================= + * Licensed 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. + * ============LICENSE_END===================================== + */ +package org.onap.dcaegen2.services.sdk.rest.services.adapters.http.exceptions; + +/** + * @author Piotr Jaszczyk + * @since March 2019 + */ +public class HttpException extends RuntimeException { + + private final String url; + private final int responseCode; + private final String reason; + + public HttpException(String url, int responseCode, String reason) { + this.url = url; + this.responseCode = responseCode; + this.reason = reason; + } + + @Override + public String getMessage() { + return String.format("Request failed for URL '%s'. Response code: %d %s", + url, + responseCode, + reason); + } +} diff --git a/rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/test/DummyHttpServer.java b/rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/test/DummyHttpServer.java new file mode 100644 index 00000000..e565c786 --- /dev/null +++ b/rest-services/common-dependency/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/test/DummyHttpServer.java @@ -0,0 +1,88 @@ +/* + * ============LICENSE_START==================================== + * DCAEGEN2-SERVICES-SDK + * ========================================================= + * Copyright (C) 2019 Nokia. All rights reserved. + * ========================================================= + * Licensed 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. + * ============LICENSE_END===================================== + */ + +package org.onap.dcaegen2.services.sdk.rest.services.adapters.http.test; + +import io.vavr.CheckedFunction0; +import java.net.URL; +import java.nio.file.Files; +import java.nio.file.Paths; +import java.util.function.Consumer; +import org.reactivestreams.Publisher; +import reactor.core.publisher.Mono; +import reactor.netty.DisposableServer; +import reactor.netty.http.server.HttpServer; +import reactor.netty.http.server.HttpServerResponse; +import reactor.netty.http.server.HttpServerRoutes; + +/** + * @author Piotr Jaszczyk + * @since February 2019 + */ +public class DummyHttpServer { + + private final DisposableServer server; + + private DummyHttpServer(DisposableServer server) { + this.server = server; + } + + public static DummyHttpServer start(Consumer routes) { + return new DummyHttpServer(HttpServer.create() + .host("127.0.0.1") + .route(routes) + .bind() + .block()); + } + + public static Publisher sendResource(HttpServerResponse httpServerResponse, String resourcePath) { + return sendString(httpServerResponse, Mono.fromCallable(() -> readResource(resourcePath))); + } + + public static Publisher sendString(HttpServerResponse httpServerResponse, Publisher content) { + return httpServerResponse.sendString(content); + } + + public void close() { + server.disposeNow(); + } + + public String host() { + return server.host(); + } + + public int port() { + return server.port(); + } + + private static String readResource(String resourcePath) { + try { + return CheckedFunction0.constant(resourcePath) + .andThen(DummyHttpServer.class::getResource) + .andThen(URL::toURI) + .andThen(Paths::get) + .andThen(Files::readAllBytes) + .andThen(String::new) + .apply(); + } catch (Throwable throwable) { + throw new RuntimeException(throwable); + } + } +} diff --git a/rest-services/common-dependency/src/test/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/CloudHttpClientIT.java b/rest-services/common-dependency/src/test/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/CloudHttpClientIT.java index 936ef0c5..a913a93f 100644 --- a/rest-services/common-dependency/src/test/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/CloudHttpClientIT.java +++ b/rest-services/common-dependency/src/test/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/CloudHttpClientIT.java @@ -42,26 +42,28 @@ import reactor.test.StepVerifier; import reactor.netty.http.client.HttpClientResponse; class CloudHttpClientIT { + private static final int MAX_CONNECTIONS = 1; private static final String SAMPLE_STRING = "sampleString"; private static final String SAMPLE_URL = "/sampleURL"; private static final String JSON_BODY = "{\"correlationId\":\"NOKnhfsadhff\"," - + "\"ipaddress-v4\":\"256.22.33.155\", " - + "\"ipaddress-v6\":\"200J:0db8:85a3:0000:0000:8a2e:0370:7334\"}"; + + "\"ipaddress-v4\":\"256.22.33.155\", " + + "\"ipaddress-v6\":\"200J:0db8:85a3:0000:0000:8a2e:0370:7334\"}"; private static final ConnectionProvider connectionProvider = ConnectionProvider.fixed("test", MAX_CONNECTIONS); - private DmaapModel dmaapModel = mock(DmaapModel.class); - private JsonBodyBuilder jsonBodyBuilder = mock(JsonBodyBuilder.class); + private final DmaapModel dmaapModel = mock(DmaapModel.class); + private final JsonBodyBuilder jsonBodyBuilder = mock(JsonBodyBuilder.class); @Test void successfulPatchResponse() { DisposableServer server = createValidServer(); - HttpClient httpClient = createHttpClientForContextWithAddress(server, connectionProvider); + RxHttpClient httpClient = createHttpClientForContextWithAddress(server); CloudHttpClient cloudHttpClient = new CloudHttpClient(httpClient); when(jsonBodyBuilder.createJsonBody(dmaapModel)).thenReturn(JSON_BODY); - Mono content = cloudHttpClient.patch(SAMPLE_URL, createRequestDiagnosticContext(), createCustomHeaders(), - jsonBodyBuilder, dmaapModel); + Mono content = cloudHttpClient + .patch(SAMPLE_URL, createRequestDiagnosticContext(), createCustomHeaders(), + jsonBodyBuilder, dmaapModel); HttpClientResponse httpClientResponse = content.block(); assertEquals(HttpResponseStatus.OK, httpClientResponse.status()); @@ -71,12 +73,13 @@ class CloudHttpClientIT { @Test void errorPatchRequest() { DisposableServer server = createInvalidServer(); - HttpClient httpClient = createHttpClientForContextWithAddress(server, connectionProvider); + RxHttpClient httpClient = createHttpClientForContextWithAddress(server); CloudHttpClient cloudHttpClient = new CloudHttpClient(httpClient); when(jsonBodyBuilder.createJsonBody(dmaapModel)).thenReturn(JSON_BODY); - Mono content = cloudHttpClient.patch(SAMPLE_URL, createRequestDiagnosticContext(), createCustomHeaders(), - jsonBodyBuilder, dmaapModel); + Mono content = cloudHttpClient + .patch(SAMPLE_URL, createRequestDiagnosticContext(), createCustomHeaders(), + jsonBodyBuilder, dmaapModel); HttpClientResponse httpClientResponse = content.block(); assertEquals(HttpResponseStatus.INTERNAL_SERVER_ERROR, httpClientResponse.status()); @@ -86,12 +89,13 @@ class CloudHttpClientIT { @Test void successfulPostResponse() { DisposableServer server = createValidServer(); - HttpClient httpClient = createHttpClientForContextWithAddress(server, connectionProvider); + RxHttpClient httpClient = createHttpClientForContextWithAddress(server); CloudHttpClient cloudHttpClient = new CloudHttpClient(httpClient); when(jsonBodyBuilder.createJsonBody(dmaapModel)).thenReturn(JSON_BODY); - Mono content = cloudHttpClient.post(SAMPLE_URL, createRequestDiagnosticContext(), createCustomHeaders(), - jsonBodyBuilder, dmaapModel); + Mono content = cloudHttpClient + .post(SAMPLE_URL, createRequestDiagnosticContext(), createCustomHeaders(), + jsonBodyBuilder, dmaapModel); HttpClientResponse httpClientResponse = content.block(); assertEquals(HttpResponseStatus.OK, httpClientResponse.status()); @@ -101,12 +105,13 @@ class CloudHttpClientIT { @Test void errorPostRequest() { DisposableServer server = createInvalidServer(); - HttpClient httpClient = createHttpClientForContextWithAddress(server, connectionProvider); + RxHttpClient httpClient = createHttpClientForContextWithAddress(server); CloudHttpClient cloudHttpClient = new CloudHttpClient(httpClient); when(jsonBodyBuilder.createJsonBody(dmaapModel)).thenReturn(JSON_BODY); - Mono content = cloudHttpClient.post(SAMPLE_URL, createRequestDiagnosticContext(), createCustomHeaders(), - jsonBodyBuilder, dmaapModel); + Mono content = cloudHttpClient + .post(SAMPLE_URL, createRequestDiagnosticContext(), createCustomHeaders(), + jsonBodyBuilder, dmaapModel); HttpClientResponse httpClientResponse = content.block(); assertEquals(HttpResponseStatus.INTERNAL_SERVER_ERROR, httpClientResponse.status()); @@ -116,36 +121,36 @@ class CloudHttpClientIT { @Test void successfulGetResponse() { DisposableServer server = createValidServer(); - HttpClient httpClient = createHttpClientForContextWithAddress(server, connectionProvider); + RxHttpClient httpClient = createHttpClientForContextWithAddress(server); CloudHttpClient cloudHttpClient = new CloudHttpClient(httpClient); when(jsonBodyBuilder.createJsonBody(dmaapModel)).thenReturn(JSON_BODY); Mono content = cloudHttpClient.get(SAMPLE_URL, String.class); Mono contentWithHeaders = cloudHttpClient.get(SAMPLE_URL, createRequestDiagnosticContext(), - createCustomHeaders(), String.class); + createCustomHeaders(), String.class); StepVerifier.create(content) - .expectNext(SAMPLE_STRING) - .expectComplete() - .verify(); + .expectNext(SAMPLE_STRING) + .expectComplete() + .verify(); StepVerifier.create(contentWithHeaders) - .expectNext(SAMPLE_STRING) - .expectComplete() - .verify(); + .expectNext(SAMPLE_STRING) + .expectComplete() + .verify(); server.disposeNow(); } @Test void errorGetRequest() { DisposableServer server = createInvalidServer(); - HttpClient httpClient = createHttpClientForContextWithAddress(server, connectionProvider); + RxHttpClient httpClient = createHttpClientForContextWithAddress(server); CloudHttpClient cloudHttpClient = new CloudHttpClient(httpClient); Mono content = cloudHttpClient.get(SAMPLE_URL, String.class); StepVerifier.create(content) - .expectError() - .verify(); + .expectError() + .verify(); server.disposeNow(); } @@ -158,26 +163,27 @@ class CloudHttpClientIT { private DisposableServer createValidServer() { Mono response = Mono.just(SAMPLE_STRING); return HttpServer.create() - .handle((req, resp) -> resp.sendString(response)) - .wiretap(true) - .bindNow(); + .handle((req, resp) -> resp.sendString(response)) + .wiretap(true) + .bindNow(); } private DisposableServer createInvalidServer() { return HttpServer.create() - .handle((req, resp) -> Mono.error(new Exception("returnError"))) - .wiretap(true) - .bindNow(); + .handle((req, resp) -> Mono.error(new Exception("returnError"))) + .wiretap(true) + .bindNow(); } private RequestDiagnosticContext createRequestDiagnosticContext() { return ImmutableRequestDiagnosticContext.builder() - .invocationId(UUID.randomUUID()).requestId(UUID.randomUUID()).build(); + .invocationId(UUID.randomUUID()).requestId(UUID.randomUUID()).build(); } - private HttpClient createHttpClientForContextWithAddress(DisposableServer disposableServer, - ConnectionProvider connectionProvider) { - HttpClient client = connectionProvider == null? HttpClient.create() : HttpClient.create(connectionProvider); - return client.addressSupplier(disposableServer::address).wiretap(true); + private RxHttpClient createHttpClientForContextWithAddress(DisposableServer disposableServer) { + HttpClient client = HttpClient.create(connectionProvider) + .addressSupplier(disposableServer::address) + .wiretap(true); + return new RxHttpClient(client); } } \ No newline at end of file diff --git a/rest-services/common-dependency/src/test/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/RxHttpClientIT.java b/rest-services/common-dependency/src/test/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/RxHttpClientIT.java new file mode 100644 index 00000000..5ae62c87 --- /dev/null +++ b/rest-services/common-dependency/src/test/java/org/onap/dcaegen2/services/sdk/rest/services/adapters/http/RxHttpClientIT.java @@ -0,0 +1,110 @@ +/* + * ============LICENSE_START==================================== + * DCAEGEN2-SERVICES-SDK + * ========================================================= + * Copyright (C) 2019 Nokia. All rights reserved. + * ========================================================= + * Licensed 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. + * ============LICENSE_END===================================== + */ + +package org.onap.dcaegen2.services.sdk.rest.services.adapters.http; + +import static org.onap.dcaegen2.services.sdk.rest.services.adapters.http.test.DummyHttpServer.sendString; + +import io.netty.handler.codec.http.HttpResponseStatus; +import java.net.MalformedURLException; +import java.net.URL; +import java.time.Duration; +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; +import org.onap.dcaegen2.services.sdk.rest.services.adapters.http.exceptions.HttpException; +import org.onap.dcaegen2.services.sdk.rest.services.adapters.http.test.DummyHttpServer; +import reactor.core.publisher.Mono; +import reactor.test.StepVerifier; + +class RxHttpClientIT { + + private static final Duration TIMEOUT = Duration.ofHours(5); + private final RxHttpClient cut = RxHttpClient.create(); + private static DummyHttpServer httpServer; + + @BeforeAll + static void setUpClass() { + httpServer = DummyHttpServer.start(routes -> + routes.get("/sample-get", (req, resp) -> sendString(resp, Mono.just("OK"))) + .get("/sample-get-500", (req, resp) -> resp.status(HttpResponseStatus.INTERNAL_SERVER_ERROR).send()) + .post("/echo-post", (req, resp) -> resp.send(req.receive().retain())) + ); + } + + @AfterAll + static void tearDownClass() { + httpServer.close(); + } + + private ImmutableHttpRequest.Builder requestFor(String path) throws MalformedURLException { + return ImmutableHttpRequest.builder() + .url(new URL("http", httpServer.host(), httpServer.port(), path).toString()); + } + + @Test + void simpleGet() throws Exception { + // given + final HttpRequest httpRequest = requestFor("/sample-get").method(HttpMethod.GET).build(); + + // when + final Mono bodyAsString = cut.call(httpRequest) + .doOnNext(HttpResponse::throwIfUnsuccessful) + .map(HttpResponse::bodyAsString); + + // then + StepVerifier.create(bodyAsString).expectNext("OK").expectComplete().verify(TIMEOUT); + } + + @Test + void getWithError() throws Exception { + // given + final HttpRequest httpRequest = requestFor("/sample-get-500").method(HttpMethod.GET).build(); + + // when + final Mono bodyAsString = cut.call(httpRequest) + .doOnNext(HttpResponse::throwIfUnsuccessful) + .map(HttpResponse::bodyAsString); + + // then + StepVerifier.create(bodyAsString).expectError(HttpException.class).verify(TIMEOUT); + } + + @Test + void simplePost() throws Exception { + // given + final String requestBody = "hello world"; + final HttpRequest httpRequest = requestFor("/echo-post") + .method(HttpMethod.POST) + .body(RequestBody.fromString(requestBody)) + .build(); + + // when + final Mono bodyAsString = cut.call(httpRequest) + .doOnNext(HttpResponse::throwIfUnsuccessful) + .map(HttpResponse::bodyAsString); + + // then + StepVerifier.create(bodyAsString) + .expectNext(requestBody) + .expectComplete() + .verify(TIMEOUT); + } +} \ No newline at end of file -- cgit 1.2.3-korg