[Projects] Add annotations field (#615)

mlrun/api/schemas/project.py

@@ -14,6 +14,7 @@ class ProjectMetadata(pydantic.BaseModel):
     name: str
     created: typing.Optional[datetime.datetime] = None
     labels: typing.Optional[dict]
+    annotations: typing.Optional[dict]
 
     class Config:
         extra = pydantic.Extra.allow

mlrun/api/utils/clients/nuclio.py

@@ -62,6 +62,10 @@ def patch_project(
             response_body.setdefault("metadata", {}).setdefault("labels", {}).update(
                 project["metadata"]["labels"]
             )
+        if project.get("metadata").get("annotations") is not None:
+            response_body.setdefault("metadata", {}).setdefault(
+                "annotations", {}
+            ).update(project["metadata"]["annotations"])
         if project.get("spec").get("description") is not None:
             response_body.setdefault("spec", {})["description"] = project["spec"][
                 "description"
@@ -159,6 +163,8 @@ def _generate_request_body(project: mlrun.api.schemas.Project):
         }
         if project.metadata.labels:
             body["metadata"]["labels"] = project.metadata.labels
+        if project.metadata.annotations:
+            body["metadata"]["annotations"] = project.metadata.annotations
         if project.spec.description:
             body["spec"] = {"description": project.spec.description}
         return body
@@ -169,6 +175,7 @@ def _transform_nuclio_project_to_schema(nuclio_project):
             metadata=mlrun.api.schemas.ProjectMetadata(
                 name=nuclio_project["metadata"]["name"],
                 labels=nuclio_project["metadata"].get("labels"),
+                annotations=nuclio_project["metadata"].get("annotations"),
             ),
             spec=mlrun.api.schemas.ProjectSpec(
                 description=nuclio_project["spec"].get("description")

mlrun/projects/project.py

@@ -206,10 +206,11 @@ def _project_instance_from_struct(struct, name):
 
 
 class ProjectMetadata(ModelObj):
-    def __init__(self, name=None, created=None, labels=None):
+    def __init__(self, name=None, created=None, labels=None, annotations=None):
         self.name = name
         self.created = created
         self.labels = labels or {}
+        self.annotations = annotations or {}
 
     @property
     def name(self) -> str:

tests/api/utils/clients/test_nuclio.py

@@ -34,8 +34,15 @@ def test_get_project(
     project_labels = {
         "some-label": "some-label-value",
     }
+    project_annotations = {
+        "some-annotation": "some-annotation-value",
+    }
     response_body = _generate_project_body(
-        project_name, project_description, project_labels, with_spec=True,
+        project_name,
+        project_description,
+        project_labels,
+        project_annotations,
+        with_spec=True,
     )
     requests_mock.get(f"{api_url}/api/projects/{project_name}", json=response_body)
     project = nuclio_client.get_project(None, project_name)
@@ -45,14 +52,21 @@ def test_get_project(
         deepdiff.DeepDiff(project_labels, project.metadata.labels, ignore_order=True,)
         == {}
     )
+    assert (
+        deepdiff.DeepDiff(
+            project_annotations, project.metadata.annotations, ignore_order=True,
+        )
+        == {}
+    )
 
-    # now without description and labels
+    # now without description, labels and annotations
     response_body = _generate_project_body(project_name, with_spec=True)
     requests_mock.get(f"{api_url}/api/projects/{project_name}", json=response_body)
     project = nuclio_client.get_project(None, project_name)
     assert project.metadata.name == project_name
     assert project.spec.description is None
     assert project.metadata.labels is None
+    assert project.metadata.annotations is None
 
 
 def test_list_project(
@@ -66,15 +80,21 @@ def test_list_project(
         {"name": "project-name-3", "labels": {"key": "value"}},
         {
             "name": "project-name-4",
+            "annotations": {"annotation-key": "annotation-value"},
+        },
+        {
+            "name": "project-name-5",
             "description": "project-description-4",
             "labels": {"key2": "value2"},
+            "annotations": {"annotation-key2": "annotation-value2"},
         },
     ]
     response_body = {
         mock_project["name"]: _generate_project_body(
             mock_project["name"],
             mock_project.get("description"),
             mock_project.get("labels"),
+            mock_project.get("annotations"),
             with_spec=True,
         )
         for mock_project in mock_projects
@@ -92,6 +112,14 @@ def test_list_project(
             )
             == {}
         )
+        assert (
+            deepdiff.DeepDiff(
+                mock_projects[index].get("annotations"),
+                project.metadata.annotations,
+                ignore_order=True,
+            )
+            == {}
+        )
 
 
 def test_create_project(
@@ -104,6 +132,9 @@ def test_create_project(
     project_labels = {
         "some-label": "some-label-value",
     }
+    project_annotations = {
+        "some-annotation": "some-annotation-value",
+    }
 
     def verify_creation(request, context):
         assert (
@@ -112,6 +143,7 @@ def verify_creation(request, context):
                     project_name,
                     project_description,
                     project_labels,
+                    project_annotations,
                     with_namespace=False,
                 ),
                 request.json(),
@@ -126,7 +158,9 @@ def verify_creation(request, context):
         None,
         mlrun.api.schemas.Project(
             metadata=mlrun.api.schemas.ProjectMetadata(
-                name=project_name, labels=project_labels
+                name=project_name,
+                labels=project_labels,
+                annotations=project_annotations,
             ),
             spec=mlrun.api.schemas.ProjectSpec(description=project_description),
         ),
@@ -143,6 +177,9 @@ def test_store_project_creation(
     project_labels = {
         "some-label": "some-label-value",
     }
+    project_annotations = {
+        "some-annotation": "some-annotation-value",
+    }
 
     def verify_store_creation(request, context):
         assert (
@@ -151,6 +188,7 @@ def verify_store_creation(request, context):
                     project_name,
                     project_description,
                     project_labels,
+                    project_annotations,
                     with_namespace=False,
                 ),
                 request.json(),
@@ -171,7 +209,9 @@ def verify_store_creation(request, context):
         project_name,
         mlrun.api.schemas.Project(
             metadata=mlrun.api.schemas.ProjectMetadata(
-                name=project_name, labels=project_labels
+                name=project_name,
+                labels=project_labels,
+                annotations=project_annotations,
             ),
             spec=mlrun.api.schemas.ProjectSpec(description=project_description),
         ),
@@ -188,9 +228,10 @@ def test_store_project_update(
     project_labels = {
         "some-label": "some-label-value",
     }
-    mocked_project_body = _generate_project_body(
-        project_name, labels={"label-key": "label-value"}, with_spec=True
-    )
+    project_annotations = {
+        "some-annotation": "some-annotation-value",
+    }
+    mocked_project_body = _generate_project_body(project_name, with_spec=True)
 
     def verify_store_update(request, context):
         assert (
@@ -199,6 +240,7 @@ def verify_store_update(request, context):
                     project_name,
                     project_description,
                     project_labels,
+                    project_annotations,
                     with_namespace=False,
                 ),
                 request.json(),
@@ -218,7 +260,9 @@ def verify_store_update(request, context):
         project_name,
         mlrun.api.schemas.Project(
             metadata=mlrun.api.schemas.ProjectMetadata(
-                name=project_name, labels=project_labels
+                name=project_name,
+                labels=project_labels,
+                annotations=project_annotations,
             ),
             spec=mlrun.api.schemas.ProjectSpec(description=project_description),
         ),
@@ -235,15 +279,22 @@ def test_patch_project(
     project_labels = {
         "some-label": "some-label-value",
     }
+    project_annotations = {
+        "some-annotation": "some-annotation-value",
+    }
     mocked_project_body = _generate_project_body(
-        project_name, labels={"label-key": "label-value"}, with_spec=True
+        project_name,
+        labels={"label-key": "label-value"},
+        annotations={"annotation-key": "annotation-value"},
+        with_spec=True,
     )
 
     def verify_patch(request, context):
         # verifying the patch kept the old labels, patched the description, and added the new label
         expected_body = mocked_project_body
         expected_body["spec"]["description"] = project_description
         expected_body["metadata"]["labels"].update(project_labels)
+        expected_body["metadata"]["annotations"].update(project_annotations)
         assert (
             deepdiff.DeepDiff(expected_body, request.json(), ignore_order=True,) == {}
         )
@@ -257,7 +308,7 @@ def verify_patch(request, context):
         None,
         project_name,
         {
-            "metadata": {"labels": project_labels},
+            "metadata": {"labels": project_labels, "annotations": project_annotations},
             "spec": {"description": project_description},
         },
     )
@@ -286,7 +337,12 @@ def verify_deletion(request, context):
 
 
 def _generate_project_body(
-    name=None, description=None, labels=None, with_namespace=True, with_spec=False
+    name=None,
+    description=None,
+    labels=None,
+    annotations=None,
+    with_namespace=True,
+    with_spec=False,
 ):
     body = {
         "metadata": {"name": name},
@@ -299,4 +355,6 @@ def _generate_project_body(
         body["metadata"]["namespace"] = "default-tenant"
     if labels:
         body["metadata"]["labels"] = labels
+    if annotations:
+        body["metadata"]["annotations"] = annotations
     return body

tests/rundb/test_httpdb.py

@@ -537,8 +537,9 @@ def test_project_file_db_roundtrip(create_server):
     subpath = "subpath"
     origin_url = "origin_url"
     labels = {"key": "value"}
+    annotations = {"annotation-key": "annotation-value"}
     project_metadata = mlrun.projects.project.ProjectMetadata(
-        project_name, labels=labels
+        project_name, labels=labels, annotations=annotations,
     )
     project_spec = mlrun.projects.project.ProjectSpec(
         description,