openshift-python-wrapper 4.13.9__tar.gz → 4.13.12__tar.gz

{openshift-python-wrapper-4.13.9 → openshift-python-wrapper-4.13.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openshift-python-wrapper
-Version: 4.13.9
+Version: 4.13.12
 Summary: Wrapper around https://github.com/openshift/openshift-restclient-python
 Author-email: Meni Yakove <myakove@gmail.com>, Ruth Netser <rnetser@gmail.com>
 Project-URL: Homepage, https://github.com/RedHatQE/openshift-python-wrapper

openshift-python-wrapper-4.13.12/VERSION

@@ -0,0 +1 @@
+4.13.12

openshift-python-wrapper-4.13.12/ocp_resources/cron_job.py

@@ -0,0 +1,102 @@
+from ocp_resources.constants import TIMEOUT_4MINUTES
+from ocp_resources.resource import NamespacedResource
+
+
+class CronJob(NamespacedResource):
+    """
+    CronJob object. API reference:
+    https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/cron-job-v1/
+    """
+
+    api_group = NamespacedResource.ApiGroup.BATCH
+
+    def __init__(
+        self,
+        name=None,
+        namespace=None,
+        client=None,
+        teardown=True,
+        schedule=None,
+        job_template=None,
+        timezone=None,
+        concurrency_policy=None,
+        starting_deadline_seconds=None,
+        suspend=None,
+        successful_jobs_history_limit=None,
+        failed_jobs_history_limit=None,
+        privileged_client=None,
+        yaml_file=None,
+        delete_timeout=TIMEOUT_4MINUTES,
+        **kwargs,
+    ):
+        """
+        Args:
+            name (str): Name of the CronJob resource
+            namespace (str): Namespace of CronJob resource
+            client: (DynamicClient): DynamicClient for api calls
+            teardown (bool): Indicates if the resource should be torn down at the end
+            privileged_client (DynamicClient): Privileged client for api calls
+            yaml_file (str): yaml file for the resource.
+            delete_timeout (int, optional): timeout associated with delete action
+            schedule (str): schedule of the cron job
+            job_template (dict): describes the job that would be created when a cronjob would be executed
+                Example:
+                    job_template: https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/job-v1/#JobSpec
+            timezone (str, optional): timezone name for the given schedule
+            concurrency_policy (str, optional): indicates how to treat concurrent execution of a job
+            suspend (bool, optional): suspend subsequent executions
+            successful_jobs_history_limit (int, optional): number of successful jobs to retain
+            failed_jobs_history_limit (int, optional): number of failed jobs to retain
+            starting_deadline_seconds (int, optional): deadline in seconds, for starting a job, in case it does not
+            start at scheduled time
+
+
+        """
+        super().__init__(
+            name=name,
+            namespace=namespace,
+            client=client,
+            teardown=teardown,
+            privileged_client=privileged_client,
+            yaml_file=yaml_file,
+            delete_timeout=delete_timeout,
+            **kwargs,
+        )
+        self.job_template = job_template
+        self.schedule = schedule
+        self.timezone = timezone
+        self.concurrency_policy = concurrency_policy
+        self.suspend = suspend
+        self.successful_jobs_history_limit = successful_jobs_history_limit
+        self.failed_jobs_history_limit = failed_jobs_history_limit
+        self.starting_deadline_seconds = starting_deadline_seconds
+
+    def to_dict(self):
+        super().to_dict()
+        if not self.yaml_file:
+            if not (self.job_template and self.schedule):
+                raise ValueError(
+                    "yaml_file or parameters 'job_template' and 'schedule' are required."
+                )
+            self.res.update(
+                {
+                    "spec": {
+                        "jobTemplate": self.job_template,
+                        "schedule": self.schedule,
+                    }
+                }
+            )
+            if self.timezone:
+                self.res["spec"]["timezone"] = self.timezone
+            if self.suspend:
+                self.res["spec"]["suspend"] = self.suspend
+            if self.successful_jobs_history_limit:
+                self.res["spec"][
+                    "successfulJobsHistoryLimit"
+                ] = self.successful_jobs_history_limit
+            if self.failed_jobs_history_limit:
+                self.res["spec"][
+                    "failedJobsHistoryLimit"
+                ] = self.failed_jobs_history_limit
+            if self.concurrency_policy:
+                self.res["spec"]["concurrencyPolicy"] = self.concurrency_policy

openshift-python-wrapper-4.13.12/ocp_resources/csi_storage_capacity.py

@@ -0,0 +1,77 @@
+from ocp_resources.constants import TIMEOUT_4MINUTES
+from ocp_resources.resource import NamespacedResource
+
+
+class CSIStorageCapacity(NamespacedResource):
+    """
+    CSIStorageCapacity object. API reference:
+    https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/csi-storage-capacity-v1/#CSIStorageCapacity
+    """
+
+    api_group = NamespacedResource.ApiGroup.STORAGE_K8S_IO
+
+    def __init__(
+        self,
+        name=None,
+        namespace=None,
+        client=None,
+        capacity=None,
+        maximum_volume_size=None,
+        node_topology=None,
+        storage_class_name=None,
+        teardown=True,
+        privileged_client=None,
+        yaml_file=None,
+        delete_timeout=TIMEOUT_4MINUTES,
+        **kwargs,
+    ):
+        """
+        Args:
+            name (str): Name of the CSIStorageCapacity resource
+            namespace (str): Namespace of CSIStorageCapacity resource
+            client: (DynamicClient): DynamicClient for api calls
+            capacity (str, optional): value reported by the csi driver
+            maximum_volume_size (str, optional): maximum volume size reported by csi driver
+            storage_class_name (str): storage class name
+            node_topology (dict, optional): defines which node has access to the storage for which capacity
+            was reported
+                Example:
+                    node_topology: {'matchLabels': {'topology.hostpath.csi/node': 'c01-dbn-413-4c48b-worker-0-pmtv8'}}
+            teardown (bool): Indicates if the resource should be torn down at the end
+            privileged_client (DynamicClient): Privileged client for api calls
+            yaml_file (str): yaml file for the resource.
+            delete_timeout (int): timeout associated with delete action
+        """
+        super().__init__(
+            name=name,
+            namespace=namespace,
+            client=client,
+            teardown=teardown,
+            privileged_client=privileged_client,
+            yaml_file=yaml_file,
+            delete_timeout=delete_timeout,
+            **kwargs,
+        )
+        self.capacity = capacity
+        self.node_topology = node_topology
+        self.storage_class_name = storage_class_name
+        self.maximum_volume_size = maximum_volume_size
+
+    def to_dict(self):
+        super().to_dict()
+        if not self.yaml_file:
+            if not self.storage_class_name:
+                raise ValueError(
+                    "yaml_file or parameter 'storage_class_name' is required."
+                )
+            self.res.update(
+                {
+                    "storageClassName": self.storage_class_name,
+                }
+            )
+            if self.maximum_volume_size:
+                self.res["maximumVolumeSize"] = self.maximum_volume_size
+            if self.node_topology:
+                self.res["nodeTopology"] = self.node_topology
+            if self.capacity:
+                self.res["capacity"] = self.capacity

openshift-python-wrapper-4.13.12/ocp_resources/endpoint_slice.py

@@ -0,0 +1,68 @@
+from ocp_resources.constants import TIMEOUT_4MINUTES
+from ocp_resources.resource import NamespacedResource
+
+
+class EndpointSlice(NamespacedResource):
+    """
+    EndpointSlice object. API reference:
+    https://kubernetes.io/docs/reference/kubernetes-api/service-resources/endpoint-slice-v1/
+    """
+
+    api_group = NamespacedResource.ApiGroup.DISCOVERY_K8S_IO
+
+    def __init__(
+        self,
+        name=None,
+        namespace=None,
+        client=None,
+        address_type=None,
+        endpoints=None,
+        ports=None,
+        teardown=True,
+        privileged_client=None,
+        yaml_file=None,
+        delete_timeout=TIMEOUT_4MINUTES,
+        **kwargs,
+    ):
+        """
+        Args:
+            name (str): Name of the EndpointSlice resource
+            namespace (str): Namespace of EndpointSlice resource
+            client: (DynamicClient): DynamicClient for api calls
+            address_type (string): Type of address carried by this endpoint
+            endpoints (list): List of unique endpoints in this slice
+            ports (list, optional): List of port numbers available on the related ip addresses
+            teardown (bool): Indicates if the resource should be torn down at the end
+            privileged_client (DynamicClient): Privileged client for api calls
+            yaml_file (str): yaml file for the resource.
+            delete_timeout (int): timeout associated with delete action
+        """
+        super().__init__(
+            name=name,
+            namespace=namespace,
+            client=client,
+            teardown=teardown,
+            privileged_client=privileged_client,
+            yaml_file=yaml_file,
+            delete_timeout=delete_timeout,
+            **kwargs,
+        )
+        self.address_type = address_type
+        self.endpoints = endpoints
+        self.ports = ports
+
+    def to_dict(self):
+        super().to_dict()
+        if not self.yaml_file:
+            if not (self.address_type and self.endpoints):
+                raise ValueError(
+                    "yaml_file or parameters 'address_type' and 'endpoints' are required."
+                )
+            self.res.update(
+                {
+                    "addressTypes": self.address_type,
+                    "endpoints": self.endpoints,
+                }
+            )
+            if self.ports:
+                self.res["ports"] = self.ports

openshift-python-wrapper-4.13.12/ocp_resources/image_content_source_policy.py

@@ -0,0 +1,33 @@
+from ocp_resources.resource import Resource
+
+
+class ImageContentSourcePolicy(Resource):
+    """
+    ICSP object, inherited from Resource.
+    """
+
+    api_group = Resource.ApiGroup.OPERATOR_OPENSHIFT_IO
+
+    def __init__(self, repository_digest_mirrors, **kwargs):
+        """
+        Create/Manage ICSP configuration object. API reference:
+        https://docs.openshift.com/container-platform/4.12/rest_api/operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.html
+
+        Args:
+            repository_digest_mirrors (list of dict):
+                e.g. [{source: <str>, mirrors: <list>}, ..., {source: <str>, mirrors: <list>}]
+            - source - the repository that users refer to, e.g. in image pull specifications
+            - mirrors - one or more repositories (str) that may also contain the same images. The order
+                of mirrors in this list is treated as the user’s desired priority
+        """
+        self.repository_digest_mirrors = repository_digest_mirrors
+        super().__init__(**kwargs)
+
+    def to_dict(self):
+        super().to_dict()
+        if not self.yaml_file:
+            if not self.repository_digest_mirrors:
+                raise ValueError("repository_digest_mirrors must be defined")
+            self.res["spec"] = {
+                "repositoryDigestMirrors": self.repository_digest_mirrors
+            }

openshift-python-wrapper-4.13.12/ocp_resources/lease.py

@@ -0,0 +1,72 @@
+from ocp_resources.constants import TIMEOUT_4MINUTES
+from ocp_resources.resource import NamespacedResource
+
+
+class Lease(NamespacedResource):
+    """
+    Lease object. API reference:
+    https://kubernetes.io/docs/reference/kubernetes-api/cluster-resources/lease-v1/
+    """
+
+    api_group = NamespacedResource.ApiGroup.COORDINATION_K8S_IO
+
+    def __init__(
+        self,
+        name=None,
+        namespace=None,
+        client=None,
+        teardown=True,
+        privileged_client=None,
+        yaml_file=None,
+        delete_timeout=TIMEOUT_4MINUTES,
+        holder_identity=None,
+        acquire_time=None,
+        renew_time=None,
+        lease_duration_seconds=None,
+        lease_transitions=None,
+        **kwargs,
+    ):
+        """
+        Args:
+            name (str): Name of the Lease resource
+            namespace (str): Namespace of Lease resource
+            client: (DynamicClient): DynamicClient for api calls
+            teardown (bool): Indicates if the resource should be torn down at the end
+            holder_identity (str, optional): identify of the holder of the current lease
+            lease_duration_seconds (int, optional): duration for which candidate of a lease needs to wait to acquire it
+            lease_transitions (int, optional):  number of transitions of a lease between holders.
+            acquire_time (time, optional): when the current lease was acquired
+            renew_time (time, optional): when current holder of the lease has last updated it
+            privileged_client (DynamicClient): Privileged client for api calls
+            yaml_file (str): yaml file for the resource.
+            delete_timeout (int): timeout associated with delete action
+        """
+        super().__init__(
+            name=name,
+            namespace=namespace,
+            client=client,
+            teardown=teardown,
+            privileged_client=privileged_client,
+            yaml_file=yaml_file,
+            delete_timeout=delete_timeout,
+            **kwargs,
+        )
+        self.holder_identity = holder_identity
+        self.lease_transitions = lease_transitions
+        self.lease_duration_seconds = lease_duration_seconds
+        self.acquire_time = acquire_time
+        self.renew_time = renew_time
+
+    def to_dict(self):
+        super().to_dict()
+        if not self.yaml_file:
+            if self.acquire_time:
+                self.res["spec"]["acquireTime"] = self.acquire_time
+            if self.renew_time:
+                self.res["spec"]["renewTime"] = self.renew_time
+            if self.holder_identity:
+                self.res["spec"]["holderIdentity"] = self.holder_identity
+            if self.lease_duration_seconds:
+                self.res["spec"]["leaseDurationSeconds"] = self.lease_duration_seconds
+            if self.lease_transitions:
+                self.res["spec"]["leaseTransitions"] = self.lease_transitions

{openshift-python-wrapper-4.13.9 → openshift-python-wrapper-4.13.12}/ocp_resources/node.py

@@ -14,12 +14,9 @@ class Node(Resource):
     @property
     def kubelet_ready(self):
         return any(
-            [
-                stat
-                for stat in self.instance.status.conditions
-                if stat["reason"] == "KubeletReady"
-                and stat["status"] == self.Condition.Status.TRUE
-            ]
+            stat["reason"] == "KubeletReady"
+            and stat["status"] == self.Condition.Status.TRUE
+            for stat in self.instance.status.conditions
         )
 
     @property

openshift-python-wrapper-4.13.12/ocp_resources/pipeline.py

@@ -0,0 +1,58 @@
+# API reference: https://tekton.dev/docs/pipelines/pipelines/
+
+from ocp_resources.resource import NamespacedResource
+
+
+class Pipeline(NamespacedResource):
+    api_group = NamespacedResource.ApiGroup.TEKTON_DEV
+
+    def __init__(
+        self,
+        name=None,
+        namespace=None,
+        tasks=None,
+        params=None,
+        final_parallel_tasks=None,
+        client=None,
+        yaml_file=None,
+        **kwargs,
+    ):
+        """
+        Args:
+            name (str): Name of the pipeline
+            namespace (str): Namespace of the pipeline
+            tasks (str, optional): actions to perform in pipeline
+            client: (DynamicClient): DynamicClient to use.
+            params (dict, optional):  params to support pipelines.
+            params can be set/changed based on tasks.
+            example: 'spec': {'params': [{'name': 'sourceTemplateName','type': 'string','default':'openshift'},
+            {'name': 'sourceTemplateNamespace', 'type':'string', 'description': 'Namespace pf template'}]}
+            final_parallel_tasks (list, optional):  a list of one or more to be executed in parallel after all other
+            tasks have completed in parallel.
+            spec section can't be empty. It requires at least one optional field.
+        """
+        super().__init__(
+            name=name,
+            namespace=namespace,
+            client=client,
+            **kwargs,
+        )
+        # TODO: Add a check for tasks when bug https://issues.redhat.com/browse/SRVKP-3019 is resolved.
+        self.tasks = tasks
+        self.params = params
+        self.final_parallel_tasks = final_parallel_tasks
+
+    def to_dict(self):
+        super().to_dict()
+        if not self.yaml_file:
+            if not (self.tasks or self.params or self.final_parallel_tasks):
+                raise ValueError(
+                    "spec is expected to have at least one of the optional fields, got none"
+                )
+            self.res["spec"] = {}
+            if self.params:
+                self.res["spec"]["params"] = self.params
+            if self.tasks:
+                self.res["spec"]["tasks"] = self.tasks
+            if self.final_parallel_tasks:
+                self.res["spec"]["finally"] = self.final_parallel_tasks

openshift-python-wrapper-4.13.12/ocp_resources/pod_metrics.py

@@ -0,0 +1,10 @@
+from ocp_resources.resource import NamespacedResource
+
+
+class PodMetrics(NamespacedResource):
+    """
+    PodMetrics object. API reference:
+    This resource is managed by: https://github.com/kubernetes-sigs/metrics-server and is a built-in resource
+    """
+
+    api_group = NamespacedResource.ApiGroup.METRICS_K8S_IO

{openshift-python-wrapper-4.13.9 → openshift-python-wrapper-4.13.12}/ocp_resources/resource.py

@@ -239,7 +239,9 @@ class Resource:
         CLONE_KUBEVIRT_IO = "clone.kubevirt.io"
         CONFIG_OPENSHIFT_IO = "config.openshift.io"
         CONSOLE_OPENSHIFT_IO = "console.openshift.io"
+        COORDINATION_K8S_IO = "coordination.k8s.io"
         DATA_IMPORT_CRON_TEMPLATE_KUBEVIRT_IO = "dataimportcrontemplate.kubevirt.io"
+        DISCOVERY_K8S_IO = "discovery.k8s.io"
         EVENTS_K8S_IO = "events.k8s.io"
         EXPORT_KUBEVIRT_IO = "export.kubevirt.io"
         FORKLIFT_KONVEYOR_IO = "forklift.konveyor.io"
@@ -259,6 +261,7 @@ class Resource:
         MACHINECONFIGURATION_OPENSHIFT_IO = "machineconfiguration.openshift.io"
         MAISTRA_IO = "maistra.io"
         METALLB_IO = "metallb.io"
+        METRICS_K8S_IO = "metrics.k8s.io"
         MIGRATIONS_KUBEVIRT_IO = "migrations.kubevirt.io"
         MONITORING_COREOS_COM = "monitoring.coreos.com"
         NETWORKADDONSOPERATOR_NETWORK_KUBEVIRT_IO = (
@@ -322,6 +325,7 @@ class Resource:
         context=None,
         label=None,
         timeout_seconds=TIMEOUT_1MINUTE,
+        api_group=None,
     ):
         """
         Create an API resource
@@ -340,8 +344,10 @@ class Resource:
             context (str): Context name for connecting to remote cluster.
             timeout_seconds (int): timeout for a get api call, call out be terminated after this many seconds
             label (dict): Resource labels
+            api_group (str): Resource API group; will overwrite API group definition in resource class
 
         """
+        self.api_group = api_group or self.api_group
         if not self.api_group and not self.api_version:
             raise NotImplementedError(
                 "Subclasses of Resource require self.api_group or self.api_version to be defined"

{openshift-python-wrapper-4.13.9 → openshift-python-wrapper-4.13.12}/ocp_resources/virtual_machine_restore.py

@@ -69,8 +69,7 @@ class VirtualMachineRestore(NamespacedResource):
             wait_timeout=timeout,
             sleep=1,
             exceptions_dict=PROTOCOL_ERROR_EXCEPTION_DICT,
-            func=lambda: self.instance.get("status", {}).get("complete", None)
-            == status,
+            func=lambda: self.instance.get("status", {}).get("complete") == status,
         )
         for sample in samples:
             if sample:

{openshift-python-wrapper-4.13.9 → openshift-python-wrapper-4.13.12}/ocp_resources/virtual_machine_snapshot.py

@@ -66,8 +66,7 @@ class VirtualMachineSnapshot(NamespacedResource):
             wait_timeout=timeout,
             sleep=1,
             exceptions_dict=PROTOCOL_ERROR_EXCEPTION_DICT,
-            func=lambda: self.instance.get("status", {}).get("readyToUse", None)
-            == status,
+            func=lambda: self.instance.get("status", {}).get("readyToUse") == status,
         )
         for sample in samples:
             if sample:

{openshift-python-wrapper-4.13.9 → openshift-python-wrapper-4.13.12}/openshift_python_wrapper.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openshift-python-wrapper
-Version: 4.13.9
+Version: 4.13.12
 Summary: Wrapper around https://github.com/openshift/openshift-restclient-python
 Author-email: Meni Yakove <myakove@gmail.com>, Ruth Netser <rnetser@gmail.com>
 Project-URL: Homepage, https://github.com/RedHatQE/openshift-python-wrapper

{openshift-python-wrapper-4.13.9 → openshift-python-wrapper-4.13.12}/openshift_python_wrapper.egg-info/SOURCES.txt

@@ -24,6 +24,8 @@ ocp_resources/console_plugin.py
 ocp_resources/console_quick_start.py
 ocp_resources/constants.py
 ocp_resources/controller_revision.py
+ocp_resources/cron_job.py
+ocp_resources/csi_storage_capacity.py
 ocp_resources/csidriver.py
 ocp_resources/custom_resource_definition.py
 ocp_resources/daemonset.py
@@ -32,6 +34,7 @@ ocp_resources/data_source.py
 ocp_resources/datavolume.py
 ocp_resources/deployment.py
 ocp_resources/destination_rule.py
+ocp_resources/endpoint_slice.py
 ocp_resources/endpoints.py
 ocp_resources/event.py
 ocp_resources/forklift_controller.py
@@ -55,6 +58,7 @@ ocp_resources/kubevirt_metrics_aggregation.py
 ocp_resources/kubevirt_node_labeller_bundle.py
 ocp_resources/kubevirt_template_validaotr.py
 ocp_resources/l2_advertisement.py
+ocp_resources/lease.py
 ocp_resources/machine.py
 ocp_resources/machine_config.py
 ocp_resources/machine_config_pool.py
@@ -88,10 +92,12 @@ ocp_resources/package_manifest.py
 ocp_resources/peer_authentication.py
 ocp_resources/persistent_volume.py
 ocp_resources/persistent_volume_claim.py
+ocp_resources/pipeline.py
 ocp_resources/pipelineruns.py
 ocp_resources/plan.py
 ocp_resources/pod.py
 ocp_resources/pod_disruption_budget.py
+ocp_resources/pod_metrics.py
 ocp_resources/priority_class.py
 ocp_resources/project.py
 ocp_resources/prometheus.py

openshift-python-wrapper-4.13.9/VERSION

@@ -1 +0,0 @@
-4.13.9

openshift-python-wrapper-4.13.9/ocp_resources/image_content_source_policy.py

@@ -1,9 +0,0 @@
-from ocp_resources.resource import Resource
-
-
-class ImageContentSourcePolicy(Resource):
-    """
-    ICSP object, inherited from Resource.
-    """
-
-    api_group = Resource.ApiGroup.OPERATOR_OPENSHIFT_IO