HONEYCOMB-127: add routing operational read

Change-Id: I52cdeb6a35e04e8626992a027ad230b9b15fce96
Signed-off-by: Marek Gradzki <mgradzki@cisco.com>

4 files changed, 222 insertions, 10 deletions

diff --git a/v3po/api/src/main/yang/v3po.yang b/v3po/api/src/main/yang/v3po.yang
index f503afe2b..fff8293d5 100644
--- a/v3po/api/src/main/yang/v3po.yang
+++ b/v3po/api/src/main/yang/v3po.yang
@@ -271,6 +271,17 @@ module v3po {
     }
   }
 
+  grouping routing-base-attributes {
+    leaf ipv4-vrf-id {
+      type uint32;
+    }
+    leaf ipv6-vrf-id {
+      type uint32;
+    }
+    description
+      "Defines VRF tables used for ipv4 and ipv6 traffic";
+  }
+
   grouping ethernet-state-attributes {
     leaf manufacturer-description {
       type string;
@@ -472,15 +483,7 @@ module v3po {
     }
 
     container routing {
-      // TODO (HONEYCOMB-127): add routing info for oper
-      leaf ipv4-vrf-id {
-        type uint32;
-      }
-      leaf ipv6-vrf-id {
-        type uint32;
-      }
-      description
-        "Defines VRF tables used for ipv4 and ipv6 traffic";
+      uses routing-base-attributes;
     }
 
     container vhost-user {
@@ -578,6 +581,10 @@ module v3po {
       uses ethernet-state-attributes;
     }
 
+    container routing {
+      uses routing-base-attributes;
+    }
+
     container vhost-user {
       when "../if:type = 'v3po:vhost-user'";
       uses vhost-user-interface-base-attributes;
diff --git a/v3po/v3po2vpp/src/main/java/io/fd/hc2vpp/v3po/factory/InterfacesStateReaderFactory.java b/v3po/v3po2vpp/src/main/java/io/fd/hc2vpp/v3po/factory/InterfacesStateReaderFactory.java
index aadb9c174..830147cc2 100644
--- a/v3po/v3po2vpp/src/main/java/io/fd/hc2vpp/v3po/factory/InterfacesStateReaderFactory.java
+++ b/v3po/v3po2vpp/src/main/java/io/fd/hc2vpp/v3po/factory/InterfacesStateReaderFactory.java
@@ -26,6 +26,7 @@ import io.fd.hc2vpp.v3po.interfacesstate.GreCustomizer;
 import io.fd.hc2vpp.v3po.interfacesstate.InterfaceCustomizer;
 import io.fd.hc2vpp.v3po.interfacesstate.L2Customizer;
 import io.fd.hc2vpp.v3po.interfacesstate.ProxyArpCustomizer;
+import io.fd.hc2vpp.v3po.interfacesstate.RoutingCustomizer;
 import io.fd.hc2vpp.v3po.interfacesstate.TapCustomizer;
 import io.fd.hc2vpp.v3po.interfacesstate.VhostUserCustomizer;
 import io.fd.hc2vpp.v3po.interfacesstate.VxlanCustomizer;
@@ -62,6 +63,7 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces.state._interface.Gre;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces.state._interface.L2;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces.state._interface.ProxyArp;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces.state._interface.Routing;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces.state._interface.Span;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces.state._interface.SpanBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces.state._interface.Tap;
@@ -145,7 +147,10 @@ public final class InterfacesStateReaderFactory implements ReaderFactory {
         registry.addStructuralReader(vppIfcAugId, VppInterfaceStateAugmentationBuilder.class);
         //    Ethernet
         registry.add(new GenericInitReader<>(vppIfcAugId.child(Ethernet.class),
-                        new EthernetCustomizer(jvpp, ifcNamingCtx)));
+            new EthernetCustomizer(jvpp, ifcNamingCtx)));
+        //    Routing
+        registry.add(new GenericInitReader<>(vppIfcAugId.child(Routing.class),
+            new RoutingCustomizer(jvpp, ifcNamingCtx)));
         //    Tap
         registry.add(new GenericInitReader<>(vppIfcAugId.child(Tap.class), new TapCustomizer(jvpp, ifcNamingCtx)));
         //    VhostUser
diff --git a/v3po/v3po2vpp/src/main/java/io/fd/hc2vpp/v3po/interfacesstate/RoutingCustomizer.java b/v3po/v3po2vpp/src/main/java/io/fd/hc2vpp/v3po/interfacesstate/RoutingCustomizer.java
new file mode 100644
index 000000000..428447d67
--- /dev/null
+++ b/v3po/v3po2vpp/src/main/java/io/fd/hc2vpp/v3po/interfacesstate/RoutingCustomizer.java
@@ -0,0 +1,107 @@
+/*
+ * 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.hc2vpp.v3po.interfacesstate;
+
+import com.google.common.primitives.UnsignedInts;
+import io.fd.hc2vpp.common.translate.util.FutureJVppCustomizer;
+import io.fd.hc2vpp.common.translate.util.JvppReplyConsumer;
+import io.fd.hc2vpp.common.translate.util.NamingContext;
+import io.fd.honeycomb.translate.read.ReadContext;
+import io.fd.honeycomb.translate.read.ReadFailedException;
+import io.fd.honeycomb.translate.spi.read.Initialized;
+import io.fd.honeycomb.translate.spi.read.InitializingReaderCustomizer;
+import io.fd.honeycomb.translate.util.RWUtils;
+import io.fd.vpp.jvpp.core.dto.SwInterfaceGetTable;
+import io.fd.vpp.jvpp.core.dto.SwInterfaceGetTableReply;
+import io.fd.vpp.jvpp.core.future.FutureJVppCore;
+import javax.annotation.Nonnull;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.VppInterfaceAugmentation;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.VppInterfaceStateAugmentationBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces.state._interface.Routing;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces.state._interface.RoutingBuilder;
+import org.opendaylight.yangtools.concepts.Builder;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class RoutingCustomizer extends FutureJVppCustomizer implements
+    InitializingReaderCustomizer<Routing, RoutingBuilder>, JvppReplyConsumer {
+
+    private static final Logger LOG = LoggerFactory.getLogger(RoutingCustomizer.class);
+    private final NamingContext interfaceContext;
+
+    public RoutingCustomizer(final FutureJVppCore vppApi, final NamingContext interfaceContext) {
+        super(vppApi);
+        this.interfaceContext = interfaceContext;
+    }
+
+    @Nonnull
+    @Override
+    public RoutingBuilder getBuilder(@Nonnull final InstanceIdentifier<Routing> id) {
+        return new RoutingBuilder();
+    }
+
+    @Override
+    public void readCurrentAttributes(@Nonnull final InstanceIdentifier<Routing> id,
+                                      @Nonnull final RoutingBuilder builder,
+                                      @Nonnull final ReadContext ctx) throws ReadFailedException {
+        LOG.debug("Reading attributes for Routing: {}", id);
+        final String ifName = id.firstKeyOf(Interface.class).getName();
+        final SwInterfaceGetTable request = new SwInterfaceGetTable();
+        request.swIfIndex = interfaceContext.getIndex(ifName, ctx.getMappingContext());
+        request.isIpv6 = 0;
+        final SwInterfaceGetTableReply ip4Reply = getReplyForRead(getFutureJVpp().swInterfaceGetTable(request).toCompletableFuture(), id);
+
+        request.isIpv6 = 1;
+        final SwInterfaceGetTableReply ip6Reply = getReplyForRead(getFutureJVpp().swInterfaceGetTable(request).toCompletableFuture(), id);
+
+        if (ip4Reply.vrfId != 0) {
+            builder.setIpv4VrfId(UnsignedInts.toLong(ip4Reply.vrfId));
+        }
+        if (ip6Reply.vrfId != 0) {
+            builder.setIpv6VrfId(UnsignedInts.toLong(ip6Reply.vrfId));
+        }
+    }
+
+    @Override
+    public void merge(@Nonnull final Builder<? extends DataObject> parentBuilder, @Nonnull final Routing readValue) {
+        ((VppInterfaceStateAugmentationBuilder)parentBuilder).setRouting(readValue);
+    }
+
+    @Nonnull
+    @Override
+    public Initialized<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.Routing> init(
+        @Nonnull final InstanceIdentifier<Routing> id,
+        @Nonnull final Routing readValue,
+        @Nonnull final ReadContext ctx) {
+        return Initialized.create(getCfgId(id),
+            new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.RoutingBuilder()
+                .setIpv4VrfId(readValue.getIpv4VrfId())
+                .setIpv6VrfId(readValue.getIpv6VrfId())
+                .build());
+    }
+
+    private InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.Routing> getCfgId(
+        final InstanceIdentifier<Routing> id) {
+        return InterfaceCustomizer.getCfgId(RWUtils.cutId(id, Interface.class))
+            .augmentation(VppInterfaceAugmentation.class)
+            .child(
+                org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.Routing.class);
+    }
+}
diff --git a/v3po/v3po2vpp/src/test/java/io/fd/hc2vpp/v3po/interfacesstate/RoutingCustomizerTest.java b/v3po/v3po2vpp/src/test/java/io/fd/hc2vpp/v3po/interfacesstate/RoutingCustomizerTest.java
new file mode 100644
index 000000000..9e1f62851
--- /dev/null
+++ b/v3po/v3po2vpp/src/test/java/io/fd/hc2vpp/v3po/interfacesstate/RoutingCustomizerTest.java
@@ -0,0 +1,93 @@
+/*
+ * 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.hc2vpp.v3po.interfacesstate;
+
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.verifyZeroInteractions;
+import static org.mockito.Mockito.when;
+
+import io.fd.hc2vpp.common.test.read.ReaderCustomizerTest;
+import io.fd.hc2vpp.common.translate.util.NamingContext;
+import io.fd.honeycomb.translate.spi.read.ReaderCustomizer;
+import io.fd.vpp.jvpp.core.dto.SwInterfaceGetTableReply;
+import org.junit.Test;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfacesState;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.VppInterfaceStateAugmentation;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.VppInterfaceStateAugmentationBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces.state._interface.Routing;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces.state._interface.RoutingBuilder;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+
+public class RoutingCustomizerTest extends ReaderCustomizerTest<Routing, RoutingBuilder> {
+
+    private static final String IFC_CTX_NAME = "ifc-test-instance";
+    private static final String IF_NAME = "local0";
+    private static final int IF_ID = 1;
+    private static final Long IP4_VRF_ID = 1L;
+    private static final Long IP6_VRF_ID = 2L;
+
+    private NamingContext interfacesContext;
+
+    public RoutingCustomizerTest() {
+        super(Routing.class, VppInterfaceStateAugmentationBuilder.class);
+    }
+
+    @Override
+    public void setUp() {
+        interfacesContext = new NamingContext("generatedIfaceName", IFC_CTX_NAME);
+        defineMapping(mappingContext, IF_NAME, IF_ID, IFC_CTX_NAME);
+    }
+
+    @Override
+    protected ReaderCustomizer<Routing, RoutingBuilder> initCustomizer() {
+        return new RoutingCustomizer(api, interfacesContext);
+    }
+
+    private InstanceIdentifier<Routing> getRoutingId(final String name) {
+        return InstanceIdentifier.create(InterfacesState.class).child(Interface.class, new InterfaceKey(name))
+             .augmentation(VppInterfaceStateAugmentation.class).child(Routing.class);
+    }
+
+    @Test
+    public void testRead() throws Exception {
+        final RoutingBuilder builder = mock(RoutingBuilder.class);
+        when(api.swInterfaceGetTable(any())).thenReturn(future(tableReply(IP4_VRF_ID))).thenReturn(future(tableReply(IP6_VRF_ID)));
+        getCustomizer().readCurrentAttributes(getRoutingId(IF_NAME), builder, ctx);
+
+        verify(builder).setIpv4VrfId(IP4_VRF_ID);
+        verify(builder).setIpv6VrfId(IP6_VRF_ID);
+    }
+
+    @Test
+    public void testReadRoutingNotDefined() throws Exception {
+        final RoutingBuilder builder = mock(RoutingBuilder.class);
+        final Long vrfId = 0L;
+        when(api.swInterfaceGetTable(any())).thenReturn(future(tableReply(vrfId)));
+        getCustomizer().readCurrentAttributes(getRoutingId(IF_NAME), builder, ctx);
+        verifyZeroInteractions(builder);
+    }
+
+    private SwInterfaceGetTableReply tableReply(final Long vrfId) {
+        final SwInterfaceGetTableReply reply = new SwInterfaceGetTableReply();
+        reply.vrfId = vrfId.intValue();
+        return reply;
+    }
+}
\ No newline at end of file