feat: IPv6 support (#227)

Author: artemrys

solnlib/net_utils.py

@@ -94,6 +94,10 @@ def is_valid_hostname(hostname: str) -> bool:
     Returns:
         True if is valid else False.
     """
+    # Splunk IPv6 support.
+    # https://docs.splunk.com/Documentation/Splunk/9.0.0/Admin/ConfigureSplunkforIPv6#Change_the_prioritization_of_IPv4_and_IPv6_communications
+    if hostname == "[::1]":
+        return True
 
     if len(hostname) > 255:
         return False

solnlib/splunk_rest_client.py

@@ -214,6 +214,8 @@ def __init__(
                 )
 
         validate_scheme_host_port(scheme, host, port)
+        if host == "[::1]":
+            host = "::1"
 
         handler = _request_handler(context)
         super().__init__(

tests/unit/test_net_utils.py

@@ -50,43 +50,63 @@ def mock_gethostbyaddr(addr):
     assert net_utils.resolve_hostname(unresolvable_ip3) is None
 
 
-def test_is_valid_hostname():
-    assert net_utils.is_valid_hostname("splunk")
-    assert net_utils.is_valid_hostname("splunk.")
-    assert net_utils.is_valid_hostname("splunk.com")
-    assert net_utils.is_valid_hostname("localhost")
-    assert not net_utils.is_valid_hostname("")
-    assert not net_utils.is_valid_hostname("localhost:8000")
-    assert not net_utils.is_valid_hostname("http://localhost:8000")
-    assert not net_utils.is_valid_hostname("a" * 999)
-
-
-def test_is_valid_port():
-    assert not net_utils.is_valid_port("0.0")
-    assert not net_utils.is_valid_port(0)
-    assert not net_utils.is_valid_port("0")
-    assert net_utils.is_valid_port("1")
-    assert net_utils.is_valid_port(1)
-    assert net_utils.is_valid_port(8080)
-    assert net_utils.is_valid_port("8080")
-    assert net_utils.is_valid_port("0808")
-    assert net_utils.is_valid_port("65535")
-    assert net_utils.is_valid_port(65535)
-    assert not net_utils.is_valid_port("65536")
-    assert not net_utils.is_valid_port(65536)
-
-
-def test_is_valid_scheme():
-    assert net_utils.is_valid_scheme("http")
-    assert net_utils.is_valid_scheme("https")
-    assert net_utils.is_valid_scheme("HTTP")
-    assert net_utils.is_valid_scheme("HTTPS")
-    assert net_utils.is_valid_scheme("HTTp")
-    assert not net_utils.is_valid_scheme("non-http")
+@pytest.mark.parametrize(
+    "hostname,expected_result",
+    [
+        ("splunk", True),
+        ("splunk.", True),
+        ("splunk.com", True),
+        ("localhost", True),
+        ("::1", True),
+        ("", False),
+        ("localhost:8000", False),
+        ("http://localhost:8000", False),
+        ("a" * 999, False),
+    ],
+)
+def test_is_valid_hostname(hostname, expected_result):
+    assert net_utils.is_valid_hostname(hostname) is expected_result
+
+
+@pytest.mark.parametrize(
+    "port,expected_result",
+    [
+        ("0.0", False),
+        (0, False),
+        ("0", False),
+        ("65536", False),
+        (65536, False),
+        ("1", True),
+        (1, True),
+        (8080, True),
+        ("8080", True),
+        ("0808", True),
+        ("65535", True),
+        (65535, True),
+    ],
+)
+def test_is_valid_port(port, expected_result):
+    assert net_utils.is_valid_port(port) is expected_result
+
+
+@pytest.mark.parametrize(
+    "scheme,expected_result",
+    [
+        ("http", True),
+        ("https", True),
+        ("HTTP", True),
+        ("HTTPS", True),
+        ("HTTp", True),
+        ("non-http", False),
+    ],
+)
+def test_is_valid_scheme(scheme, expected_result):
+    assert net_utils.is_valid_scheme(scheme) is expected_result
 
 
 def test_validate_scheme_host_port():
     net_utils.validate_scheme_host_port("http", "localhost", 8080)
+    net_utils.validate_scheme_host_port("https", "::1", 8089)
     with pytest.raises(ValueError):
         net_utils.validate_scheme_host_port("scheme", "localhost:8000", 8080)
     with pytest.raises(ValueError):

tests/unit/test_utils.py

@@ -111,31 +111,64 @@ def mock_error(msg, *args, **kwargs):
     assert record[1] == 0
 
 
-def test_extract_http_scheme_host_port(monkeypatch):
-    h1 = "https://localhost:8089"
-    scheme, host, port = utils.extract_http_scheme_host_port(h1)
-    assert scheme == "https" and host == "localhost" and port == 8089
-
-    h2 = "https://localhost:8089/"
-    scheme, host, port = utils.extract_http_scheme_host_port(h2)
-    assert scheme == "https" and host == "localhost" and port == 8089
-
-    h3 = "https://localhost:8089/servicesNS/"
-    scheme, host, port = utils.extract_http_scheme_host_port(h3)
-    assert scheme == "https" and host == "localhost" and port == 8089
-
-    h1 = "http://localhost:8089"
-    scheme, host, port = utils.extract_http_scheme_host_port(h1)
-    assert scheme == "http" and host == "localhost" and port == 8089
+@pytest.mark.parametrize(
+    "url,expected_scheme,expected_host,expected_port",
+    [
+        (
+            "https://localhost:8089",
+            "https",
+            "localhost",
+            8089,
+        ),
+        (
+            "https://localhost:8089/",
+            "https",
+            "localhost",
+            8089,
+        ),
+        (
+            "https://localhost:8089/servicesNS/",
+            "https",
+            "localhost",
+            8089,
+        ),
+        (
+            "http://localhost:8089",
+            "http",
+            "localhost",
+            8089,
+        ),
+        (
+            "http://localhost:8089/",
+            "http",
+            "localhost",
+            8089,
+        ),
+        (
+            "http://localhost:8089/servicesNS/",
+            "http",
+            "localhost",
+            8089,
+        ),
+        (
+            "https://[::1]:8089",
+            "https",
+            "::1",
+            8089,
+        ),
+    ],
+)
+def test_extract_http_scheme_host_port_when_success(
+    url, expected_scheme, expected_host, expected_port
+):
+    scheme, host, port = utils.extract_http_scheme_host_port(url)
 
-    h2 = "http://localhost:8089/"
-    scheme, host, port = utils.extract_http_scheme_host_port(h2)
-    assert scheme == "http" and host == "localhost" and port == 8089
+    assert expected_scheme == scheme
+    assert expected_host == host
+    assert expected_port == port
 
-    h3 = "http://localhost:8089/servicesNS/"
-    scheme, host, port = utils.extract_http_scheme_host_port(h3)
-    assert scheme == "http" and host == "localhost" and port == 8089
 
+def test_extract_http_scheme_host_port_when_invalid():
     invalid = "localhost:8089"
     with pytest.raises(ValueError):
         _, _, _ = utils.extract_http_scheme_host_port(invalid)