Refactor snippet client v2's stop server method (#807)
diff --git a/mobly/snippet/client_base.py b/mobly/snippet/client_base.py
index 31e99dc..5f8e581 100644
--- a/mobly/snippet/client_base.py
+++ b/mobly/snippet/client_base.py
@@ -62,8 +62,8 @@
Connects to a remote device running a JSON RPC compatible server. Users call
the function `start_server` to start the server on the remote device before
- sending any RPC. After sending all RPCs, users call the function `stop_server`
- to stop all the running instances.
+ sending any RPC. After sending all RPCs, users call the function `stop`
+ to stop the snippet server and release all the requested resources.
Attributes:
package: str, the user-visible name of the snippet library being
@@ -135,11 +135,11 @@
'Error occurred trying to start and connect to the snippet server '
'of %s.', self.package)
try:
- self.stop_server()
+ self.stop()
except Exception: # pylint: disable=broad-except
# Only prints this exception and re-raises the original exception
self.log.exception(
- 'Failed to stop the snippet server of %s after failure to start '
+ 'Failed to stop the snippet package %s after failure to start '
'and connect.', self.package)
raise
@@ -418,15 +418,9 @@
The callback handler object.
"""
- def stop_server(self):
- """Proxy function of do_stop_server."""
- self.log.debug('Stopping snippet %s.', self.package)
- self.do_stop_server()
- self.log.debug('Snippet %s stopped.', self.package)
-
@abc.abstractmethod
- def do_stop_server(self):
- """Kills any running instance of the server."""
+ def stop(self):
+ """Releases all the resources acquired in `initialize`."""
@abc.abstractmethod
def close_connection(self):
diff --git a/tests/mobly/snippet/client_base_test.py b/tests/mobly/snippet/client_base_test.py
index 3eb6521..d9d99bd 100755
--- a/tests/mobly/snippet/client_base_test.py
+++ b/tests/mobly/snippet/client_base_test.py
@@ -84,7 +84,7 @@
def handle_callback(self, callback_id, ret_value, rpc_func_name):
pass
- def do_stop_server(self):
+ def stop(self):
pass
def close_connection(self):
@@ -119,38 +119,37 @@
]
self.assertListEqual(order_manager.mock_calls, expected_call_order)
- @mock.patch.object(FakeClient, 'stop_server')
+ @mock.patch.object(FakeClient, 'stop')
@mock.patch.object(FakeClient, 'before_starting_server')
def test_init_server_before_starting_server_fail(self, mock_before_func,
- mock_stop_server):
+ mock_stop_func):
"""Test before_starting_server stage of initialization fails."""
mock_before_func.side_effect = Exception('ha')
with self.assertRaisesRegex(Exception, 'ha'):
self.client.initialize()
- mock_stop_server.assert_not_called()
+ mock_stop_func.assert_not_called()
- @mock.patch.object(FakeClient, 'stop_server')
+ @mock.patch.object(FakeClient, 'stop')
@mock.patch.object(FakeClient, 'start_server')
- def test_init_server_start_server_fail(self, mock_start_func,
- mock_stop_server):
+ def test_init_server_start_server_fail(self, mock_start_func, mock_stop_func):
"""Test start_server stage of initialization fails."""
mock_start_func.side_effect = Exception('ha')
with self.assertRaisesRegex(Exception, 'ha'):
self.client.initialize()
- mock_stop_server.assert_called()
+ mock_stop_func.assert_called()
- @mock.patch.object(FakeClient, 'stop_server')
+ @mock.patch.object(FakeClient, 'stop')
@mock.patch.object(FakeClient, '_make_connection')
def test_init_server_make_connection_fail(self, mock_make_conn_func,
- mock_stop_server):
+ mock_stop_func):
"""Test _make_connection stage of initialization fails."""
mock_make_conn_func.side_effect = Exception('ha')
with self.assertRaisesRegex(Exception, 'ha'):
self.client.initialize()
- mock_stop_server.assert_called()
+ mock_stop_func.assert_called()
@mock.patch.object(FakeClient, 'check_server_proc_running')
@mock.patch.object(FakeClient, '_gen_rpc_request')
