feat(RHOAIENG-29330):Deny RayCluster creation with Ray Version mismatches fixed

Author: LilyLinh

src/codeflare_sdk/common/utils/test_validation.py

@@ -1,4 +1,8 @@
+<<<<<<< HEAD
 # Copyright 2024 IBM, Red Hat
+=======
+# Copyright 2022-2025 IBM, Red Hat
+>>>>>>> 7327753 (feat(RHOAIENG-29330):Deny RayCluster creation with Ray Version mismatches fixed)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,7 +16,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+<<<<<<< HEAD
 import pytest
+=======
+>>>>>>> 7327753 (feat(RHOAIENG-29330):Deny RayCluster creation with Ray Version mismatches fixed)
 from codeflare_sdk.common.utils.validation import (
     extract_ray_version_from_image,
     validate_ray_version_compatibility,
@@ -105,6 +112,7 @@ class TestRayVersionValidation:
     def test_validate_compatible_versions(self):
         """Test validation with compatible Ray versions."""
         # Exact match
+<<<<<<< HEAD
         is_compatible, message = validate_ray_version_compatibility(
             f"ray:{RAY_VERSION}"
         )
@@ -116,37 +124,81 @@ def test_validate_compatible_versions(self):
             f"quay.io/modh/ray:{RAY_VERSION}-py311-cu121"
         )
         assert is_compatible is True
+=======
+        is_compatible, is_warning, message = validate_ray_version_compatibility(
+            f"ray:{RAY_VERSION}"
+        )
+        assert is_compatible is True
+        assert is_warning is False
+        assert "Ray versions match" in message
+
+        # With registry and suffixes
+        is_compatible, is_warning, message = validate_ray_version_compatibility(
+            f"quay.io/modh/ray:{RAY_VERSION}-py311-cu121"
+        )
+        assert is_compatible is True
+        assert is_warning is False
+>>>>>>> 7327753 (feat(RHOAIENG-29330):Deny RayCluster creation with Ray Version mismatches fixed)
         assert "Ray versions match" in message
 
     def test_validate_incompatible_versions(self):
         """Test validation with incompatible Ray versions."""
         # Different version
+<<<<<<< HEAD
         is_compatible, message = validate_ray_version_compatibility("ray:2.46.0")
         assert is_compatible is False
+=======
+        is_compatible, is_warning, message = validate_ray_version_compatibility(
+            "ray:2.46.0"
+        )
+        assert is_compatible is False
+        assert is_warning is False
+>>>>>>> 7327753 (feat(RHOAIENG-29330):Deny RayCluster creation with Ray Version mismatches fixed)
         assert "Ray version mismatch detected" in message
         assert "CodeFlare SDK uses Ray" in message
         assert "runtime image uses Ray" in message
 
         # Older version
+<<<<<<< HEAD
         is_compatible, message = validate_ray_version_compatibility("ray:1.13.0")
         assert is_compatible is False
+=======
+        is_compatible, is_warning, message = validate_ray_version_compatibility(
+            "ray:1.13.0"
+        )
+        assert is_compatible is False
+        assert is_warning is False
+>>>>>>> 7327753 (feat(RHOAIENG-29330):Deny RayCluster creation with Ray Version mismatches fixed)
         assert "Ray version mismatch detected" in message
 
     def test_validate_empty_image(self):
         """Test validation with no custom image (should use default)."""
         # Empty string
+<<<<<<< HEAD
         is_compatible, message = validate_ray_version_compatibility("")
         assert is_compatible is True
         assert "Using default Ray image compatible with SDK" in message
 
         # None
         is_compatible, message = validate_ray_version_compatibility(None)
         assert is_compatible is True
+=======
+        is_compatible, is_warning, message = validate_ray_version_compatibility("")
+        assert is_compatible is True
+        assert is_warning is False
+        assert "Using default Ray image compatible with SDK" in message
+
+        # None
+        is_compatible, is_warning, message = validate_ray_version_compatibility(None)
+        assert is_compatible is True
+        assert is_warning is False
+>>>>>>> 7327753 (feat(RHOAIENG-29330):Deny RayCluster creation with Ray Version mismatches fixed)
         assert "Using default Ray image compatible with SDK" in message
 
     def test_validate_unknown_version(self):
         """Test validation when version cannot be determined."""
         # SHA-based image
+<<<<<<< HEAD
         is_compatible, message = validate_ray_version_compatibility(
             "quay.io/modh/ray@sha256:6d076aeb38ab3c34a6a2ef0f58dc667089aa15826fa08a73273c629333e12f1e"
         )
@@ -159,10 +211,27 @@ def test_validate_unknown_version(self):
         )
         assert is_compatible is True
         assert "Warning: Cannot determine Ray version" in message
+=======
+        is_compatible, is_warning, message = validate_ray_version_compatibility(
+            "quay.io/modh/ray@sha256:6d076aeb38ab3c34a6a2ef0f58dc667089aa15826fa08a73273c629333e12f1e"
+        )
+        assert is_compatible is True
+        assert is_warning is True
+        assert "Cannot determine Ray version" in message
+
+        # Custom image without version
+        is_compatible, is_warning, message = validate_ray_version_compatibility(
+            "my-custom-ray:latest"
+        )
+        assert is_compatible is True
+        assert is_warning is True
+        assert "Cannot determine Ray version" in message
+>>>>>>> 7327753 (feat(RHOAIENG-29330):Deny RayCluster creation with Ray Version mismatches fixed)
 
     def test_validate_custom_sdk_version(self):
         """Test validation with custom SDK version."""
         # Compatible with custom SDK version
+<<<<<<< HEAD
         is_compatible, message = validate_ray_version_compatibility(
             "ray:2.46.0", "2.46.0"
         )
@@ -174,15 +243,61 @@ def test_validate_custom_sdk_version(self):
             "ray:2.47.1", "2.46.0"
         )
         assert is_compatible is False
+=======
+        is_compatible, is_warning, message = validate_ray_version_compatibility(
+            "ray:2.46.0", "2.46.0"
+        )
+        assert is_compatible is True
+        assert is_warning is False
+        assert "Ray versions match" in message
+
+        # Incompatible with custom SDK version
+        is_compatible, is_warning, message = validate_ray_version_compatibility(
+            "ray:2.47.1", "2.46.0"
+        )
+        assert is_compatible is False
+        assert is_warning is False
+>>>>>>> 7327753 (feat(RHOAIENG-29330):Deny RayCluster creation with Ray Version mismatches fixed)
         assert "CodeFlare SDK uses Ray 2.46.0" in message
         assert "runtime image uses Ray 2.47.1" in message
 
     def test_validate_message_content(self):
         """Test that validation messages contain expected guidance."""
         # Mismatch message should contain helpful guidance
+<<<<<<< HEAD
         is_compatible, message = validate_ray_version_compatibility("ray:2.46.0")
         assert is_compatible is False
+=======
+        is_compatible, is_warning, message = validate_ray_version_compatibility(
+            "ray:2.46.0"
+        )
+        assert is_compatible is False
+        assert is_warning is False
+>>>>>>> 7327753 (feat(RHOAIENG-29330):Deny RayCluster creation with Ray Version mismatches fixed)
         assert "compatibility issues" in message.lower()
         assert "unexpected behavior" in message.lower()
         assert "please use a runtime image" in message.lower()
         assert "update your sdk version" in message.lower()
+<<<<<<< HEAD
+=======
+
+    def test_semantic_version_comparison(self):
+        """Test that semantic version comparison works correctly."""
+        # Test that 2.10.0 > 2.9.1 (would fail with string comparison)
+        is_compatible, is_warning, message = validate_ray_version_compatibility(
+            "ray:2.10.0", "2.9.1"
+        )
+        assert is_compatible is False
+        assert is_warning is False
+        assert "CodeFlare SDK uses Ray 2.9.1" in message
+        assert "runtime image uses Ray 2.10.0" in message
+
+        # Test that 2.9.1 < 2.10.0 (would fail with string comparison)
+        is_compatible, is_warning, message = validate_ray_version_compatibility(
+            "ray:2.9.1", "2.10.0"
+        )
+        assert is_compatible is False
+        assert is_warning is False
+        assert "CodeFlare SDK uses Ray 2.10.0" in message
+        assert "runtime image uses Ray 2.9.1" in message
+>>>>>>> 7327753 (feat(RHOAIENG-29330):Deny RayCluster creation with Ray Version mismatches fixed)

src/codeflare_sdk/common/utils/validation.py

@@ -1,4 +1,8 @@
+<<<<<<< HEAD
 # Copyright 2024 IBM, Red Hat
+=======
+# Copyright 2022-2025 IBM, Red Hat
+>>>>>>> 7327753 (feat(RHOAIENG-29330):Deny RayCluster creation with Ray Version mismatches fixed)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -19,10 +23,21 @@
 configuration compatibility and correctness.
 """
 
+<<<<<<< HEAD
 import re
 from typing import Optional, Tuple
 from .constants import RAY_VERSION
 
+=======
+import logging
+import re
+from typing import Optional, Tuple
+from packaging.version import Version, InvalidVersion
+from .constants import RAY_VERSION
+
+logger = logging.getLogger(__name__)
+
+>>>>>>> 7327753 (feat(RHOAIENG-29330):Deny RayCluster creation with Ray Version mismatches fixed)
 
 def extract_ray_version_from_image(image_name: str) -> Optional[str]:
     """
@@ -62,7 +77,11 @@ def extract_ray_version_from_image(image_name: str) -> Optional[str]:
 
 def validate_ray_version_compatibility(
     image_name: str, sdk_ray_version: str = RAY_VERSION
+<<<<<<< HEAD
 ) -> Tuple[bool, str]:
+=======
+) -> Tuple[bool, bool, str]:
+>>>>>>> 7327753 (feat(RHOAIENG-29330):Deny RayCluster creation with Ray Version mismatches fixed)
     """
     Validate that the Ray version in the runtime image matches the SDK's Ray version.
 
@@ -71,20 +90,32 @@ def validate_ray_version_compatibility(
         sdk_ray_version: The Ray version used by the CodeFlare SDK
 
     Returns:
+<<<<<<< HEAD
         tuple: (is_compatible, message)
             - is_compatible: True if versions match or cannot be determined, False if mismatch
+=======
+        tuple: (is_compatible, is_warning, message)
+            - is_compatible: True if versions match or cannot be determined, False if mismatch
+            - is_warning: True if this is a warning (non-fatal), False otherwise
+>>>>>>> 7327753 (feat(RHOAIENG-29330):Deny RayCluster creation with Ray Version mismatches fixed)
             - message: Descriptive message about the validation result
     """
     if not image_name:
         # No custom image specified, will use default - this is compatible
+<<<<<<< HEAD
         return True, "Using default Ray image compatible with SDK"
+=======
+        logger.debug("Using default Ray image compatible with SDK")
+        return True, False, "Using default Ray image compatible with SDK"
+>>>>>>> 7327753 (feat(RHOAIENG-29330):Deny RayCluster creation with Ray Version mismatches fixed)
 
     image_ray_version = extract_ray_version_from_image(image_name)
 
     if image_ray_version is None:
         # Cannot determine version from image name, issue a warning but allow
         return (
             True,
+<<<<<<< HEAD
             f"Warning: Cannot determine Ray version from image '{image_name}'. Please ensure it's compatible with Ray {sdk_ray_version}",
         )
 
@@ -101,5 +132,46 @@ def validate_ray_version_compatibility(
     # Versions match
     return (
         True,
+=======
+            True,
+            f"Cannot determine Ray version from image '{image_name}'. Please ensure it's compatible with Ray {sdk_ray_version}",
+        )
+
+    # Use semantic version comparison for robust version checking
+    try:
+        sdk_version = Version(sdk_ray_version)
+        image_version = Version(image_ray_version)
+
+        if image_version != sdk_version:
+            # Version mismatch detected
+            message = (
+                f"Ray version mismatch detected!\n"
+                f"CodeFlare SDK uses Ray {sdk_ray_version}, but runtime image uses Ray {image_ray_version}.\n"
+                f"This mismatch can cause compatibility issues and unexpected behavior.\n"
+                f"Please use a runtime image with Ray {sdk_ray_version} or update your SDK version."
+            )
+            return False, False, message
+    except InvalidVersion as e:
+        # If version parsing fails, fall back to string comparison with a warning
+        logger.warning(
+            f"Failed to parse version for comparison ({e}), falling back to string comparison"
+        )
+        if image_ray_version != sdk_ray_version:
+            message = (
+                f"Ray version mismatch detected!\n"
+                f"CodeFlare SDK uses Ray {sdk_ray_version}, but runtime image uses Ray {image_ray_version}.\n"
+                f"This mismatch can cause compatibility issues and unexpected behavior.\n"
+                f"Please use a runtime image with Ray {sdk_ray_version} or update your SDK version."
+            )
+            return False, False, message
+
+    # Versions match
+    logger.debug(
+        f"Ray version validation successful: SDK and runtime image both use Ray {sdk_ray_version}"
+    )
+    return (
+        True,
+        False,
+>>>>>>> 7327753 (feat(RHOAIENG-29330):Deny RayCluster creation with Ray Version mismatches fixed)
         f"Ray versions match: SDK and runtime image both use Ray {sdk_ray_version}",
     )

src/codeflare_sdk/ray/cluster/config.py

@@ -25,6 +25,7 @@
 from kubernetes.client import V1Toleration, V1Volume, V1VolumeMount
 from ...common.utils.validation import validate_ray_version_compatibility
 
+
 dir = pathlib.Path(__file__).parent.parent.resolve()
 
 # https://docs.ray.io/en/latest/ray-core/scheduling/accelerators.html

src/codeflare_sdk/ray/cluster/test_config.py

@@ -1,4 +1,4 @@
-# Copyright 2024 IBM, Red Hat
+# Copyright 2022-2025 IBM, Red Hat
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.