Validate schema before it is loaded

Author: tsterbak

openandroidinstaller/installer_config.py

@@ -15,6 +15,8 @@
 
 from pathlib import Path
 from typing import List, Optional
+import schema
+from schema import Regex, Schema, SchemaError
 
 import yaml
 from loguru import logger
@@ -56,11 +58,16 @@ def from_file(cls, path):
         with open(path, "r") as stream:
             try:
                 raw_config = yaml.safe_load(stream)
-                config = dict(raw_config)
-                raw_steps = config["steps"]
-                metadata = config["metadata"]
+                if validate_config(raw_config):
+                    config = dict(raw_config)
+                    raw_steps = config["steps"]
+                    metadata = config["metadata"]
+                else:
+                    logger.info("Validation of config failed.")
+                    return None
             except yaml.YAMLError as exc:
                 logger.info(exc)
+                return None
 
         if raw_steps.get("unlock_bootloader") is not None:
             unlock_bootloader = [
@@ -92,8 +99,42 @@ def _load_config(device_code: str, config_path: Path) -> Optional[InstallerConfi
         try:
             config = InstallerConfig.from_file(path)
             logger.info(f"Loaded device config from {path}.")
-            logger.info(f"Config metadata: {config.metadata}.")
+            if config:
+                logger.info(f"Config metadata: {config.metadata}.")
             return config
         except FileNotFoundError:
             logger.info(f"No device config found for {path}.")
             return None
+
+
+def validate_config(config: str) -> bool:
+    """Validate the schema of the config.""" 
+
+    step_schema = {
+        "title": str,
+        "type": Regex(r"text|confirm_button|call_button|call_button_with_input"),
+        "content": str,
+        schema.Optional("command"): Regex(r"^adb\s|^fastboot\s|^heimdall\s"), 
+        schema.Optional("allow_skip"): bool,
+    }
+
+    config_schema = Schema({
+        "metadata": {
+            "maintainer": str,
+            "devicename": str,
+            "devicecode": str,
+        },
+        "requirements": schema.Or(None, []),
+        "steps": {
+            "unlock_bootloader": schema.Or(None, [step_schema]),
+            "flash_recovery": [step_schema],
+            "install_os": [step_schema],
+        }
+    })
+    try:
+        config_schema.validate(config)
+        logger.info("Config is valid.")
+        return True
+    except SchemaError as se:
+        logger.info(f"Config is invalid. Error {se}")
+        return False

openandroidinstaller/openandroidinstaller.py

@@ -33,7 +33,7 @@
 
 # Toggle to True for development purposes
 DEVELOPMENT = True
-DEVELOPMENT_CONFIG = "FP2"  # "a3y17lte"  # "sargo"
+DEVELOPMENT_CONFIG = "sargo"  # "a3y17lte"  # "sargo"
 
 
 PLATFORM = sys.platform
@@ -217,6 +217,7 @@ def search_devices(self, e):
             else:
                 # failed to load config
                 logger.info(f"Failed to load config for {device_code}.")
+                self.device_name.value = f"Failed to load config for {device_code}."
         self.view.update()
 
 

poetry.lock

@@ -19,6 +19,7 @@ loguru = "^0.6.0"
 requests = "^2.28.1"
 pytest = "^7.1.3"
 regex = "^2022.9.13"
+schema = "^0.7.5"
 
 [tool.poetry.dev-dependencies]