openshift-python-wrapper 4.11.60__tar.gz → 4.11.61__tar.gz

{openshift-python-wrapper-4.11.60/openshift_python_wrapper.egg-info → openshift_python_wrapper-4.11.61}/PKG-INFO

@@ -1,18 +1,31 @@
 Metadata-Version: 2.1
 Name: openshift-python-wrapper
-Version: 4.11.60
-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
-Project-URL: Download, https://pypi.org/project/openshift-python-wrapper/
-Project-URL: Bug Tracker, https://github.com/RedHatQE/openshift-python-wrapper/issues
-Project-URL: Documentation, https://openshift-python-wrapper.readthedocs.io/en/latest/
+Version: 4.11.61
+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
-Classifier: Programming Language :: Python :: 3
+Author: Meni Yakove
+Author-email: myakove@gmail.com
+Requires-Python: >=3.8,<4.0
+Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.7
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: colorlog (>=6.7.0,<7.0.0)
+Requires-Dist: kubernetes (>=27.2.0,<28.0.0)
+Requires-Dist: openshift (>=0.13.2,<0.14.0)
+Requires-Dist: packaging (>=23.1,<24.0)
+Requires-Dist: python-benedict (>=0.32.0,<0.33.0)
+Requires-Dist: python-simple-logger (>=1.0.5,<2.0.0)
+Requires-Dist: xmltodict (>=0.13.0,<0.14.0)
+Project-URL: Bug Tracker, https://github.com/RedHatQE/openshift-python-wrapper/issues
+Project-URL: Documentation, https://openshift-python-wrapper.readthedocs.io/en/latest/
+Project-URL: Download, https://pypi.org/project/openshift-python-wrapper/
 Description-Content-Type: text/markdown
-License-File: LICENSE
 
 # openshift-python-wrapper
 Pypi: [openshift-python-wrapper](https://pypi.org/project/openshift-python-wrapper)  
@@ -172,3 +185,4 @@ We use pre-commit for code check.
 ```bash
 pre-commit install
 ```
+

openshift_python_wrapper-4.11.61/pyproject.toml

@@ -0,0 +1,61 @@
+[tool.black]
+line-length = 88
+target_version = ['py37', 'py38', 'py39', 'py310', "py311"]
+exclude = '''
+(
+  /(
+    | \.git
+    | \.venv
+    | \.mypy_cache
+    | \.tox
+  )/
+)
+'''
+
+[tool.isort]
+line_length = 88
+profile = "black"
+
+[tool.poetry]
+name = "openshift-python-wrapper"
+version = "4.11.61"
+description = "Wrapper around https://github.com/kubernetes-client/python"
+authors = ["Meni Yakove <myakove@gmail.com>", "Ruth Netser <rnetser@gmail.com>"]
+readme = "README.md"
+license = "Apache-2.0"
+packages = [{include = "ocp_resources"}]
+homepage = "https://github.com/RedHatQE/openshift-python-wrapper"
+documentation = "https://openshift-python-wrapper.readthedocs.io/en/latest/"
+keywords = ["Openshift", "Kubevirt", "CNV"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+
+[tool.poetry.urls]
+Download = "https://pypi.org/project/openshift-python-wrapper/"
+"Bug Tracker" = "https://github.com/RedHatQE/openshift-python-wrapper/issues"
+
+[tool.poetry.group.dev.dependencies]
+ipdb = "^0.13.13"
+
+[tool.poetry-dynamic-versioning.substitution]
+files = ["VERSION"]
+
+[tool.poetry-dynamic-versioning]
+enable = false
+pattern = "((?P<epoch>\\d+)!)?(?P<base>\\d+(\\.\\d+)*)"
+
+[build-system]
+requires = ["poetry-core>=1.0.0", "poetry-dynamic-versioning"]
+build-backend = "poetry_dynamic_versioning.backend"
+
+[tool.poetry.dependencies]
+python = "^3.8"
+openshift = "^0.13.2"
+xmltodict = "^0.13.0"
+colorlog = "^6.7.0"
+kubernetes = "^27.2.0"
+python-benedict = "^0.32.0"
+packaging = "^23.1"
+python-simple-logger = "^1.0.5"

openshift-python-wrapper-4.11.60/PKG-INFO

@@ -1,174 +0,0 @@
-Metadata-Version: 2.1
-Name: openshift-python-wrapper
-Version: 4.11.60
-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
-Project-URL: Download, https://pypi.org/project/openshift-python-wrapper/
-Project-URL: Bug Tracker, https://github.com/RedHatQE/openshift-python-wrapper/issues
-Project-URL: Documentation, https://openshift-python-wrapper.readthedocs.io/en/latest/
-Keywords: Openshift,Kubevirt,CNV
-Classifier: Programming Language :: Python :: 3
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-License-File: LICENSE
-
-# openshift-python-wrapper
-Pypi: [openshift-python-wrapper](https://pypi.org/project/openshift-python-wrapper)  
-A python wrapper for [openshift-restclient-python](https://github.com/openshift/openshift-restclient-python) with support for RedHat Container Virtualization. ([Openshift Virtualization](https://www.openshift.com/learn/topics/virtualization))  
-Docs: [openshift-python-wrapper docs](https://openshift-python-wrapper.readthedocs.io/en/latest/)
-
-## Installation
-From source:
-```bash
-git clone https://github.com/RedHatQE/openshift-python-wrapper.git
-cd openshift-python-wrapper
-python setup.py install --user
-```
-From pypi:
-```bash
-pip install openshift-python-wrapper --user
-```
-
-## Release new version
-### requirements:
-* Export GitHub token
-```bash
-export GITHUB_TOKEN=<your_github_token>
-```
-* [release-it](https://github.com/release-it/release-it)
-```bash
-sudo npm install --global release-it
-npm install --save-dev @release-it/bumper
-```
-### usage:
-* Create a release, run from the relevant branch.  
-To create a 4.11 release, run:
-```bash
-git checkout v4.11
-git pull
-release-it # Follow the instructions
-```
-
-## docs
-Hosted on readthedocs.io [openshift-python-wrapper](https://openshift-python-wrapper.readthedocs.io/en/latest/)
-
-## PR dependency
-For PR dependency we use [dpulls](https://www.dpulls.com/)  
-To make PR depends on other PR add `depends on #<PR NUMBER>` in the PR description.
-
-## Logging configuration
-To change log level export OPENSHIFT_PYTHON_WRAPPER_LOG_LEVEL:  
-
-```bash
-export OPENSHIFT_PYTHON_WRAPPER_LOG_LEVEL=<LOG_LEVEL> # can be: "DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"
-```
-
-## Examples
-### Client
-```python
-client = DynamicClient(client=kubernetes.config.new_client_from_config())
-```
-The examples given below are relevant to all resources. For simplicity we will use the resource - Namespace.
-### Import
-Import Namespace:
-```python
-from resources.namespace import Namespace
-```
-### Create
-Create a Namespace:
-```python
-ns = Namespace(name="namespace-example-1")
-ns.create()
-```
-Will return ``True`` if creation succeeded.
-
-We can also use the ``with`` statement which ensures automatic clean-up of the code executed:
-```python
-with Namespace(name="namespace-example-2") as ns:
-    yield ns
-```
-``teardown=False`` -  Disables clean-up after execution.
-### Wait
-Wait for Namespace to be in status ``Active``:
-```python
-ns.wait_for_status(status=Namespace.Status.ACTIVE, timeout=120)
-```
-Will raise a ``TimeoutExpiredError`` if Namespace is not in the desired status.
-### Delete
-Delete the Namespace
-```python
-ns.delete()
-```
-Will return ``False`` if not found.
-### Exists
-Checks if Namespace exists on the server:
-```python
-ns.exists
-```
-Will return ``None`` if not found.
-### Get
-Query to get Pods (resource) in the connected cluster with label of ``label_example=example``. Returns a ``generator`` of the resource - ``pod``
-```python
-for pod in Pod.get(dyn_client=client, label_selector="label_example=example")):
-    pod.log()
-```
-We can also get the name of the Node that the ``pod`` is running on:
-```python
-pod.node.name
-```
-### VM
-Start:
-```python
-with VirtualMachine(
-    name="vm-example",
-    namespace="namespace-example",
-    node_selector="worker-node-example",
-) as vm:
-    vm.start()
-```
-Stop:
-```python
-vm.stop()
-```
-Restart:
-```python
-vm.restart()
-```
-Get VMI:
-```python
-test_vmi = vm.vmi
-```
-After having a VMI, we can wait until VMI is in running state:
-```python
-test_vmi.wait_until_running()
-```
-Will raise ``TimeoutExpiredError`` if VMI failed to run.
-
-Then, we can get the Pod that is in Running state and execute a command on it:
-```python
-command_output = test_vmi.virt_launcher_pod.execute(command="command-example")
-```
-If no Pod was found, will raise ``ResourceNotFoundError``.
-
-### NNCP Capture Syntax
-Using capture syntax to switch ipv4 config between interfaces
-```python
-with NodeNetworkConfigurationPolicy(
-    name="capture_nncp",
-    capture={'first-nic': 'interfaces.name=="ens8"',
-              'second-nic': 'interfaces.name=="ens9"'},
-    teardown=False, # Capture doesn't support reverting config on teardown
-    ...  
-) as nncp:
-    nncp.add_interface(name="{{ capture.first-nic.interfaces.0.name }}", set_ipv4="{{ capture.second-nic.interfaces.0.ipv4 }}")
-    nncp.add_interface(name="{{ capture.second-nic.interfaces.0.name }}", set_ipv4="{{ capture.first-nic.interfaces.0.ipv4 }}")
-    yield nncp
-```
-
-## Code check
-We use pre-commit for code check.
-```bash
-pre-commit install
-```

openshift-python-wrapper-4.11.60/VERSION

@@ -1 +0,0 @@
-4.11.60

openshift-python-wrapper-4.11.60/openshift_python_wrapper.egg-info/SOURCES.txt

@@ -1,139 +0,0 @@
-LICENSE
-README.md
-VERSION
-pyproject.toml
-ocp_resources/__init__.py
-ocp_resources/api_service.py
-ocp_resources/backup.py
-ocp_resources/benchmark.py
-ocp_resources/catalog_source.py
-ocp_resources/catalog_source_config.py
-ocp_resources/cdi.py
-ocp_resources/cdi_config.py
-ocp_resources/chaos_engine.py
-ocp_resources/chaos_result.py
-ocp_resources/cluster_operator.py
-ocp_resources/cluster_role.py
-ocp_resources/cluster_role_binding.py
-ocp_resources/cluster_service_version.py
-ocp_resources/cluster_version.py
-ocp_resources/configmap.py
-ocp_resources/console_cli_download.py
-ocp_resources/console_plugin.py
-ocp_resources/console_quick_start.py
-ocp_resources/constants.py
-ocp_resources/csidriver.py
-ocp_resources/custom_resource_definition.py
-ocp_resources/daemonset.py
-ocp_resources/data_import_cron.py
-ocp_resources/data_source.py
-ocp_resources/datavolume.py
-ocp_resources/deployment.py
-ocp_resources/destination_rule.py
-ocp_resources/event.py
-ocp_resources/forklift_controller.py
-ocp_resources/gateway.py
-ocp_resources/hook.py
-ocp_resources/host.py
-ocp_resources/hostpath_provisioner.py
-ocp_resources/hyperconverged.py
-ocp_resources/image.py
-ocp_resources/image_content_source_policy.py
-ocp_resources/image_stream.py
-ocp_resources/imagestreamtag.py
-ocp_resources/infrastructure.py
-ocp_resources/installplan.py
-ocp_resources/job.py
-ocp_resources/kube_descheduler.py
-ocp_resources/kubevirt.py
-ocp_resources/kubevirt_common_templates_bundle.py
-ocp_resources/kubevirt_metrics_aggregation.py
-ocp_resources/kubevirt_node_labeller_bundle.py
-ocp_resources/kubevirt_template_validaotr.py
-ocp_resources/logger.py
-ocp_resources/machine.py
-ocp_resources/machine_config.py
-ocp_resources/machine_config_pool.py
-ocp_resources/machine_health_check.py
-ocp_resources/machine_set.py
-ocp_resources/migration.py
-ocp_resources/migration_policy.py
-ocp_resources/mtv.py
-ocp_resources/mutating_webhook_config.py
-ocp_resources/namespace.py
-ocp_resources/network.py
-ocp_resources/network_addons_config.py
-ocp_resources/network_attachment_definition.py
-ocp_resources/network_map.py
-ocp_resources/network_policy.py
-ocp_resources/nmstate.py
-ocp_resources/node.py
-ocp_resources/node_health_check.py
-ocp_resources/node_maintenance.py
-ocp_resources/node_network_configuration_enactment.py
-ocp_resources/node_network_configuration_policy.py
-ocp_resources/node_network_state.py
-ocp_resources/oauth.py
-ocp_resources/operator_condition.py
-ocp_resources/operator_group.py
-ocp_resources/operator_hub.py
-ocp_resources/operator_source.py
-ocp_resources/package_manifest.py
-ocp_resources/peer_authentication.py
-ocp_resources/persistent_volume.py
-ocp_resources/persistent_volume_claim.py
-ocp_resources/plan.py
-ocp_resources/pod.py
-ocp_resources/pod_disruption_budget.py
-ocp_resources/priority_class.py
-ocp_resources/project.py
-ocp_resources/prometheus.py
-ocp_resources/prometheus_rule.py
-ocp_resources/provider.py
-ocp_resources/replicaset.py
-ocp_resources/resource.py
-ocp_resources/restore.py
-ocp_resources/role.py
-ocp_resources/role_binding.py
-ocp_resources/route.py
-ocp_resources/secret.py
-ocp_resources/security_context_constraints.py
-ocp_resources/service.py
-ocp_resources/service_account.py
-ocp_resources/service_mesh_control_plane.py
-ocp_resources/service_mesh_member_roll.py
-ocp_resources/service_monitor.py
-ocp_resources/sriov_network.py
-ocp_resources/sriov_network_node_policy.py
-ocp_resources/sriov_network_node_state.py
-ocp_resources/ssp.py
-ocp_resources/storage_class.py
-ocp_resources/storage_map.py
-ocp_resources/storage_profile.py
-ocp_resources/subscription.py
-ocp_resources/tekton_tasks.py
-ocp_resources/template.py
-ocp_resources/upload_token_request.py
-ocp_resources/utils.py
-ocp_resources/validating_webhook_config.py
-ocp_resources/virtual_machine.py
-ocp_resources/virtual_machine_Instance_replica_set.py
-ocp_resources/virtual_machine_cluster_flavor.py
-ocp_resources/virtual_machine_flavor.py
-ocp_resources/virtual_machine_import.py
-ocp_resources/virtual_machine_instance.py
-ocp_resources/virtual_machine_instance_migration.py
-ocp_resources/virtual_machine_instance_preset.py
-ocp_resources/virtual_machine_restore.py
-ocp_resources/virtual_machine_snapshot.py
-ocp_resources/virtual_service.py
-ocp_resources/vm_import_config.py
-ocp_resources/volume_snapshot.py
-ocp_resources/volume_snapshot_class.py
-openshift_python_wrapper.egg-info/PKG-INFO
-openshift_python_wrapper.egg-info/SOURCES.txt
-openshift_python_wrapper.egg-info/dependency_links.txt
-openshift_python_wrapper.egg-info/requires.txt
-openshift_python_wrapper.egg-info/top_level.txt
-tests/test_resources.py
-tests/test_validate_resources.py

openshift-python-wrapper-4.11.60/openshift_python_wrapper.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

openshift-python-wrapper-4.11.60/openshift_python_wrapper.egg-info/requires.txt

@@ -1,5 +0,0 @@
-openshift
-xmltodict
-urllib3
-colorlog
-packaging

openshift-python-wrapper-4.11.60/openshift_python_wrapper.egg-info/top_level.txt

@@ -1 +0,0 @@
-ocp_resources

openshift-python-wrapper-4.11.60/pyproject.toml

@@ -1,47 +0,0 @@
-[tool.black]
-line-length = 88
-
-[build-system]
-requires = ["setuptools>=61.2"]
-build-backend = "setuptools.build_meta"
-
-[project]
-name = "openshift-python-wrapper"
-authors = [
-    {name = "Meni Yakove", email = "myakove@gmail.com"},
-    {name = "Ruth Netser", email = "rnetser@gmail.com"}
-]
-description = "Wrapper around https://github.com/openshift/openshift-restclient-python"
-classifiers = [
-    "Programming Language :: Python :: 3",
-    "Operating System :: OS Independent",
-]
-requires-python = ">=3.7"
-keywords = ["Openshift", "Kubevirt", "CNV"]
-dependencies = [
-    "openshift",
-    "xmltodict",
-    "urllib3",
-    "colorlog",
-    "packaging",
-]
-dynamic = ["version"]
-# ...
-[tool.setuptools.dynamic]
-version = {file = "VERSION"}
-
-[project.readme]
-file = "README.md"
-content-type = "text/markdown"
-
-[project.urls]
-Homepage = "https://github.com/RedHatQE/openshift-python-wrapper"
-Download = "https://pypi.org/project/openshift-python-wrapper/"
-"Bug Tracker" = "https://github.com/RedHatQE/openshift-python-wrapper/issues"
-Documentation = "https://openshift-python-wrapper.readthedocs.io/en/latest/"
-
-[tool.setuptools]
-include-package-data = true
-
-[tool.setuptools.packages.find]
-include = ["ocp_resources"]

openshift-python-wrapper-4.11.60/setup.cfg

@@ -1,4 +0,0 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-

openshift-python-wrapper-4.11.60/tests/test_resources.py

@@ -1,36 +0,0 @@
-import kubernetes
-import pytest
-from openshift.dynamic import DynamicClient
-
-from ocp_resources.namespace import Namespace
-from ocp_resources.pod import Pod
-from ocp_resources.virtual_machine import VirtualMachine
-from tests.utils import generate_yaml_from_template
-
-
-@pytest.fixture(scope="session")
-def client():
-    return DynamicClient(client=kubernetes.config.new_client_from_config())
-
-
-@pytest.fixture(scope="session")
-def namespace():
-    with Namespace(name="namespace-for-tests") as ns:
-        yield ns
-
-
-def test_get(client):
-    Pod.get(dyn_client=client)
-
-
-def test_create():
-    with Namespace(name="test-namespace"):
-        pass
-
-
-def test_vm(namespace):
-    name = "test-vm"
-    with VirtualMachine(
-        name=name, namespace=namespace.name, body=generate_yaml_from_template(name=name)
-    ):
-        pass

openshift-python-wrapper-4.11.60/tests/test_validate_resources.py

@@ -1,159 +0,0 @@
-# This test uses https://github.com/RedHatQE/openshift-resources-definitions to get resource definitions json file
-# File: resources_definitions.json
-
-import ast
-import json
-import os
-
-import pytest
-import requests
-
-from ocp_resources.resource import Resource  # noqa
-
-
-def _api_group_name(api_value):
-    try:
-        return eval(f"Resource.ApiGroup.{api_value}")
-    except AttributeError:
-        return api_value
-
-
-def _api_group_dict(resource_dict, api_group_name):
-    resource_dict_api_group = resource_dict["api_group"]
-    api_group = resource_dict_api_group.get(api_group_name)
-    if not api_group:
-        try:
-            api_group = resource_dict_api_group["null"]
-        except KeyError:
-            api_group = resource_dict_api_group[[*resource_dict_api_group][0]]
-
-    return api_group
-
-
-def _process_api_type(api_type, api_value, resource_dict, cls):
-    if api_type == "api_group":
-        return _get_api_group(
-            api_value=api_value,
-            cls=cls,
-            resource_dict=resource_dict,
-        )
-
-    if api_type == "api_version":
-        return _get_api_version(
-            api_value=api_value,
-            cls=cls,
-            resource_dict=resource_dict,
-        )
-
-    return [f"Resource {cls.name} must have api_group or api_version"]
-
-
-def _get_api_group_and_version(bodies):
-    for targets in bodies:
-        api_type = targets.targets[0].id
-        return api_type, getattr(
-            targets.value, "attr", getattr(targets.value, "s", None)
-        )
-
-
-def _get_namespaced(cls, resource_dict, api_value):
-    errors = []
-    for base in getattr(cls, "bases", []):
-        api_group_name = _api_group_name(api_value=api_value)
-        namespaced = base.id == "NamespacedResource"
-        api_group = _api_group_dict(
-            resource_dict=resource_dict, api_group_name=api_group_name
-        )
-        should_be_namespaced = api_group["namespaced"] == "true"
-
-        if namespaced != should_be_namespaced:
-            errors.append(
-                f"Resource {cls.name} should be "
-                f"{'namespaced' if should_be_namespaced else 'in cluster scope (not namespaced)'}"
-            )
-    return errors
-
-
-def _get_api_group(api_value, cls, resource_dict):
-    errors = []
-    api_group_name = _api_group_name(api_value=api_value)
-
-    if api_group_name not in resource_dict["api_group"]:
-        errors.append(
-            f"Resource {cls.name} api_group should be "
-            f"{resource_dict['api_group']}. got {api_group_name}"
-        )
-    return errors
-
-
-def _get_api_version(api_value, cls, resource_dict):
-    errors = []
-    api_group_name = _api_group_name(api_value=api_value)
-    api_group = _api_group_dict(
-        resource_dict=resource_dict, api_group_name=api_group_name
-    )
-    if api_value.lower() != api_group["api_version"]:
-        desire_api_group = resource_dict["api_version"].split("/")[0]
-        errors.append(
-            f"Resource {cls.name} have api_version {api_value} "
-            f"but should have api_group = {desire_api_group}"
-        )
-
-    return errors
-
-
-def _resource_file():
-    ocp_resources_exclude_files = ["resource.py", "utils.py", "__init__.py"]
-    for root, dirs, files in os.walk("ocp_resources"):
-        for _file in files:
-            if _file in ocp_resources_exclude_files or not _file.endswith(".py"):
-                continue
-            yield os.path.join(root, _file)
-
-
-@pytest.fixture()
-def resources_definitions():
-    file_ = (
-        "https://raw.githubusercontent.com/RedHatQE/"
-        "openshift-resources-definitions/main/resources_definitions.json"
-    )
-    content = requests.get(file_).content
-    return json.loads(content)
-
-
-@pytest.fixture()
-def resources_definitions_errors(resources_definitions):
-    errors = []
-    for _file in _resource_file():
-        with open(_file, "r") as fd:
-            tree = ast.parse(source=fd.read())
-            classes = [cls for cls in tree.body if isinstance(cls, ast.ClassDef)]
-            for cls in classes:
-                resource_dict = resources_definitions.get(cls.name)
-                if not resource_dict:
-                    continue
-
-                bodies = [
-                    body_
-                    for body_ in getattr(cls, "body")
-                    if isinstance(body_, ast.Assign)
-                ]
-                api_type, api_value = _get_api_group_and_version(bodies=bodies)
-                errors.extend(
-                    _get_namespaced(
-                        cls=cls, resource_dict=resource_dict, api_value=api_value
-                    )
-                )
-                errors.extend(
-                    _process_api_type(
-                        api_type=api_type,
-                        api_value=api_value,
-                        resource_dict=resource_dict,
-                        cls=cls,
-                    )
-                )
-    return errors
-
-
-def test_resources_definitions(resources_definitions_errors):
-    assert not resources_definitions_errors, "\n".join(resources_definitions_errors)