openshift-python-wrapper 11.0.148__tar.gz → 11.0.149__tar.gz

{openshift_python_wrapper-11.0.148 → openshift_python_wrapper-11.0.149}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: openshift-python-wrapper
-Version: 11.0.148
+Version: 11.0.149
 Summary: Wrapper around https://github.com/kubernetes-client/python
 Project-URL: homepage, https://github.com/RedHatQE/openshift-python-wrapper
 Project-URL: documentation, https://redhatqe.github.io/openshift-python-wrapper/

{openshift_python_wrapper-11.0.148 → openshift_python_wrapper-11.0.149}/ocp_resources/resource.py

@@ -514,6 +514,7 @@ class Resource(ResourceConstants):
         EVENTS_K8S_IO: str = "events.k8s.io"
         EXPORT_KUBEVIRT_IO: str = "export.kubevirt.io"
         FENCE_AGENTS_REMEDIATION_MEDIK8S_IO: str = "fence-agents-remediation.medik8s.io"
+        FILERESTORE_KUBEVIRT_IO: str = "filerestore.kubevirt.io"
         FORKLIFT_KONVEYOR_IO: str = "forklift.konveyor.io"
         FRRK8S_METALLB_IO = "frrk8s.metallb.io"
         GATEWAY_NETWORKING_K8S_IO: str = "gateway.networking.k8s.io"

{openshift_python_wrapper-11.0.148 → openshift_python_wrapper-11.0.149}/ocp_resources/utils/resource_constants.py

@@ -91,3 +91,16 @@ class ResourceConstants:
             PARTIALLYFAILED: str = "PartiallyFailed"
             FAILED: str = "Failed"
             DELETING: str = "Deleting"
+
+    class VirtualMachineFileRestore:
+        class Phase:
+            NEW: str = "New"
+            INIT: str = "Init"
+            HOTPLUGGING: str = "Hotplugging"
+            WAITING_FOR_ATTACHMENT: str = "WaitingForAttachment"
+            SSH_CONNECTING: str = "SSHConnecting"
+            RESTORING: str = "Restoring"
+            VOLUME_READY: str = "VolumeReady"
+            CLEANUP: str = "Cleanup"
+            SUCCEEDED: str = "Succeeded"
+            FAILED: str = "Failed"

openshift_python_wrapper-11.0.149/ocp_resources/virtual_machine_file_restore.py

@@ -0,0 +1,138 @@
+# Generated using https://github.com/RedHatQE/openshift-python-wrapper/blob/main/class_generator/README.md
+
+
+from typing import Any
+
+from ocp_resources.exceptions import MissingRequiredArgumentError
+from ocp_resources.resource import NamespacedResource
+
+
+class VirtualMachineFileRestore(NamespacedResource):
+    """
+    VirtualMachineFileRestore is the Schema for the virtualmachinefilerestores API.
+    """
+
+    api_group: str = NamespacedResource.ApiGroup.FILERESTORE_KUBEVIRT_IO
+
+    def __init__(
+        self,
+        source: dict[str, Any] | None = None,
+        source_path: str | None = None,
+        target: dict[str, Any] | None = None,
+        **kwargs: Any,
+    ) -> None:
+        r"""
+        Args:
+            source (dict[str, Any]): Source specifies where to restore files from (PVC, VolumeSnapshot, or
+              remote storage).
+
+            source_path (str): SourcePath specifies the file or directory path to restore from the
+              backup. If not specified, manual restore mode is enabled (volume
+              is hotplugged but no automatic restore).
+
+            target (dict[str, Any]): Target is a reference to the target VirtualMachine to restore files
+              into.
+
+        """
+        super().__init__(**kwargs)
+
+        self.source = source
+        self.source_path = source_path
+        self.target = target
+
+    def to_dict(self) -> None:
+
+        super().to_dict()
+
+        if not self.kind_dict and not self.yaml_file:
+            if self.source is None:
+                raise MissingRequiredArgumentError(argument="self.source")
+
+            if self.target is None:
+                raise MissingRequiredArgumentError(argument="self.target")
+
+            self.res["spec"] = {}
+            _spec = self.res["spec"]
+
+            _spec["source"] = self.source
+            _spec["target"] = self.target
+
+            if self.source_path is not None:
+                _spec["sourcePath"] = self.source_path
+
+    # End of generated code
+
+    @property
+    def restored_files_count(self) -> int | None:
+        """Number of restored files, or None before a transfer or in manual mode.
+
+        A count of zero means an automatic transfer ran without copying any files.
+
+        Returns:
+            The number of restored files, or None if the restore has not yet run or is in manual mode.
+        """
+        return self.instance.get("status", {}).get("restoredFilesCount")
+
+    @classmethod
+    def from_snapshot(
+        cls,
+        target_vm_name: str,
+        source_snapshot_name: str,
+        source_path: str | None = None,
+        source_namespace: str | None = None,
+        **kwargs: Any,
+    ) -> "VirtualMachineFileRestore":
+        """Build a file restore from a VolumeSnapshot without creating it on the cluster.
+
+        Args:
+            target_vm_name: Name of the target VirtualMachine in the restore's namespace.
+            source_snapshot_name: Name of the source VolumeSnapshot.
+            source_path: Path to restore. Omit to enable manual restore mode.
+            source_namespace: Namespace of the source snapshot. Omit to use the restore's namespace.
+            **kwargs: Additional arguments passed to the generated constructor.
+
+        Returns:
+            A VirtualMachineFileRestore configured to restore from the snapshot.
+        """
+        snapshot: dict[str, str] = {"name": source_snapshot_name}
+        if source_namespace is not None:
+            snapshot["namespace"] = source_namespace
+
+        return cls(
+            source={"snapshot": snapshot},
+            source_path=source_path,
+            target={"apiGroup": cls.ApiGroup.KUBEVIRT_IO, "kind": "VirtualMachine", "name": target_vm_name},
+            **kwargs,
+        )
+
+    @classmethod
+    def from_pvc(
+        cls,
+        target_vm_name: str,
+        source_pvc_name: str,
+        source_path: str | None = None,
+        source_namespace: str | None = None,
+        **kwargs: Any,
+    ) -> "VirtualMachineFileRestore":
+        """Build a file restore from a PVC without creating it on the cluster.
+
+        Args:
+            target_vm_name: Name of the target VirtualMachine in the restore's namespace.
+            source_pvc_name: Name of the source PersistentVolumeClaim.
+            source_path: Path to restore. Omit to enable manual restore mode.
+            source_namespace: Namespace of the source PVC. Omit to use the restore's namespace.
+            **kwargs: Additional arguments passed to the generated constructor.
+
+        Returns:
+            A VirtualMachineFileRestore configured to restore from the PVC.
+        """
+        pvc: dict[str, str] = {"name": source_pvc_name}
+        if source_namespace is not None:
+            pvc["namespace"] = source_namespace
+
+        return cls(
+            source={"pvc": pvc},
+            source_path=source_path,
+            target={"apiGroup": cls.ApiGroup.KUBEVIRT_IO, "kind": "VirtualMachine", "name": target_vm_name},
+            **kwargs,
+        )

{openshift_python_wrapper-11.0.148 → openshift_python_wrapper-11.0.149}/pyproject.toml

@@ -75,7 +75,7 @@ include = [
 [project]
 requires-python = ">=3.11,<3.15"
 name = "openshift-python-wrapper"
-version = "11.0.148"
+version = "11.0.149"
 description = "Wrapper around https://github.com/kubernetes-client/python"
 readme = "README.md"
 license = "Apache-2.0"

openshift_python_wrapper-11.0.149/tests/test_virtual_machine_file_restore.py

@@ -0,0 +1,82 @@
+"""Tests for the custom VirtualMachineFileRestore helpers."""
+
+from collections.abc import Callable
+from typing import Any
+from unittest.mock import PropertyMock, patch
+
+import pytest
+
+from fake_kubernetes_client.dynamic_client import FakeDynamicClient
+from ocp_resources.virtual_machine_file_restore import VirtualMachineFileRestore
+
+
+@pytest.fixture()
+def vmfr_client(fake_client: FakeDynamicClient) -> FakeDynamicClient:
+    fake_client.register_resources(
+        resources={
+            "kind": "VirtualMachineFileRestore",
+            "api_version": "v1alpha1",
+            "group": "filerestore.kubevirt.io",
+            "namespaced": True,
+            "plural": "virtualmachinefilerestores",
+        }
+    )
+    return fake_client
+
+
+@pytest.mark.parametrize(
+    ("factory", "source_name_argument", "source_kind"),
+    [
+        (VirtualMachineFileRestore.from_snapshot, "source_snapshot_name", "snapshot"),
+        (VirtualMachineFileRestore.from_pvc, "source_pvc_name", "pvc"),
+    ],
+)
+@pytest.mark.parametrize("source_namespace", [None, "backup-ns"])
+@pytest.mark.parametrize("source_path", [None, "/etc/config"])
+def test_factory_builds_source_and_target(
+    vmfr_client: FakeDynamicClient,
+    factory: Callable[..., VirtualMachineFileRestore],
+    source_name_argument: str,
+    source_kind: str,
+    source_namespace: str | None,
+    source_path: str | None,
+) -> None:
+    restore = factory(
+        target_vm_name="target-vm",
+        **{source_name_argument: "backup-volume"},
+        source_namespace=source_namespace,
+        source_path=source_path,
+        client=vmfr_client,
+        name="test-restore",
+        namespace="target-ns",
+        teardown=False,
+    )
+
+    expected_source = {"name": "backup-volume"}
+    if source_namespace is not None:
+        expected_source["namespace"] = source_namespace
+
+    assert restore.source == {source_kind: expected_source}
+    assert restore.target == {"apiGroup": "kubevirt.io", "kind": "VirtualMachine", "name": "target-vm"}
+    assert restore.source_path == source_path
+    assert restore.client is vmfr_client
+    assert restore.name == "test-restore"
+    assert restore.namespace == "target-ns"
+    assert restore.teardown is False
+
+
+@pytest.mark.parametrize(
+    ("instance", "expected_count"),
+    [
+        ({}, None),
+        ({"status": {}}, None),
+        ({"status": {"restoredFilesCount": 0}}, 0),
+        ({"status": {"restoredFilesCount": 3}}, 3),
+    ],
+)
+def test_restored_files_count(
+    vmfr_client: FakeDynamicClient, instance: dict[str, Any], expected_count: int | None
+) -> None:
+    restore = VirtualMachineFileRestore(client=vmfr_client, name="test-restore", namespace="target-ns")
+    with patch.object(VirtualMachineFileRestore, "instance", new_callable=PropertyMock, return_value=instance):
+        assert restore.restored_files_count == expected_count

{openshift_python_wrapper-11.0.148 → openshift_python_wrapper-11.0.149}/uv.lock

@@ -889,8 +889,8 @@ name = "httpcore2"
 version = "2.16.0"
 source = { registry = "https://pypi.org/simple" }
 dependencies = [
-    { name = "h11" },
-    { name = "truststore" },
+    { name = "h11", marker = "python_full_version < '3.12' or sys_platform != 'emscripten'" },
+    { name = "truststore", marker = "python_full_version < '3.12' or sys_platform != 'emscripten'" },
 ]
 sdist = { url = "https://files.pythonhosted.org/packages/c0/61/afa9d6b7452f9eca73f73d45324eb0bb52f098fd5e6049bf6b8263be9b4e/httpcore2-2.16.0.tar.gz", hash = "sha256:c72cd0413563b17e1cd8354677dff887466f8ec2551679759e93126534428643", size = 69886, upload-time = "2026-10-21T07:09:45.31Z" }
 wheels = [
@@ -1300,7 +1300,7 @@ wheels = [
 
 [[package]]
 name = "openshift-python-wrapper"
-version = "11.0.148"
+version = "11.0.149"
 source = { editable = "." }
 dependencies = [
     { name = "authlib" },
@@ -1431,7 +1431,7 @@ name = "pexpect"
 version = "4.9.0"
 source = { registry = "https://pypi.org/simple" }
 dependencies = [
-    { name = "ptyprocess" },
+    { name = "ptyprocess", marker = "python_full_version < '3.12' or sys_platform != 'emscripten'" },
 ]
 sdist = { url = "https://files.pythonhosted.org/packages/42/92/cc564bf6381ff43ce1f4d06852fc19a2f11d180f23dc32d9588bee2f149d/pexpect-4.9.0.tar.gz", hash = "sha256:ee7d41123f3c9911050ea2c2dac107568dc43b2d3b0c7557a33212c398ead30f", size = 166450, upload-time = "2023-11-25T09:07:26.339Z" }
 wheels = [