Merge ~pgentili/checkbox-support:fix-zapper-control-api into checkbox-support:master

[Paolo Gentili]

Change: updated zapper zombiemux get/set state calls

https://warthogs.atlassian.net/browse/ZAP-228

[Maciej Kisielewski (kissiel)]

wohoo, negative diff :D
+1

review: Approve

diff --git a/checkbox_support/scripts/tests/test_zapper_proxy.py b/checkbox_support/scripts/tests/test_zapper_proxy.py
index db3e754..c641cb3 100644
--- a/checkbox_support/scripts/tests/test_zapper_proxy.py
+++ b/checkbox_support/scripts/tests/test_zapper_proxy.py
@@ -1,6 +1,7 @@
 # Copyright 2022 Canonical Ltd.
 # Written by:
 #   Maciej Kisielewski <[e-mail]>
+#   Paolo Gentili <[e-mail]>
 #
 # This is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License version 3,
@@ -31,16 +32,9 @@ class ZapperProxyV1Tests(TestCase):
     def test_usb_get_state_smoke(self):
         """
         Check if usb_get_state calls appropriate function on the rpyc client.
-
-        Current implementation on the service side uses mutable arguments for
-        returning values (C-style stuff that should be removed) this is why we
-        need the stateful side_effect below
         """
-        def side_effect_fn(_, ret):
-            ret.append('ON')
-            return True
         self._mocked_conn.root.zombiemux_get_state = Mock(
-            side_effect=side_effect_fn)
+            return_value="ON")
         zapctl = ZapperControlV1(self._mocked_conn)
 
         with patch('builtins.print') as mocked_print:
@@ -49,19 +43,23 @@ class ZapperProxyV1Tests(TestCase):
                 'State for address 0 is ON')
 
     def test_usb_get_state_fails(self):
-        """Check if usb_get_state quits with a proper message on failure."""
-        self._mocked_conn.root.zombiemux_get_state = Mock(return_value=False)
+        """
+        Check if usb_get_state quits with the exception from
+        the rpyc server on failure.
+        """
+        self._mocked_conn.root.zombiemux_get_state = Mock(
+            side_effect=Exception("Failure message"))
         zapctl = ZapperControlV1(self._mocked_conn)
-        with self.assertRaises(SystemExit) as context:
+        with self.assertRaises(Exception) as context:
             zapctl.usb_get_state(0)
         self.assertEqual(
-            context.exception.code, 'Failed to get state for address 0.')
+            str(context.exception), 'Failure message')
 
     def test_usb_set_state_smoke(self):
         """
         Check if usb_set_state calls appropriate functions on the rpyc client.
         """
-        self._mocked_conn.root.zombiemux_set_state = Mock(return_value=True)
+        self._mocked_conn.root.zombiemux_set_state = Mock()
         zapctl = ZapperControlV1(self._mocked_conn)
         with patch('builtins.print') as mocked_print:
             zapctl.usb_set_state(0, 'ON')
@@ -69,13 +67,17 @@ class ZapperProxyV1Tests(TestCase):
                 "State 'ON' set for the address 0.")
 
     def test_usb_set_state_fails(self):
-        """Check if usb_set_state quits with a proper message on failure."""
-        self._mocked_conn.root.zombiemux_set_state = Mock(return_value=False)
+        """
+        Check if usb_set_state quits with the exception from
+        the rpcy server on failure.
+        """
+        self._mocked_conn.root.zombiemux_set_state = Mock(
+            side_effect=Exception("Failure message"))
         zapctl = ZapperControlV1(self._mocked_conn)
-        with self.assertRaises(SystemExit) as context:
+        with self.assertRaises(Exception) as context:
             zapctl.usb_set_state(0, 'ON')
         self.assertEqual(
-            context.exception.code, "Failed to set 'ON' state for address 0.")
+            str(context.exception), 'Failure message')
 
     def test_get_capabilities_one_cap(self):
         """
diff --git a/checkbox_support/scripts/zapper_proxy.py b/checkbox_support/scripts/zapper_proxy.py
index d3db200..8eff71d 100644
--- a/checkbox_support/scripts/zapper_proxy.py
+++ b/checkbox_support/scripts/zapper_proxy.py
@@ -1,6 +1,7 @@
 # Copyright 2022 Canonical Ltd.
 # Written by:
 #   Maciej Kisielewski <[e-mail]>
+#   Paolo Gentili <[e-mail]>
 #
 # This is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License version 3,
@@ -72,19 +73,11 @@ class ZapperControlV1(IZapperControl):
         self._conn = connection
 
     def usb_get_state(self, address):
-        ret = []
-        success = self._conn.root.zombiemux_get_state(address, ret)
-        if not success:
-            raise SystemExit(
-                "Failed to get state for address {}.".format(address))
-        print("State for address {} is {}".format(address, ret[0]))
+        state = self._conn.root.zombiemux_get_state(address)
+        print("State for address {} is {}".format(address, state))
 
     def usb_set_state(self, address, state):
-        success = self._conn.root.zombiemux_set_state(address, state)
-        if not success:
-            raise SystemExit(
-                "Failed to set '{}' state for address {}.".format(
-                    state, address))
+        self._conn.root.zombiemux_set_state(address, state)
         print("State '{}' set for the address {}.".format(state, address))
 
     def get_capabilities(self):