HC2VPP-105: nat64 prefix read

Also updates NAT postman collection with nat64 prefix configuration examples

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

4 files changed, 323 insertions, 0 deletions

diff --git a/nat/nat2vpp/src/main/java/io/fd/hc2vpp/nat/read/Nat64PrefixesCustomizer.java b/nat/nat2vpp/src/main/java/io/fd/hc2vpp/nat/read/Nat64PrefixesCustomizer.java
new file mode 100644
index 000000000..badc6e9bd
--- /dev/null
+++ b/nat/nat2vpp/src/main/java/io/fd/hc2vpp/nat/read/Nat64PrefixesCustomizer.java
@@ -0,0 +1,142 @@
+/*
+ * Copyright (c) 2017 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.nat.read;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+
+import com.google.common.collect.Maps;
+import com.google.common.primitives.UnsignedBytes;
+import com.google.common.primitives.UnsignedInts;
+import io.fd.hc2vpp.common.translate.util.Ipv6Translator;
+import io.fd.hc2vpp.common.translate.util.JvppReplyConsumer;
+import io.fd.honeycomb.translate.read.ReadContext;
+import io.fd.honeycomb.translate.read.ReadFailedException;
+import io.fd.honeycomb.translate.spi.read.ListReaderCustomizer;
+import io.fd.honeycomb.translate.util.read.cache.DumpCacheManager;
+import io.fd.honeycomb.translate.util.read.cache.EntityDumpExecutor;
+import io.fd.honeycomb.translate.util.read.cache.StaticCacheKeyFactory;
+import io.fd.vpp.jvpp.nat.dto.Nat64PrefixDetails;
+import io.fd.vpp.jvpp.nat.dto.Nat64PrefixDetailsReplyDump;
+import io.fd.vpp.jvpp.nat.dto.Nat64PrefixDump;
+import io.fd.vpp.jvpp.nat.future.FutureJVppNatFacade;
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+import javax.annotation.Nonnull;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.nat.parameters.Nat64Prefixes;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.nat.parameters.Nat64PrefixesBuilder;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.nat.parameters.Nat64PrefixesKey;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.nat.state.nat.instances.NatInstance;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.nat.state.nat.instances.NatInstanceKey;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.nat.state.nat.instances.nat.instance.NatCurrentConfigBuilder;
+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;
+
+final class Nat64PrefixesCustomizer
+        implements ListReaderCustomizer<Nat64Prefixes, Nat64PrefixesKey, Nat64PrefixesBuilder>,
+        JvppReplyConsumer, Ipv6Translator {
+
+    private static final Logger LOG = LoggerFactory.getLogger(Nat64PrefixesCustomizer.class);
+
+    private final DumpCacheManager<Map<Long, Nat64PrefixDetails>, Void> dumpManager;
+
+    Nat64PrefixesCustomizer(@Nonnull final FutureJVppNatFacade jvppNat) {
+        this.dumpManager = new DumpCacheManager.DumpCacheManagerBuilder<Map<Long, Nat64PrefixDetails>, Void>()
+                .withExecutor(new Nat64PrefixesExecutor(jvppNat))
+                .withCacheKeyFactory(
+                        new StaticCacheKeyFactory(Nat64PrefixesCustomizer.class.getName() + "_dump", Map.class))
+                .build();
+    }
+
+    @Nonnull
+    @Override
+    public List<Nat64PrefixesKey> getAllIds(@Nonnull final InstanceIdentifier<Nat64Prefixes> id,
+                                            @Nonnull final ReadContext context)
+            throws ReadFailedException {
+        final NatInstanceKey natKey = id.firstKeyOf(NatInstance.class);
+        LOG.trace("Listing IDs for all nat64 prefixes within nat-instance(vrf): {}", natKey);
+
+        final Map<Long, Nat64PrefixDetails> prefixesByVrfId =
+                dumpManager.getDump(id, context.getModificationCache(), null).get();
+        final Nat64PrefixDetails nat64PrefixDetails = prefixesByVrfId.get(natKey.getId());
+        if (nat64PrefixDetails != null) {
+            // VPP supports only single nat64-prefix per VRF/nat-instance (we map nat-instances to VRFs)
+            // To ensure that (and for simplicity), we set nat64-prefix-id to 0.
+            return Collections.singletonList(new Nat64PrefixesKey(0L));
+        } else {
+            return Collections.emptyList();
+        }
+    }
+
+    @Override
+    public void merge(@Nonnull final Builder<? extends DataObject> builder,
+                      @Nonnull final List<Nat64Prefixes> readData) {
+        ((NatCurrentConfigBuilder) builder).setNat64Prefixes(readData);
+    }
+
+    @Nonnull
+    @Override
+    public Nat64PrefixesBuilder getBuilder(@Nonnull final InstanceIdentifier<Nat64Prefixes> id) {
+        return new Nat64PrefixesBuilder();
+    }
+
+    @Override
+    public void readCurrentAttributes(@Nonnull final InstanceIdentifier<Nat64Prefixes> id,
+                                      @Nonnull final Nat64PrefixesBuilder builder, @Nonnull final ReadContext context)
+            throws ReadFailedException {
+        LOG.trace("Reading nat64-prefixes: {}", id);
+        final long prefixId = id.firstKeyOf(Nat64Prefixes.class).getNat64PrefixId().longValue();
+        if (prefixId != 0L) {
+            // Ignore non zero IDs (VPP supports single nat64 prefix per VRF)
+            return;
+        }
+        final Map<Long, Nat64PrefixDetails> prefixesByVrfId =
+                dumpManager.getDump(id, context.getModificationCache(), null).get();
+        final Nat64PrefixDetails prefixDetails = prefixesByVrfId.get(id.firstKeyOf(NatInstance.class).getId());
+        if (prefixDetails != null) {
+            builder.setNat64PrefixId(prefixId);
+            builder.setNat64Prefix(
+                    arrayToIpv6Prefix(prefixDetails.prefix, UnsignedBytes.toInt(prefixDetails.prefixLen)));
+        }
+    }
+
+    private final class Nat64PrefixesExecutor implements EntityDumpExecutor<Map<Long, Nat64PrefixDetails>, Void> {
+        private final FutureJVppNatFacade jvppNat;
+
+        private Nat64PrefixesExecutor(@Nonnull final FutureJVppNatFacade jvppNat) {
+            this.jvppNat = checkNotNull(jvppNat, "jvppNat should not be null");
+        }
+
+        @Nonnull
+        @Override
+        public Map<Long, Nat64PrefixDetails> executeDump(final InstanceIdentifier<?> id, final Void params)
+                throws ReadFailedException {
+            final Nat64PrefixDetailsReplyDump dump =
+                    getReplyForRead(jvppNat.nat64PrefixDump(new Nat64PrefixDump()).toCompletableFuture(), id);
+            // To improve read performance (if multiple nat instances are defined),
+            // we store map instead of list of prefixes.
+
+            // Current nat64-prefixes mapping relies on the fact, that VPP supports single prefix for VRF.
+            // To validate that we rely on Guava's Maps.uniqueIndex which trows IllegalStateException
+            // if duplicate key is found.
+            return Maps.uniqueIndex(dump.nat64PrefixDetails, prefixDetails -> UnsignedInts.toLong(prefixDetails.vrfId));
+        }
+    }
+}
diff --git a/nat/nat2vpp/src/main/java/io/fd/hc2vpp/nat/read/NatReaderFactory.java b/nat/nat2vpp/src/main/java/io/fd/hc2vpp/nat/read/NatReaderFactory.java
index 754f19337..a97d47a1a 100644
--- a/nat/nat2vpp/src/main/java/io/fd/hc2vpp/nat/read/NatReaderFactory.java
+++ b/nat/nat2vpp/src/main/java/io/fd/hc2vpp/nat/read/NatReaderFactory.java
@@ -20,6 +20,7 @@ import com.google.common.collect.Sets;
 import com.google.inject.Inject;
 import io.fd.hc2vpp.nat.util.MappingEntryContext;
 import io.fd.honeycomb.translate.impl.read.GenericInitListReader;
+import io.fd.honeycomb.translate.impl.read.GenericListReader;
 import io.fd.honeycomb.translate.read.ReaderFactory;
 import io.fd.honeycomb.translate.read.registry.ModifiableReaderRegistryBuilder;
 import io.fd.honeycomb.translate.util.read.cache.DumpCacheManager;
@@ -32,6 +33,8 @@ import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev1509
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.mapping.entry.ExternalSrcPort;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.mapping.entry.InternalSrcPort;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.nat.parameters.ExternalIpAddressPool;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.nat.parameters.Nat64Prefixes;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.nat.parameters.nat64.prefixes.DestinationIpv4Prefix;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.nat.state.NatInstances;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.nat.state.NatInstancesBuilder;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.nat.state.nat.instances.NatInstance;
@@ -90,5 +93,11 @@ public class NatReaderFactory implements ReaderFactory {
         registry.addStructuralReader(CURRENT_CONFIG, NatCurrentConfigBuilder.class);
         registry.add(new GenericInitListReader<>(CURRENT_CONFIG.child(ExternalIpAddressPool.class),
                 new ExternalIpPoolCustomizer(jvppNat)));
+
+        // nat64-prefixes
+        registry.subtreeAdd(
+                Sets.newHashSet(InstanceIdentifier.create(Nat64Prefixes.class).child(DestinationIpv4Prefix.class)),
+                new GenericListReader<>(CURRENT_CONFIG.child(Nat64Prefixes.class),
+                        new Nat64PrefixesCustomizer(jvppNat)));
     }
 }
diff --git a/nat/nat2vpp/src/test/java/io/fd/hc2vpp/nat/read/Nat64PrefixesCustomizerTest.java b/nat/nat2vpp/src/test/java/io/fd/hc2vpp/nat/read/Nat64PrefixesCustomizerTest.java
new file mode 100644
index 000000000..bdb1793ff
--- /dev/null
+++ b/nat/nat2vpp/src/test/java/io/fd/hc2vpp/nat/read/Nat64PrefixesCustomizerTest.java
@@ -0,0 +1,130 @@
+/*
+ * Copyright (c) 2017 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.nat.read;
+
+import static org.junit.Assert.assertEquals;
+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.ListReaderCustomizerTest;
+import io.fd.honeycomb.translate.read.ReadFailedException;
+import io.fd.honeycomb.translate.spi.read.ReaderCustomizer;
+import io.fd.vpp.jvpp.nat.dto.Nat64PrefixDetails;
+import io.fd.vpp.jvpp.nat.dto.Nat64PrefixDetailsReplyDump;
+import io.fd.vpp.jvpp.nat.future.FutureJVppNatFacade;
+import java.util.List;
+import org.junit.Test;
+import org.mockito.Mock;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.nat.parameters.Nat64Prefixes;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.nat.parameters.Nat64PrefixesBuilder;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.nat.parameters.Nat64PrefixesKey;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.nat.state.NatInstances;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.nat.state.nat.instances.NatInstance;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.nat.state.nat.instances.NatInstanceKey;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.nat.state.nat.instances.nat.instance.NatCurrentConfig;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.nat.state.nat.instances.nat.instance.NatCurrentConfigBuilder;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+
+public class Nat64PrefixesCustomizerTest extends ListReaderCustomizerTest<Nat64Prefixes, Nat64PrefixesKey, Nat64PrefixesBuilder> {
+
+    @Mock
+    private FutureJVppNatFacade jvppNat;
+
+    public Nat64PrefixesCustomizerTest() {
+        super(Nat64Prefixes.class, NatCurrentConfigBuilder.class);
+    }
+
+    @Override
+    protected ReaderCustomizer<Nat64Prefixes, Nat64PrefixesBuilder> initCustomizer() {
+        return new Nat64PrefixesCustomizer(jvppNat);
+    }
+
+    @Test
+    public void testGetAllNoPrefixes() throws ReadFailedException {
+        when(jvppNat.nat64PrefixDump(any())).thenReturn(future(dump()));
+        final List<Nat64PrefixesKey> allIds = getCustomizer().getAllIds(getWildcardedId(123), ctx);
+        assertEquals(0, allIds.size());
+    }
+
+    @Test
+    public void testGetAll() throws ReadFailedException {
+        when(jvppNat.nat64PrefixDump(any())).thenReturn(future(dump()));
+        final long vrfId = 0;
+        final List<Nat64PrefixesKey> allIds = getCustomizer().getAllIds(getWildcardedId(vrfId), ctx);
+        assertEquals(1, allIds.size());
+        assertEquals(new Nat64PrefixesKey(0L), allIds.get(0));
+    }
+
+    @Test
+    public void testReadNonZeroId() throws ReadFailedException {
+        final Nat64PrefixesBuilder builder = mock(Nat64PrefixesBuilder.class);
+        getCustomizer().readCurrentAttributes(getId(0L, 42L), builder, ctx);
+        verifyZeroInteractions(builder);
+    }
+
+    @Test
+    public void testReadMissingForGivenVrf() throws ReadFailedException {
+        final long vrfId = 123;
+        when(jvppNat.nat64PrefixDump(any())).thenReturn(future(dump()));
+        final Nat64PrefixesBuilder builder = mock(Nat64PrefixesBuilder.class);
+        getCustomizer().readCurrentAttributes(getId(vrfId, 0L), builder, ctx);
+        verifyZeroInteractions(builder);
+    }
+
+    @Test
+    public void testRead() throws ReadFailedException {
+        final long vrfId = 1;
+        when(jvppNat.nat64PrefixDump(any())).thenReturn(future(dump()));
+        final Nat64PrefixesBuilder builder = mock(Nat64PrefixesBuilder.class);
+        getCustomizer().readCurrentAttributes(getId(vrfId, 0L), builder, ctx);
+        verify(builder).setNat64PrefixId(0L);
+        verify(builder).setNat64Prefix(new Ipv6Prefix("::1/128"));
+    }
+
+    private static InstanceIdentifier<Nat64Prefixes> getWildcardedId(final long vrfId) {
+        return InstanceIdentifier.create(NatInstances.class)
+                .child(NatInstance.class, new NatInstanceKey(vrfId))
+                .child(NatCurrentConfig.class)
+                .child(Nat64Prefixes.class);
+    }
+
+    private static InstanceIdentifier<Nat64Prefixes> getId(final long vrfId, final long prefixId) {
+        return InstanceIdentifier.create(NatInstances.class)
+                .child(NatInstance.class, new NatInstanceKey(vrfId))
+                .child(NatCurrentConfig.class)
+                .child(Nat64Prefixes.class, new Nat64PrefixesKey(prefixId));
+    }
+
+    private Nat64PrefixDetailsReplyDump dump() {
+        final Nat64PrefixDetailsReplyDump reply = new Nat64PrefixDetailsReplyDump();
+        final Nat64PrefixDetails prefix0 = new Nat64PrefixDetails();
+        prefix0.vrfId = 0;
+        prefix0.prefix = new byte[]{0, 0x64, (byte) 0xff, (byte) 0x9b, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1};
+        prefix0.prefixLen = (byte) 96;
+        reply.nat64PrefixDetails.add(prefix0);
+        final Nat64PrefixDetails prefix1 = new Nat64PrefixDetails();
+        prefix1.vrfId = 1;
+        prefix1.prefix = new byte[]{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1};
+        prefix1.prefixLen = (byte) 128;
+        reply.nat64PrefixDetails.add(prefix1);
+        return reply;
+    }
+}
\ No newline at end of file
diff --git a/nat/nat_postman_collection.json b/nat/nat_postman_collection.json
index 49ea7b91f..d63190ace 100644
--- a/nat/nat_postman_collection.json
+++ b/nat/nat_postman_collection.json
@@ -42,9 +42,11 @@
 				"c256b9c8-c530-acc2-f197-fd59e0d6843f",
 				"376fb011-96eb-fc09-4f87-0a16a9532ea9",
 				"cbad80e8-367a-6d8b-0a93-a81c717057aa",
+				"cff7d30d-f0d3-3750-76fb-94500340bc9e",
 				"4a9a9b25-ea4e-7d4f-1fd0-b4d7d7f60ad3",
 				"501132a6-ac08-bc36-e5f4-0fb2dda82c4d",
 				"b7c9a0d0-394d-eeb3-1615-af7349ba229e",
+				"2992acee-87da-3d9f-8bec-f00721d0c7e0",
 				"4f7bf0d9-f468-0041-e7e3-44386b74bb7e",
 				"84c2abaa-67f5-305e-e536-4bddcb8230cc"
 			],
@@ -191,6 +193,26 @@
 			"folder": "b22a3174-1314-bfbb-91f8-86c57b71b0cb"
 		},
 		{
+			"id": "cff7d30d-f0d3-3750-76fb-94500340bc9e",
+			"headers": "Authorization: Basic YWRtaW46YWRtaW4=\nContent-Type: application/json\n",
+			"url": "http://localhost:8183/restconf/config/ietf-nat:nat-config/nat-instances/nat-instance/0/nat64-prefixes/0",
+			"preRequestScript": "",
+			"pathVariables": {},
+			"method": "PUT",
+			"data": [],
+			"dataMode": "raw",
+			"version": 2,
+			"tests": "",
+			"currentHelper": "normal",
+			"helperAttributes": {},
+			"time": 1503467548572,
+			"name": "Set NAT64 prefix",
+			"description": "Configures NAT64 prefix for default VRF\n\nCLI: nat64 add prefix <ip6-prefix>/<plen> [tenant-vrf <vrf-id>] [del]\n\nCan be verified with\n\nCLI: show nat64 prefix\n\nMore information: https://wiki.fd.io/view/VPP/SNAT",
+			"collectionId": "87e0bcaa-5031-9a2b-8a6b-329758310154",
+			"responses": [],
+			"rawModeData": "{\r\n\t\"nat64-prefixes\" : {\r\n\t\t\"nat64-prefix-id\" : 0,\r\n\t\t\"nat64-prefix\" : \"2001:db8:122:300::/56\"\r\n\t}\r\n}"
+		},
+		{
 			"id": "4a9a9b25-ea4e-7d4f-1fd0-b4d7d7f60ad3",
 			"headers": "Authorization: Basic YWRtaW46YWRtaW4=\nContent-Type: application/json\n",
 			"url": "http://localhost:8183/restconf/config/ietf-interfaces:interfaces/interface/local0/interface-nat:nat/inbound",
@@ -543,6 +565,26 @@
 			"rawModeData": ""
 		},
 		{
+			"id": "2992acee-87da-3d9f-8bec-f00721d0c7e0",
+			"headers": "Authorization: Basic YWRtaW46YWRtaW4=\nContent-Type: application/json\n",
+			"url": "http://localhost:8183/restconf/config/ietf-nat:nat-config/nat-instances/nat-instance/0/nat64-prefixes/0",
+			"preRequestScript": "",
+			"pathVariables": {},
+			"method": "DELETE",
+			"data": [],
+			"dataMode": "raw",
+			"version": 2,
+			"tests": "",
+			"currentHelper": "normal",
+			"helperAttributes": {},
+			"time": 1503488485762,
+			"name": "Delete NAT64 prefix",
+			"description": "Removes configured NAT64 prefix:\n\nCLI: nat64 add prefix <ip6-prefix>/<plen> [tenant-vrf <vrf-id>] [del]\n\nCan be verified with\n\nCLI: show nat64 prefix\n\nMore information: https://wiki.fd.io/view/VPP/SNAT",
+			"collectionId": "87e0bcaa-5031-9a2b-8a6b-329758310154",
+			"responses": [],
+			"rawModeData": ""
+		},
+		{
 			"id": "bb79f635-3d21-8f07-a2e9-fc2c1a7b7f4a",
 			"headers": "Authorization: Basic YWRtaW46YWRtaW4=\nContent-Type: application/json\n",
 			"headerData": [