Add proxy support to Kubernetes client configuration in get_client (#2291)

* Add proxy support to Kubernetes client configuration in get_client

This update modifies the get_client function to support
setting a proxy for the Kubernetes client configuration.
The client_configuration argument is introduced to allow
passing a client.Configuration object directly, and if not
provided, it defaults to creating a new configuration instance.
Additionally, if the HTTPS_PROXY or HTTP_PROXY environment
variables are set, the proxy is applied to the Kubernetes
client configuration.

This enhancement enables easier integration of Kubernetes
client setup when working behind a proxy.

Signed-off-by: Shahaf Bahar <[email protected]>

* Simplify docstring by removing redundant default value explanation

* Update proxy configuration logic and README documentation

* Simplify use_proxy docstring in get_client method

* Add support for enabling proxy with use_proxy flag

* Remove client_configuration from get_client and initialize only for proxy usage

Signed-off-by: Shahaf Bahar <[email protected]>

* Refactor proxy handling in get_client function

* Refactor docstring to clarify proxy behavior

* Simplify proxy configuration logic in get_client

* Improve error message for missing proxy configuration in get_client

* Remove redundant dot in README

* Remove unnecessary check for client_configuration in get_client

* Update README to clarify proxy enablement instructions

* Clarify proxy enablement in README

* Clarify use_proxy argument type in README

* Retrieve client_configuration from kwargs if provided

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Ensure environment variable overrides use_proxy

* Remove redundant proxy configuration log

* Preserve client_configuration from kwargs when setting proxy

* Update docstring to clarify proxy conf behavior with env var

* Refactor proxy configuration logic for clarity

* Update README with proxy enablement details

* Refactor client_configuration retrieval in get_client

* Refactor proxy configuration in get_client for improved clarity

* Refactor use_proxy argument in get_client to support None as default value

* Remove use_proxy argument from get_client and update README

* Ensure proxy settings are always applied when enabled

* Check for proxy conflicts in client_configuration and environment variable

* Add test to verify proxy conflict raises ValueError for mismatched proxy settings

* Refactor test for proxy conflict in get_client method

Signed-off-by: Shahaf Bahar <[email protected]>

* Refactor test for proxy conflict to use pytest.raises match exp

* Add test for proxy enabled without proxy env variables set

---------

Signed-off-by: Shahaf Bahar <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: sbahar619

README.md

@@ -93,6 +93,23 @@ export OPENSHIFT_PYTHON_WRAPPER_LOG_LEVEL=<LOG_LEVEL> # can be: "DEBUG", "INFO",
   export OPENSHIFT_PYTHON_WRAPPER_HASH_LOG_DATA="false"
   ```
 
+## Proxy Enablement
+
+This configuration allows the client to route traffic through a specified proxy server.
+It can be enabled via the environment variable `OPENSHIFT_PYTHON_WRAPPER_CLIENT_USE_PROXY`.
+
+To enable proxy configuration for the client:
+
+1. Set the environment variable `OPENSHIFT_PYTHON_WRAPPER_CLIENT_USE_PROXY=<any value>`
+
+2. Define either `HTTPS_PROXY` or `HTTP_PROXY` environment variable with your proxy URL:
+```bash
+export HTTPS_PROXY="http://proxy.example.com:8080"
+# or
+export HTTP_PROXY="http://proxy.example.com:8080"
+```
+If neither variable is set when proxy is enabled, a `ValueError` will be raised.
+
 ## Code check
 
 We use pre-commit for code check.

ocp_resources/resource.py

@@ -76,7 +76,10 @@ def _get_api_version(dyn_client: DynamicClient, api_group: str, kind: str) -> st
 
 
 def get_client(
-    config_file: str = "", config_dict: dict[str, Any] | None = None, context: str = "", **kwargs: Any
+    config_file: str = "",
+    config_dict: dict[str, Any] | None = None,
+    context: str = "",
+    **kwargs: Any,
 ) -> DynamicClient:
     """
     Get a kubernetes client.
@@ -104,6 +107,7 @@ def get_client(
                 config_dict=config_dict, context=context or None, **kwargs
             )
         )
+    client_configuration = kwargs.get("client_configuration", kubernetes.client.Configuration())
     try:
         # Ref: https://github.com/kubernetes-client/python/blob/v26.1.0/kubernetes/base/config/__init__.py
         LOGGER.info("Trying to get client via new_client_from_config")
@@ -112,15 +116,34 @@ def get_client(
         # If `KUBECONFIG` environment variable is set via code, the `KUBE_CONFIG_DEFAULT_LOCATION` will be None since
         # is populated during import which comes before setting the variable in code.
         config_file = config_file or os.environ.get("KUBECONFIG", "~/.kube/config")
+
+        if os.environ.get("OPENSHIFT_PYTHON_WRAPPER_CLIENT_USE_PROXY"):
+            proxy = os.environ.get("HTTPS_PROXY") or os.environ.get("HTTP_PROXY")
+            if not proxy:
+                raise ValueError(
+                    "Proxy configuration is enabled but neither HTTPS_PROXY nor HTTP_PROXY environment variables are set."
+                )
+            if client_configuration.proxy and client_configuration.proxy != proxy:
+                raise ValueError(
+                    f"Conflicting proxy settings: client_configuration.proxy={client_configuration.proxy}, "
+                    f"but the environment variable 'OPENSHIFT_PYTHON_WRAPPER_CLIENT_USE_PROXY' defines proxy as {proxy}."
+                )
+            client_configuration.proxy = proxy
+
         return kubernetes.dynamic.DynamicClient(
-            client=kubernetes.config.new_client_from_config(config_file=config_file, context=context or None, **kwargs)
+            client=kubernetes.config.new_client_from_config(
+                config_file=config_file,
+                client_configuration=client_configuration,
+                context=context or None,
+                **kwargs,
+            )
         )
     except MaxRetryError:
         # Ref: https://github.com/kubernetes-client/python/blob/v26.1.0/kubernetes/base/config/incluster_config.py
         LOGGER.info("Trying to get client via incluster_config")
         return kubernetes.dynamic.DynamicClient(
             client=kubernetes.config.incluster_config.load_incluster_config(
-                client_configuration=kwargs.get("client_configuration"),
+                client_configuration=client_configuration,
                 try_refresh_token=kwargs.get("try_refresh_token", True),
             )
         )

tests/test_resources.py

@@ -1,5 +1,6 @@
 import pytest
 import yaml
+import kubernetes
 from testcontainers.k3s import K3SContainer
 
 from ocp_resources.exceptions import ResourceTeardownError
@@ -103,3 +104,26 @@ def test_resource_context_manager_exit(self, client):
         with pytest.raises(ResourceTeardownError):
             with TestSecretExit(name="test-context-manager-exit", namespace="default", client=client):
                 pass
+
+    def test_proxy_enabled_but_no_proxy_set(self, monkeypatch):
+        monkeypatch.setenv(name="OPENSHIFT_PYTHON_WRAPPER_CLIENT_USE_PROXY", value="1")
+
+        with pytest.raises(
+            ValueError,
+            match="Proxy configuration is enabled but neither HTTPS_PROXY nor HTTP_PROXY environment variables are set.",
+        ):
+            get_client()
+
+    def test_proxy_conflict_raises_value_error(self, monkeypatch):
+        monkeypatch.setenv(name="OPENSHIFT_PYTHON_WRAPPER_CLIENT_USE_PROXY", value="1")
+        monkeypatch.setenv(name="HTTPS_PROXY", value="http://env-proxy.com")
+
+        client_configuration = kubernetes.client.Configuration()
+        client_configuration.proxy = "http://not-env-proxy.com"
+
+        with pytest.raises(
+            ValueError,
+            match="Conflicting proxy settings: client_configuration.proxy=http://not-env-proxy.com, "
+            "but the environment variable 'OPENSHIFT_PYTHON_WRAPPER_CLIENT_USE_PROXY' defines proxy as http://env-proxy.com.",
+        ):
+            get_client(client_configuration=client_configuration)