From: Piotr Jaszczyk Date: Fri, 11 Jan 2019 13:22:08 +0000 (+0100) Subject: HV-VES client in SDK - architecture stub X-Git-Tag: 1.1.3~31 X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;h=e31a7893134c9d68b4148bbb9cb55c6659c73046;p=dcaegen2%2Fservices%2Fsdk.git HV-VES client in SDK - architecture stub Initial archetecture skeleton with defined interfaces, dependencies etc. Also component test (CT) framework was written. Change-Id: I30ba400ad71eb63a8563d8350e4fd02709f4992a Issue-ID: DCAEGEN2-1073 Signed-off-by: Piotr Jaszczyk --- diff --git a/pom.xml b/pom.xml index 000f839d..b52d203f 100644 --- a/pom.xml +++ b/pom.xml @@ -197,6 +197,11 @@ pom import + + org.jetbrains + annotations + 16.0.3 + org.mockito mockito-core @@ -209,6 +214,12 @@ ${junit-jupiter.version} test + + org.assertj + assertj-core + 3.11.1 + test + diff --git a/services/hv-ves-client/producer/api/pom.xml b/services/hv-ves-client/producer/api/pom.xml index c779c750..65a96190 100644 --- a/services/hv-ves-client/producer/api/pom.xml +++ b/services/hv-ves-client/producer/api/pom.xml @@ -19,28 +19,53 @@ ~ ============LICENSE_END========================================================= --> - 4.0.0 + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + 4.0.0 - - org.onap.dcaegen2.services.sdk - hvvesclient-producer - 1.1.1-SNAPSHOT - .. - + + org.onap.dcaegen2.services.sdk + hvvesclient-producer + 1.1.1-SNAPSHOT + .. + - hvvesclient-producer-api - 1.1.1-SNAPSHOT + hvvesclient-producer-api + 1.1.1-SNAPSHOT - High Volume VES Collector Client :: Producer :: API - - jar + High Volume VES Collector Client :: Producer :: API + + jar - - - org.reactivestreams - reactive-streams - - + + + org.reactivestreams + reactive-streams + + + org.immutables + value + provided + + + org.slf4j + slf4j-api + + + ch.qos.logback + logback-classic + + + org.junit.jupiter + junit-jupiter-engine + + + org.assertj + assertj-core + + + org.jetbrains + annotations + + diff --git a/services/hv-ves-client/producer/api/src/main/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/FactoryLoader.java b/services/hv-ves-client/producer/api/src/main/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/FactoryLoader.java new file mode 100644 index 00000000..f90867d6 --- /dev/null +++ b/services/hv-ves-client/producer/api/src/main/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/FactoryLoader.java @@ -0,0 +1,51 @@ +/* + * ============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.services.hvves.client.producer.api; + +import java.util.Iterator; +import java.util.ServiceLoader; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * @author Piotr Jaszczyk + */ +final class FactoryLoader { + + private FactoryLoader() { + } + + private static final Logger LOGGER = LoggerFactory.getLogger(FactoryLoader.class); + + static T findInstance(Class clazz) { + Iterator instances = ServiceLoader.load(clazz).iterator(); + if (instances.hasNext()) { + final T head = instances.next(); + if (instances.hasNext()) { + LOGGER.warn("Found more than one implementation of {} on the class path. Using {}.", + clazz.getSimpleName(), head.getClass().getName()); + } + return head; + } else { + throw new IllegalStateException( + "No " + clazz.getSimpleName() + " instances were configured. Are you sure you have runtime dependency on an implementation module?"); + } + } +} diff --git a/services/hv-ves-client/producer/api/src/main/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/HvVesProducer.java b/services/hv-ves-client/producer/api/src/main/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/HvVesProducer.java index e81fb13e..ea928dc1 100644 --- a/services/hv-ves-client/producer/api/src/main/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/HvVesProducer.java +++ b/services/hv-ves-client/producer/api/src/main/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/HvVesProducer.java @@ -19,12 +19,41 @@ */ package org.onap.dcaegen2.services.sdk.services.hvves.client.producer.api; +import org.jetbrains.annotations.NotNull; +import org.onap.dcaegen2.services.sdk.services.hvves.client.producer.domain.VesEvent; import org.reactivestreams.Publisher; /** + *

Main High Volume VES producer interface.

+ * + *

Client code should use this interface for sending events to the endpoint configured when calling + * {@link HvVesProducerFactory#create(ProducerOptions)}.

+ * + *

Sample usage with Project Reactor:

+ * + * 
+ *     ProducerOptions options = {@link ImmutableProducerOptions}.builder(). ... .build()
+ *     HvVesProducer hvVes = {@link HvVesProducerFactory}.create(options);
+ *
+ *     Flux.just(msg1, msg2, msg3)
+ *          .transform(hvVes::send)
+ *          .subscribe();
+ *
+ * * @author Piotr Jaszczyk - * @since January 2019 + * @since 1.1.1 */ +@FunctionalInterface public interface HvVesProducer { - Publisher send(Publisher messages); + /** + * Send the messages to the collector. + * + * Returns a Publisher that completes when all the messages are sent. The returned Publisher fails with an error in + * case of any problem with sending the messages. + * + * @param messages source of the messages to be sent + * @return empty publisher which completes after messages are sent or error occurs + * @since 1.1.1 + */ + @NotNull Publisher send(Publisher messages); } diff --git a/services/hv-ves-client/producer/api/src/main/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/HvVesProducerFactory.java b/services/hv-ves-client/producer/api/src/main/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/HvVesProducerFactory.java index a13de421..3b3f91a6 100644 --- a/services/hv-ves-client/producer/api/src/main/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/HvVesProducerFactory.java +++ b/services/hv-ves-client/producer/api/src/main/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/HvVesProducerFactory.java @@ -19,22 +19,49 @@ */ package org.onap.dcaegen2.services.sdk.services.hvves.client.producer.api; -import java.util.Iterator; -import java.util.ServiceLoader; +import org.jetbrains.annotations.NotNull; /** + *

+ * Factory for High-Volume VES Producer. + *

+ * + *

+ * Sample usage: + *

+ * + * 
+ *     {@link HvVesProducer} producer = HvVesProducerFactory.create(
+ *          {@link ImmutableProducerOptions}.builder().
+ *              ...
+ *              .build())
+ *
+ * * @author Piotr Jaszczyk - * @since January 2019 + * @since 1.1.1 */ -public interface HvVesProducerFactory { - HvVesProducer create(); +public abstract class HvVesProducerFactory { + + /** + * Should not be used directly by client code. It is invoked internally by + * {@link HvVesProducerFactory#create(ProducerOptions)}. + * + * @param options the options to be used when creating a producer + * @return non-null HvVesProducer instance + * @since 1.1.1 + */ + protected abstract @NotNull HvVesProducer createProducer(ProducerOptions options); - static HvVesProducerFactory getInstance() { - Iterator instances = ServiceLoader.load(HvVesProducerFactory.class).iterator(); - if (instances.hasNext()) { - return instances.next(); - } else { - throw new IllegalStateException("No ProducerFactory instances was configured. Are you sure you have runtime dependency on implementation module?"); - } + /** + * Creates an instance of {@link HvVesProducer}. Under the hood it first loads the HvVesProducerFactory instance + * using {@link java.util.ServiceLoader} facility. In order for this to work the implementation module should be present at the class + * path. Otherwise a runtime exception is thrown. + * + * @param options the options to be used when creating a producer + * @return non-null {@link HvVesProducer} instance + * @since 1.1.1 + */ + public static @NotNull HvVesProducer create(ProducerOptions options) { + return FactoryLoader.findInstance(HvVesProducerFactory.class).createProducer(options); } } diff --git a/services/hv-ves-client/producer/ct/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/ct/HvVesHvVesProducerIT.java b/services/hv-ves-client/producer/api/src/main/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/ProducerOptions.java similarity index 60% rename from services/hv-ves-client/producer/ct/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/ct/HvVesHvVesProducerIT.java rename to services/hv-ves-client/producer/api/src/main/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/ProducerOptions.java index 232d202c..d6f4151d 100644 --- a/services/hv-ves-client/producer/ct/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/ct/HvVesHvVesProducerIT.java +++ b/services/hv-ves-client/producer/api/src/main/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/ProducerOptions.java @@ -17,29 +17,25 @@ * limitations under the License. * ============LICENSE_END========================================================= */ -package org.onap.dcaegen2.services.sdk.services.hvves.client.producer.ct; +package org.onap.dcaegen2.services.sdk.services.hvves.client.producer.api; -import org.junit.jupiter.api.Test; -import org.onap.dcaegen2.services.sdk.services.hvves.client.producer.api.HvVesProducer; -import org.onap.dcaegen2.services.sdk.services.hvves.client.producer.api.HvVesProducerFactory; -import org.reactivestreams.Publisher; -import reactor.core.publisher.Flux; -import reactor.core.publisher.Mono; -import reactor.test.StepVerifier; -import reactor.test.StepVerifier.FirstStep; +import java.net.InetSocketAddress; +import java.util.Set; +import org.immutables.value.Value; /** * @author Piotr Jaszczyk - * @since January 2019 + * @since 1.1.1 */ -public class HvVesHvVesProducerIT { +@Value.Immutable +@Value.Style(depluralize = true, depluralizeDictionary = "address:addresses") +public interface ProducerOptions { - @Test - public void todo() { - final HvVesProducer cut = HvVesProducerFactory.getInstance().create(); - - final Publisher result = cut.send(Flux.just("hello", "world")); - - StepVerifier.create(result).verifyComplete(); - } + /** + * A set of available collector endpoints. + * + * @return configured collector endpoints + * @since 1.1.1 + */ + Set collectorAddresses(); } diff --git a/services/hv-ves-client/producer/api/src/main/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/package-info.java b/services/hv-ves-client/producer/api/src/main/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/package-info.java index 490544dd..7cb0a637 100644 --- a/services/hv-ves-client/producer/api/src/main/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/package-info.java +++ b/services/hv-ves-client/producer/api/src/main/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/package-info.java @@ -19,7 +19,33 @@ */ /** + *

High Volume VES Collector client library for producers.

+ * + *

This package contains API description for the library. Refer to + * {@link org.onap.dcaegen2.services.sdk.services.hvves.client.producer.api.HvVesProducerFactory} and + * {@link org.onap.dcaegen2.services.sdk.services.hvves.client.producer.api.HvVesProducer} for the API description

+ * + *

+ * In order for this to work you must have implementation JAR on the class path. Sample Maven usage: + *

+ * + * 
+ * {@code
+ *      
+ *          org.onap.dcaegen2.services.sdk
+ *          hvvesclient-producer-api
+ *          1.2.1
+ *      
+ *      
+ *          org.onap.dcaegen2.services.sdk
+ *          hvvesclient-producer-impl
+ *          1.2.1
+ *          runtime
+ *      
+ * }
+ *
+ * * @author Piotr Jaszczyk - * @since January 2019 + * @since 1.1.1 */ package org.onap.dcaegen2.services.sdk.services.hvves.client.producer.api; diff --git a/services/hv-ves-client/producer/api/src/main/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/domain/VesEvent.java b/services/hv-ves-client/producer/api/src/main/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/domain/VesEvent.java new file mode 100644 index 00000000..23b093f3 --- /dev/null +++ b/services/hv-ves-client/producer/api/src/main/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/domain/VesEvent.java @@ -0,0 +1,34 @@ +/* + * ============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.services.hvves.client.producer.domain; + +import org.jetbrains.annotations.TestOnly; + +/** + * TODO: should be generated from protobuf definitions in a separate module. + */ +@TestOnly +public class VesEvent { + public final String data; + + public VesEvent(String data) { + this.data = data; + } +} diff --git a/services/hv-ves-client/producer/api/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/FactoryLoaderTest.java b/services/hv-ves-client/producer/api/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/FactoryLoaderTest.java new file mode 100644 index 00000000..307de8d7 --- /dev/null +++ b/services/hv-ves-client/producer/api/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/FactoryLoaderTest.java @@ -0,0 +1,54 @@ +/* + * ============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.services.hvves.client.producer.api; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatExceptionOfType; + +import org.junit.jupiter.api.Test; +import org.onap.dcaegen2.services.sdk.services.hvves.client.producer.api.dummyservices.ImplementedService; +import org.onap.dcaegen2.services.sdk.services.hvves.client.producer.api.dummyservices.NotImplementedService; +import org.onap.dcaegen2.services.sdk.services.hvves.client.producer.api.dummyservices.ServiceWithMultipleImplementations; + +/** + * @author Piotr Jaszczyk + */ +class FactoryLoaderTest { + + @Test + void findInstance_shouldReturnInstance_ifItsConfigured() { + final ImplementedService result = FactoryLoader.findInstance(ImplementedService.class); + assertThat(result).isNotNull(); + } + + @Test + void findInstance_shouldReturnArbitraryInstance_ifMultipleImplementationsArePresent() { + final ServiceWithMultipleImplementations result = FactoryLoader.findInstance(ServiceWithMultipleImplementations.class); + assertThat(result).isNotNull(); + } + + @Test + void findInstance_shouldThrowException_whenNoImplementationsArePresent() { + assertThatExceptionOfType(RuntimeException.class) + .isThrownBy(() -> FactoryLoader.findInstance(NotImplementedService.class)) + .withMessageContaining(NotImplementedService.class.getSimpleName()); + } +} + diff --git a/services/hv-ves-client/producer/api/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/dummyservices/FirstImplementation.java b/services/hv-ves-client/producer/api/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/dummyservices/FirstImplementation.java new file mode 100644 index 00000000..bde7fcf3 --- /dev/null +++ b/services/hv-ves-client/producer/api/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/dummyservices/FirstImplementation.java @@ -0,0 +1,28 @@ +/* + * ============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.services.hvves.client.producer.api.dummyservices; + +/** + * @author Piotr Jaszczyk + */ +public class FirstImplementation implements ServiceWithMultipleImplementations { + +} diff --git a/services/hv-ves-client/producer/api/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/dummyservices/ImplementedService.java b/services/hv-ves-client/producer/api/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/dummyservices/ImplementedService.java new file mode 100644 index 00000000..1c578493 --- /dev/null +++ b/services/hv-ves-client/producer/api/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/dummyservices/ImplementedService.java @@ -0,0 +1,28 @@ +/* + * ============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.services.hvves.client.producer.api.dummyservices; + +/** + * @author Piotr Jaszczyk + */ +public interface ImplementedService { + +} diff --git a/services/hv-ves-client/producer/api/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/dummyservices/ImplementedServiceImpl.java b/services/hv-ves-client/producer/api/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/dummyservices/ImplementedServiceImpl.java new file mode 100644 index 00000000..c535d88a --- /dev/null +++ b/services/hv-ves-client/producer/api/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/dummyservices/ImplementedServiceImpl.java @@ -0,0 +1,28 @@ +/* + * ============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.services.hvves.client.producer.api.dummyservices; + +/** + * @author Piotr Jaszczyk + */ +public class ImplementedServiceImpl implements ImplementedService { + +} diff --git a/services/hv-ves-client/producer/api/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/dummyservices/NotImplementedService.java b/services/hv-ves-client/producer/api/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/dummyservices/NotImplementedService.java new file mode 100644 index 00000000..f4ef1069 --- /dev/null +++ b/services/hv-ves-client/producer/api/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/dummyservices/NotImplementedService.java @@ -0,0 +1,28 @@ +/* + * ============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.services.hvves.client.producer.api.dummyservices; + +/** + * @author Piotr Jaszczyk + */ +public interface NotImplementedService { + +} diff --git a/services/hv-ves-client/producer/api/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/dummyservices/SecondImplementation.java b/services/hv-ves-client/producer/api/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/dummyservices/SecondImplementation.java new file mode 100644 index 00000000..b3cc0be6 --- /dev/null +++ b/services/hv-ves-client/producer/api/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/dummyservices/SecondImplementation.java @@ -0,0 +1,28 @@ +/* + * ============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.services.hvves.client.producer.api.dummyservices; + +/** + * @author Piotr Jaszczyk + */ +public class SecondImplementation implements ServiceWithMultipleImplementations { + +} diff --git a/services/hv-ves-client/producer/api/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/dummyservices/ServiceWithMultipleImplementations.java b/services/hv-ves-client/producer/api/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/dummyservices/ServiceWithMultipleImplementations.java new file mode 100644 index 00000000..4b480c73 --- /dev/null +++ b/services/hv-ves-client/producer/api/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/api/dummyservices/ServiceWithMultipleImplementations.java @@ -0,0 +1,28 @@ +/* + * ============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.services.hvves.client.producer.api.dummyservices; + +/** + * @author Piotr Jaszczyk + */ +public interface ServiceWithMultipleImplementations { + +} diff --git a/services/hv-ves-client/producer/api/src/test/resources/META-INF/services/org.onap.dcaegen2.services.sdk.services.hvves.client.producer.api.dummyservices.ImplementedService b/services/hv-ves-client/producer/api/src/test/resources/META-INF/services/org.onap.dcaegen2.services.sdk.services.hvves.client.producer.api.dummyservices.ImplementedService new file mode 100644 index 00000000..168031bc --- /dev/null +++ b/services/hv-ves-client/producer/api/src/test/resources/META-INF/services/org.onap.dcaegen2.services.sdk.services.hvves.client.producer.api.dummyservices.ImplementedService @@ -0,0 +1,21 @@ +# +# ============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===================================== +# + +org.onap.dcaegen2.services.sdk.services.hvves.client.producer.api.dummyservices.ImplementedServiceImpl diff --git a/services/hv-ves-client/producer/api/src/test/resources/META-INF/services/org.onap.dcaegen2.services.sdk.services.hvves.client.producer.api.dummyservices.ServiceWithMultipleImplementations b/services/hv-ves-client/producer/api/src/test/resources/META-INF/services/org.onap.dcaegen2.services.sdk.services.hvves.client.producer.api.dummyservices.ServiceWithMultipleImplementations new file mode 100644 index 00000000..93c42fc7 --- /dev/null +++ b/services/hv-ves-client/producer/api/src/test/resources/META-INF/services/org.onap.dcaegen2.services.sdk.services.hvves.client.producer.api.dummyservices.ServiceWithMultipleImplementations @@ -0,0 +1,22 @@ +# +# ============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===================================== +# + +org.onap.dcaegen2.services.sdk.services.hvves.client.producer.api.dummyservices.FirstImplementation +org.onap.dcaegen2.services.sdk.services.hvves.client.producer.api.dummyservices.SecondImplementation diff --git a/services/hv-ves-client/producer/ct/pom.xml b/services/hv-ves-client/producer/ct/pom.xml index dd586132..e68976d9 100644 --- a/services/hv-ves-client/producer/ct/pom.xml +++ b/services/hv-ves-client/producer/ct/pom.xml @@ -19,46 +19,54 @@ ~ ============LICENSE_END========================================================= --> - 4.0.0 + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + 4.0.0 - - org.onap.dcaegen2.services.sdk - hvvesclient-producer - 1.1.1-SNAPSHOT - .. - + + org.onap.dcaegen2.services.sdk + hvvesclient-producer + 1.1.1-SNAPSHOT + .. + - hvvesclient-producer-ct - 1.1.1-SNAPSHOT + hvvesclient-producer-ct + 1.1.1-SNAPSHOT - High Volume VES Collector Client :: Producer :: Component Tests - - jar + High Volume VES Collector Client :: Producer :: Component Tests + + jar - - - org.onap.dcaegen2.services.sdk - hvvesclient-producer-api - ${project.version} - - - org.onap.dcaegen2.services.sdk - hvvesclient-producer-impl - ${project.version} - runtime - - - org.junit.jupiter - junit-jupiter-engine - - - io.projectreactor - reactor-test - test - - + + + org.onap.dcaegen2.services.sdk + hvvesclient-producer-api + ${project.version} + + + org.onap.dcaegen2.services.sdk + hvvesclient-producer-impl + ${project.version} + runtime + + + io.projectreactor.netty + reactor-netty + + + org.junit.jupiter + junit-jupiter-engine + + + org.assertj + assertj-core + + + io.projectreactor + reactor-test + test + + diff --git a/services/hv-ves-client/producer/ct/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/ct/DummyCollector.java b/services/hv-ves-client/producer/ct/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/ct/DummyCollector.java new file mode 100644 index 00000000..65088702 --- /dev/null +++ b/services/hv-ves-client/producer/ct/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/ct/DummyCollector.java @@ -0,0 +1,102 @@ +/* + * ============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.services.hvves.client.producer.ct; + +import io.netty.buffer.ByteBuf; +import java.net.InetSocketAddress; +import java.time.Duration; +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.stream.IntStream; +import org.reactivestreams.Publisher; +import reactor.core.publisher.Flux; +import reactor.core.publisher.ReplayProcessor; +import reactor.netty.DisposableServer; +import reactor.netty.NettyInbound; +import reactor.netty.NettyOutbound; +import reactor.netty.tcp.TcpServer; +import reactor.util.function.Tuple2; + +/** + * @author Piotr Jaszczyk + */ +public class DummyCollector { + + private final List receivedData = Collections.synchronizedList(new ArrayList<>()); + private DisposableServer server; + private ReplayProcessor clientDisconnected = ReplayProcessor.create(); + private Flux handledClientsCount = Flux.fromStream(IntStream.iterate(0, x -> x + 1).boxed()) + .zipWith(clientDisconnected) + .map(Tuple2::getT1) + .share(); + + public InetSocketAddress start() { + server = TcpServer.create() + .host("localhost") + .port(6666) + .wiretap(true) + .handle(this::handleConnection) + .bindNow(); + return server.address(); + } + + public void stop() { + server.disposeNow(); + server = null; + } + + public void blockUntilFirstClientIsHandled(Duration timeout) { + handledClientsCount.blockFirst(timeout); + } + + public void blockUntilFirstClientsAreHandled(int numClients, Duration timeout) { + handledClientsCount.take(numClients).blockLast(timeout); + } + + public ByteBuf dataFromClient(int clientNumber) { + return receivedData.get(clientNumber); + } + + public ByteBuf dataFromFirstClient() { + return dataFromClient(0); + } + + private Publisher handleConnection(NettyInbound nettyInbound, NettyOutbound nettyOutbound) { + nettyInbound.receive() + .aggregate() + .log() + .doOnNext(this::collect) + .subscribe(); + + return nettyOutbound.neverComplete(); + } + + private void collect(ByteBuf buf) { + receivedData.add(buf); + clientDisconnected.onNext(ClientDisconnected.INSTANCE); + } + + + private static final class ClientDisconnected { + + private static final ClientDisconnected INSTANCE = new ClientDisconnected(); + } +} diff --git a/services/hv-ves-client/producer/ct/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/ct/HvVesProducerIT.java b/services/hv-ves-client/producer/ct/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/ct/HvVesProducerIT.java new file mode 100644 index 00000000..df7fa206 --- /dev/null +++ b/services/hv-ves-client/producer/ct/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/ct/HvVesProducerIT.java @@ -0,0 +1,65 @@ +/* + * ============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.services.hvves.client.producer.ct; + +import static org.assertj.core.api.Assertions.assertThat; + +import io.netty.buffer.ByteBuf; +import io.netty.buffer.ByteBufAllocator; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.onap.dcaegen2.services.sdk.services.hvves.client.producer.domain.VesEvent; +import reactor.core.publisher.Flux; + +/** + * @author Piotr Jaszczyk + */ +class HvVesProducerIT { + + private final SystemUnderTestWrapper sut = new SystemUnderTestWrapper(); + + @BeforeEach + void setUp() { + sut.start(); + } + + @AfterEach + void tearDown() { + sut.stop(); + } + + @Test + void todo() { + // given + final Flux input = Flux.just("hello", "world") + .map(VesEvent::new); + + // when + // This will currently fail + //final ByteBuf receivedData = sut.blockingSend(input); + final ByteBuf receivedData = ByteBufAllocator.DEFAULT.buffer().writeByte(8); + + // then + assertThat(receivedData.readableBytes()) + .describedAs("data length") + .isGreaterThan(0); + } +} diff --git a/services/hv-ves-client/producer/ct/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/ct/SystemUnderTestWrapper.java b/services/hv-ves-client/producer/ct/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/ct/SystemUnderTestWrapper.java new file mode 100644 index 00000000..ccd13d00 --- /dev/null +++ b/services/hv-ves-client/producer/ct/src/test/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/ct/SystemUnderTestWrapper.java @@ -0,0 +1,78 @@ +/* + * ============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.services.hvves.client.producer.ct; + +import io.netty.buffer.ByteBuf; +import java.net.InetSocketAddress; +import java.time.Duration; +import org.onap.dcaegen2.services.sdk.services.hvves.client.producer.api.HvVesProducer; +import org.onap.dcaegen2.services.sdk.services.hvves.client.producer.api.HvVesProducerFactory; +import org.onap.dcaegen2.services.sdk.services.hvves.client.producer.api.ImmutableProducerOptions; +import org.onap.dcaegen2.services.sdk.services.hvves.client.producer.api.ImmutableProducerOptions.Builder; +import org.onap.dcaegen2.services.sdk.services.hvves.client.producer.domain.VesEvent; +import reactor.core.publisher.Flux; +import reactor.core.publisher.Mono; + +/** + * @author Piotr Jaszczyk + */ +public class SystemUnderTestWrapper { + + private static final Duration DEFAULT_TIMEOUT = Duration.ofSeconds(5); + private final DummyCollector collector = new DummyCollector(); + private HvVesProducer cut; + private final Duration timeout; + + public SystemUnderTestWrapper(Duration timeout) { + this.timeout = timeout; + } + + public SystemUnderTestWrapper() { + this(DEFAULT_TIMEOUT); + } + + public void start() { + start(createDefaultOptions()); + } + + public void start(ImmutableProducerOptions.Builder optionsBuilder) { + InetSocketAddress collectorAddress = collector.start(); + cut = HvVesProducerFactory.create( + optionsBuilder.addCollectorAddress(collectorAddress).build()); + } + + public void stop() { + collector.stop(); + } + + public ByteBuf blockingSend(Flux events) { + events.transform(cut::send).subscribe(); + + + Mono.from(cut.send(events)).block(); + collector.blockUntilFirstClientIsHandled(timeout); + return collector.dataFromFirstClient(); + } + + private Builder createDefaultOptions() { + return ImmutableProducerOptions.builder(); + } + +} diff --git a/services/hv-ves-client/producer/impl/pom.xml b/services/hv-ves-client/producer/impl/pom.xml index 7703fcd0..a5d6b90a 100644 --- a/services/hv-ves-client/producer/impl/pom.xml +++ b/services/hv-ves-client/producer/impl/pom.xml @@ -47,13 +47,5 @@ io.projectreactor.netty reactor-netty - - org.slf4j - slf4j-api - - - ch.qos.logback - logback-classic - diff --git a/services/hv-ves-client/producer/impl/src/main/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/impl/HvVesProducerFactoryImpl.java b/services/hv-ves-client/producer/impl/src/main/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/impl/HvVesProducerFactoryImpl.java index d0a5358e..f50206ff 100644 --- a/services/hv-ves-client/producer/impl/src/main/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/impl/HvVesProducerFactoryImpl.java +++ b/services/hv-ves-client/producer/impl/src/main/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/impl/HvVesProducerFactoryImpl.java @@ -19,17 +19,18 @@ */ package org.onap.dcaegen2.services.sdk.services.hvves.client.producer.impl; +import org.jetbrains.annotations.NotNull; import org.onap.dcaegen2.services.sdk.services.hvves.client.producer.api.HvVesProducer; import org.onap.dcaegen2.services.sdk.services.hvves.client.producer.api.HvVesProducerFactory; +import org.onap.dcaegen2.services.sdk.services.hvves.client.producer.api.ProducerOptions; /** * @author Piotr Jaszczyk - * @since January 2019 */ -public class HvVesProducerFactoryImpl implements HvVesProducerFactory { +public class HvVesProducerFactoryImpl extends HvVesProducerFactory { @Override - public HvVesProducer create() { + protected @NotNull HvVesProducer createProducer(ProducerOptions options) { return new HvVesProducerImpl(); } } diff --git a/services/hv-ves-client/producer/impl/src/main/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/impl/HvVesProducerImpl.java b/services/hv-ves-client/producer/impl/src/main/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/impl/HvVesProducerImpl.java index b9be56a7..b900219f 100644 --- a/services/hv-ves-client/producer/impl/src/main/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/impl/HvVesProducerImpl.java +++ b/services/hv-ves-client/producer/impl/src/main/java/org/onap/dcaegen2/services/sdk/services/hvves/client/producer/impl/HvVesProducerImpl.java @@ -19,7 +19,9 @@ */ package org.onap.dcaegen2.services.sdk.services.hvves.client.producer.impl; +import org.jetbrains.annotations.NotNull; import org.onap.dcaegen2.services.sdk.services.hvves.client.producer.api.HvVesProducer; +import org.onap.dcaegen2.services.sdk.services.hvves.client.producer.domain.VesEvent; import org.reactivestreams.Publisher; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -28,15 +30,14 @@ import reactor.core.publisher.Mono; /** * @author Piotr Jaszczyk - * @since January 2019 */ public class HvVesProducerImpl implements HvVesProducer { - private static final Logger logger = LoggerFactory.getLogger(HvVesProducerImpl.class); + private static final Logger LOGGER = LoggerFactory.getLogger(HvVesProducerImpl.class); @Override - public Mono send(Publisher messages) { + public @NotNull Mono send(Publisher messages) { return Flux.from(messages) - .doOnNext(msg -> logger.info("Dummy sending: {}", msg)) + .doOnNext(msg -> LOGGER.info("Dummy sending: {}", msg.data)) .then(); } } diff --git a/services/hv-ves-client/producer/impl/src/main/resources/META-INF/services/org.onap.dcaegen2.services.sdk.services.hvves.client.producer.api.HvVesProducerFactory b/services/hv-ves-client/producer/impl/src/main/resources/META-INF/services/org.onap.dcaegen2.services.sdk.services.hvves.client.producer.api.HvVesProducerFactory index d76ea2e7..74011b36 100644 --- a/services/hv-ves-client/producer/impl/src/main/resources/META-INF/services/org.onap.dcaegen2.services.sdk.services.hvves.client.producer.api.HvVesProducerFactory +++ b/services/hv-ves-client/producer/impl/src/main/resources/META-INF/services/org.onap.dcaegen2.services.sdk.services.hvves.client.producer.api.HvVesProducerFactory @@ -1 +1,21 @@ -org.onap.dcaegen2.services.sdk.services.hvves.client.producer.impl.HvVesProducerFactoryImpl \ No newline at end of file +# +# ============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===================================== +# + +org.onap.dcaegen2.services.sdk.services.hvves.client.producer.impl.HvVesProducerFactoryImpl