summaryrefslogtreecommitdiffstats
path: root/infra/rpc/impl
diff options
context:
space:
mode:
Diffstat (limited to 'infra/rpc/impl')
-rw-r--r--infra/rpc/impl/asciidoc/Readme.adoc3
-rw-r--r--infra/rpc/impl/pom.xml69
-rw-r--r--infra/rpc/impl/src/main/java/io/fd/honeycomb/rpc/HoneycombDOMRpcService.java96
-rw-r--r--infra/rpc/impl/src/main/java/io/fd/honeycomb/rpc/RpcRegistryBuilder.java63
-rw-r--r--infra/rpc/impl/src/test/java/io/fd/honeycomb/rpc/HoneycombDOMRpcServiceTest.java82
-rw-r--r--infra/rpc/impl/src/test/java/io/fd/honeycomb/rpc/RpcRegistryBuilderTest.java80
6 files changed, 393 insertions, 0 deletions
diff --git a/infra/rpc/impl/asciidoc/Readme.adoc b/infra/rpc/impl/asciidoc/Readme.adoc
new file mode 100644
index 000000000..9b9441a5a
--- /dev/null
+++ b/infra/rpc/impl/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= rpc-impl
+
+Overview of rpc-impl \ No newline at end of file
diff --git a/infra/rpc/impl/pom.xml b/infra/rpc/impl/pom.xml
new file mode 100644
index 000000000..7e52f4d8f
--- /dev/null
+++ b/infra/rpc/impl/pom.xml
@@ -0,0 +1,69 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright (c) 2015 Cisco and/or its affiliates.
+ 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.
+-->
+<project xmlns="http://maven.apache.org/POM/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">
+ <parent>
+ <groupId>io.fd.honeycomb.common</groupId>
+ <artifactId>impl-parent</artifactId>
+ <version>1.17.01-SNAPSHOT</version>
+ <relativePath>../../../common/impl-parent</relativePath>
+ </parent>
+
+ <modelVersion>4.0.0</modelVersion>
+ <groupId>io.fd.honeycomb</groupId>
+ <artifactId>rpc-impl</artifactId>
+ <name>${project.artifactId}</name>
+ <version>1.17.01-SNAPSHOT</version>
+ <packaging>bundle</packaging>
+
+ <dependencies>
+ <dependency>
+ <groupId>${project.groupId}</groupId>
+ <artifactId>rpc-api</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.mockito</groupId>
+ <artifactId>mockito-core</artifactId>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.opendaylight.mdsal</groupId>
+ <artifactId>mdsal-binding-dom-codec</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.opendaylight.controller</groupId>
+ <artifactId>sal-core-spi</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>net.javacrumbs.future-converter</groupId>
+ <artifactId>future-converter-java8-guava</artifactId>
+ <version>0.3.0</version>
+ </dependency>
+
+ <!-- tests -->
+ <dependency>
+ <groupId>junit</groupId>
+ <artifactId>junit</artifactId>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.mockito</groupId>
+ <artifactId>mockito-core</artifactId>
+ <scope>test</scope>
+ </dependency>
+ </dependencies>
+</project>
diff --git a/infra/rpc/impl/src/main/java/io/fd/honeycomb/rpc/HoneycombDOMRpcService.java b/infra/rpc/impl/src/main/java/io/fd/honeycomb/rpc/HoneycombDOMRpcService.java
new file mode 100644
index 000000000..09f93db36
--- /dev/null
+++ b/infra/rpc/impl/src/main/java/io/fd/honeycomb/rpc/HoneycombDOMRpcService.java
@@ -0,0 +1,96 @@
+/*
+ * Copyright (c) 2016 Cisco and/or its affiliates.
+ *
+ * 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.
+ */
+
+package io.fd.honeycomb.rpc;
+
+import static net.javacrumbs.futureconverter.java8guava.FutureConverter.toListenableFuture;
+
+import com.google.common.base.Function;
+import com.google.common.util.concurrent.CheckedFuture;
+import com.google.common.util.concurrent.Futures;
+import com.google.common.util.concurrent.ListenableFuture;
+import java.util.concurrent.CompletableFuture;
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+import org.opendaylight.controller.md.sal.dom.api.DOMRpcAvailabilityListener;
+import org.opendaylight.controller.md.sal.dom.api.DOMRpcException;
+import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
+import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
+import org.opendaylight.controller.md.sal.dom.spi.DefaultDOMRpcResult;
+import org.opendaylight.yangtools.binding.data.codec.api.BindingNormalizedNodeSerializer;
+import org.opendaylight.yangtools.concepts.ListenerRegistration;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
+import org.opendaylight.yangtools.yang.model.api.SchemaPath;
+
+public final class HoneycombDOMRpcService implements DOMRpcService {
+
+ private static final Function<? super Exception, DOMRpcException> ANY_EX_TO_RPC_EXCEPTION_MAPPER =
+ (Function<Exception, DOMRpcException>) e -> (e instanceof DOMRpcException)
+ ? (DOMRpcException) e
+ : new RpcException("RPC failed", e);
+
+ // TODO HONEYCOMB-161 what to use instead of deprecated BindingNormalizedNodeSerializer ?
+ private final BindingNormalizedNodeSerializer serializer;
+ private final RpcRegistry rpcRegistry;
+
+ public HoneycombDOMRpcService(@Nonnull final BindingNormalizedNodeSerializer serializer,
+ @Nonnull final RpcRegistry rpcRegistry) {
+ this.serializer = serializer;
+ this.rpcRegistry = rpcRegistry;
+ }
+
+ @Nonnull
+ @Override
+ public CheckedFuture<DOMRpcResult, DOMRpcException> invokeRpc(@Nonnull final SchemaPath schemaPath,
+ @Nullable final NormalizedNode<?, ?> normalizedNode) {
+ DataObject input = null;
+ if (normalizedNode != null) {
+ // RPC input is optional
+ final SchemaPath nodePatch = schemaPath.createChild(normalizedNode.getNodeType());
+ input = serializer.fromNormalizedNodeRpcData(nodePatch, (ContainerNode) normalizedNode);
+ }
+ final CompletableFuture<DataObject> result = rpcRegistry.invoke(schemaPath, input).toCompletableFuture();
+ final ListenableFuture<DOMRpcResult> output = getDOMRpcResult(toListenableFuture(result));
+ return Futures.makeChecked(output, ANY_EX_TO_RPC_EXCEPTION_MAPPER);
+ }
+
+ private ListenableFuture<DOMRpcResult> getDOMRpcResult(final ListenableFuture<DataObject> invoke) {
+ return Futures.transform(
+ invoke,
+ (Function<DataObject, DOMRpcResult>) output -> {
+ final ContainerNode outputNode = serializer.toNormalizedNodeRpcData(output);
+ return new DefaultDOMRpcResult(outputNode);
+ });
+ }
+
+ @Nonnull
+ @Override
+ public <T extends DOMRpcAvailabilityListener> ListenerRegistration<T> registerRpcListener(@Nonnull final T t) {
+ return new ListenerRegistration<T>() {
+ @Override
+ public void close() {
+ // Noop
+ }
+
+ @Override
+ public T getInstance() {
+ return t;
+ }
+ };
+ }
+}
diff --git a/infra/rpc/impl/src/main/java/io/fd/honeycomb/rpc/RpcRegistryBuilder.java b/infra/rpc/impl/src/main/java/io/fd/honeycomb/rpc/RpcRegistryBuilder.java
new file mode 100644
index 000000000..0b96be0a3
--- /dev/null
+++ b/infra/rpc/impl/src/main/java/io/fd/honeycomb/rpc/RpcRegistryBuilder.java
@@ -0,0 +1,63 @@
+/*
+ * Copyright (c) 2016 Cisco and/or its affiliates.
+ *
+ * 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.
+ */
+
+package io.fd.honeycomb.rpc;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.CompletionStage;
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+import org.opendaylight.controller.md.sal.dom.api.DOMRpcImplementationNotAvailableException;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.model.api.SchemaPath;
+
+public final class RpcRegistryBuilder {
+
+ private Map<SchemaPath, RpcService> services = new HashMap<>();
+
+ public RpcRegistry build() {
+ return new RpcRegistryImpl(services);
+ }
+
+ public void addService(@Nonnull final RpcService service) {
+ services.put(service.getManagedNode(), service);
+ }
+
+
+ private static final class RpcRegistryImpl implements RpcRegistry {
+ private final Map<SchemaPath, RpcService> services;
+
+ private RpcRegistryImpl(@Nonnull final Map<SchemaPath, RpcService> services) {
+ this.services = services;
+ }
+
+ @Override
+ @Nonnull
+ public CompletionStage invoke(@Nonnull final SchemaPath schemaPath, @Nullable final DataObject request) {
+ final RpcService rpcService = services.get(schemaPath);
+ if (rpcService == null) {
+ final CompletableFuture<DataObject> result = new CompletableFuture<>();
+ result.completeExceptionally(
+ new DOMRpcImplementationNotAvailableException("Service not found: %s", schemaPath));
+ return result;
+ }
+ return rpcService.invoke(request);
+
+ }
+ }
+}
diff --git a/infra/rpc/impl/src/test/java/io/fd/honeycomb/rpc/HoneycombDOMRpcServiceTest.java b/infra/rpc/impl/src/test/java/io/fd/honeycomb/rpc/HoneycombDOMRpcServiceTest.java
new file mode 100644
index 000000000..476db5604
--- /dev/null
+++ b/infra/rpc/impl/src/test/java/io/fd/honeycomb/rpc/HoneycombDOMRpcServiceTest.java
@@ -0,0 +1,82 @@
+/*
+ * Copyright (c) 2016 Cisco and/or its affiliates.
+ *
+ * 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.
+ */
+
+package io.fd.honeycomb.rpc;
+
+import static org.junit.Assert.assertEquals;
+
+import java.util.concurrent.CompletableFuture;
+import org.junit.Before;
+import org.junit.Test;
+import org.mockito.ArgumentMatchers;
+import org.mockito.Mock;
+import org.mockito.Mockito;
+import org.mockito.MockitoAnnotations;
+import org.opendaylight.yangtools.binding.data.codec.api.BindingNormalizedNodeSerializer;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
+import org.opendaylight.yangtools.yang.model.api.SchemaPath;
+
+public class HoneycombDOMRpcServiceTest {
+
+ @Mock
+ private BindingNormalizedNodeSerializer serializer;
+ @Mock
+ private RpcRegistry registry;
+ @Mock
+ private SchemaPath path;
+ @Mock
+ private DataObject input;
+ @Mock
+ private ContainerNode output;
+
+ private ContainerNode node;
+ private HoneycombDOMRpcService service;
+
+ @Before
+ public void setUp() {
+ MockitoAnnotations.initMocks(this);
+ node = mockContainerNode(QName.create("a"));
+
+ service = new HoneycombDOMRpcService(serializer, registry);
+
+ Mockito.when(serializer.fromNormalizedNodeRpcData(ArgumentMatchers.any(), ArgumentMatchers.any())).thenReturn(input);
+ Mockito.when(serializer.toNormalizedNodeRpcData(ArgumentMatchers.any())).thenReturn(output);
+ }
+
+ @Test
+ public void testInvokeRpc() throws Exception {
+ Mockito.when(registry.invoke(path, input)).thenReturn(CompletableFuture.completedFuture(input));
+
+ assertEquals(output, service.invokeRpc(path, node).get().getResult());
+ }
+
+ @Test(expected = RpcException.class)
+ public void testInvokeRpcFailed() throws Exception {
+ final CompletableFuture future = new CompletableFuture();
+ future.completeExceptionally(new RuntimeException());
+ Mockito.when(registry.invoke(path, input)).thenReturn(future);
+
+ service.invokeRpc(path, node).checkedGet();
+ }
+
+ private ContainerNode mockContainerNode(final QName nn1) {
+ final ContainerNode nn1B = Mockito.mock(ContainerNode.class);
+ Mockito.when(nn1B.getNodeType()).thenReturn(nn1);
+ return nn1B;
+ }
+} \ No newline at end of file
diff --git a/infra/rpc/impl/src/test/java/io/fd/honeycomb/rpc/RpcRegistryBuilderTest.java b/infra/rpc/impl/src/test/java/io/fd/honeycomb/rpc/RpcRegistryBuilderTest.java
new file mode 100644
index 000000000..c7d7ce746
--- /dev/null
+++ b/infra/rpc/impl/src/test/java/io/fd/honeycomb/rpc/RpcRegistryBuilderTest.java
@@ -0,0 +1,80 @@
+/*
+ * Copyright (c) 2016 Cisco and/or its affiliates.
+ *
+ * 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.
+ */
+
+package io.fd.honeycomb.rpc;
+
+import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.fail;
+
+import java.util.concurrent.ExecutionException;
+import org.junit.Before;
+import org.junit.Test;
+import org.mockito.ArgumentMatchers;
+import org.mockito.Mock;
+import org.mockito.Mockito;
+import org.opendaylight.controller.md.sal.dom.api.DOMRpcImplementationNotAvailableException;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.model.api.SchemaPath;
+
+public class RpcRegistryBuilderTest {
+
+ private RpcRegistry registry;
+ @Mock
+ private RpcService service1;
+ @Mock
+ private RpcService service2;
+ private static final SchemaPath ID1 = SchemaPath.ROOT.createChild(QName.create("a"));
+ private static final SchemaPath ID2 = SchemaPath.ROOT.createChild(QName.create("b"));
+
+ @Before
+ public void setUp() {
+ service1 = Mockito.mock(RpcService.class);
+ Mockito.when(service1.getManagedNode()).thenReturn(ID1);
+
+ service2 = Mockito.mock(RpcService.class);
+ Mockito.when(service2.getManagedNode()).thenReturn(ID2);
+
+ final RpcRegistryBuilder builder = new RpcRegistryBuilder();
+ builder.addService(service1);
+ builder.addService(service2);
+ registry = builder.build();
+ }
+
+ @Test
+ public void testInvokeService() {
+ final DataObject request = Mockito.mock(DataObject.class);
+
+ registry.invoke(ID2, request);
+
+ Mockito.verify(service2).invoke(request);
+ Mockito.verify(service1, Mockito.never()).invoke(ArgumentMatchers.any());
+ }
+
+ @Test
+ public void testServiceNotFound() throws ExecutionException, InterruptedException {
+ final SchemaPath id = SchemaPath.ROOT.createChild(QName.create("c"));
+ final DataObject request = Mockito.mock(DataObject.class);
+
+ try {
+ registry.invoke(id, request).toCompletableFuture().get();
+ } catch (Exception e) {
+ assertTrue(e.getCause() instanceof DOMRpcImplementationNotAvailableException);
+ return;
+ }
+ fail("Exception expected");
+ }
+} \ No newline at end of file