diff options
Diffstat (limited to '')
| -rw-r--r-- | testing/raptor/test/test_control_server.py | 189 |
1 files changed, 189 insertions, 0 deletions
diff --git a/testing/raptor/test/test_control_server.py b/testing/raptor/test/test_control_server.py new file mode 100644 index 0000000000..83d47a4d3f --- /dev/null +++ b/testing/raptor/test/test_control_server.py @@ -0,0 +1,189 @@ +import os +import shutil +import sys +from unittest import mock + +import mozunit +import requests + +try: + from http.server import HTTPServer # py3 +except ImportError: + from BaseHTTPServer import HTTPServer # py2 + +from mozlog.structuredlog import StructuredLogger, set_default_logger +from raptor.control_server import RaptorControlServer + +# need this so the raptor unit tests can find output & filter classes +here = os.path.abspath(os.path.dirname(__file__)) +raptor_dir = os.path.join(os.path.dirname(here), "raptor") +sys.path.insert(0, raptor_dir) + +from raptor.results import RaptorResultsHandler + +set_default_logger(StructuredLogger("test_control_server")) + + +def clear_cache(): + # remove the condprof download cache + from condprof.client import CONDPROF_CACHE # noqa + + if os.path.exists(CONDPROF_CACHE): + shutil.rmtree(CONDPROF_CACHE) + + +clear_cache() + + +def test_start_and_stop(): + + results_handler = RaptorResultsHandler() + control = RaptorControlServer(results_handler) + + assert control.server is None + control.start() + assert isinstance(control.server, HTTPServer) + assert control.server.fileno() + assert control._server_thread.is_alive() + + control.stop() + assert not control._server_thread.is_alive() + + +def test_server_get_timeout(raptor): + test_name = "test-name" + url = "test-url" + metrics = {"metric1": False, "metric2": True, "metric3": True} + page_cycle = 1 + + def post_state(): + requests.post( + "http://127.0.0.1:%s/" % raptor.control_server.port, + json={ + "type": "webext_raptor-page-timeout", + "data": [test_name, url, page_cycle, metrics], + }, + ) + + assert len(raptor.results_handler.page_timeout_list) == 0 + + post_state() + + assert len(raptor.results_handler.page_timeout_list) == 1 + + timeout_details = raptor.results_handler.page_timeout_list[0] + assert timeout_details["test_name"] == test_name + assert timeout_details["url"] == url + + pending_metrics = [k for k, v in metrics.items() if v] + assert len(timeout_details["pending_metrics"].split(", ")) == len(pending_metrics) + + +def test_server_android_app_backgrounding(): + # Mock the background and foreground functions + with mock.patch.object( + RaptorControlServer, "background_app", return_value=True + ) as _, mock.patch.object( + RaptorControlServer, "foreground_app", return_value=True + ) as _: + + results_handler = RaptorResultsHandler() + control = RaptorControlServer(results_handler) + control.backgrounded = False + + control.start() + assert control._server_thread.is_alive() + + def post_start_background(): + requests.post( + "http://127.0.0.1:%s/" % control.port, + json={ + "type": "webext_start_background", + "data": "starting background app", + }, + ) + + def post_end_background(): + requests.post( + "http://127.0.0.1:%s/" % control.port, + json={"type": "webext_end_background", "data": "ending background app"}, + ) + + # Test that app is backgrounded + post_start_background() + control.background_app.assert_called() + + # Test that app is returned to foreground + post_end_background() + control.foreground_app.assert_called() + + # Make sure the control server stops after these requests + control.stop() + assert not control._server_thread.is_alive() + + +def test_server_wait_states(raptor): + import datetime + + def post_state(): + requests.post( + "http://127.0.0.1:%s/" % raptor.control_server.port, + json={"type": "webext_status", "data": "test status"}, + ) + + wait_time = 5 + message_state = "webext_status/test status" + rhc = raptor.control_server.server.RequestHandlerClass + + # Test initial state + assert rhc.wait_after_messages == {} + assert rhc.waiting_in_state is None + assert rhc.wait_timeout == 60 + assert raptor.control_server_wait_get() == "None" + + # Test setting a state + assert raptor.control_server_wait_set(message_state) == "" + assert message_state in rhc.wait_after_messages + assert rhc.wait_after_messages[message_state] + + # Test clearing a non-existent state + assert raptor.control_server_wait_clear("nothing") == "" + assert message_state in rhc.wait_after_messages + + # Test clearing a state + assert raptor.control_server_wait_clear(message_state) == "" + assert message_state not in rhc.wait_after_messages + + # Test clearing all states + assert raptor.control_server_wait_set(message_state) == "" + assert message_state in rhc.wait_after_messages + assert raptor.control_server_wait_clear("all") == "" + assert rhc.wait_after_messages == {} + + # Test wait timeout + # Block on post request + assert raptor.control_server_wait_set(message_state) == "" + assert rhc.wait_after_messages[message_state] + assert raptor.control_server_wait_timeout(wait_time) == "" + assert rhc.wait_timeout == wait_time + start = datetime.datetime.now() + post_state() + assert datetime.datetime.now() - start < datetime.timedelta(seconds=wait_time + 2) + assert raptor.control_server_wait_get() == "None" + assert message_state not in rhc.wait_after_messages + + raptor.clean_up() + assert not raptor.control_server._server_thread.is_alive() + + +def test_clean_up_stop_server(raptor): + assert raptor.control_server._server_thread.is_alive() + assert raptor.control_server.port is not None + assert raptor.control_server.server is not None + + raptor.clean_up() + assert not raptor.control_server._server_thread.is_alive() + + +if __name__ == "__main__": + mozunit.main() |