openshift-python-wrapper 10.0.29__tar.gz → 10.0.31__tar.gz

{openshift_python_wrapper-10.0.29 → openshift_python_wrapper-10.0.31}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openshift-python-wrapper
-Version: 10.0.29
+Version: 10.0.31
 Summary: Wrapper around https://github.com/kubernetes-client/python
 Home-page: https://github.com/RedHatQE/openshift-python-wrapper
 License: Apache-2.0

{openshift_python_wrapper-10.0.29 → openshift_python_wrapper-10.0.31}/ocp_resources/datavolume.py

@@ -273,6 +273,7 @@ class DataVolume(NamespacedResource):
         self,
         timeout=TIMEOUT_10MINUTES,
         failure_timeout=TIMEOUT_2MINUTES,
+        dv_garbage_collection_enabled=False,
         stop_status_func=None,
         *stop_status_func_args,
         **stop_status_func_kwargs,
@@ -283,6 +284,7 @@ class DataVolume(NamespacedResource):
         Args:
             timeout (int):  Time to wait for the DataVolume to succeed.
             failure_timeout (int): Time to wait for the DataVolume to have not Pending/None status
+            dv_garbage_collection_enabled (bool, default: False): if True, expect that DV will disappear after success
             stop_status_func (function): function that is called inside the TimeoutSampler
                 if it returns True - stop the Sampler and raise TimeoutExpiredError
                 Example:
@@ -308,8 +310,10 @@ class DataVolume(NamespacedResource):
                 wait_timeout=timeout,
                 func=lambda: self.exists,
             ):
-                # DV reach to success if the status is succeeded or if the DV does not exist
-                if sample is None or sample.get("status", {}).get("phase") == self.Status.SUCCEEDED:
+                # DV reach success if the status is Succeeded, or if DV garbage collection enabled and the DV does not exist
+                if sample and sample.get("status", {}).get("phase") == self.Status.SUCCEEDED:
+                    break
+                elif sample is None and dv_garbage_collection_enabled:
                     break
                 elif stop_status_func and stop_status_func(*stop_status_func_args, **stop_status_func_kwargs):
                     raise TimeoutExpiredError(
@@ -319,7 +323,6 @@ class DataVolume(NamespacedResource):
                             f" {status_of_dv_str} {sample.status}"
                         )
                     )
-
         except TimeoutExpiredError:
             self.logger.error(f"{status_of_dv_str} {sample.status}")
             raise

{openshift_python_wrapper-10.0.29 → openshift_python_wrapper-10.0.31}/ocp_resources/resource.py

@@ -10,7 +10,6 @@ from signal import SIGINT, signal
 import kubernetes
 import yaml
 from benedict import benedict
-from kubernetes.dynamic import DynamicClient
 from kubernetes.dynamic.exceptions import (
     ConflictError,
     MethodNotAllowedError,
@@ -20,6 +19,7 @@ from kubernetes.dynamic.exceptions import (
 from kubernetes.dynamic.resource import ResourceField
 from packaging.version import Version
 from simple_logger.logger import get_logger
+from urllib3.exceptions import MaxRetryError
 
 from ocp_resources.constants import (
     DEFAULT_CLUSTER_RETRY_EXCEPTIONS,
@@ -61,10 +61,14 @@ def _get_api_version(dyn_client, api_group, kind):
     return res.group_version
 
 
-def get_client(config_file=None, config_dict=None, context=None):
+def get_client(config_file=None, config_dict=None, context=None, **kwargs):
     """
     Get a kubernetes client.
 
+
+    This function is a replica of `ocp_utilities.infra.get_client` which cannot be imported as ocp_utilities imports
+    from ocp_resources.
+
     Pass either config_file or config_dict.
     If none of them are passed, client will be created from default OS kubeconfig
     (environment variable or .kube folder).
@@ -77,19 +81,31 @@ def get_client(config_file=None, config_dict=None, context=None):
     Returns:
         DynamicClient: a kubernetes client.
     """
+    # Ref: https://github.com/kubernetes-client/python/blob/v26.1.0/kubernetes/base/config/kube_config.py
     if config_dict:
-        return DynamicClient(
-            client=kubernetes.config.new_client_from_config_dict(
-                config_dict=config_dict,
-                context=context,
-            )
+        return kubernetes.dynamic.DynamicClient(
+            client=kubernetes.config.new_client_from_config_dict(config_dict=config_dict, context=context, **kwargs)
         )
-    return DynamicClient(
-        client=kubernetes.config.new_client_from_config(
-            config_file=config_file,
-            context=context,
+    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")
+
+        # kubernetes.config.kube_config.load_kube_config sets KUBE_CONFIG_DEFAULT_LOCATION during module import.
+        # 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")
+        return kubernetes.dynamic.DynamicClient(
+            client=kubernetes.config.new_client_from_config(config_file=config_file, context=context, **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"),
+                try_refresh_token=kwargs.get("try_refresh_token", True),
+            )
         )
-    )
 
 
 def sub_resource_level(current_class, owner_class, parent_class):

{openshift_python_wrapper-10.0.29 → openshift_python_wrapper-10.0.31}/pyproject.toml

@@ -9,7 +9,7 @@ exclude = [".git", ".venv", ".mypy_cache", ".tox", "__pycache__"]
 
 [tool.poetry]
 name = "openshift-python-wrapper"
-version = "10.0.29"
+version = "10.0.31"
 description = "Wrapper around https://github.com/kubernetes-client/python"
 authors = ["Meni Yakove <myakove@gmail.com>", "Ruth Netser <rnetser@gmail.com>"]
 readme = "README.md"