openshift-python-wrapper 11.0.126__tar.gz → 11.0.128__tar.gz

openshift_python_wrapper-11.0.128/.git

@@ -0,0 +1 @@
+gitdir: /tmp/github-webhook-openshift-python-wrapper-8u52wz1c/.git/worktrees/github-webhook-openshift-python-wrapper-8u52wz1c-worktree-2546535d-afd3-4abb-89b0-3c5f457b8a5d

{openshift_python_wrapper-11.0.126 → openshift_python_wrapper-11.0.128}/.pre-commit-config.yaml

@@ -45,7 +45,7 @@ repos:
           ]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.15.11
+    rev: v0.15.12
     hooks:
       - id: ruff
       - id: ruff-format
@@ -56,7 +56,7 @@ repos:
       - id: gitleaks
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.20.1
+    rev: v1.20.2
     hooks:
       - id: mypy
         exclude: ^(tests/|examples/|docs/)

{openshift_python_wrapper-11.0.126 → openshift_python_wrapper-11.0.128}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openshift-python-wrapper
-Version: 11.0.126
+Version: 11.0.128
 Summary: Wrapper around https://github.com/kubernetes-client/python
 Project-URL: homepage, https://github.com/RedHatQE/openshift-python-wrapper
 Project-URL: documentation, https://openshift-python-wrapper.readthedocs.io/en/latest/

{openshift_python_wrapper-11.0.126 → openshift_python_wrapper-11.0.128}/class_generator/cli.py

@@ -489,7 +489,7 @@ def handle_test_generation(add_tests: bool) -> None:
         # Run the generated test file
         LOGGER.info("Running generated tests...")
         test_file = "class_generator/tests/test_class_generator.py"
-        exit_code = os.system(f"uv run pytest {test_file}")
+        exit_code = os.system(f"uv run --group tests pytest {test_file}")
 
         # os.system returns the exit status shifted left by 8 bits
         if exit_code != 0:

openshift_python_wrapper-11.0.128/class_generator/formatters/file_writer.py

@@ -0,0 +1,71 @@
+"""File writing utilities for generated code."""
+
+from pathlib import Path
+
+from pyhelper_utils.shell import run_command
+from simple_logger.logger import get_logger
+
+LOGGER = get_logger(name=__name__)
+
+# Project root directory (contains pyproject.toml and .pre-commit-config.yaml)
+_PROJECT_ROOT = Path(__file__).resolve().parent.parent.parent
+
+
+def write_and_format_rendered(filepath: str, output: str) -> None:
+    """
+    Write rendered content to file and format with prek, falling back to ruff.
+
+    Args:
+        filepath: Path to write the file to
+        output: Content to write
+    """
+    with open(filepath, "w", encoding="utf-8") as fd:
+        fd.write(output)
+
+    pre_commit_config = str(_PROJECT_ROOT / ".pre-commit-config.yaml")
+    pyproject_toml = str(_PROJECT_ROOT / "pyproject.toml")
+
+    # Try prek first (runs all pre-commit hooks including ruff)
+    prek_success = False
+    try:
+        rc, stdout, stderr = run_command(
+            command=["uvx", "prek", "-c", pre_commit_config, "run", "--files", filepath],
+            verify_stderr=False,
+            check=False,
+            log_errors=False,
+        )
+        if not rc:
+            if stderr:
+                LOGGER.warning(f"Prek hooks failed for {filepath}, falling back to ruff.")
+                LOGGER.debug(f"prek stderr: {stderr}")
+            else:
+                prek_success = True
+
+            if stdout:
+                LOGGER.info(f"{filepath} fixed by prek")
+                LOGGER.debug(f"prek stdout: {stdout}")
+    except Exception as e:
+        LOGGER.warning(f"Failed to run prek for {filepath}, falling back to ruff: {e}")
+
+    if not prek_success:
+        _run_ruff_fallback(filepath=filepath, pyproject_toml=pyproject_toml)
+
+
+def _run_ruff_fallback(filepath: str, pyproject_toml: str) -> None:
+    """Run ruff check --fix and ruff format as fallback when prek fails."""
+    for ruff_cmd in (
+        ["uvx", "ruff", "check", "--fix", "--config", pyproject_toml, filepath],
+        ["uvx", "ruff", "format", "--config", pyproject_toml, filepath],
+    ):
+        try:
+            _, stdout, _ = run_command(
+                command=ruff_cmd,
+                verify_stderr=False,
+                check=False,
+                log_errors=False,
+            )
+            if stdout:
+                LOGGER.info(f"{filepath} fixed by ruff")
+                LOGGER.debug(f"ruff stdout: {stdout}")
+        except Exception as e:
+            LOGGER.error(f"Ruff fallback failed for {filepath}: {e}")

{openshift_python_wrapper-11.0.126 → openshift_python_wrapper-11.0.128}/class_generator/manifests/class_generator_template.j2

@@ -14,8 +14,12 @@
 {% endfor %}
 
 from typing import Any
-from ocp_resources.resource import {{ base_class }}
+
+{% if all_required_args %}
 from ocp_resources.exceptions import MissingRequiredArgumentError
+{% endif %}
+from ocp_resources.resource import {{ base_class }}
+
 
 class {{ kind }}({{ base_class }}):
     """

{openshift_python_wrapper-11.0.126 → openshift_python_wrapper-11.0.128}/class_generator/tests/manifests/test_parse_explain.j2

@@ -1,16 +1,15 @@
 # Generated using https://github.com/RedHatQE/openshift-python-wrapper/blob/main/scripts/resource/README.md#adding-tests
 
 import filecmp
+import traceback
 from pathlib import Path
-import pytest
-from typing import List, Tuple, Optional
 
 from class_generator.constants import TESTS_MANIFESTS_DIR
 from class_generator.core.generator import class_generator
 from class_generator.utils import execute_parallel_tasks
 
 
-def _test_single_resource(kind: str, tmp_path: Path) -> Optional[Tuple[str, str]]:
+def _test_single_resource(kind: str, tmp_path: Path) -> tuple[str, str] | None:
     """
     Test a single resource kind and return failure info if test fails.
 
@@ -45,9 +44,9 @@ def _test_single_resource(kind: str, tmp_path: Path) -> Optional[Tuple[str, str]
             if not filecmp.cmp(output_file, expected_file):
                 try:
                     # Read both files to show diff details
-                    with open(output_file, "r") as f:
+                    with open(output_file) as f:
                         generated_content = f.read()
-                    with open(expected_file, "r") as f:
+                    with open(expected_file) as f:
                         expected_content = f.read()
 
                     # Find first difference for debugging
@@ -60,7 +59,7 @@ def _test_single_resource(kind: str, tmp_path: Path) -> Optional[Tuple[str, str]
                     diff_info += f"\nGenerated lines: {len(generated_lines)}, Expected lines: {len(expected_lines)}"
 
                     # Find first differing line
-                    for i, (gen_line, exp_line) in enumerate(zip(generated_lines, expected_lines)):
+                    for i, (gen_line, exp_line) in enumerate(zip(generated_lines, expected_lines, strict=True)):
                         if gen_line != exp_line:
                             diff_info += f"\nFirst difference at line {i + 1}:"
                             diff_info += f"\nGenerated: {repr(gen_line[:100])}..."
@@ -81,8 +80,6 @@ def _test_single_resource(kind: str, tmp_path: Path) -> Optional[Tuple[str, str]
         return None
 
     except Exception as e:
-        import traceback
-
         error_details = f"Exception during generation: {str(e)}\n"
         error_details += f"Traceback:\n{traceback.format_exc()}"
         return (kind, error_details)
@@ -97,17 +94,17 @@ def test_parse_explain(tmp_path: Path) -> None:
     {% endfor %}
     ]
 
-    failures: List[Tuple[str, str]] = []
+    failures: list[tuple[str, str]] = []
 
     # Process test results and collect failures
-    def process_test_result(kind: str, result: Optional[Tuple[str, str]]) -> None:
+    def process_test_result(kind: str, result: tuple[str, str] | None) -> None:
         if result is not None:
             failures.append(result)
 
     def handle_test_error(kind: str, exc: Exception) -> None:
         failures.append((kind, f"Task execution failed: {str(exc)}"))
 
-    def create_test_task(kind: str) -> Optional[Tuple[str, str]]:
+    def create_test_task(kind: str) -> tuple[str, str] | None:
         return _test_single_resource(kind, tmp_path / f"test-{kind}")
 
     # Run tests in parallel
@@ -136,12 +133,10 @@ def test_parse_explain(tmp_path: Path) -> None:
 
         # Create a concise failure message for pytest
         failed_kinds = [kind for kind, _ in failures]
-        failure_summary = f"{len(failures)} resource(s) failed: {', '.join(failed_kinds[:5])}"
-        if len(failed_kinds) > 5:
-            failure_summary += f" and {len(failed_kinds) - 5} more"
+        failure_summary = f"{len(failures)} resource(s) failed: {','.join(failed_kinds)}"
 
         # Fail the test with summary - detailed output is already printed above
-        assert False, failure_summary
+        raise AssertionError(failure_summary)
 
     # If we get here, all tests passed
     print(f"\nAll {len(resource_kinds)} resource generation tests passed successfully!")

{openshift_python_wrapper-11.0.126 → openshift_python_wrapper-11.0.128}/class_generator/tests/test_class_generator.py

@@ -97,14 +97,14 @@ def test_parse_explain(tmp_path: Path) -> None:
         "ImageContentSourcePolicy",
         "Machine",
         "NMState",
-        "OAuth",
-        "Pipeline",
         "Pod",
         "Secret",
         "ServiceMeshMember",
-        "ServingRuntime",
         "Ingress",
+        "OAuth",
+        "Pipeline",
         "RouteAdvertisements",
+        "ServingRuntime",
     ]
 
     failures: list[tuple[str, str]] = []
@@ -146,9 +146,7 @@ def test_parse_explain(tmp_path: Path) -> None:
 
         # Create a concise failure message for pytest
         failed_kinds = [kind for kind, _ in failures]
-        failure_summary = f"{len(failures)} resource(s) failed: {', '.join(failed_kinds[:5])}"
-        if len(failed_kinds) > 5:
-            failure_summary += f" and {len(failed_kinds) - 5} more"
+        failure_summary = f"{len(failures)} resource(s) failed: {','.join(failed_kinds)}"
 
         # Fail the test with summary - detailed output is already printed above
         raise AssertionError(failure_summary)

{openshift_python_wrapper-11.0.126 → openshift_python_wrapper-11.0.128}/class_generator/tests/test_cli.py

@@ -170,7 +170,9 @@ class TestCLIFunctionality:
 
             assert result.exit_code == 0
             mock_test_gen.assert_called_once()
-            mock_os_system.assert_called_once_with("uv run pytest class_generator/tests/test_class_generator.py")
+            mock_os_system.assert_called_once_with(
+                "uv run --group tests pytest class_generator/tests/test_class_generator.py"
+            )
 
     def test_add_tests_requires_kind(self):
         """Test that --add-tests cannot be used alone."""

openshift_python_wrapper-11.0.128/ocp_resources/data_protection_application.py

@@ -0,0 +1,124 @@
+# Generated using https://github.com/RedHatQE/openshift-python-wrapper/blob/main/scripts/resource/README.md
+
+
+from typing import Any
+
+from ocp_resources.exceptions import MissingRequiredArgumentError
+from ocp_resources.resource import NamespacedResource
+
+
+class DataProtectionApplication(NamespacedResource):
+    """
+    DataProtectionApplication is the Schema for the dpa API
+    """
+
+    api_group: str = NamespacedResource.ApiGroup.OADP_OPENSHIFT_IO
+
+    def __init__(
+        self,
+        backup_images: bool | None = None,
+        backup_locations: list[Any] | None = None,
+        configuration: dict[str, Any] | None = None,
+        features: dict[str, Any] | None = None,
+        image_pull_policy: str | None = None,
+        pod_annotations: dict[str, Any] | None = None,
+        pod_dns_config: dict[str, Any] | None = None,
+        pod_dns_policy: str | None = None,
+        snapshot_locations: list[Any] | None = None,
+        unsupported_overrides: dict[str, Any] | None = None,
+        **kwargs: Any,
+    ) -> None:
+        r"""
+        Args:
+            backup_images (bool): backupImages is used to specify whether you want to deploy a registry
+              for enabling backup and restore of images
+
+            backup_locations (list[Any]): backupLocations defines the list of desired configuration to use for
+              BackupStorageLocations
+
+            configuration (dict[str, Any]): configuration is used to configure the data protection application's
+              server config
+
+            features (dict[str, Any]): features defines the configuration for the DPA to enable the OADP tech
+              preview features
+
+            image_pull_policy (str): which imagePullPolicy to use in all container images used by OADP. By
+              default, for images with sha256 or sha512 digest, OADP uses
+              IfNotPresent and uses Always for all other images.
+
+            pod_annotations (dict[str, Any]): add annotations to pods deployed by operator
+
+            pod_dns_config (dict[str, Any]): podDnsConfig defines the DNS parameters of a pod in addition to those
+              generated from DNSPolicy.
+              https://kubernetes.io/docs/concepts/services-networking/dns-pod-
+              service/#pod-dns-config
+
+            pod_dns_policy (str): podDnsPolicy defines how a pod's DNS will be configured.
+              https://kubernetes.io/docs/concepts/services-networking/dns-pod-
+              service/#pod-s-dns-policy
+
+            snapshot_locations (list[Any]): snapshotLocations defines the list of desired configuration to use for
+              VolumeSnapshotLocations
+
+            unsupported_overrides (dict[str, Any]): unsupportedOverrides can be used to override images used in
+              deployments. Available keys are:   - veleroImageFqin   -
+              awsPluginImageFqin   - legacyAWSPluginImageFqin   -
+              openshiftPluginImageFqin   - azurePluginImageFqin   -
+              gcpPluginImageFqin   - resticRestoreImageFqin   -
+              kubevirtPluginImageFqin   - operator-type
+
+        """
+        super().__init__(**kwargs)
+
+        self.backup_images = backup_images
+        self.backup_locations = backup_locations
+        self.configuration = configuration
+        self.features = features
+        self.image_pull_policy = image_pull_policy
+        self.pod_annotations = pod_annotations
+        self.pod_dns_config = pod_dns_config
+        self.pod_dns_policy = pod_dns_policy
+        self.snapshot_locations = snapshot_locations
+        self.unsupported_overrides = unsupported_overrides
+
+    def to_dict(self) -> None:
+
+        super().to_dict()
+
+        if not self.kind_dict and not self.yaml_file:
+            if self.configuration is None:
+                raise MissingRequiredArgumentError(argument="self.configuration")
+
+            self.res["spec"] = {}
+            _spec = self.res["spec"]
+
+            _spec["configuration"] = self.configuration
+
+            if self.backup_images is not None:
+                _spec["backupImages"] = self.backup_images
+
+            if self.backup_locations is not None:
+                _spec["backupLocations"] = self.backup_locations
+
+            if self.features is not None:
+                _spec["features"] = self.features
+
+            if self.image_pull_policy is not None:
+                _spec["imagePullPolicy"] = self.image_pull_policy
+
+            if self.pod_annotations is not None:
+                _spec["podAnnotations"] = self.pod_annotations
+
+            if self.pod_dns_config is not None:
+                _spec["podDnsConfig"] = self.pod_dns_config
+
+            if self.pod_dns_policy is not None:
+                _spec["podDnsPolicy"] = self.pod_dns_policy
+
+            if self.snapshot_locations is not None:
+                _spec["snapshotLocations"] = self.snapshot_locations
+
+            if self.unsupported_overrides is not None:
+                _spec["unsupportedOverrides"] = self.unsupported_overrides
+
+    # End of generated code

{openshift_python_wrapper-11.0.126 → openshift_python_wrapper-11.0.128}/ocp_resources/resource.py

@@ -557,6 +557,7 @@ class Resource(ResourceConstants):
         NMSTATE_IO: str = "nmstate.io"
         NODE_LABELLER_KUBEVIRT_IO: str = "node-labeller.kubevirt.io"
         NODEMAINTENANCE_KUBEVIRT_IO: str = "nodemaintenance.kubevirt.io"
+        OADP_OPENSHIFT_IO: str = "oadp.openshift.io"
         OBSERVABILITY_OPEN_CLUSTER_MANAGEMENT_IO: str = "observability.open-cluster-management.io"
         OCS_OPENSHIFT_IO: str = "ocs.openshift.io"
         OPENTELEMETRY_IO: str = "opentelemetry.io"

{openshift_python_wrapper-11.0.126 → openshift_python_wrapper-11.0.128}/ocp_resources/virtual_machine_clone.py

@@ -17,6 +17,7 @@ class VirtualMachineClone(NamespacedResource):
         annotation_filters=None,
         new_mac_addresses=None,
         new_smbios_serial=None,
+        volume_name_policy=None,
         **kwargs,
     ):
         """
@@ -30,6 +31,7 @@ class VirtualMachineClone(NamespacedResource):
             annotation_filters (list, optional): List of annotation filters, e.g. ["firstKey/*", "secondKey/*"]
             new_mac_addresses (dict, optional): Dict of new MAC addresses, {interface_name: mac_address}
             new_smbios_serial (str, optional): the clone's new smbios serial
+            volume_name_policy (str, optional): the clone's volume name policy
         """
         super().__init__(**kwargs)
         self.source_name = source_name
@@ -39,6 +41,7 @@ class VirtualMachineClone(NamespacedResource):
         self.annotation_filters = annotation_filters
         self.new_mac_addresses = new_mac_addresses
         self.new_smbios_serial = new_smbios_serial
+        self.volume_name_policy = volume_name_policy
 
     def to_dict(self) -> None:
         super().to_dict()
@@ -49,7 +52,7 @@ class VirtualMachineClone(NamespacedResource):
 
             source = spec.setdefault("source", {})
             source["apiGroup"] = NamespacedResource.ApiGroup.KUBEVIRT_IO
-            source["kind"] = self.source_kind if self.source_kind else VirtualMachine.kind
+            source["kind"] = self.source_kind or VirtualMachine.kind
             source["name"] = self.source_name
 
             if self.target_name:
@@ -66,3 +69,5 @@ class VirtualMachineClone(NamespacedResource):
                 spec["newMacAddresses"] = self.new_mac_addresses
             if self.new_smbios_serial:
                 spec["newSMBiosSerial"] = self.new_smbios_serial
+            if self.volume_name_policy:
+                spec["volumeNamePolicy"] = self.volume_name_policy

{openshift_python_wrapper-11.0.126 → openshift_python_wrapper-11.0.128}/ocp_resources/virtual_machine_restore.py

@@ -23,6 +23,7 @@ class VirtualMachineRestore(NamespacedResource):
         teardown=True,
         yaml_file=None,
         delete_timeout=TIMEOUT_4MINUTES,
+        volume_name_policy=None,
         **kwargs,
     ):
         super().__init__(
@@ -36,6 +37,7 @@ class VirtualMachineRestore(NamespacedResource):
         )
         self.vm_name = vm_name
         self.snapshot_name = snapshot_name
+        self.volume_name_policy = volume_name_policy
 
     def to_dict(self) -> None:
         super().to_dict()
@@ -45,6 +47,8 @@ class VirtualMachineRestore(NamespacedResource):
             spec["target"]["kind"] = VirtualMachine.kind
             spec["target"]["name"] = self.vm_name
             spec["virtualMachineSnapshotName"] = self.snapshot_name
+            if self.volume_name_policy:
+                spec["volumeNamePolicy"] = self.volume_name_policy
 
     def wait_complete(self, status=True, timeout=TIMEOUT_4MINUTES):
         """

{openshift_python_wrapper-11.0.126 → openshift_python_wrapper-11.0.128}/pyproject.toml

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

{openshift_python_wrapper-11.0.126 → openshift_python_wrapper-11.0.128}/tests/scripts/generate_pytest_test.py

@@ -517,7 +517,7 @@ def run_ruff_on_files(filepaths: list[str]) -> bool:
 
         # Run ruff format and check on all files
         for op in ("format", "check"):
-            cmd_str = f"uvx ruff {op} {' '.join(filepaths)}"
+            cmd_str = f"uvx ruff --config pyproject.toml {op} {' '.join(filepaths)}"
             rc, _, _ = run_command(
                 command=shlex.split(cmd_str),
                 verify_stderr=False,