GRPC support for APEX-CDS interaction 76/102676/7
authora.sreekumar <ajith.sreekumar@est.tech>
Sun, 1 Mar 2020 19:38:50 +0000 (19:38 +0000)
committera.sreekumar <ajith.sreekumar@est.tech>
Tue, 3 Mar 2020 15:47:23 +0000 (15:47 +0000)
Change-Id: I586153244dbd97a41e9b9d616ee9a84327b7c2da
Issue-ID: POLICY-1656
Signed-off-by: a.sreekumar <ajith.sreekumar@est.tech>
plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-grpc/pom.xml [new file with mode: 0644]
plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-grpc/src/main/java/org/onap/policy/apex/plugins/event/carrier/grpc/ApexGrpcConsumer.java [new file with mode: 0644]
plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-grpc/src/main/java/org/onap/policy/apex/plugins/event/carrier/grpc/ApexGrpcProducer.java [new file with mode: 0644]
plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-grpc/src/main/java/org/onap/policy/apex/plugins/event/carrier/grpc/GrpcCarrierTechnologyParameters.java [new file with mode: 0644]
plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-grpc/src/main/java/org/onap/policy/apex/plugins/event/carrier/grpc/package-info.java [new file with mode: 0644]
plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-grpc/src/test/java/org/onap/policy/apex/plugins/event/carrier/grpc/ApexGrpcConsumerTest.java [new file with mode: 0644]
plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-grpc/src/test/java/org/onap/policy/apex/plugins/event/carrier/grpc/ApexGrpcProducerTest.java [new file with mode: 0644]
plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-grpc/src/test/java/org/onap/policy/apex/plugins/event/carrier/grpc/GrpcCarrierTechnologyParametersTest.java [new file with mode: 0644]
plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-grpc/src/test/resources/executionServiceInputEvent.json [new file with mode: 0644]
plugins/plugins-event/plugins-event-carrier/pom.xml

diff --git a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-grpc/pom.xml b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-grpc/pom.xml
new file mode 100644 (file)
index 0000000..443f8f1
--- /dev/null
@@ -0,0 +1,76 @@
+<?xml version="1.0"?>
+<!--
+  ============LICENSE_START=======================================================
+   Copyright (C) 2020 Nordix Foundation.
+  ================================================================================
+  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.
+
+  SPDX-License-Identifier: Apache-2.0
+  ============LICENSE_END=========================================================
+-->
+<project
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"
+ xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+ <modelVersion>4.0.0</modelVersion>
+ <parent>
+  <groupId>org.onap.policy.apex-pdp.plugins.plugins-event.plugins-event-carrier</groupId>
+  <artifactId>plugins-event-carrier</artifactId>
+  <version>2.3.0-SNAPSHOT</version>
+ </parent>
+
+ <artifactId>plugins-event-carrier-grpc</artifactId>
+ <name>${project.artifactId}</name>
+ <description>[${project.parent.artifactId}] Plugin for handling GRPC requests and responses</description>
+    <dependencies>
+        <dependency>
+            <groupId>org.onap.policy.models.policy-models-interactions.model-impl</groupId>
+            <artifactId>cds</artifactId>
+            <version>${version.policy.models}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.onap.policy.models.policy-models-interactions.model-actors</groupId>
+            <artifactId>actor.cds</artifactId>
+            <version>${version.policy.models}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.assertj</groupId>
+            <artifactId>assertj-core</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-all</artifactId>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+    <profiles>
+        <profile>
+            <id>apexSite</id>
+            <activation>
+                <property>
+                    <name>apexSite</name>
+                </property>
+            </activation>
+            <properties>
+                <adsite-plugins-event-carrier-grpc-dir>${project.basedir}/src</adsite-plugins-event-carrier-grpc-dir>
+            </properties>
+            <distributionManagement>
+                <site>
+                    <id>${project.artifactId}-site</id>
+                    <url>${apex.adsite.prefix}/modules/plugins/plugins-event/${project.parent.artifactId}/${project.artifactId}/</url>
+                </site>
+            </distributionManagement>
+        </profile>
+    </profiles>
+</project>
diff --git a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-grpc/src/main/java/org/onap/policy/apex/plugins/event/carrier/grpc/ApexGrpcConsumer.java b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-grpc/src/main/java/org/onap/policy/apex/plugins/event/carrier/grpc/ApexGrpcConsumer.java
new file mode 100644 (file)
index 0000000..7333c8a
--- /dev/null
@@ -0,0 +1,72 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2020 Nordix Foundation.
+ * ================================================================================
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.apex.plugins.event.carrier.grpc;
+
+import org.onap.policy.apex.service.engine.event.ApexEventException;
+import org.onap.policy.apex.service.engine.event.ApexEventReceiver;
+import org.onap.policy.apex.service.engine.event.ApexEventRuntimeException;
+import org.onap.policy.apex.service.engine.event.ApexPluginsEventConsumer;
+import org.onap.policy.apex.service.engine.event.PeeredReference;
+import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerParameters;
+import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerPeeredMode;
+
+/**
+ * This class implements an Apex gRPC consumer. It is not expected to receive events using gRPC.
+ * So, initializing a gRPC consumer will result in error.
+ *
+ * @author Ajith Sreekumar (ajith.sreekumar@est.tech)
+ */
+public class ApexGrpcConsumer extends ApexPluginsEventConsumer {
+
+    private static final String GRPC_CONSUMER_ERROR_MSG =
+        "A gRPC Consumer may not be specified. Only sending events is possible using gRPC";
+
+    @Override
+    public void init(final String consumerName, final EventHandlerParameters consumerParameters,
+        final ApexEventReceiver incomingEventReceiver) throws ApexEventException {
+        throw new ApexEventException(GRPC_CONSUMER_ERROR_MSG);
+    }
+
+    @Override
+    public void run() {
+        throw new ApexEventRuntimeException(GRPC_CONSUMER_ERROR_MSG);
+    }
+
+    @Override
+    public void start() {
+        throw new ApexEventRuntimeException(GRPC_CONSUMER_ERROR_MSG);
+    }
+
+    @Override
+    public void stop() {
+        throw new ApexEventRuntimeException(GRPC_CONSUMER_ERROR_MSG);
+    }
+
+    @Override
+    public PeeredReference getPeeredReference(EventHandlerPeeredMode peeredMode) {
+        throw new ApexEventRuntimeException(GRPC_CONSUMER_ERROR_MSG);
+    }
+
+    @Override
+    public void setPeeredReference(EventHandlerPeeredMode peeredMode, PeeredReference peeredReference) {
+        throw new ApexEventRuntimeException(GRPC_CONSUMER_ERROR_MSG);
+    }
+}
diff --git a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-grpc/src/main/java/org/onap/policy/apex/plugins/event/carrier/grpc/ApexGrpcProducer.java b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-grpc/src/main/java/org/onap/policy/apex/plugins/event/carrier/grpc/ApexGrpcProducer.java
new file mode 100644 (file)
index 0000000..380ae12
--- /dev/null
@@ -0,0 +1,152 @@
+/*-
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2020 Nordix Foundation.
+ * ================================================================================
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.apex.plugins.event.carrier.grpc;
+
+import com.google.protobuf.InvalidProtocolBufferException;
+import com.google.protobuf.util.JsonFormat;
+import java.util.Properties;
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicReference;
+import org.onap.ccsdk.cds.controllerblueprints.common.api.EventType;
+import org.onap.ccsdk.cds.controllerblueprints.common.api.Status;
+import org.onap.ccsdk.cds.controllerblueprints.processing.api.ExecutionServiceInput;
+import org.onap.ccsdk.cds.controllerblueprints.processing.api.ExecutionServiceInput.Builder;
+import org.onap.ccsdk.cds.controllerblueprints.processing.api.ExecutionServiceOutput;
+import org.onap.policy.apex.service.engine.event.ApexEventException;
+import org.onap.policy.apex.service.engine.event.ApexEventRuntimeException;
+import org.onap.policy.apex.service.engine.event.ApexPluginsEventProducer;
+import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerParameters;
+import org.onap.policy.cds.api.CdsProcessorListener;
+import org.onap.policy.cds.client.CdsProcessorGrpcClient;
+import org.onap.policy.cds.properties.CdsServerProperties;
+import org.onap.policy.controlloop.actor.cds.constants.CdsActorConstants;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Concrete implementation of an Apex gRPC plugin that manages to send a GRPC request.
+ *
+ * @author Ajith Sreekumar(ajith.sreekumar@est.tech)
+ *
+ */
+public class ApexGrpcProducer extends ApexPluginsEventProducer implements CdsProcessorListener {
+    private static final Logger LOGGER = LoggerFactory.getLogger(ApexGrpcProducer.class);
+
+    private CdsServerProperties props;
+    // The gRPC client
+    private CdsProcessorGrpcClient client;
+
+    private AtomicReference<ExecutionServiceOutput> cdsResponse = new AtomicReference<>();
+
+    /**
+     * {@inheritDoc}.
+     */
+    @Override
+    public void init(final String producerName, final EventHandlerParameters producerParameters)
+        throws ApexEventException {
+        this.name = producerName;
+
+        // Check and get the gRPC Properties
+        if (!(producerParameters.getCarrierTechnologyParameters() instanceof GrpcCarrierTechnologyParameters)) {
+            final String errorMessage =
+                "Specified producer properties are not applicable to gRPC producer (" + this.name + ")";
+            throw new ApexEventException(errorMessage);
+        }
+        GrpcCarrierTechnologyParameters grpcProducerProperties =
+            (GrpcCarrierTechnologyParameters) producerParameters.getCarrierTechnologyParameters();
+
+        client = makeGrpcClient(grpcProducerProperties);
+    }
+
+    private CdsProcessorGrpcClient makeGrpcClient(GrpcCarrierTechnologyParameters grpcProducerProperties) {
+        props = new CdsServerProperties();
+        props.setHost(grpcProducerProperties.getHost());
+        props.setPort(grpcProducerProperties.getPort());
+        props.setUsername(grpcProducerProperties.getUsername());
+        props.setPassword(grpcProducerProperties.getPassword());
+        props.setTimeout(grpcProducerProperties.getTimeout());
+
+        return new CdsProcessorGrpcClient(this, props);
+    }
+
+    /**
+     * {@inheritDoc}.
+     */
+    @Override
+    public void sendEvent(final long executionId, final Properties executionProperties, final String eventName,
+        final Object event) {
+
+        ExecutionServiceInput executionServiceInput;
+        Builder builder = ExecutionServiceInput.newBuilder();
+        try {
+            JsonFormat.parser().ignoringUnknownFields().merge((String) event, builder);
+            executionServiceInput = builder.build();
+        } catch (InvalidProtocolBufferException e) {
+            throw new ApexEventRuntimeException(
+                "Incoming Event cannot be converted to ExecutionServiceInput type for gRPC request." + e.getMessage());
+        }
+        try {
+            CountDownLatch countDownLatch = client.sendRequest(executionServiceInput);
+            if (!countDownLatch.await(props.getTimeout(), TimeUnit.SECONDS)) {
+                cdsResponse.set(ExecutionServiceOutput.newBuilder().setStatus(Status.newBuilder()
+                    .setErrorMessage(CdsActorConstants.TIMED_OUT).setEventType(EventType.EVENT_COMPONENT_FAILURE))
+                    .build());
+                LOGGER.error("gRPC Request timed out.");
+            }
+        } catch (InterruptedException e) {
+            LOGGER.error("gRPC request failed. {}", e.getMessage());
+            cdsResponse.set(ExecutionServiceOutput.newBuilder().setStatus(Status.newBuilder()
+                .setErrorMessage(CdsActorConstants.INTERRUPTED).setEventType(EventType.EVENT_COMPONENT_FAILURE))
+                .build());
+            Thread.currentThread().interrupt();
+        }
+
+        if (!EventType.EVENT_COMPONENT_EXECUTED.equals(cdsResponse.get().getStatus().getEventType())) {
+            String errorMessage = "Sending event \"" + eventName + "\" by " + this.name + " to CDS failed, "
+                + "response from CDS:\n" + cdsResponse.get();
+            throw new ApexEventRuntimeException(errorMessage);
+        }
+    }
+
+    /**
+     * {@inheritDoc}.
+     */
+    @Override
+    public void stop() {
+        client.close();
+    }
+
+    @Override
+    public void onMessage(ExecutionServiceOutput message) {
+        LOGGER.info("Received notification from CDS: {}", message);
+        cdsResponse.set(message);
+    }
+
+    @Override
+    public void onError(Throwable throwable) {
+        String errorMsg = throwable.getLocalizedMessage();
+        cdsResponse.set(ExecutionServiceOutput.newBuilder()
+            .setStatus(Status.newBuilder().setErrorMessage(errorMsg).setEventType(EventType.EVENT_COMPONENT_FAILURE))
+            .build());
+        LOGGER.error("Failed processing blueprint {} {}", errorMsg, throwable);
+    }
+}
diff --git a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-grpc/src/main/java/org/onap/policy/apex/plugins/event/carrier/grpc/GrpcCarrierTechnologyParameters.java b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-grpc/src/main/java/org/onap/policy/apex/plugins/event/carrier/grpc/GrpcCarrierTechnologyParameters.java
new file mode 100644 (file)
index 0000000..59db167
--- /dev/null
@@ -0,0 +1,90 @@
+/*-
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2020 Nordix Foundation.
+ * ================================================================================
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.apex.plugins.event.carrier.grpc;
+
+import lombok.Getter;
+import lombok.Setter;
+import org.onap.policy.apex.service.parameters.carriertechnology.CarrierTechnologyParameters;
+import org.onap.policy.common.parameters.annotations.Max;
+import org.onap.policy.common.parameters.annotations.Min;
+import org.onap.policy.common.parameters.annotations.NotNull;
+
+// @formatter:off
+/**
+ * Apex parameters for gRPC as an event carrier technology.
+ *
+ * <p>The parameters for this plugin are:
+ * <ol>
+ * <li>host: The host on which CDS is running. This parameter is mandatory
+ * <li>port: The port on the CDS host to connect to for CDS. This parameter is mandatory.
+ * <li>username: The username for basic authentication to connect to CDS. This parameter is mandatory.
+ * <li>password: The password for basic authentication to connect to CDS. This parameter is mandatory.
+ * <li>timeout: The timeout in seconds for CDS requests. This parameter is mandatory.
+ * </ol>
+ *
+ * @author Ajith Sreekumar(ajith.sreekumar@est.tech)
+ */
+//@formatter:on
+@Getter
+@Setter
+public class GrpcCarrierTechnologyParameters extends CarrierTechnologyParameters {
+    // @formatter:off
+    private static final int MIN_USER_PORT =  1024;
+    private static final int MAX_USER_PORT = 65535;
+
+    /** The label of this carrier technology. */
+    public static final String GRPC_CARRIER_TECHNOLOGY_LABEL = "GRPC";
+
+    /** The producer plugin class for the grpc carrier technology. */
+    public static final String GRPC_EVENT_PRODUCER_PLUGIN_CLASS = ApexGrpcProducer.class.getName();
+
+    /** The consumer plugin class for the gRPC carrier technology. */
+    public static final String GRPC_EVENT_CONSUMER_PLUGIN_CLASS = ApexGrpcConsumer.class.getName();
+
+    @Min(value = 1)
+    private int timeout;
+
+    @Min(value = MIN_USER_PORT)
+    @Max(value = MAX_USER_PORT)
+    private int port;
+
+    @NotNull
+    private String host;
+
+    @NotNull
+    private String username;
+
+    @NotNull
+    private String password;
+
+
+    /**
+     * Constructor to create a gRPC carrier technology parameters instance and register the instance with the
+     * parameter service.
+     */
+    public GrpcCarrierTechnologyParameters() {
+        super();
+        // Set the carrier technology properties for the gRPC carrier technology
+        this.setLabel(GRPC_CARRIER_TECHNOLOGY_LABEL);
+        this.setEventProducerPluginClass(GRPC_EVENT_PRODUCER_PLUGIN_CLASS);
+        this.setEventConsumerPluginClass(GRPC_EVENT_CONSUMER_PLUGIN_CLASS);
+    }
+}
diff --git a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-grpc/src/main/java/org/onap/policy/apex/plugins/event/carrier/grpc/package-info.java b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-grpc/src/main/java/org/onap/policy/apex/plugins/event/carrier/grpc/package-info.java
new file mode 100644 (file)
index 0000000..77d2626
--- /dev/null
@@ -0,0 +1,21 @@
+/*-
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2020 Nordix Foundation.
+ * ================================================================================
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.apex.plugins.event.carrier.grpc;
diff --git a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-grpc/src/test/java/org/onap/policy/apex/plugins/event/carrier/grpc/ApexGrpcConsumerTest.java b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-grpc/src/test/java/org/onap/policy/apex/plugins/event/carrier/grpc/ApexGrpcConsumerTest.java
new file mode 100644 (file)
index 0000000..dc5cc38
--- /dev/null
@@ -0,0 +1,93 @@
+/*-
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2020 Nordix Foundation.
+ * ================================================================================
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.apex.plugins.event.carrier.grpc;
+
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
+import static org.junit.Assert.assertEquals;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.onap.policy.apex.service.engine.event.ApexEventException;
+import org.onap.policy.apex.service.engine.event.ApexEventReceiver;
+import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerParameters;
+import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerPeeredMode;
+
+public class ApexGrpcConsumerTest {
+    ApexGrpcConsumer grpcConsumer = null;
+    EventHandlerParameters consumerParameters = null;
+    ApexEventReceiver incomingEventReceiver = null;
+
+    private static final String GRPC_CONSUMER_ERROR_MSG =
+        "A gRPC Consumer may not be specified. Only sending events is possible using gRPC";
+
+    /**
+     * Set up testing.
+     *
+     * @throws ApexEventException on test set up errors.
+     */
+    @Before
+    public void setUp() throws ApexEventException {
+        grpcConsumer = new ApexGrpcConsumer();
+        consumerParameters = new EventHandlerParameters();
+        consumerParameters.setCarrierTechnologyParameters(new GrpcCarrierTechnologyParameters() {});
+    }
+
+    @Test
+    public void testInit() {
+        assertThatThrownBy(() -> {
+            grpcConsumer.init("TestApexGrpcConsumer", consumerParameters, incomingEventReceiver);
+        }).hasMessage(GRPC_CONSUMER_ERROR_MSG);
+    }
+
+    @Test
+    public void testStart() {
+        assertThatThrownBy(() -> {
+            grpcConsumer.start();
+        }).hasMessage(GRPC_CONSUMER_ERROR_MSG);
+    }
+
+    @Test
+    public void testGetName() {
+        assertEquals(null, new ApexGrpcConsumer().getName());
+    }
+
+    @Test
+    public void testGetPeeredReference() {
+        assertThatThrownBy(() -> {
+            grpcConsumer.getPeeredReference(EventHandlerPeeredMode.REQUESTOR);
+        }).hasMessage(GRPC_CONSUMER_ERROR_MSG);
+    }
+
+    @Test
+    public void testSetPeeredReference() {
+        assertThatThrownBy(() -> {
+            grpcConsumer.setPeeredReference(null, null);
+        }).hasMessage(GRPC_CONSUMER_ERROR_MSG);
+    }
+
+    @Test()
+    public void testStop() {
+        assertThatThrownBy(() -> {
+            new ApexGrpcConsumer().stop();
+        }).hasMessage(GRPC_CONSUMER_ERROR_MSG);
+    }
+
+}
diff --git a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-grpc/src/test/java/org/onap/policy/apex/plugins/event/carrier/grpc/ApexGrpcProducerTest.java b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-grpc/src/test/java/org/onap/policy/apex/plugins/event/carrier/grpc/ApexGrpcProducerTest.java
new file mode 100644 (file)
index 0000000..53d191e
--- /dev/null
@@ -0,0 +1,98 @@
+/*-
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2020 Nordix Foundation.
+ * ================================================================================
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.apex.plugins.event.carrier.grpc;
+
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
+import static org.mockito.Mockito.spy;
+
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import org.assertj.core.api.Assertions;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.runners.MockitoJUnitRunner;
+import org.onap.policy.apex.service.engine.event.ApexEventException;
+import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerParameters;
+import org.onap.policy.cds.client.CdsProcessorGrpcClient;
+
+@RunWith(MockitoJUnitRunner.class)
+public class ApexGrpcProducerTest {
+    private static final String HOST = "localhost";
+    @Mock
+    private CdsProcessorGrpcClient grpcClient;
+    private ApexGrpcProducer apexGrpcProducer = spy(new ApexGrpcProducer());
+    @Mock
+    private EventHandlerParameters eventHandlerParameters;
+
+    /**
+     * Set up testing.
+     *
+     * @throws ApexEventException on test set up errors.
+     */
+    @Before
+    public void setUp() throws ApexEventException {
+        populateEventHandlerParameters(HOST, 5);
+    }
+
+    @Test(expected = ApexEventException.class)
+    public void testInit_fail() throws ApexEventException {
+        apexGrpcProducer.init("TestApexGrpcProducer", new EventHandlerParameters());
+    }
+
+    @Test
+    public void testInit_pass() {
+        // should not throw an exception
+        Assertions.assertThatCode(() -> apexGrpcProducer.init("TestApexGrpcProducer", eventHandlerParameters))
+            .doesNotThrowAnyException();
+    }
+
+    @Test
+    public void testStop() throws ApexEventException {
+        apexGrpcProducer.init("TestApexGrpcProducer", eventHandlerParameters);
+        // should not throw an exception
+        Assertions.assertThatCode(() -> apexGrpcProducer.stop()).doesNotThrowAnyException();
+    }
+
+    @Test
+    public void testSendEvent() throws ApexEventException {
+        apexGrpcProducer.init("TestApexGrpcProducer", eventHandlerParameters);
+        assertThatThrownBy(() -> {
+            apexGrpcProducer.sendEvent(123, null, "grpcEvent",
+                Files.readString(Paths.get("src/test/resources/executionServiceInputEvent.json")));
+        }).hasMessageContaining("UNAVAILABLE: io exception");
+    }
+
+    private void populateEventHandlerParameters(String host, int timeout) {
+        eventHandlerParameters = new EventHandlerParameters();
+        GrpcCarrierTechnologyParameters params = new GrpcCarrierTechnologyParameters();
+        params.setLabel("GRPC");
+        params.setEventProducerPluginClass(ApexGrpcProducer.class.getName());
+        params.setEventConsumerPluginClass(ApexGrpcConsumer.class.getName());
+        params.setHost(host);
+        params.setPort(3214);
+        params.setUsername("dummyUser");
+        params.setPassword("dummyPassword");
+        params.setTimeout(timeout);
+        eventHandlerParameters.setCarrierTechnologyParameters(params);
+    }
+}
diff --git a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-grpc/src/test/java/org/onap/policy/apex/plugins/event/carrier/grpc/GrpcCarrierTechnologyParametersTest.java b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-grpc/src/test/java/org/onap/policy/apex/plugins/event/carrier/grpc/GrpcCarrierTechnologyParametersTest.java
new file mode 100644 (file)
index 0000000..a3994c2
--- /dev/null
@@ -0,0 +1,87 @@
+/*-
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2020 Nordix Foundation.
+ * ================================================================================
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.apex.plugins.event.carrier.grpc;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.onap.policy.common.parameters.GroupValidationResult;
+
+public class GrpcCarrierTechnologyParametersTest {
+
+    private static final String USERNAME = "username";
+    private static final String PASSWORD = "password";
+    private static final String HOST = "localhost";
+
+    private GrpcCarrierTechnologyParameters params;
+
+    @Before
+    public void setUp() {
+        params = new GrpcCarrierTechnologyParameters();
+    }
+
+    @Test
+    public void testGrpcCarrierTechnologyParameters_invalid() {
+        GroupValidationResult result = params.validate();
+        assertFalse(result.isValid());
+        assertTrue(result.getResult().contains("field \"timeout\" type \"int\" value \"0\" INVALID, must be >= 1"));
+        assertTrue(result.getResult().contains("field \"port\" type \"int\" value \"0\" INVALID, must be >= 1024"));
+        assertTrue(
+            result.getResult().contains("field \"host\" type \"java.lang.String\" value \"null\" INVALID, is null"));
+        assertTrue(result.getResult()
+            .contains("field \"username\" type \"java.lang.String\" value \"null\" INVALID, is null"));
+        assertTrue(result.getResult()
+            .contains("field \"password\" type \"java.lang.String\" value \"null\" INVALID, is null"));
+        assertTrue(result.getResult().contains(""));
+        assertTrue(result.getResult().contains(""));
+    }
+
+    @Test
+    public void testGrpcCarrierTechnologyParameters_valid() {
+        assertEquals("GRPC", params.getName());
+        assertEquals(ApexGrpcConsumer.class.getName(), params.getEventConsumerPluginClass());
+        assertEquals(ApexGrpcProducer.class.getName(), params.getEventProducerPluginClass());
+
+        params.setHost(HOST);
+        params.setPassword(PASSWORD);
+        params.setPort(2233);
+        params.setTimeout(1000);
+        params.setUsername(USERNAME);
+        GroupValidationResult result = params.validate();
+        assertTrue(result.isValid());
+    }
+
+    @Test
+    public void testGrpcCarrierTechnologyParameters_invalid_values() {
+        params.setHost(HOST);
+        params.setPassword(PASSWORD);
+        params.setTimeout(1000);
+        params.setUsername(USERNAME);
+
+        params.setPort(23); // invalid value
+        GroupValidationResult result = params.validate();
+        assertFalse(result.isValid());
+        assertTrue(result.getResult().contains("field \"port\" type \"int\" value \"23\" INVALID, must be >= 1024"));
+    }
+}
diff --git a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-grpc/src/test/resources/executionServiceInputEvent.json b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-grpc/src/test/resources/executionServiceInputEvent.json
new file mode 100644 (file)
index 0000000..1054af1
--- /dev/null
@@ -0,0 +1,25 @@
+{
+  "actionIdentifiers": {
+    "actionName": "actionName",
+    "blueprintName": "bluePrintName",
+    "blueprintVersion": "1.0.0",
+    "mode": "sync"
+  },
+  "commonHeader": {
+    "originatorId": "sdnc",
+    "requestId": "1234567",
+    "subRequestId": "subReqId"
+  },
+  "payload": {
+    "config-assign-request": {
+      "resolution-key": "RES-KEY",
+      "config-assign-properties": {
+        "service-instance-id": "sid12",
+        "pnf-id": "pnf-id",
+        "pnf-address": "1.2.3.4",
+        "service-uuid": "service-uuid",
+        "customization-uuid": "customization-uuid"
+      }
+    }
+  }
+}
index cd48929..3127c2a 100644 (file)
@@ -1,6 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
 <!--
   ============LICENSE_START=======================================================
    Copyright (C) 2018 Ericsson. All rights reserved.
+   Modifications Copyright (C) 2020 Nordix Foundation.
   ================================================================================
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
@@ -39,7 +41,8 @@
         <module>plugins-event-carrier-restclient</module>
         <module>plugins-event-carrier-restserver</module>
         <module>plugins-event-carrier-restrequestor</module>
-    </modules>
+        <module>plugins-event-carrier-grpc</module>
+  </modules>
 
     <profiles>
         <profile>