openshift-python-wrapper 10.0.65__tar.gz → 10.0.66__tar.gz

{openshift_python_wrapper-10.0.65 → openshift_python_wrapper-10.0.66}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: openshift-python-wrapper
-Version: 10.0.65
+Version: 10.0.66
 Summary: Wrapper around https://github.com/kubernetes-client/python
 Home-page: https://github.com/RedHatQE/openshift-python-wrapper
 License: Apache-2.0
-Keywords: Openshift,Kubevirt,CNV
+Keywords: Openshift,Kubevirt,Openshift Virtualization
 Author: Meni Yakove
 Author-email: myakove@gmail.com
 Requires-Python: >=3.8,<4.0
@@ -16,12 +16,15 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: click (>=8.1.7,<9.0.0)
 Requires-Dist: colorlog (>=6.7.0,<7.0.0)
 Requires-Dist: jinja2 (>=3.1.2,<4.0.0)
 Requires-Dist: kubernetes (>=30.0.0,<31.0.0)
 Requires-Dist: packaging (>=23.1,<24.0)
+Requires-Dist: pyhelper-utils (>=0.0.27,<0.0.28)
 Requires-Dist: python-benedict (>=0.33.0,<0.34.0)
 Requires-Dist: python-simple-logger (>=1.0.6)
+Requires-Dist: ruff (>=0.5.3,<0.6.0)
 Requires-Dist: timeout-sampler (>=0.0.17)
 Requires-Dist: xmltodict (>=0.13.0,<0.14.0)
 Project-URL: Bug Tracker, https://github.com/RedHatQE/openshift-python-wrapper/issues
@@ -29,11 +32,32 @@ Project-URL: Documentation, https://openshift-python-wrapper.readthedocs.io/en/l
 Project-URL: Download, https://pypi.org/project/openshift-python-wrapper/
 Description-Content-Type: text/markdown
 
-# openshift-python-wrapper
+# openshift-python-wrapper (`wrapper`)
 Pypi: [openshift-python-wrapper](https://pypi.org/project/openshift-python-wrapper)  
-A python wrapper for [kubernetes-python-client](https://github.com/kubernetes-client/python) with support for RedHat Container Virtualization. ([Openshift Virtualization](https://www.openshift.com/learn/topics/virtualization))
+A python wrapper for [kubernetes-python-client](https://github.com/kubernetes-client/python) with support for [RedHat Container Virtualization](https://www.openshift.com/learn/topics/virtualization)  
 Docs: [openshift-python-wrapper docs](https://openshift-python-wrapper.readthedocs.io/en/latest/)
 
+The wrapper offers a simple and intuitive interface for interacting with the API.  
+It standardizes how to work with cluster resources and offers unified resource CRUD (Create, Read, Update, and Delete) flows.  
+The wrapper also provides additional capabilities, such as resource-specific functionality that otherwise needs to be implemented by users.  
+The wrapper makes code easier to read and maintain over time.
+
+One example of simplified usage is interacting with a container.  
+Running a command inside a container requires using Kubernetes stream, handling errors, and more.  
+The wrapper handles it all and provides simple and intuitive functionality.
+
+![Alt Text](examples/pod_example.gif)
+
+Both developers or testers can use the wrapper.  The code is modular and easy to maintain.  
+Instead of writing custom code for every API, you can use the wrapper that provides a consistent interface for interacting with APIs.  
+It saves time, avoids code duplications, and reduces the chance of errors.
+
+Using Python capabilities, context managers can provide out-of-the-box resource creation and deletion,  
+and inheritance can be used to extend functionality for specific use cases.  
+Pytest fixtures can utilize the code for setup and teardown, leaving no leftovers.  
+Resources can even be saved for debugging.  
+Resource manifests and logs can be easily collected.
+
 ## Installation
 From source:
 ```bash
@@ -86,7 +110,7 @@ We use pre-commit for code check.
 pre-commit install
 ```
 
-Some code examples locate at `examples` directory
+Some code examples locate at [examples](examples) directory
 
 ## Contribute to the project
 To contribute new additions or changes to the project, please refer to the [contribution guide](CONTRIBUTING.md) first.

{openshift_python_wrapper-10.0.65 → openshift_python_wrapper-10.0.66}/README.md

@@ -1,8 +1,29 @@
-# openshift-python-wrapper
+# openshift-python-wrapper (`wrapper`)
 Pypi: [openshift-python-wrapper](https://pypi.org/project/openshift-python-wrapper)  
-A python wrapper for [kubernetes-python-client](https://github.com/kubernetes-client/python) with support for RedHat Container Virtualization. ([Openshift Virtualization](https://www.openshift.com/learn/topics/virtualization))
+A python wrapper for [kubernetes-python-client](https://github.com/kubernetes-client/python) with support for [RedHat Container Virtualization](https://www.openshift.com/learn/topics/virtualization)  
 Docs: [openshift-python-wrapper docs](https://openshift-python-wrapper.readthedocs.io/en/latest/)
 
+The wrapper offers a simple and intuitive interface for interacting with the API.  
+It standardizes how to work with cluster resources and offers unified resource CRUD (Create, Read, Update, and Delete) flows.  
+The wrapper also provides additional capabilities, such as resource-specific functionality that otherwise needs to be implemented by users.  
+The wrapper makes code easier to read and maintain over time.
+
+One example of simplified usage is interacting with a container.  
+Running a command inside a container requires using Kubernetes stream, handling errors, and more.  
+The wrapper handles it all and provides simple and intuitive functionality.
+
+![Alt Text](examples/pod_example.gif)
+
+Both developers or testers can use the wrapper.  The code is modular and easy to maintain.  
+Instead of writing custom code for every API, you can use the wrapper that provides a consistent interface for interacting with APIs.  
+It saves time, avoids code duplications, and reduces the chance of errors.
+
+Using Python capabilities, context managers can provide out-of-the-box resource creation and deletion,  
+and inheritance can be used to extend functionality for specific use cases.  
+Pytest fixtures can utilize the code for setup and teardown, leaving no leftovers.  
+Resources can even be saved for debugging.  
+Resource manifests and logs can be easily collected.
+
 ## Installation
 From source:
 ```bash
@@ -55,7 +76,7 @@ We use pre-commit for code check.
 pre-commit install
 ```
 
-Some code examples locate at `examples` directory
+Some code examples locate at [examples](examples) directory
 
 ## Contribute to the project
 To contribute new additions or changes to the project, please refer to the [contribution guide](CONTRIBUTING.md) first.

{openshift_python_wrapper-10.0.65 → openshift_python_wrapper-10.0.66}/ocp_resources/benchmark.py

@@ -1,3 +1,5 @@
+from typing import Any, Optional
+
 from ocp_resources.constants import NOT_FOUND_ERROR_EXCEPTION_DICT
 from ocp_resources.resource import NamespacedResource
 from timeout_sampler import TimeoutSampler
@@ -16,23 +18,23 @@ class Benchmark(NamespacedResource):
     api_group = NamespacedResource.ApiGroup.RIPSAW_CLOUDBULLDOZER_IO
 
     class Status:
-        NONE = None  # None state is valid for newly created benchmark resources
+        NONE: str = "None"  # None state is valid for newly created benchmark resources
 
     class Workload:
         class Kind:
-            VM = "vm"
-            POD = "pod"
+            VM: str = "vm"
+            POD: str = "pod"
 
-    def _wait_for_instance_key(self, parent, key):
+    def _wait_for_instance_key(self, parent: str, key: str) -> Any:
         """
         Wait for key to exist in parent attribute of instance
 
         Args:
-            parent (str): An attribute of self.instance that should contain key
+            parent (str): An attribute of `self.instance` that should contain key.
             key (str): A dictionary entry within parent
 
         Returns:
-            str or None: Value of key if found, otherwise None
+            Any: Value of key if found, otherwise None
         """
         samples = TimeoutSampler(
             wait_timeout=30,
@@ -45,7 +47,7 @@ class Benchmark(NamespacedResource):
                 return sample.get(key)
 
     @property
-    def uuid(self):
+    def uuid(self) -> str:
         """
         Returns:
             str: UUID string from resource instance
@@ -53,7 +55,7 @@ class Benchmark(NamespacedResource):
         return self._wait_for_instance_key(parent="status", key="uuid")
 
     @property
-    def suuid(self):
+    def suuid(self) -> str:
         """
         Returns:
             str: (short)UUID string from resource instance
@@ -61,7 +63,7 @@ class Benchmark(NamespacedResource):
         return self._wait_for_instance_key(parent="status", key="suuid")
 
     @property
-    def workload_kind(self):
+    def workload_kind(self) -> str:
         """
         Retrieve the value of spec.workload.args.kind
 
@@ -73,7 +75,7 @@ class Benchmark(NamespacedResource):
         """
         return self.workload_arg(arg="kind", default="pod")
 
-    def workload_arg(self, arg, default=None):
+    def workload_arg(self, arg: str, default: Optional[Any] = None) -> Any:
         """
         Retrieve the value of spec.workload.args[arg]
 
@@ -81,12 +83,11 @@ class Benchmark(NamespacedResource):
 
         Args:
             arg (str): Argument to retrieve from spec.workload.args
-            default (any): Default value to return if arg is not found in workload args
+            default (Any): Default value to return if arg is not found in workload args
 
         Returns:
-            any: Value of workload arg or 'default' if does not exist
+            Any: Value of workload arg or 'default' if workload arg does not exist
         """
-        workload = self._wait_for_instance_key(parent="spec", key="workload")
-        if workload:
+        if (workload := self._wait_for_instance_key(parent="spec", key="workload")) and isinstance(workload, dict):
             return workload.get("args", {}).get(arg, default)
         return default

{openshift_python_wrapper-10.0.65 → openshift_python_wrapper-10.0.66}/ocp_resources/catalog_source.py

@@ -1,3 +1,4 @@
+from typing import Any, Dict
 from ocp_resources.resource import MissingRequiredArgumentError, NamespacedResource
 
 
@@ -10,13 +11,13 @@ class CatalogSource(NamespacedResource):
 
     def __init__(
         self,
-        source_type=None,
-        image=None,
-        display_name=None,
-        publisher=None,
-        update_strategy_registry_poll_interval=None,
-        **kwargs,
-    ):
+        source_type: str = "",
+        image: str = "",
+        display_name: str = "",
+        publisher: str = "",
+        update_strategy_registry_poll_interval: str = "",
+        **kwargs: Any,
+    ) -> None:
         """
         Args:
             source_type (str): Name of the source type.
@@ -38,19 +39,14 @@ class CatalogSource(NamespacedResource):
         if not self.yaml_file:
             if not all([self.source_type, self.image, self.display_name, self.publisher]):
                 raise MissingRequiredArgumentError(argument="'source_type', 'image', 'display_name' and 'publisher'")
-            self.res.update({
-                "spec": {
-                    "sourceType": self.source_type,
-                    "image": self.image,
-                    "displayName": self.display_name,
-                    "publisher": self.publisher,
-                }
-            })
+
+            self.res["spec"] = {
+                "sourceType": self.source_type,
+                "image": self.image,
+                "displayName": self.display_name,
+                "publisher": self.publisher,
+            }
+            _spec: Dict[str, Any] = self.res["spec"]
+
             if self.update_strategy_registry_poll_interval:
-                self.res["spec"].update({
-                    "updateStrategy": {
-                        "registryPoll": {
-                            "interval": self.update_strategy_registry_poll_interval,
-                        },
-                    },
-                })
+                _spec["updateStrategy"] = {"registryPoll": {"interval": self.update_strategy_registry_poll_interval}}

{openshift_python_wrapper-10.0.65 → openshift_python_wrapper-10.0.66}/ocp_resources/cdi.py

@@ -9,5 +9,5 @@ class CDI(Resource):
     api_group = Resource.ApiGroup.CDI_KUBEVIRT_IO
 
     class Status(Resource.Status):
-        DEPLOYING = "Deploying"
-        DEPLOYED = "Deployed"
+        DEPLOYING: str = "Deploying"
+        DEPLOYED: str = "Deployed"

{openshift_python_wrapper-10.0.65 → openshift_python_wrapper-10.0.66}/ocp_resources/cdi_config.py

@@ -13,18 +13,18 @@ class CDIConfig(Resource):
     api_group = Resource.ApiGroup.CDI_KUBEVIRT_IO
 
     @property
-    def scratch_space_storage_class_from_spec(self):
+    def scratch_space_storage_class_from_spec(self) -> str:
         return self.instance.spec.scratchSpaceStorageClass
 
     @property
-    def scratch_space_storage_class_from_status(self):
+    def scratch_space_storage_class_from_status(self) -> str:
         return self.instance.status.scratchSpaceStorageClass
 
     @property
-    def upload_proxy_url(self):
+    def upload_proxy_url(self) -> str:
         return self.instance.status.uploadProxyURL
 
-    def wait_until_upload_url_changed(self, uploadproxy_url, timeout=TIMEOUT_4MINUTES):
+    def wait_until_upload_url_changed(self, uploadproxy_url: str, timeout: int = TIMEOUT_4MINUTES) -> bool:
         """
         Wait until upload proxy url is changed
 
@@ -45,6 +45,8 @@ class CDIConfig(Resource):
         for sample in samples:
             if sample.items:
                 status = sample.items[0].status
-                current_url = status.uploadProxyURL
+                current_url: str = status.uploadProxyURL
                 if current_url == uploadproxy_url:
-                    return
+                    return True
+
+        return False

{openshift_python_wrapper-10.0.65 → openshift_python_wrapper-10.0.66}/ocp_resources/chaos_engine.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 
+from typing import Any, Dict, List
 from ocp_resources.resource import NamespacedResource
 
 
@@ -7,17 +8,17 @@ class ChaosEngine(NamespacedResource):
     api_group = NamespacedResource.ApiGroup.LITMUS_IO
 
     class EngineStatus:
-        INITIALIZED = "initialized"
-        COMPLETED = "completed"
-        STOPPED = "stopped"
+        INITIALIZED: str = "initialized"
+        COMPLETED: str = "completed"
+        STOPPED: str = "stopped"
 
     @property
-    def engine_status(self):
+    def engine_status(self) -> str:
         return self.instance.status["engineStatus"]
 
     @property
-    def experiments_status(self):
-        experiments = self.instance.status["experiments"]
+    def experiments_status(self) -> Dict[str, Dict[str, Any]]:
+        experiments: List[Dict[Any, Any]] = self.instance.status["experiments"]
         ret_value = {}
         for experiment in experiments:
             exp = {"verdict": experiment["verdict"], "status": experiment["status"]}
@@ -25,6 +26,6 @@ class ChaosEngine(NamespacedResource):
         return ret_value
 
     @property
-    def success(self):
+    def success(self) -> bool:
         exps = self.experiments_status
         return all(exp["verdict"] == "Pass" for exp in exps.values())

{openshift_python_wrapper-10.0.65 → openshift_python_wrapper-10.0.66}/ocp_resources/ingress_controller.py

@@ -141,7 +141,7 @@ class IngressController(NamespacedResource):
         self.endpoint_publishing_strategy = endpoint_publishing_strategy
         self.default_certificate = default_certificate
         self.namespace_selector = namespace_selector
-        self.node_selector = node_selector  # type: ignore
+        self.node_selector = node_selector
         self.route_selector = route_selector
         self.tls_security_profile = tls_security_profile
         self.logging = logging

openshift_python_wrapper-10.0.66/ocp_resources/machine_config.py

@@ -0,0 +1,93 @@
+from typing import Any, Dict, List, Optional
+from ocp_resources.resource import Resource
+
+
+class MachineConfig(Resource):
+    """
+    https://docs.openshift.com/container-platform/4.16/rest_api/machine_apis/machineconfig-machineconfiguration-openshift-io-v1.html
+    """
+
+    api_group = Resource.ApiGroup.MACHINECONFIGURATION_OPENSHIFT_IO
+
+    def __init__(
+        self,
+        os_image_url: Optional[str] = "",
+        config: Optional[Dict[str, Any]] = None,
+        kernel_arguments: Optional[List[str]] = None,
+        extensions: Optional[List[str]] = None,
+        fips: Optional[bool] = None,
+        kernel_type: Optional[str] = "",
+        base_os_extensions_container_image: Optional[str] = "",
+        **kwargs: Any,
+    ) -> None:
+        """
+        Args:
+            os_image_url (str, optional): URL to the OS image.
+            config (dict, optional): Ignition config file data.
+                Example:
+                {
+                    "ignition": {
+                        "version": "3.1.0",
+                        "config": {
+                            "merge": [
+                                {
+                                    "source": "http://path/to/your/config.ign"
+                                }
+                            ]
+                        }
+                    },
+                    "storage": {
+                        "filesystems": [
+                            {
+                                "name": "root",
+                                "mount": {
+                                    "device": "/dev/disk/by-label/root",
+                                    "format": "xfs",
+                                    "wipeFilesystem": False
+                                }
+                            }
+                        ]
+                    }
+                }
+            kernel_arguments (list, optional): List of kernel arguments.
+            extensions (list, optional): List of extensions to install.
+            fips (bool, optional): Enable FIPS mode. Defaults to False.
+            kernel_type (str, optional): Type of kernel to use.
+            base_os_extensions_container_image (str, optional): URL to the base OS extensions container image.
+        """
+        super().__init__(**kwargs)
+        self.os_image_url: Optional[str] = os_image_url
+        self.config: Optional[Dict[str, Any]] = config
+        self.kernel_arguments: Optional[List[str]] = kernel_arguments
+        self.extensions: Optional[List[str]] = extensions
+        self.fips: Optional[bool] = fips
+        self.kernel_type: Optional[str] = kernel_type
+        self.base_os_extensions_container_image: Optional[str] = base_os_extensions_container_image
+
+    def to_dict(self) -> None:
+        super().to_dict()
+
+        if not self.yaml_file:
+            self.res["spec"] = {}
+            _spec = self.res["spec"]
+
+            if self.os_image_url:
+                _spec["osImageURL"] = self.os_image_url
+
+            if self.config:
+                _spec["config"] = self.config
+
+            if self.kernel_arguments:
+                _spec["kernelArguments"] = self.kernel_arguments
+
+            if self.extensions:
+                _spec["extensions"] = self.extensions
+
+            if self.fips is not None:
+                _spec["fips"] = self.fips
+
+            if self.kernel_type:
+                _spec["kernelType"] = self.kernel_type
+
+            if self.base_os_extensions_container_image:
+                _spec["baseOSExtensionsContainerImage"] = self.base_os_extensions_container_image

{openshift_python_wrapper-10.0.65 → openshift_python_wrapper-10.0.66}/ocp_resources/project.py

@@ -48,13 +48,3 @@ class ProjectRequest(Resource):
 
     def clean_up(self):
         Project(name=self.name).delete(wait=True)
-
-    def client_wait_deleted(self, timeout):
-        """
-        client-side Wait until resource is deleted
-
-        Args:
-            timeout (int): Time to wait for the resource.
-
-        """
-        super().client_wait_deleted(timeout=timeout)