Fix some issues per Pierre's comments

Author: eugene-yujinwu

providers/base/bin/wol_check.py

@@ -65,22 +65,16 @@ def get_system_boot_time():
     Read btime from /proc/stat and
     return the system boot timestamp (Unix timestamp, in seconds).
     """
-    try:
-        with open("/proc/stat", "r") as f:
-            for line in f:
-                if line.startswith("btime"):
-                    btime = float(line.split()[1])
-                    back_time = datetime.datetime.fromtimestamp(btime)
-                    logging.debug("System back time: {}".format(back_time))
-                    return btime
-        logging.error("cannot find btime")
-        return None
-    except FileNotFoundError:
-        logging.error("cannot open /proc/stat.")
-        return None
-    except Exception as e:
-        logging.error("error while read btime: {}".format(e))
-        return None
+
+    with open("/proc/stat", "r") as f:
+        for line in f:
+            if line.startswith("btime"):
+                btime = int(line.split()[1])
+                back_time = datetime.datetime.fromtimestamp(btime)
+                logging.debug("System back time: {}".format(back_time))
+                return btime
+    logging.error("cannot find btime")
+    return None
 
 
 def parse_args(args=sys.argv[1:]):

providers/base/bin/wol_client.py

@@ -51,12 +51,12 @@ def send_request_to_wol_server(url, data=None, retry=3):
                 logging.debug("Status code: {}".format(status_code))
                 if status_code == 200:
                     logging.info(
-                        "Send request to Wake-on-lan server successful."
+                        "Request to Wake-on-LAN server sent successfully."
                     )
                     return
                 else:
                     logging.error(
-                        "Failded to send request to Wkae-on-lan server."
+                        "Failed to send request to Wake-on-LAN server."
                     )
         except Exception as e:
             logging.error("An unexpected error occurred: {}".format(e))
@@ -96,7 +96,7 @@ def check_wakeup(interface):
         )
 
 
-def __get_ip_address(interface):
+def get_ip_address(interface):
     try:
         s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
         ip_addr = fcntl.ioctl(
@@ -109,7 +109,7 @@ def __get_ip_address(interface):
         return None
 
 
-def __get_mac_address(interface):
+def get_mac_address(interface):
     try:
         s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
         mac_addr = fcntl.ioctl(
@@ -122,13 +122,6 @@ def __get_mac_address(interface):
         raise SystemExit("Error: Unable to retrieve MAC address")
 
 
-def get_ip_mac(interface):
-    ip_a = __get_ip_address(interface)
-    mac_a = __get_mac_address(interface)
-
-    return ip_a, mac_a
-
-
 # set the rtc wake time to bring up system in case the wake-on-lan failed
 def set_rtc_wake(wake_time):
     """
@@ -250,7 +243,8 @@ def main():
     delay = args.delay
     retry = args.retry
 
-    ip, mac = get_ip_mac(args.interface)
+    ip = get_ip_address(args.interface)
+    mac = get_mac_address(args.interface)
 
     logging.info("IP: {}, MAC: {}".format(ip, mac))
 
@@ -266,7 +260,7 @@ def main():
         "wake_type": args.waketype,
     }
 
-    send_request_to_wol_server(url, data=req, retry=3)
+    send_request_to_wol_server(url, data=req, retry=retry)
 
     bring_up_system("rtc", delay * retry * 2)
 

providers/base/tests/test_wol_check.py

@@ -78,20 +78,6 @@ def test_get_system_boot_time_no_btime(self, mock_file):
             self.assertIsNone(boot_time)
             self.assertIn("cannot find btime", log.output[0])
 
-    @patch("builtins.open", side_effect=FileNotFoundError)
-    def test_get_system_boot_time_file_not_found(self, mock_file):
-        with self.assertLogs(level="ERROR") as log:
-            boot_time = get_system_boot_time()
-            self.assertIsNone(boot_time)
-            self.assertIn("cannot open /proc/stat.", log.output[0])
-
-    @patch("builtins.open", side_effect=Exception("some error"))
-    def test_get_system_boot_time_exception(self, mock_file):
-        with self.assertLogs(level="ERROR") as log:
-            boot_time = get_system_boot_time()
-            self.assertIsNone(boot_time)
-            self.assertIn("error while read btime: some error", log.output[0])
-
 
 class TestGetWakeupTimestamp(unittest.TestCase):
 

providers/base/tests/test_wol_client.py

@@ -26,7 +26,8 @@
 from wol_client import (
     send_request_to_wol_server,
     check_wakeup,
-    get_ip_mac,
+    get_ip_address,
+    get_mac_address,
     set_rtc_wake,
     s3_or_s5_system,
     bring_up_system,
@@ -37,7 +38,6 @@
 
 
 class TestSendRequestToWolServerFunction(unittest.TestCase):
-
     @patch("urllib.request.urlopen")
     def test_send_request_success(self, mock_urlopen):
         mock_response = MagicMock()
@@ -137,14 +137,13 @@ def test_unexpected_error(self, mock_file):
         self.assertEqual(str(context.exception), "Unexpected error")
 
 
-class TestGetIPMac(unittest.TestCase):
+class TestGetIPAddress(unittest.TestCase):
     @patch("socket.socket")
     @patch("fcntl.ioctl")
-    def test_get_ip_mac_success(self, mock_ioctl, mock_socket):
+    def test_get_ip_success(self, mock_ioctl, mock_socket):
         # Mock data
         interface = "eth0"
         mock_ip = b"\xc0\xa8\x00\x01"  # 192.168.0.1
-        mock_mac = b"\x00\x0c)\x85\xac\x0e"  # 00:0c:29:85:ac:0e
 
         # Configure the mock objects
         mock_socket_instance = MagicMock()
@@ -153,60 +152,78 @@ def test_get_ip_mac_success(self, mock_ioctl, mock_socket):
         def ioctl_side_effect(fd, request, arg):
             if request == 0x8915:
                 return b"\x00" * 20 + mock_ip + b"\x00" * (256 - 24)
-            elif request == 0x8927:
-                return b"\x00" * 18 + mock_mac + b"\x00" * (256 - 24)
-            # raise IOError("Invalid request")
+            raise IOError("Invalid request")
 
         mock_ioctl.side_effect = ioctl_side_effect
 
-        ip_address, mac_address = get_ip_mac(interface)
+        ip_address = get_ip_address(interface)
 
         self.assertEqual(ip_address, "192.168.0.1")
-        self.assertEqual(mac_address, "00:0c:29:85:ac:0e")
 
     @patch("socket.socket")
     @patch("fcntl.ioctl")
     def test_get_ip_address_failure(self, mock_ioctl, mock_socket):
         # Mock data
         interface = "eth0"
-        mock_mac = b"\x00\x0c)\x85\xac\x0e"  # 00:0c:29:85:ac:0e
 
         mock_socket_instance = MagicMock()
         mock_socket.return_value = mock_socket_instance
 
         def ioctl_side_effect(fd, request, arg):
             if request == 0x8915:
                 raise IOError("IP address retrieval failed")
-            elif request == 0x8927:
-                # return struct.pack('256s', b'\x00' * 18) + mock_mac
+
+        mock_ioctl.side_effect = ioctl_side_effect
+
+        ip_address = get_ip_address(interface)
+        self.assertIsNone(ip_address)
+
+
+class TestGetMACAddress(unittest.TestCase):
+    @patch("socket.socket")
+    @patch("fcntl.ioctl")
+    def test_get_mac_success(self, mock_ioctl, mock_socket):
+        # Mock data
+        interface = "eth0"
+        mock_mac = b"\x00\x0c\x29\x85\xac\x0e"  # 00:0c:29:85:ac:0e
+
+        # Configure the mock objects
+        mock_socket_instance = MagicMock()
+        mock_socket.return_value = mock_socket_instance
+
+        def ioctl_side_effect(fd, request, arg):
+            if request == 0x8927:
                 return b"\x00" * 18 + mock_mac + b"\x00" * (256 - 24)
 
+            raise IOError("Invalid request")
+
         mock_ioctl.side_effect = ioctl_side_effect
 
-        ip_address, mac_address = get_ip_mac(interface)
+        mac_address = get_mac_address(interface)
 
-        self.assertIsNone(ip_address)
         self.assertEqual(mac_address, "00:0c:29:85:ac:0e")
 
     @patch("socket.socket")
     @patch("fcntl.ioctl")
     def test_get_mac_address_failure(self, mock_ioctl, mock_socket):
+        # Mock data
         interface = "eth0"
-        mock_ip = b"\xc0\xa8\x00\x01"  # 192.168.0.1
 
         mock_socket_instance = MagicMock()
         mock_socket.return_value = mock_socket_instance
 
         def ioctl_side_effect(fd, request, arg):
-            if request == 0x8915:
-                return struct.pack("256s", b"\x00" * 16) + mock_ip
-            elif request == 0x8927:
+            if request == 0x8927:
                 raise IOError("MAC address retrieval failed")
 
         mock_ioctl.side_effect = ioctl_side_effect
 
-        with self.assertRaises(SystemExit):
-            get_ip_mac(interface)
+        with self.assertRaises(SystemExit) as cm:
+            get_mac_address(interface)
+
+        self.assertEqual(
+            cm.exception.code, "Error: Unable to retrieve MAC address"
+        )
 
 
 class TestSetRTCWake(unittest.TestCase):
@@ -371,26 +388,32 @@ class TestMainFunction(unittest.TestCase):
     @patch("wol_client.bring_up_system")
     @patch("wol_client.send_request_to_wol_server")
     @patch("wol_client.check_wakeup")
-    @patch("wol_client.get_ip_mac")
+    @patch("wol_client.get_ip_address")
+    @patch("wol_client.get_mac_address")
     @patch("wol_client.parse_args")
     def test_main_success(
         self,
         mock_parse_args,
-        mock_get_ip_mac,
+        mock_get_mac_address,
+        mock_get_ip_address,
         mock_check_wakeup,
         mock_send_request_to_wol_server,
         mock_bring_up_system,
         mock_write_timestamp,
         mock_s3_or_s5_system,
     ):
         mock_parse_args.return_value = create_mock_args()
-        mock_get_ip_mac.return_value = ("192.168.1.100", "00:11:22:33:44:55")
+        mock_get_ip_address.return_value = "192.168.1.100"
+        mock_get_mac_address.return_value = "00:11:22:33:44:55"
+        mock_bring_up_system.return_value = None
+
         mock_check_wakeup.return_value = True
         mock_send_request_to_wol_server.return_value = create_mock_response()
 
         main()
 
-        mock_get_ip_mac.assert_called_once_with("eth0")
+        mock_get_ip_address.assert_called_once_with("eth0")
+        mock_get_mac_address.assert_called_once_with("eth0")
         mock_send_request_to_wol_server.assert_called_once_with(
             "http://192.168.1.1",
             data={
@@ -407,18 +430,25 @@ def test_main_success(
         mock_s3_or_s5_system.assert_called_once_with("s3")
 
     @patch("wol_client.send_request_to_wol_server")
-    @patch("wol_client.get_ip_mac")
+    @patch("wol_client.bring_up_system")
+    @patch("wol_client.get_ip_address")
+    @patch("wol_client.get_mac_address")
     @patch("wol_client.check_wakeup")
     @patch("wol_client.parse_args")
     def test_main_ip_none(
         self,
         mock_parse_args,
         mock_check_wakeup,
-        mock_get_ip_mac,
+        mock_bring_up_system,
+        mock_get_ip_address,
+        mock_get_mac_address,
         mock_send_request_to_wol_server,
     ):
         mock_parse_args.return_value = create_mock_args()
-        mock_get_ip_mac.return_value = (None, "00:11:22:33:44:55")
+
+        mock_get_ip_address.return_value = None
+        mock_get_mac_address.return_value = "00:11:22:33:44:55"
+        mock_bring_up_system.return_value = None
         mock_check_wakeup.return_value = True
 
         with self.assertRaises(SystemExit) as cm:
@@ -428,19 +458,22 @@ def test_main_ip_none(
         )
 
     @patch("wol_client.send_request_to_wol_server")
-    @patch("wol_client.get_ip_mac")
+    @patch("wol_client.get_ip_address")
+    @patch("wol_client.get_mac_address")
     @patch("wol_client.check_wakeup")
     @patch("wol_client.parse_args")
     def test_main_checkwakeup_disable(
         self,
         mock_parse_args,
         mock_check_wakeup,
-        mock_get_ip_mac,
+        mock_get_ip_address,
+        mock_get_mac_address,
         mock_send_request_to_wol_server,
     ):
         mock_parse_args.return_value = create_mock_args()
         mock_check_wakeup.return_value = False
-        mock_get_ip_mac.return_value = ("192.168.1.100", "00:11:22:33:44:55")
+        mock_get_ip_address.return_value = "192.168.1.100"
+        mock_get_mac_address.return_value = "00:11:22:33:44:55"
         mock_send_request_to_wol_server.return_value = create_mock_response()
 
         with self.assertRaises(SystemExit) as cm:

providers/base/units/ethernet/jobs.pxu

@@ -440,26 +440,25 @@ _summary: Network reconnect resume test (wired)
 _purpose:
  Checks the length of time it takes to reconnect an existing wired connection after a suspend/resume cycle.
 
-id: ethernet/wol_auto_S3_{{ interface }}
+id: ethernet/wol_auto_S3_{ interface }
 template-id: ethernet/wol_auto_S3_interface
 category_id: com.canonical.plainbox::ethernet
 unit: template
 template-resource: device
-template-engine: jinja2
 template-filter: device.category == 'NETWORK' and device.mac != 'UNKNOWN'
-_summary: Wake on LAN (WOL) automatic test from S3 - {{ interface }}
+_summary: Wake on LAN (WOL) automatic test from S3 - { interface }
 plugin: shell
 environ: SERVER_WAKE_ON_LAN WAKE_ON_LAN_DELAY WAKE_ON_LAN_RETRY PLAINBOX_SESSION_SHARE
 imports: from com.canonical.plainbox import manifest
 requires:
  manifest.has_ethernet_adapter == 'True'
  manifest.has_ethernet_wake_on_lan_support == 'True'
- manifest.has_wake_on_lan_server == 'True'
+ manifest.wake_on_lan_server_running == 'True'
 command:
  set -e
- wol_client.py --interface {{ interface }} --target "$SERVER_WAKE_ON_LAN" --delay "$WAKE_ON_LAN_DELAY" --retry "$WAKE_ON_LAN_RETRY" --waketype g --powertype s3  --timestamp_file "$PLAINBOX_SESSION_SHARE"/{{ interface }}_s3_timestamp
+ wol_client.py --interface { interface } --target "$SERVER_WAKE_ON_LAN" --delay "$WAKE_ON_LAN_DELAY" --retry "$WAKE_ON_LAN_RETRY" --waketype g --powertype s3  --timestamp_file "$PLAINBOX_SESSION_SHARE"/{ interface }_s3_timestamp
  sleep 30
- wol_check.py --delay "$WAKE_ON_LAN_DELAY" --retry "$WAKE_ON_LAN_RETRY" --powertype s3 --timestamp_file "$PLAINBOX_SESSION_SHARE"/{{ interface }}_s3_timestamp
+ wol_check.py --delay "$WAKE_ON_LAN_DELAY" --retry "$WAKE_ON_LAN_RETRY" --powertype s3 --timestamp_file "$PLAINBOX_SESSION_SHARE"/{ interface }_s3_timestamp
 user: root
 estimated_duration: 600
 flags: preserve-locale

providers/base/units/ethernet/manifest.pxu

@@ -9,8 +9,9 @@ _name: Wake-on-LAN support through Ethernet port
 value-type: bool
 
 unit: manifest entry
-id: has_wake_on_lan_server
-_name: Has wake-on-Lan server for automation setup and running
+id: wake_on_lan_server_running
+_prompt: Is the following server setup and running?:
+_name: A Wake-on-LAN server for automation
 value-type: bool
 
 unit: manifest entry