mirror of
https://github.com/vale981/ray
synced 2025-03-10 13:26:39 -04:00
5d6bc5360d
## Why are these changes needed? - Fixes the jobs tab in the new dashboard. Previously it didn't load. - Combines the old job concept, "driver jobs" and the new job submission conception into a single concept called "jobs". Jobs tab shows information about both jobs. - Updates all job APIs: They now returns both submission jobs and driver jobs. They also contains additional data in the response including "id", "job_id", "submission_id", and "driver". They also accept either job_id or submission_id as input. - Job ID is the same as the "ray core job id" concept. It is in the form of "0100000" and is the primary id to represent jobs. - Submission ID is an ID that is generated for each ray job submission. It is in the form of "raysubmit_12345...". It is a secondary id that can be used if a client needs to provide a self-generated id. or if the job id doesn't exist (ex: if the submission job doesn't create a ray driver) This PR has 2 deprecations - The `submit_job` sdk now accepts a new kwarg `submission_id`. `job_id is deprecated. - The `ray job submit` CLI now accepts `--submission-id`. `--job-id` is deprecated. **This PR has 4 backwards incompatible changes:** - list_jobs sdk now returns a list instead of a dictionary - the `ray job list` CLI now prints a list instead of a dictionary - The `/api/jobs` endpoint returns a list instead of a dictionary - The `POST api/jobs` endpoint (submit job) now returns a json with `submission_id` field instead of `job_id`.
60 lines
2 KiB
Python
60 lines
2 KiB
Python
import logging
|
|
|
|
import pytest
|
|
import sys
|
|
import os
|
|
import subprocess
|
|
import uuid
|
|
from contextlib import contextmanager
|
|
|
|
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:
|
|
# TODO(aguo): Unskip this test once 2.0.0 is released.
|
|
@pytest.mark.skip("#25902 breaks backwards compatibility of the REST api.")
|
|
def test_cli(self):
|
|
"""
|
|
1) Create a new conda environment with ray version X installed
|
|
inherits same env as current conda envionment except ray version
|
|
2) Start head node and dashboard with ray version X
|
|
3) 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
|
|
|
|
|
|
if __name__ == "__main__":
|
|
sys.exit(pytest.main(["-v", __file__]))
|