[Dashboard] Metrics Export Service. (#7728)

python/ray/tests/BUILD

@@ -259,6 +259,14 @@ py_test(
     deps = ["//:ray_lib"],
 )
 
+py_test(
+    name = "test_metrics_export",
+    size = "small",
+    srcs = ["test_metrics_export.py"],
+    tags = ["exclusive"],
+    deps = ["//:ray_lib"],
+)
+
 py_test(
     name = "test_microbenchmarks",
     size = "small",

python/ray/tests/test_metrics.py

@@ -380,4 +380,7 @@ def test_profiling_info_endpoint(shutdown_only):
 if __name__ == "__main__":
     import pytest
     import sys
+    import os
+    os.environ["LC_ALL"] = "en_US.UTF-8"
+    os.environ["LANG"] = "en_US.UTF-8"
     sys.exit(pytest.main(["-v", __file__]))

python/ray/tests/test_metrics_export.py

@@ -0,0 +1,171 @@
+import pytest
+import requests
+
+from unittest.mock import patch
+
+from ray.dashboard.metrics_exporter.client import MetricsExportClient
+from ray.dashboard.metrics_exporter.client import Exporter
+from ray.dashboard.metrics_exporter.schema import (AuthResponse, BaseModel,
+                                                   ValidationError)
+
+MOCK_DASHBOARD_ID = "1234"
+MOCK_DASHBOARD_ADDRESS = "127.0.0.1:9081"
+MOCK_ACCESS_TOKEN = "1234"
+
+
+def _setup_client_and_exporter(controller):
+    exporter = Exporter(MOCK_DASHBOARD_ID, MOCK_DASHBOARD_ADDRESS, controller)
+    client = MetricsExportClient(MOCK_DASHBOARD_ADDRESS, controller,
+                                 MOCK_DASHBOARD_ID, exporter)
+    return exporter, client
+
+
+@patch("ray.dashboard.dashboard.DashboardController")
+def test_verify_exporter_cannot_run_without_access_token(mock_controller):
+    exporter, client = _setup_client_and_exporter(mock_controller)
+    # Should raise an assertion error because there's no access token set.
+    with pytest.raises(AssertionError):
+        exporter.run()
+
+
+@patch("ray.dashboard.dashboard.DashboardController")
+@patch(
+    "ray.dashboard.metrics_exporter.api.authentication_request",
+    side_effect=requests.exceptions.HTTPError)
+def test_client_invalid_request_status_returned(auth_request, mock_controller):
+    """
+    If authentication request fails with an invalid status code,
+       `start_exporting_metrics` should fail.
+    """
+    exporter, client = _setup_client_and_exporter(mock_controller)
+
+    # authenticate should throw an exception because API request fails.
+    with pytest.raises(requests.exceptions.HTTPError):
+        client._authenticate()
+
+    # This should fail because authentication throws an exception.
+    result, error = client.start_exporting_metrics()
+    assert result is False
+
+
+@patch("ray.dashboard.dashboard.DashboardController")
+@patch("ray.dashboard.metrics_exporter.api.authentication_request")
+def test_authentication(auth_request, mock_controller):
+    auth_request.return_value = AuthResponse(
+        dashboard_url=MOCK_DASHBOARD_ADDRESS, access_token=MOCK_ACCESS_TOKEN)
+    exporter, client = _setup_client_and_exporter(mock_controller)
+
+    assert client.enabled is False
+    client._authenticate()
+    assert client.dashboard_url == MOCK_DASHBOARD_ADDRESS
+    assert client.enabled is True
+
+
+@patch.object(Exporter, "start")
+@patch("ray.dashboard.dashboard.DashboardController")
+@patch("ray.dashboard.metrics_exporter.api.authentication_request")
+def test_start_exporting_metrics_without_authentication(
+        auth_request, mock_controller, start):
+    """
+    `start_exporting_metrics` should trigger authentication if users
+        are not authenticated.
+    """
+    auth_request.return_value = AuthResponse(
+        dashboard_url=MOCK_DASHBOARD_ADDRESS, access_token=MOCK_ACCESS_TOKEN)
+    exporter, client = _setup_client_and_exporter(mock_controller)
+
+    # start_exporting_metrics should succeed.
+    result, error = client.start_exporting_metrics()
+    assert result is True
+    assert error is None
+    assert client.enabled is True
+
+
+@patch.object(Exporter, "start")
+@patch("ray.dashboard.dashboard.DashboardController")
+@patch("ray.dashboard.metrics_exporter.api.authentication_request")
+def test_start_exporting_metrics_with_authentication(auth_request,
+                                                     mock_controller, start):
+    """
+    If users are already authenticated, `start_exporting_metrics`
+       should not authenticate users.
+    """
+    auth_request.return_value = AuthResponse(
+        dashboard_url=MOCK_DASHBOARD_ADDRESS, access_token=MOCK_ACCESS_TOKEN)
+    exporter, client = _setup_client_and_exporter(mock_controller)
+    # Already authenticated.
+    client._authenticate()
+    assert client.enabled is True
+
+    result, error = client.start_exporting_metrics()
+    # Auth request should be called only once because
+    # it was already authenticated.
+    auth_request.call_count == 1
+    assert result is True
+    assert error is None
+
+
+@patch.object(Exporter, "start")
+@patch("ray.dashboard.dashboard.DashboardController")
+@patch("ray.dashboard.metrics_exporter.api.authentication_request")
+def test_start_exporting_metrics_succeed(auth_request, mock_controller, start):
+    auth_request.return_value = AuthResponse(
+        dashboard_url=MOCK_DASHBOARD_ADDRESS, access_token=MOCK_ACCESS_TOKEN)
+    exporter, client = _setup_client_and_exporter(mock_controller)
+
+    result, error = client.start_exporting_metrics()
+    assert result is True
+    assert error is None
+    assert client.is_exporting_started is True
+    start.call_count == 1
+
+    with pytest.raises(AssertionError):
+        client.start_exporting_metrics()
+
+
+"""
+BaseModel Test
+"""
+
+
+def test_base_model():
+    class A(BaseModel):
+        __slots__ = ["a", "b"]
+
+    # Test the correct case.
+    obj = {"a": "1", "b": "1"}
+    a = A.parse_obj(obj)
+    assert a.a == "1"
+    assert a.b == "1"
+    assert a._dict == obj
+    string = "{name}\n{dict}".format(name=A.__name__, dict=str(obj))
+    assert str(a) == string
+
+    # Test wrong types. It is not checked in the current implementation.
+    obj = {"a": 1, "b": 2}
+    a = A.parse_obj(obj)
+    assert a.a == 1
+    assert a.b == 2
+
+    # Test wrong types. parse_obj can only parse dictionary.
+    obj = None
+    with pytest.raises(AssertionError):
+        a = A.parse_obj(obj)
+
+    # Test when fields are not sufficient.
+    obj = {"a": "1"}
+    with pytest.raises(ValidationError):
+        a = A.parse_obj(obj)
+
+    # Test when fields are more than expected.
+    obj = {"a": "1", "b": "1", "c": "1"}
+    with pytest.raises(ValidationError):
+        a = A.parse_obj(obj)
+
+
+if __name__ == "__main__":
+    import sys
+    import os
+    os.environ["LC_ALL"] = "en_US.UTF-8"
+    os.environ["LANG"] = "en_US.UTF-8"
+    sys.exit(pytest.main(["-v", __file__]))

python/ray/tests/test_webui.py

@@ -35,4 +35,7 @@ def test_get_webui(shutdown_only):
 if __name__ == "__main__":
     import pytest
     import sys
+    import os
+    os.environ["LC_ALL"] = "en_US.UTF-8"
+    os.environ["LANG"] = "en_US.UTF-8"
     sys.exit(pytest.main(["-v", __file__]))