From 0f4601449609e9e4b606008c433e40ad81f8b5b1 Mon Sep 17 00:00:00 2001
From: Simone Chemelli <simone.chemelli@gmail.com>
Date: Thu, 25 Jan 2024 17:35:31 +0100
Subject: [PATCH] refactor: library_test.py params via JSON config file (#87)

---
 .gitignore          |  3 +++
 .vscode/launch.json |  2 +-
 library_test.py     | 60 +++++++++++++++++++++++++++++++--------------
 3 files changed, 45 insertions(+), 20 deletions(-)

diff --git a/.gitignore b/.gitignore
index 08cfdfd..a862838 100644
--- a/.gitignore
+++ b/.gitignore
@@ -138,3 +138,6 @@ dmypy.json
 
 # Cython debug symbols
 cython_debug/
+
+# Optional config file for library_test.py script
+library_test.json
diff --git a/.vscode/launch.json b/.vscode/launch.json
index 99da390..aecd08c 100644
--- a/.vscode/launch.json
+++ b/.vscode/launch.json
@@ -6,7 +6,7 @@
       "type": "python",
       "request": "launch",
       "program": "library_test.py",
-      "args": ["-bp", "<your pin>", "-vp", "<your pin"],
+      "args": ["-cf", "library_test.json"],
       "console": "integratedTerminal",
       "justMyCode": true
     }
diff --git a/library_test.py b/library_test.py
index e10d840..21e7637 100644
--- a/library_test.py
+++ b/library_test.py
@@ -1,8 +1,9 @@
 """Test script for aiocomelit library."""
-import argparse
-import ast
 import asyncio
+import json
 import logging
+import os
+from argparse import ArgumentParser, Namespace
 
 from colorlog import ColoredFormatter
 
@@ -30,9 +31,9 @@
 INDEX = 0
 
 
-def get_arguments() -> tuple[argparse.ArgumentParser, argparse.Namespace]:
+def get_arguments() -> tuple[ArgumentParser, Namespace]:
     """Get parsed passed in arguments."""
-    parser = argparse.ArgumentParser(description="aiovodafone library test")
+    parser = ArgumentParser(description="aiocomelit library test")
     parser.add_argument(
         "--bridge",
         "-b",
@@ -78,11 +79,22 @@ def get_arguments() -> tuple[argparse.ArgumentParser, argparse.Namespace]:
     parser.add_argument(
         "--test",
         "-t",
-        type=ast.literal_eval,
-        default=True,
+        type=str,
+        default="True",
         help="Execute test actions",
+    ),
+    parser.add_argument(
+        "--configfile",
+        "-cf",
+        type=str,
+        help="Load options from JSON config file. Command line options override those in the file.",
     )
     arguments = parser.parse_args()
+    if arguments.configfile:
+        # Re-parse the command line, taking the options in the optional JSON file as a basis
+        if os.path.exists(arguments.configfile):
+            with open(arguments.configfile) as f:
+                arguments = parser.parse_args(namespace=Namespace(**json.load(f)))
 
     return parser, arguments
 
@@ -107,13 +119,8 @@ async def execute_alarm_test(api: ComelitVedoApi, area: ComelitVedoAreaObject) -
     print("Status after: ", await api.get_area_status(area))
 
 
-async def main() -> None:
-    """Run main."""
-    parser, args = get_arguments()
-
-    print("-" * 20)
-    print(f"aiocomelit version: {__version__}")
-    print("-" * 20)
+async def bridge_test(args: Namespace) -> None:
+    """Test code for Comelit Serial Bridge."""
     bridge_api = ComeliteSerialBridgeApi(args.bridge, args.bridge_port, args.bridge_pin)
     logged = False
     try:
@@ -130,7 +137,7 @@ async def main() -> None:
     devices = await bridge_api.get_all_devices()
     print("Devices:", devices)
     print("-" * 20)
-    if args.test:
+    if args.test == "True":
         for device in devices[LIGHT].values():
             if device.index == INDEX:
                 await execute_device_test(bridge_api, device, LIGHT)
@@ -152,11 +159,9 @@ async def main() -> None:
     await bridge_api.logout()
     await bridge_api.close()
 
-    # VEDO system mandatorily requires a pin
-    if not args.vedo_pin:
-        print("VEDO, missing PIN. Skipping")
-        return
 
+async def vedo_test(args: Namespace) -> None:
+    """Test code for Comelit VEDO system."""
     vedo_api = ComelitVedoApi(args.vedo, args.vedo_port, args.vedo_pin)
     logged = False
     try:
@@ -179,7 +184,7 @@ async def main() -> None:
     for zone in alarm_data[ALARM_ZONES]:
         print(alarm_data[ALARM_ZONES][zone])
     print("-" * 20)
-    if args.test:
+    if args.test == "True":
         await execute_alarm_test(vedo_api, alarm_data[ALARM_AREAS][INDEX])
         print("-" * 20)
     print("Logout & close session")
@@ -187,6 +192,23 @@ async def main() -> None:
     await vedo_api.close()
 
 
+async def main() -> None:
+    """Run main."""
+    parser, args = get_arguments()
+
+    print("-" * 20)
+    print(f"aiocomelit version: {__version__}")
+    print("-" * 20)
+    await bridge_test(args)
+
+    # VEDO system mandatorily requires a pin
+    if not args.vedo_pin:
+        print("Comelit VEDO System: missing PIN. Skipping tests")
+        parser.print_help()
+        return
+    await vedo_test(args)
+
+
 def set_logging() -> None:
     logging.basicConfig(level=logging.DEBUG)
     logging.getLogger("asyncio").setLevel(logging.INFO)