Merge pull request #122 from weaviate/fix-connect-to-custom-json-config

- Bump weaviate-client version to 4.14.3 and allow IPs as hostname in config file

Author: jfrancoa

requirements-dev.txt

@@ -1,4 +1,4 @@
-weaviate-client>=4.12.0
+weaviate-client>=4.14.3
 click==8.1.7
 twine
 pytest

setup.cfg

@@ -37,7 +37,7 @@ classifiers =
 include_package_data = True
 python_requires = >=3.9
 install_requires =
-    weaviate-client>=4.12.0
+    weaviate-client>=4.14.3
     #weaviate-client @ git+https://github.com/weaviate/weaviate-python-client.git@dev/1.30
     click==8.1.7
     semver>=3.0.2

test/unittests/test_managers/test_config_manager.py

@@ -139,3 +139,126 @@ def test_get_client_with_api_key_auth():
                     call_kwargs["auth_credentials"], weaviate.auth.AuthApiKey
                 )
                 assert call_kwargs["auth_credentials"].api_key == "test-key"
+
+
+def test_get_client_with_ip_address():
+    config_data = {
+        "host": "127.0.0.1",
+        "grpc_host": "127.0.0.1",
+        "http_port": 8080,
+        "grpc_port": 50051,
+    }
+
+    with patch("builtins.open", mock_open(read_data=json.dumps(config_data))):
+        with patch("os.path.isfile") as mock_isfile:
+            mock_isfile.return_value = True
+            with patch("weaviate.connect_to_custom") as mock_connect:
+                config = ConfigManager(config_file="test_config.json")
+                config.get_client()
+
+                mock_connect.assert_called_once()
+                call_kwargs = mock_connect.call_args.kwargs
+                assert call_kwargs["http_host"] == "127.0.0.1"
+                assert call_kwargs["grpc_host"] == "127.0.0.1"
+                assert call_kwargs["http_port"] == 8080
+                assert call_kwargs["grpc_port"] == 50051
+                assert call_kwargs["http_secure"] == False
+                assert call_kwargs["grpc_secure"] == False
+
+
+def test_get_client_with_ip_address_and_secure_ports():
+    config_data = {
+        "host": "127.0.0.1",
+        "grpc_host": "127.0.0.1",
+        "http_port": 443,
+        "grpc_port": 443,
+    }
+
+    with patch("builtins.open", mock_open(read_data=json.dumps(config_data))):
+        with patch("os.path.isfile") as mock_isfile:
+            mock_isfile.return_value = True
+            with patch("weaviate.connect_to_custom") as mock_connect:
+                config = ConfigManager(config_file="test_config.json")
+                config.get_client()
+
+                mock_connect.assert_called_once()
+                call_kwargs = mock_connect.call_args.kwargs
+                assert call_kwargs["http_host"] == "127.0.0.1"
+                assert call_kwargs["grpc_host"] == "127.0.0.1"
+                assert call_kwargs["http_port"] == 443
+                assert call_kwargs["grpc_port"] == 443
+                assert call_kwargs["http_secure"] == True
+                assert call_kwargs["grpc_secure"] == True
+
+
+def test_get_client_with_ip_address_with_https():
+    config_data = {
+        "host": "https://85.10.20.30",
+        "grpc_host": "https://85.10.20.31",
+        "http_port": 443,
+        "grpc_port": 443,
+    }
+
+    with patch("builtins.open", mock_open(read_data=json.dumps(config_data))):
+        with patch("os.path.isfile") as mock_isfile:
+            mock_isfile.return_value = True
+            with patch("weaviate.connect_to_custom") as mock_connect:
+                config = ConfigManager(config_file="test_config.json")
+                config.get_client()
+
+                mock_connect.assert_called_once()
+                call_kwargs = mock_connect.call_args.kwargs
+                assert call_kwargs["http_host"] == "85.10.20.30"
+                assert call_kwargs["grpc_host"] == "85.10.20.31"
+                assert call_kwargs["http_port"] == 443
+                assert call_kwargs["grpc_port"] == 443
+                assert call_kwargs["http_secure"] == True
+                assert call_kwargs["grpc_secure"] == True
+
+
+def test_get_client_with_host_and_custom():
+    config_data = {
+        "host": "https://weaviate.google.my-cloud.com",
+        "grpc_host": "https://grpc.weaviate.google.my-cloud.com",
+    }
+
+    with patch("builtins.open", mock_open(read_data=json.dumps(config_data))):
+        with patch("os.path.isfile") as mock_isfile:
+            mock_isfile.return_value = True
+            with patch("weaviate.connect_to_custom") as mock_connect:
+                config = ConfigManager(config_file="test_config.json")
+                config.get_client()
+
+                mock_connect.assert_called_once()
+                call_kwargs = mock_connect.call_args.kwargs
+                assert call_kwargs["http_host"] == "weaviate.google.my-cloud.com"
+                assert call_kwargs["grpc_host"] == "grpc.weaviate.google.my-cloud.com"
+                assert call_kwargs["http_port"] == 443
+                assert call_kwargs["grpc_port"] == 443
+                assert call_kwargs["http_secure"] == True
+                assert call_kwargs["grpc_secure"] == True
+
+
+def test_get_client_with_host_and_custom_with_ports():
+    config_data = {
+        "host": "https://weaviate.google.my-cloud.com",
+        "grpc_host": "https://grpc.weaviate.google.my-cloud.com",
+        "http_port": 8080,
+        "grpc_port": 8080,
+    }
+
+    with patch("builtins.open", mock_open(read_data=json.dumps(config_data))):
+        with patch("os.path.isfile") as mock_isfile:
+            mock_isfile.return_value = True
+            with patch("weaviate.connect_to_custom") as mock_connect:
+                config = ConfigManager(config_file="test_config.json")
+                config.get_client()
+
+                mock_connect.assert_called_once()
+                call_kwargs = mock_connect.call_args.kwargs
+                assert call_kwargs["http_host"] == "weaviate.google.my-cloud.com"
+                assert call_kwargs["grpc_host"] == "grpc.weaviate.google.my-cloud.com"
+                assert call_kwargs["http_port"] == 8080
+                assert call_kwargs["grpc_port"] == 8080
+                assert call_kwargs["http_secure"] == True  # URL contains https
+                assert call_kwargs["grpc_secure"] == True  # URL contains https

weaviate_cli/managers/config_manager.py

@@ -85,6 +85,14 @@ def __get_port(self, url_parsed):
         else:
             return 80
 
+    def __is_url(self, host: str) -> bool:
+        """Check if the host is a URL (has a scheme and a network location)."""
+        try:
+            result = urlparse(host)
+            return all([result.scheme, result.netloc])
+        except ValueError:
+            return False
+
     def get_client(self) -> weaviate.WeaviateClient:
         """Get weaviate client from config"""
         auth_config: Optional[weaviate.auth.AuthCredentials] = None
@@ -124,15 +132,44 @@ def get_client(self) -> weaviate.WeaviateClient:
                 headers=self.config["headers"] if "headers" in self.config else None,
             )
         else:
-            host_parsed = urlparse(self.config["host"])
-            grpc_parsed = urlparse(self.config["grpc_host"])
-            return weaviate.connect_to_custom(
-                http_host=host_parsed.hostname,
-                grpc_host=grpc_parsed.hostname,
-                grpc_secure=grpc_parsed.scheme == "https",
-                http_secure=host_parsed.scheme == "https",
-                http_port=self.__get_port(host_parsed),
-                grpc_port=self.__get_port(grpc_parsed),
-                auth_credentials=auth_config,
-                headers=self.config["headers"] if "headers" in self.config else None,
-            )
+            # Check if host is a URL or IP/hostname
+            if self.__is_url(self.config["host"]):
+                # Handle URL format
+                host_parsed = urlparse(self.config["host"])
+                grpc_parsed = urlparse(self.config["grpc_host"])
+                return weaviate.connect_to_custom(
+                    http_host=host_parsed.hostname,
+                    grpc_host=grpc_parsed.hostname,
+                    grpc_secure=grpc_parsed.scheme == "https",
+                    http_secure=host_parsed.scheme == "https",
+                    http_port=(
+                        self.__get_port(host_parsed)
+                        if "http_port" not in self.config
+                        or self.config["http_port"] == ""
+                        else self.config["http_port"]
+                    ),
+                    grpc_port=(
+                        self.__get_port(grpc_parsed)
+                        if "grpc_port" not in self.config
+                        or self.config["grpc_port"] == ""
+                        else self.config["grpc_port"]
+                    ),
+                    auth_credentials=auth_config,
+                    headers=(
+                        self.config["headers"] if "headers" in self.config else None
+                    ),
+                )
+            else:
+                # Handle IP/hostname format
+                return weaviate.connect_to_custom(
+                    http_host=self.config["host"],
+                    grpc_host=self.config["grpc_host"],
+                    grpc_secure=self.config["grpc_port"] == 443,  # Secure if port 443
+                    http_secure=self.config["http_port"] == 443,  # Secure if port 443
+                    http_port=self.config["http_port"],
+                    grpc_port=self.config["grpc_port"],
+                    auth_credentials=auth_config,
+                    headers=(
+                        self.config["headers"] if "headers" in self.config else None
+                    ),
+                )