Add test for experiments query function

Author: Hailey Fong

faculty/experiments.py

@@ -49,17 +49,19 @@ def _from_client_model(cls, client_object):
         return cls(**client_object._asdict())
 
     @classmethod
-    def query(cls, project_id, experiment_ids=None):
+    def query(cls, project_id, filter=None, sort=None):
         def get_runs():
             client = faculty.client("experiment")
 
-            response = client.list_runs(project_id, experiment_ids)
+            response = client.query_runs(project_id, filter, sort)
+            print(response)
             yield from map(cls._from_client_model, response.runs)
 
             while response.pagination.next is not None:
-                response = client.list_runs(
+                response = client.query_runs(
                     project_id,
-                    experiment_ids,
+                    filter,
+                    sort,
                     start=response.pagination.next.start,
                     limit=response.pagination.next.limit,
                 )

tests/test_experiments.py

@@ -0,0 +1,160 @@
+from datetime import datetime
+from uuid import uuid4
+
+import pytest
+from pytz import UTC
+
+from faculty.clients.experiment import (
+  Experiment,
+  ExperimentClient,
+	ExperimentRun,
+  ExperimentRunStatus,
+  ListExperimentRunsResponse,
+  Metric,
+	Pagination,
+  Param,
+  SingleFilter,
+  SingleFilterBy,
+  SingleFilterOperator,
+  Sort,
+  SortBy,
+  SortOrder,
+  Tag
+)
+
+from faculty.experiments import (
+  ExperimentRun as FacultyExperimentRun,
+  ExperimentRunQueryResult
+)
+
+
+
+PROJECT_ID = uuid4()
+EXPERIMENT_ID = 661
+EXPERIMENT_RUN_ID = uuid4()
+EXPERIMENT_RUN_NUMBER = 3
+EXPERIMENT_RUN_NAME = "run name"
+PARENT_RUN_ID = uuid4()
+RUN_STARTED_AT = datetime(2018, 3, 10, 11, 39, 12, 110000, tzinfo=UTC)
+RUN_ENDED_AT = datetime(2018, 3, 10, 11, 39, 15, 110000, tzinfo=UTC)
+CREATED_AT = datetime(2018, 3, 10, 11, 32, 6, 247000, tzinfo=UTC)
+LAST_UPDATED_AT = datetime(2018, 3, 10, 11, 32, 30, 172000, tzinfo=UTC)
+DELETED_AT = datetime(2018, 3, 10, 11, 37, 42, 482000, tzinfo=UTC)
+TAG = Tag(key="tag-key", value="tag-value")
+PARAM = Param(key="param-key", value="param-value")
+METRIC_KEY = "metric-key"
+METRIC_TIMESTAMP = datetime(2018, 3, 12, 16, 20, 22, 122000, tzinfo=UTC)
+METRIC = Metric(key=METRIC_KEY, value=123, timestamp=METRIC_TIMESTAMP)
+
+EXPERIMENT = Experiment(
+    id=EXPERIMENT_ID,
+    name="experiment name",
+    description="experiment description",
+    artifact_location="https://example.com",
+    created_at=CREATED_AT,
+    last_updated_at=LAST_UPDATED_AT,
+    deleted_at=DELETED_AT,
+)
+
+EXPERIMENT_RUN = ExperimentRun(
+    id=EXPERIMENT_RUN_ID,
+    run_number=EXPERIMENT_RUN_NUMBER,
+    name=EXPERIMENT_RUN_NAME,
+    parent_run_id=PARENT_RUN_ID,
+    experiment_id=EXPERIMENT.id,
+    artifact_location="faculty:",
+    status=ExperimentRunStatus.RUNNING,
+    started_at=RUN_STARTED_AT,
+    ended_at=RUN_ENDED_AT,
+    deleted_at=DELETED_AT,
+    tags=[TAG],
+    params=[PARAM],
+    metrics=[METRIC],
+)
+
+PAGINATION = Pagination(
+    start=20,
+    size=10,
+    previous=None,
+    next=None,
+)
+
+LIST_EXPERIMENT_RUNS_RESPONSE = ListExperimentRunsResponse(
+    runs=[EXPERIMENT_RUN], pagination=PAGINATION
+)
+
+FILTER = SingleFilter(
+            SingleFilterBy.EXPERIMENT_ID,
+            None,
+            SingleFilterOperator.EQUAL_TO,
+            "2"
+          ) 
+
+SORT = [Sort(SortBy.METRIC, "metric_key", SortOrder.ASC)]
+
+def test_experiment_run_query(mocker):
+
+    experiment_client_mock = mocker.MagicMock()
+    experiment_client_mock.query_runs = LIST_EXPERIMENT_RUNS_RESPONSE
+    mocker.patch(
+        "faculty.client", new=experiment_client_mock
+    )
+
+    expected_response = FacultyExperimentRun(
+      id=EXPERIMENT_RUN_ID,
+      run_number=EXPERIMENT_RUN_NUMBER,
+      name=EXPERIMENT_RUN_NAME,
+      parent_run_id=PARENT_RUN_ID,
+      experiment_id=EXPERIMENT.id,
+      artifact_location="faculty:",
+      status=ExperimentRunStatus.RUNNING,
+      started_at=RUN_STARTED_AT,
+      ended_at=RUN_ENDED_AT,
+      deleted_at=DELETED_AT,
+      tags=[TAG],
+      params=[PARAM],
+      metrics=[METRIC]
+    )
+
+    print("hello")
+
+    response = FacultyExperimentRun.query(PROJECT_ID, FILTER, SORT)
+
+    print(response)
+    assert isinstance(response, ExperimentRunQueryResult)
+    # l = list(response)
+    # l = l[0]
+    # assert all(i==j for i,j in list(zip([getattr(l, attr) for attr in dir(l)],
+    #  [getattr(expected_response, attr) for attr in dir(expected_response)])))
+
+
+ #    response_schema_mock = mocker.patch(
+ #        "faculty.clients.experiment.ListExperimentRunsResponseSchema"
+ #    )
+ #    request_schema_mock = mocker.patch(
+ #        "faculty.clients.experiment.QueryRunsSchema"
+ #    )
+ #    dump_mock = request_schema_mock.return_value.dump
+
+    # test_filter = SingleFilter(
+    #     SingleFilterBy.EXPERIMENT_ID, None, SingleFilterOperator.EQUAL_TO, "2"
+    # )
+ #    test_sort = [Sort(SortBy.METRIC, "metric_key", SortOrder.ASC)]
+
+ #    client = ExperimentClient(mocker.Mock())
+ #    list_result = client.query_runs(
+ #        PROJECT_ID, filter=test_filter, sort=test_sort, start=20, limit=10
+ #    )
+
+ #    assert list_result == LIST_EXPERIMENT_RUNS_RESPONSE
+
+ #    request_schema_mock.assert_called_once_with()
+ #    dump_mock.assert_called_once_with(
+ #        QueryRuns(test_filter, test_sort, Page(20, 10))
+ #    )
+ #    response_schema_mock.assert_called_once_with()
+ #    ExperimentClient._post.assert_called_once_with(
+ #        "/project/{}/run/query".format(PROJECT_ID),
+ #        response_schema_mock.return_value,
+ #        json=dump_mock.return_value,
+ #    )