revise/add watchdog related test scripts

revise watchdog_config_test.py
add watchdog_test.py

Author: stanley31huang

providers/base/bin/watchdog_config_test.py

@@ -17,6 +17,7 @@
 # You should have received a copy of the GNU General Public License
 # along with Checkbox.  If not, see <http://www.gnu.org/licenses/>.
 
+import argparse
 import subprocess
 
 from checkbox_support.snap_utils.system import on_ubuntucore
@@ -53,57 +54,103 @@ def watchdog_service_check():
         raise SystemExit("Error: {}".format(err))
 
 
-def main():
-    runtime_watchdog_usec = get_systemd_wdt_usec()
-    systemd_wdt_configured = runtime_watchdog_usec != "0"
-    wdt_service_configured = watchdog_service_check()
+def check_timeout() -> bool:
     ubuntu_version = int(get_series().split(".")[0])
-    watchdog_config_ready = True
+    runtime_watchdog_usec = get_systemd_wdt_usec()
+    is_systemd_wdt_configured = runtime_watchdog_usec != "0"
 
-    if (ubuntu_version >= 20) or (on_ubuntucore()):
-        if not systemd_wdt_configured:
+    if ubuntu_version >= 20 or on_ubuntucore():
+        if not is_systemd_wdt_configured:
             print(
                 "systemd watchdog should be enabled but reset timeout "
                 "(RuntimeWatchdogUSec) is set to: "
                 "{}".format(runtime_watchdog_usec)
             )
             print(
-                "In order for the watchdog service to work, the "
-                "RuntimeWatchdogUSec configuration option must be set before "
-                "running this test."
+                "In order for the systemd watchdog to work, "
+                "the RuntimeWatchdogUSec configuration option must be set "
+                "before running this test."
             )
-            watchdog_config_ready = False
-        if wdt_service_configured:
-            print("found unexpected active watchdog.service unit")
-            watchdog_config_ready = False
-        if watchdog_config_ready:
-            print(
-                "systemd watchdog enabled, reset timeout: {}".format(
-                    runtime_watchdog_usec
-                )
+            raise SystemExit(1)
+        print(
+            "systemd watchdog enabled, reset timeout: {}".format(
+                runtime_watchdog_usec
             )
-            print("watchdog.service is not active")
+        )
     else:
-        if systemd_wdt_configured:
+        if is_systemd_wdt_configured:
             print(
                 "systemd watchdog should not be enabled but reset timeout "
                 "(RuntimeWatchdogUSec) is set to: "
                 "{}".format(runtime_watchdog_usec)
             )
             print(
-                "In order for the watchdog service to work, the "
-                "RuntimeWatchdogUSec configuration option must be set before "
-                "running this test."
+                "In order for the watchdog.service to work, "
+                "the RuntimeWatchdogUSec configuration option must be 0 "
+                "before running this test."
+            )
+            raise SystemExit(1)
+        print(
+            "systemd watchdog disabled, reset timeout: {}".format(
+                runtime_watchdog_usec
             )
-            watchdog_config_ready = False
-        if not wdt_service_configured:
-            print("watchdog.service unit does not report as active")
-            watchdog_config_ready = False
-        if watchdog_config_ready:
-            print("systemd watchdog disabled")
-            print("watchdog.service active")
-
-    raise SystemExit(not watchdog_config_ready)
+        )
+
+
+def check_service() -> bool:
+    ubuntu_version = int(get_series().split(".")[0])
+    is_wdt_service_configured = watchdog_service_check()
+
+    if ubuntu_version >= 20 or on_ubuntucore():
+        if is_wdt_service_configured:
+            raise SystemExit("Found unexpected active watchdog.service unit")
+        print("watchdog.service is not active")
+    else:
+        if not is_wdt_service_configured:
+            raise SystemExit("watchdog.service unit does not report as active")
+        print("watchdog.service is active")
+
+
+def watchdog_argparse() -> argparse.Namespace:
+    """
+    Parse command line arguments and return the parsed arguments.
+
+    This function parses the command line arguments and returns the parsed
+    arguments. The arguments are parsed using the `argparse` module. The
+    function takes no parameters.
+
+    Returns:
+        argparse.Namespace: The parsed command line arguments.
+    """
+    parser = argparse.ArgumentParser(
+        prog="Watchdog Testing Tool",
+        description="This is a tool to help you perform the watchdog testing",
+        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
+    )
+    group = parser.add_mutually_exclusive_group(required=True)
+    group.add_argument(
+        "-t",
+        "--check-time",
+        action="store_true",
+        help="Check if watchdog service timeout is configured correctly",
+    )
+    group.add_argument(
+        "-s",
+        "--check-service",
+        action="store_true",
+        help="Check if watchdog service is running",
+    )
+    return parser.parse_args()
+
+
+def main():
+    args = watchdog_argparse()
+    if args.check_time:
+        check_timeout()
+    elif args.check_service:
+        check_service()
+    else:
+        raise SystemExit("Unexpected arguments")
 
 
 if __name__ == "__main__":