chore: import upstream snapshot with attribution

python/ray/dashboard/modules/job/tests/test_backwards_compatibility.py

@@ -0,0 +1,124 @@
+import logging
+import os
+import subprocess
+import sys
+import uuid
+from contextlib import contextmanager
+
+import pytest
+
+from ray.job_submission import JobStatus, JobSubmissionClient
+
+logger = logging.getLogger(__name__)
+
+
+@contextmanager
+def conda_env(env_name):
+    # Set env name for shell script
+    os.environ["JOB_COMPATIBILITY_TEST_TEMP_ENV"] = env_name
+    # Delete conda env if it already exists
+    try:
+        yield
+    finally:
+        # Clean up created conda env upon test exit to prevent leaking
+        del os.environ["JOB_COMPATIBILITY_TEST_TEMP_ENV"]
+        subprocess.run(
+            f"conda env remove -y --name {env_name}", shell=True, stdout=subprocess.PIPE
+        )
+
+
+def _compatibility_script_path(file_name: str) -> str:
+    return os.path.join(
+        os.path.dirname(__file__), "backwards_compatibility_scripts", file_name
+    )
+
+
+class TestBackwardsCompatibility:
+    @pytest.mark.skipif(
+        sys.platform == "darwin",
+        reason="ray 2.0.1 runs differently on apple silicon than today's.",
+    )
+    def test_cli(self):
+        """
+        Test that the current commit's CLI works with old server-side Ray versions.
+
+        1) Create a new conda environment with old ray version X installed;
+            inherits same env as current conda envionment except ray version
+        2) (Server) Start head node and dashboard with old ray version X
+        3) (Client) Use current commit's CLI code to do sample job submission flow
+        4) Deactivate the new conda environment and back to original place
+        """
+        # Shell script creates and cleans up tmp conda environment regardless
+        # of the outcome
+        env_name = f"jobs-backwards-compatibility-{uuid.uuid4().hex}"
+        with conda_env(env_name):
+            shell_cmd = f"{_compatibility_script_path('test_backwards_compatibility.sh')}"  # noqa: E501
+
+            try:
+                subprocess.check_output(shell_cmd, shell=True, stderr=subprocess.STDOUT)
+            except subprocess.CalledProcessError as e:
+                logger.error(str(e))
+                logger.error(e.stdout.decode())
+                raise e
+
+
+@pytest.mark.skipif(
+    os.environ.get("JOB_COMPATIBILITY_TEST_TEMP_ENV") is None,
+    reason="This test is only meant to be run from the "
+    "test_backwards_compatibility.sh shell script.",
+)
+def test_error_message():
+    """
+    Check that we get a good error message when running against an old server version.
+    """
+    # Import lazily so the module still loads when the compatibility script
+    # installs an older Ray that does not expose `ray._common`.
+    from ray._common.test_utils import wait_for_condition
+
+    client = JobSubmissionClient("http://127.0.0.1:8265")
+
+    # Check that a basic job successfully runs.
+    job_id = client.submit_job(
+        entrypoint="echo 'hello world'",
+    )
+    wait_for_condition(lambda: client.get_job_status(job_id) == JobStatus.SUCCEEDED)
+
+    # `entrypoint_num_cpus`, `entrypoint_num_gpus`, `entrypoint_resources`, and
+    # `entrypoint_label_selector`
+    # are not supported in ray<2.2.0.
+    for unsupported_submit_kwargs in [
+        {"entrypoint_num_cpus": 1},
+        {"entrypoint_num_gpus": 1},
+        {"entrypoint_resources": {"custom": 1}},
+        {"entrypoint_label_selector": {"fragile_node": "!1"}},
+    ]:
+        with pytest.raises(
+            Exception,
+            match="Ray version 2.0.1 is running on the cluster. "
+            "`entrypoint_num_cpus`, `entrypoint_num_gpus`, "
+            "`entrypoint_resources`, and `entrypoint_label_selector` kwargs"
+            " are not supported on the Ray cluster. Please ensure the cluster is "
+            "running Ray 2.2 or higher.",
+        ):
+            client.submit_job(
+                entrypoint="echo hello",
+                **unsupported_submit_kwargs,
+            )
+
+    with pytest.raises(
+        Exception,
+        match="Ray version 2.0.1 is running on the cluster. "
+        "`entrypoint_memory` kwarg"
+        " is not supported on the Ray cluster. Please ensure the cluster is "
+        "running Ray 2.8 or higher.",
+    ):
+        client.submit_job(
+            entrypoint="echo hello",
+            entrypoint_memory=4,
+        )
+
+    assert True
+
+
+if __name__ == "__main__":
+    sys.exit(pytest.main(["-v", __file__]))