From: Andrej Mak <andmak@cisco.com>
Date: Wed, 6 Apr 2016 09:14:45 +0000 (+0200)
Subject: Add IPv6 to NetconfHelloMessageAdditionalHeader
X-Git-Tag: release/boron~147^2
X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=commitdiff_plain;h=ed7b5f6ecdff528f93dc485b42c9311366c5ca63;p=netconf.git

Add IPv6 to NetconfHelloMessageAdditionalHeader

Address is no longer validated via regex.
Instead, InetAddresses.isInetAddress(address) is used.

Change-Id: I54438405125c1c4fa411a741eab6b3e2d3d13e22
Signed-off-by: Andrej Mak <andmak@cisco.com>
---

diff --git a/netconf/netconf-api/src/main/java/org/opendaylight/netconf/api/messages/NetconfHelloMessageAdditionalHeader.java b/netconf/netconf-api/src/main/java/org/opendaylight/netconf/api/messages/NetconfHelloMessageAdditionalHeader.java
index 03b211d472..32557653c0 100644
--- a/netconf/netconf-api/src/main/java/org/opendaylight/netconf/api/messages/NetconfHelloMessageAdditionalHeader.java
+++ b/netconf/netconf-api/src/main/java/org/opendaylight/netconf/api/messages/NetconfHelloMessageAdditionalHeader.java
@@ -9,6 +9,7 @@
 package org.opendaylight.netconf.api.messages;
 
 import com.google.common.base.Preconditions;
+import com.google.common.net.InetAddresses;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
@@ -90,11 +91,10 @@ public class NetconfHelloMessageAdditionalHeader {
         return sb.toString();
     }
 
-    // TODO IPv6
     private static final Pattern PATTERN = Pattern
-            .compile("\\[(?<username>[^;]+);(?<address>[0-9\\.]+)[:/](?<port>[0-9]+);(?<transport>[a-z]+)[^\\]]+\\]");
+            .compile("\\[(?<username>[^;]+);(?<address>.+)[:/](?<port>[0-9]+);(?<transport>[a-z]+)[^\\]]+\\]");
     private static final Pattern CUSTOM_HEADER_PATTERN = Pattern
-            .compile("\\[(?<username>[^;]+);(?<address>[0-9\\.]+)[:/](?<port>[0-9]+);(?<transport>[a-z]+);(?<sessionIdentifier>[a-z]+)[^\\]]+\\]");
+            .compile("\\[(?<username>[^;]+);(?<address>.+)[:/](?<port>[0-9]+);(?<transport>[a-z]+);(?<sessionIdentifier>[a-z]+)[^\\]]+\\]");
 
     /**
      * Parse additional header from a formatted string
@@ -108,6 +108,7 @@ public class NetconfHelloMessageAdditionalHeader {
 
         String username = matcher.group("username");
         String address = matcher.group("address");
+        Preconditions.checkArgument(InetAddresses.isInetAddress(address));
         String port = matcher.group("port");
         String transport = matcher.group("transport");
         String sessionIdentifier = "client";
diff --git a/netconf/netconf-impl/src/main/java/org/opendaylight/netconf/impl/NetconfServerSession.java b/netconf/netconf-impl/src/main/java/org/opendaylight/netconf/impl/NetconfServerSession.java
index 16e9285d70..b6c88a60b2 100644
--- a/netconf/netconf-impl/src/main/java/org/opendaylight/netconf/impl/NetconfServerSession.java
+++ b/netconf/netconf-impl/src/main/java/org/opendaylight/netconf/impl/NetconfServerSession.java
@@ -9,11 +9,14 @@
 package org.opendaylight.netconf.impl;
 
 import com.google.common.base.Preconditions;
+import com.google.common.net.InetAddresses;
 import io.netty.channel.Channel;
 import io.netty.channel.ChannelFuture;
 import io.netty.channel.ChannelFutureListener;
 import io.netty.handler.codec.ByteToMessageDecoder;
 import io.netty.handler.codec.MessageToByteEncoder;
+import java.net.Inet4Address;
+import java.net.InetAddress;
 import java.time.Instant;
 import java.time.ZoneId;
 import java.time.ZonedDateTime;
@@ -26,8 +29,10 @@ import org.opendaylight.netconf.api.monitoring.NetconfManagementSession;
 import org.opendaylight.netconf.nettyutil.AbstractNetconfSession;
 import org.opendaylight.netconf.nettyutil.handler.NetconfMessageToXMLEncoder;
 import org.opendaylight.netconf.nettyutil.handler.NetconfXMLToMessageDecoder;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.DomainName;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Host;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Address;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv6Address;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.extension.rev131210.NetconfTcp;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.extension.rev131210.Session1;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.extension.rev131210.Session1Builder;
@@ -109,7 +114,14 @@ public final class NetconfServerSession extends AbstractNetconfSession<NetconfSe
         SessionBuilder builder = new SessionBuilder();
 
         builder.setSessionId(getSessionId());
-        builder.setSourceHost(new Host(new DomainName(header.getAddress())));
+        IpAddress address;
+        InetAddress address1 = InetAddresses.forString(header.getAddress());
+        if (address1 instanceof Inet4Address) {
+            address = new IpAddress(new Ipv4Address(header.getAddress()));
+        } else {
+            address = new IpAddress(new Ipv6Address(header.getAddress()));
+        }
+        builder.setSourceHost(new Host(address));
 
         Preconditions.checkState(DateAndTime.PATTERN_CONSTANTS.size() == 1);
         String formattedDateTime = dateFormatter.format(loginTime);
diff --git a/netconf/netconf-monitoring/src/main/java/org/opendaylight/netconf/monitoring/xml/model/MonitoringSession.java b/netconf/netconf-monitoring/src/main/java/org/opendaylight/netconf/monitoring/xml/model/MonitoringSession.java
index 6d96688019..3b075433d3 100644
--- a/netconf/netconf-monitoring/src/main/java/org/opendaylight/netconf/monitoring/xml/model/MonitoringSession.java
+++ b/netconf/netconf-monitoring/src/main/java/org/opendaylight/netconf/monitoring/xml/model/MonitoringSession.java
@@ -11,6 +11,7 @@ import com.google.common.base.Joiner;
 import javax.xml.bind.annotation.XmlElement;
 import javax.xml.bind.annotation.XmlTransient;
 import org.opendaylight.netconf.monitoring.MonitoringConstants;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.extension.rev131210.Session1;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.sessions.Session;
 import org.opendaylight.yangtools.yang.common.QName;
@@ -38,7 +39,12 @@ final class MonitoringSession {
 
     @XmlElement(name = "source-host")
     public String getSourceHost() {
-        return managementSession.getSourceHost().getDomainName().getValue();
+        final IpAddress ipAddress = managementSession.getSourceHost().getIpAddress();
+        if (ipAddress.getIpv4Address() != null) {
+            return ipAddress.getIpv4Address().getValue();
+        } else {
+            return ipAddress.getIpv6Address().getValue();
+        }
     }
 
     @XmlElement(name = "login-time")
diff --git a/netconf/netconf-monitoring/src/test/java/org/opendaylight/netconf/monitoring/xml/JaxBSerializerTest.java b/netconf/netconf-monitoring/src/test/java/org/opendaylight/netconf/monitoring/xml/JaxBSerializerTest.java
index 98291dc06c..af332963e6 100644
--- a/netconf/netconf-monitoring/src/test/java/org/opendaylight/netconf/monitoring/xml/JaxBSerializerTest.java
+++ b/netconf/netconf-monitoring/src/test/java/org/opendaylight/netconf/monitoring/xml/JaxBSerializerTest.java
@@ -12,28 +12,26 @@ import static org.hamcrest.MatcherAssert.assertThat;
 import static org.mockito.Mockito.doReturn;
 import static org.mockito.Mockito.mock;
 
-import com.google.common.base.Optional;
 import com.google.common.collect.Lists;
-import java.util.Set;
 import org.hamcrest.CoreMatchers;
+import org.junit.Before;
 import org.junit.Test;
-import org.opendaylight.controller.config.util.capability.Capability;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
 import org.opendaylight.controller.config.util.xml.XmlUtil;
-import org.opendaylight.netconf.api.monitoring.NetconfManagementSession;
 import org.opendaylight.netconf.api.monitoring.NetconfMonitoringService;
 import org.opendaylight.netconf.monitoring.xml.model.NetconfState;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.DomainName;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Host;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Address;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv6Address;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Uri;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.extension.rev131210.NetconfTcp;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.extension.rev131210.Session1;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.NetconfSsh;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.Transport;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.Yang;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Capabilities;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Schemas;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.SchemasBuilder;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Sessions;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.SessionsBuilder;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.schemas.Schema;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.schemas.SchemaKey;
@@ -43,59 +41,44 @@ import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.
 
 public class JaxBSerializerTest {
 
+    private static final String IPV4 = "192.168.1.1";
+    private static final String IPV6 = "FE80:0000:0000:0000:0202:B3FF:FE1E:8329";
+    private static final String SESSION_XML = "<session>" +
+            "<session-id>1</session-id>" +
+            "<in-bad-rpcs>0</in-bad-rpcs>" +
+            "<in-rpcs>0</in-rpcs>" +
+            "<login-time>2010-10-10T12:32:32Z</login-time>" +
+            "<out-notifications>0</out-notifications>" +
+            "<out-rpc-errors>0</out-rpc-errors>" +
+            "<ncme:session-identifier>client</ncme:session-identifier>" +
+            "<source-host>%s</source-host>" +
+            "<transport>ncme:netconf-tcp</transport>" +
+            "<username>username</username>" +
+            "</session>";
+
+    @Mock
+    private NetconfMonitoringService monitoringService;
+
+    @Before
+    public void setUp() throws Exception {
+        MockitoAnnotations.initMocks(this);
+        doReturn(new SessionsBuilder().setSession(Lists.newArrayList(
+                getMockIPv4Session(NetconfTcp.class),
+                getMockIPv4Session(NetconfSsh.class),
+                getMockIPv6Session(NetconfTcp.class),
+                getMockIPv6Session(NetconfSsh.class)
+        )).build())
+                .when(monitoringService).getSessions();
+        doReturn(new SchemasBuilder().setSchema(Lists.newArrayList(getMockSchema("id", "v1", Yang.class), getMockSchema("id2", "", Yang.class))).build())
+                .when(monitoringService).getSchemas();
+    }
+
     @Test
     public void testSerialization() throws Exception {
 
-        final NetconfMonitoringService service = new NetconfMonitoringService() {
-
-            @Override
-            public void onCapabilitiesChanged(Set<Capability> added, Set<Capability> removed) {
-
-            }
-
-            @Override
-            public void onSessionUp(final NetconfManagementSession session) {
-
-            }
-
-            @Override
-            public void onSessionDown(final NetconfManagementSession session) {
-
-            }
-
-            @Override
-            public Sessions getSessions() {
-                return new SessionsBuilder().setSession(Lists.newArrayList(getMockSession(NetconfTcp.class), getMockSession(NetconfSsh.class))).build();
-            }
-
-            @Override
-            public Schemas getSchemas() {
-                return new SchemasBuilder().setSchema(Lists.newArrayList(getMockSchema("id", "v1", Yang.class), getMockSchema("id2", "", Yang.class))).build();
-            }
-
-            @Override
-            public String getSchemaForCapability(final String moduleName, final Optional<String> revision) {
-                return null;
-            }
-
-            @Override
-            public Capabilities getCapabilities() {
-                return null;
-            }
-
-            @Override
-            public AutoCloseable registerListener(final MonitoringListener listener) {
-                return new AutoCloseable() {
-                    @Override
-                    public void close() throws Exception {
-                        // NOOP
-                    }
-                };
-            }
-        };
-        final NetconfState model = new NetconfState(service);
+        final NetconfState model = new NetconfState(monitoringService);
         final String xml = XmlUtil.toString(new JaxBSerializer().toXml(model)).replaceAll("\\s", "");
-
+        System.out.println(xml);
         assertThat(xml, CoreMatchers.containsString(
                 "<schema>" +
                 "<format>yang</format>" +
@@ -106,18 +89,9 @@ public class JaxBSerializerTest {
                 "</schema>"));
 
         assertThat(xml, CoreMatchers.containsString(
-                "<session>" +
-                "<session-id>1</session-id>" +
-                "<in-bad-rpcs>0</in-bad-rpcs>" +
-                "<in-rpcs>0</in-rpcs>" +
-                "<login-time>2010-10-10T12:32:32Z</login-time>" +
-                "<out-notifications>0</out-notifications>" +
-                "<out-rpc-errors>0</out-rpc-errors>" +
-                "<ncme:session-identifier>client</ncme:session-identifier>" +
-                "<source-host>192.168.1.1</source-host>" +
-                "<transport>ncme:netconf-tcp</transport>" +
-                "<username>username</username>" +
-                "</session>"));
+                String.format(SESSION_XML, IPV4)));
+        assertThat(xml, CoreMatchers.containsString(
+                String.format(SESSION_XML, IPV6)));
     }
 
     private Schema getMockSchema(final String id, final String version, final Class<Yang> format) {
@@ -132,13 +106,24 @@ public class JaxBSerializerTest {
         return mock;
     }
 
+    private Session getMockIPv4Session(final Class<? extends Transport> transportType) {
+        final Session mocked = getMockSession(transportType);
+        doReturn(new Host(new IpAddress(new Ipv4Address(IPV4)))).when(mocked).getSourceHost();
+        return mocked;
+    }
+
+    private Session getMockIPv6Session(final Class<? extends Transport> transportType) {
+        final Session mocked = getMockSession(transportType);
+        doReturn(new Host(new IpAddress(new Ipv6Address(IPV6)))).when(mocked).getSourceHost();
+        return mocked;
+    }
+
     private Session getMockSession(final Class<? extends Transport> transportType) {
         final Session mocked = mock(Session.class);
         final Session1 mockedSession1 = mock(Session1.class);
         doReturn("client").when(mockedSession1).getSessionIdentifier();
         doReturn(1L).when(mocked).getSessionId();
         doReturn(new DateAndTime("2010-10-10T12:32:32Z")).when(mocked).getLoginTime();
-        doReturn(new Host(new DomainName("192.168.1.1"))).when(mocked).getSourceHost();
         doReturn(new ZeroBasedCounter32(0L)).when(mocked).getInBadRpcs();
         doReturn(new ZeroBasedCounter32(0L)).when(mocked).getInRpcs();
         doReturn(new ZeroBasedCounter32(0L)).when(mocked).getOutNotifications();