Ray projects schema and validation (#5329)

python/ray/tests/project_files/docker_project.yaml

@@ -0,0 +1,7 @@
+name: testproject1
+description: "Test project for docker environment"
+
+environment:
+  docker: "Dockerfile"
+
+cluster: "cluster.yaml"

python/ray/tests/project_files/no_project2.yaml

@@ -0,0 +1,4 @@
+name: testproject2
+
+environment:
+  shell: "one command"

python/ray/tests/project_files/no_project3.yaml

@@ -0,0 +1,8 @@
+name: testproject3
+
+environment:
+  dockerfile: "Dockerfile"
+
+  dockerimage: "some docker image"
+
+cluster: "cluster.yaml"

python/ray/tests/project_files/project1/.rayproject/project.yaml

@@ -0,0 +1,10 @@
+name: "project1"
+
+cluster: .rayproject/cluster.yaml
+
+environment:
+  requirements: requirements.txt
+
+commands:
+  - name: default
+    command: ls

python/ray/tests/project_files/requirements_project.yaml

@@ -0,0 +1,6 @@
+name: testproject2
+
+environment:
+  requirements: "requirements.txt"
+
+cluster: "cluster.yaml"

python/ray/tests/project_files/shell_project.yaml

@@ -0,0 +1,10 @@
+name: testproject3
+repo: "https://github.com/ray-project/ray"
+
+environment:
+  shell:
+    - first command
+    - second command
+    - third command
+
+cluster: "cluster.yaml"

python/ray/tests/test_projects.py

@@ -0,0 +1,61 @@
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+
+import jsonschema
+import os
+import pytest
+import subprocess
+import yaml
+
+import ray
+
+TEST_DIR = os.path.dirname(os.path.abspath(__file__))
+
+
+def load_project_description(project_file):
+    path = os.path.join(TEST_DIR, "project_files", project_file)
+    with open(path) as f:
+        return yaml.load(f)
+
+
+def test_validation_success():
+    project_files = [
+        "docker_project.yaml", "requirements_project.yaml",
+        "shell_project.yaml"
+    ]
+    for project_file in project_files:
+        project_definition = load_project_description(project_file)
+        ray.projects.validate_project_schema(project_definition)
+
+
+def test_validation_failure():
+    project_files = ["no_project1.yaml", "no_project2.yaml"]
+    for project_file in project_files:
+        project_definition = load_project_description(project_file)
+        with pytest.raises(jsonschema.exceptions.ValidationError):
+            ray.projects.validate_project_schema(project_definition)
+
+
+def test_check_failure():
+    project_files = ["no_project3.yaml"]
+    for project_file in project_files:
+        project_definition = load_project_description(project_file)
+        with pytest.raises(ValueError):
+            ray.projects.check_project_definition("", project_definition)
+
+
+def test_project_root():
+    path = os.path.join(TEST_DIR, "project_files", "project1")
+    assert ray.projects.find_root(path) == path
+
+    path2 = os.path.join(TEST_DIR, "project_files", "project1", "subdir")
+    assert ray.projects.find_root(path2) == path
+
+    path3 = "/tmp/"
+    assert ray.projects.find_root(path3) is None
+
+
+def test_project_validation():
+    path = os.path.join(TEST_DIR, "project_files", "project1")
+    subprocess.check_call(["ray", "session", "create", "--dry"], cwd=path)