Traffic scripts: Move valid_ipv* to a library

No need to implement the same two functions in 5 places.

Change-Id: I7bbcfaba18030a0520aaef5dcf06ed155bcf806b
Signed-off-by: Vratko Polak <vrpolak@cisco.com>

6 files changed, 63 insertions, 158 deletions

diff --git a/GPL/traffic_scripts/ValidIp.py b/GPL/traffic_scripts/ValidIp.py
new file mode 100644
index 0000000000..57244119c7
--- /dev/null
+++ b/GPL/traffic_scripts/ValidIp.py
@@ -0,0 +1,58 @@
+#!/usr/bin/env python3
+
+# Copyright (c) 2021 Cisco and/or its affiliates.
+#
+# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
+#
+# Licensed under the Apache License 2.0 or
+# GNU General Public License v2.0 or later;  you may not use this file
+# except in compliance with one of these Licenses. You
+# may obtain a copy of the Licenses at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#     https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
+#
+# Note: If this file is linked with Scapy, which is GPLv2+, your use of it
+# must be under GPLv2+.  If at any point in the future it is no longer linked
+# with Scapy (or other GPLv2+ licensed software), you are free to choose
+# Apache 2.
+#
+# 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.
+
+"""Functions simplifying address validation."""
+
+import ipaddress
+
+
+def valid_ipv4(ip_address):
+    """Check IPv4 address.
+
+    :param ip_address: IPv4 address to check.
+    :type ip_address: str
+    :returns: True if IP address is correct.
+    :rtype: bool
+    """
+    try:
+        ipaddress.IPv4Address(ip_address)
+        return True
+    except (AttributeError, ipaddress.AddressValueError):
+        return False
+
+
+def valid_ipv6(ip_address):
+    """Check IPv6 address.
+
+    :param ip_address: IPv6 address to check.
+    :type ip_address: str
+    :returns: True if IP address is correct.
+    :rtype: bool
+    """
+    try:
+        ipaddress.IPv6Address(ip_address)
+        return True
+    except (AttributeError, ipaddress.AddressValueError):
+        return False
diff --git a/GPL/traffic_scripts/lisp/lisp_check.py b/GPL/traffic_scripts/lisp/lisp_check.py
index bfe8990e1c..35377b0eb6 100644
--- a/GPL/traffic_scripts/lisp/lisp_check.py
+++ b/GPL/traffic_scripts/lisp/lisp_check.py
@@ -28,7 +28,6 @@ a LISP-encapsulated packet on the other interface and verifies received packet.
 """
 
 import sys
-import ipaddress
 
 from scapy.all import bind_layers, Packet
 from scapy.fields import FlagsField, BitField, IntField
@@ -40,6 +39,7 @@ from scapy.packet import Raw
 
 from ..PacketVerifier import RxQueue, TxQueue
 from ..TrafficScriptArg import TrafficScriptArg
+from ..ValidIp import valid_ipv4, valid_ipv6
 
 
 class LispHeader(Packet):
@@ -66,36 +66,6 @@ class LispInnerIPv6(IPv6):
     name = u"Lisp Inner Layer - IPv6"
 
 
-def valid_ipv4(ip_address):
-    """Check IPv4 address.
-
-    :param ip_address: IPv4 address to check.
-    :type ip_address: str
-    :returns: True if IP address is correct.
-    :rtype: bool
-    """
-    try:
-        ipaddress.IPv4Address(ip_address)
-        return True
-    except (AttributeError, ipaddress.AddressValueError):
-        return False
-
-
-def valid_ipv6(ip_address):
-    """Check IPv6 address.
-
-    :param ip_address: IPv6 address to check.
-    :type ip_address: str
-    :returns: True if IP address is correct.
-    :rtype: bool
-    """
-    try:
-        ipaddress.IPv6Address(ip_address)
-        return True
-    except (AttributeError, ipaddress.AddressValueError):
-        return False
-
-
 def main():
     """Send IP ICMP packet from one traffic generator interface to the other.
 
diff --git a/GPL/traffic_scripts/lisp/lispgpe_check.py b/GPL/traffic_scripts/lisp/lispgpe_check.py
index 85c85885f6..74740378ea 100644
--- a/GPL/traffic_scripts/lisp/lispgpe_check.py
+++ b/GPL/traffic_scripts/lisp/lispgpe_check.py
@@ -29,7 +29,6 @@ packet.
 """
 
 import sys
-import ipaddress
 
 from scapy.all import bind_layers, Packet
 from scapy.fields import FlagsField, BitField, XBitField, IntField
@@ -41,6 +40,7 @@ from scapy.packet import Raw
 
 from ..PacketVerifier import RxQueue, TxQueue
 from ..TrafficScriptArg import TrafficScriptArg
+from ..ValidIp import valid_ipv4, valid_ipv6
 
 
 class LispGPEHeader(Packet):
@@ -92,36 +92,6 @@ class LispGPEInnerNSH(Packet):
     """
 
 
-def valid_ipv4(ip_address):
-    """Check IPv4 address.
-
-    :param ip_address: IPv4 address to check.
-    :type ip_address: str
-    :returns: True if IP address is correct.
-    :rtype: bool
-    """
-    try:
-        ipaddress.IPv4Address(ip_address)
-        return True
-    except (AttributeError, ipaddress.AddressValueError):
-        return False
-
-
-def valid_ipv6(ip_address):
-    """Check IPv6 address.
-
-    :param ip_address: IPv6 address to check.
-    :type ip_address: str
-    :returns: True if IP address is correct.
-    :rtype: bool
-    """
-    try:
-        ipaddress.IPv6Address(ip_address)
-        return True
-    except (AttributeError, ipaddress.AddressValueError):
-        return False
-
-
 def main():
     """Send IP ICMP packet from one traffic generator interface to the other.
 
diff --git a/GPL/traffic_scripts/nat.py b/GPL/traffic_scripts/nat.py
index 9e224dbae8..3722d6b8db 100644
--- a/GPL/traffic_scripts/nat.py
+++ b/GPL/traffic_scripts/nat.py
@@ -27,8 +27,6 @@
 
 import sys
 
-import ipaddress
-
 from scapy.layers.inet import IP, TCP, UDP
 from scapy.layers.inet6 import IPv6, ICMPv6ND_NS, ICMPv6MLReport2, ICMPv6ND_RA
 from scapy.layers.l2 import Ether
@@ -36,36 +34,7 @@ from scapy.packet import Raw
 
 from .PacketVerifier import RxQueue, TxQueue
 from .TrafficScriptArg import TrafficScriptArg
-
-
-def valid_ipv4(ip_address):
-    """Check IPv4 address.
-
-    :param ip_address: IPv4 address to check.
-    :type ip_address: str
-    :returns: True if IP address is correct.
-    :rtype: bool
-    """
-    try:
-        ipaddress.IPv4Address(ip_address)
-        return True
-    except (AttributeError, ipaddress.AddressValueError):
-        return False
-
-
-def valid_ipv6(ip_address):
-    """Check IPv6 address.
-
-    :param ip_address: IPv6 address to check.
-    :type ip_address: str
-    :returns: True if IP address is correct.
-    :rtype: bool
-    """
-    try:
-        ipaddress.IPv6Address(ip_address)
-        return True
-    except (AttributeError, ipaddress.AddressValueError):
-        return False
+from .ValidIp import valid_ipv4, valid_ipv6
 
 
 def main():
diff --git a/GPL/traffic_scripts/send_icmp_wait_for_reply.py b/GPL/traffic_scripts/send_icmp_wait_for_reply.py
index ea82a81f4b..f09287f24e 100644
--- a/GPL/traffic_scripts/send_icmp_wait_for_reply.py
+++ b/GPL/traffic_scripts/send_icmp_wait_for_reply.py
@@ -26,7 +26,6 @@
 """Traffic script that sends an IP ICMPv4 or ICMPv6."""
 
 import sys
-import ipaddress
 
 from scapy.layers.inet import ICMP, IP
 from scapy.layers.inet6 import ICMPv6EchoRequest, ICMPv6EchoReply,\
@@ -36,36 +35,7 @@ from scapy.packet import Raw
 
 from .PacketVerifier import RxQueue, TxQueue
 from .TrafficScriptArg import TrafficScriptArg
-
-
-def valid_ipv4(ip_address):
-    """Check IPv4 address.
-
-    :param ip_address: IPv4 address to check.
-    :type ip_address: str
-    :returns: True if IP address is correct.
-    :rtype: bool
-    """
-    try:
-        ipaddress.IPv4Address(ip_address)
-        return True
-    except (AttributeError, ipaddress.AddressValueError):
-        return False
-
-
-def valid_ipv6(ip_address):
-    """Check IPv6 address.
-
-    :param ip_address: IPv6 address to check.
-    :type ip_address: str
-    :returns: True if IP address is correct.
-    :rtype: bool
-    """
-    try:
-        ipaddress.IPv6Address(ip_address)
-        return True
-    except (AttributeError, ipaddress.AddressValueError):
-        return False
+from .ValidIp import valid_ipv4, valid_ipv6
 
 
 def main():
diff --git a/GPL/traffic_scripts/send_ip_check_headers.py b/GPL/traffic_scripts/send_ip_check_headers.py
index be1f7f045a..a13b1b73b8 100644
--- a/GPL/traffic_scripts/send_ip_check_headers.py
+++ b/GPL/traffic_scripts/send_ip_check_headers.py
@@ -30,8 +30,6 @@ MAC addresses are checked in received packet.
 
 import sys
 
-import ipaddress
-
 from robot.api import logger
 from scapy.layers.inet import IP
 from scapy.layers.inet6 import IPv6, ICMPv6ND_NS, ICMPv6MLReport2, ICMPv6ND_RA
@@ -40,37 +38,7 @@ from scapy.packet import Raw
 
 from .PacketVerifier import RxQueue, TxQueue
 from .TrafficScriptArg import TrafficScriptArg
-
-
-def valid_ipv4(ip_address):
-    """Check IPv4 address.
-
-    :param ip_address: IPv4 address to check.
-    :type ip_address: str
-    :returns: True if IP address is correct.
-    :rtype: bool
-    """
-    try:
-        ipaddress.IPv4Address(ip_address)
-        return True
-    except (AttributeError, ipaddress.AddressValueError):
-        return False
-
-
-def valid_ipv6(ip_address):
-    """Check IPv6 address.
-
-    :param ip_address: IPv6 address to check.
-    :type ip_address: str
-    :returns: True if IP address is correct.
-    :rtype: bool
-    """
-    try:
-        ipaddress.IPv6Address(ip_address)
-        return True
-    except (AttributeError, ipaddress.AddressValueError):
-        return False
-
+from .ValidIp import valid_ipv4, valid_ipv6
 
 def main():
     """Send IP/IPv6 packet from one traffic generator interface to the other."""