Refactor search_device function

Author: tsterbak

Makefile

@@ -3,10 +3,13 @@ install:
 	poetry install
 	poetry run python scripts/download-tools.py
 
+test:
+	poetry run pytest tests/
+
 app:
 	poetry run python openandroidinstaller/openandroidinstaller.py
 
-build-app: install
+build-app:
 	poetry run pyinstaller openandroidinstaller/openandroidinstaller.py --noconsole --noconfirm --onefile --icon "/assets/favicon.ico" --add-data "openandroidinstaller/assets:assets" --add-binary "openandroidinstaller/bin/adb:bin" --add-binary "openandroidinstaller/bin/fastboot:bin" --add-binary "openandroidinstaller/bin/heimdall:bin"
 
 

openandroidinstaller/openandroidinstaller.py

@@ -18,7 +18,7 @@
 from loguru import logger
 from subprocess import STDOUT, CalledProcessError, call, check_output
 from time import sleep
-from typing import Callable
+from typing import Callable, Optional
 from pathlib import Path
 
 import flet
@@ -50,6 +50,7 @@
 )
 from installer_config import InstallerConfig, Step
 from widgets import call_button, confirm_button, get_title
+from tool_utils import search_device, call_tool_with_command
 
 # Toggle to True for development purposes
 DEVELOPMENT = False 
@@ -178,66 +179,34 @@ def close_developer_options_dlg(self, e):
 
     def search_devices(self, e):
         """Search the device when the button is clicked."""
-        logger.info("Search devices...")
-        try:
-            # read device properties
-            # TODO: This is not windows ready...
-            if PLATFORM in ("linux", "darwin"):
-                output = check_output(
-                    [
-                        str(BIN_PATH.joinpath(Path("adb"))),
-                        "shell",
-                        "getprop",
-                        "|",
-                        "grep",
-                        "ro.product.device"
-                    ],
-                    stderr=STDOUT,
-                ).decode()
-            elif PLATFORM == "windows":
-                output = check_output(
-                    [
-                        str(BIN_PATH.joinpath(Path("adb"))),
-                        "shell",
-                        "getprop",
-                        "|",
-                        "findstr",
-                        "ro.product.device"
-                    ],
-                    stderr=STDOUT,
-                ).decode()
+        # search the device
+        if DEVELOPMENT:
+            # this only happens for testing
+            device_code = DEVELOPMENT_CONFIG
+            logger.info(f"Running search in development mode and loading config {device_code}.yaml.")
+        else:
+            device_code = search_device(platform=PLATFORM, bin_path=BIN_PATH)
+            if device_code:
+                self.device_name.value = device_code
             else:
-                raise Exception(f"Unknown platform {PLATFORM}.")
+                self.device_name.value = "No device detected! Connect to USB and try again."
 
-            output = output.split("[")[-1][:-2]
-            logger.info(f"Detected {output}")
-            # write the device code to the text shown in the box
-            self.device_name.value = output.strip()
+        # load the config, if a device is detected
+        if device_code:
+            self.device_name.value = device_code 
             # load config from file
-            path = CONFIG_PATH.joinpath(Path(f"{output.strip()}.yaml"))
-            load_config_success = self.load_config(path)
+            path = CONFIG_PATH.joinpath(Path(f"{device_code}.yaml"))
+            device_name = self.load_config(path)
+
             # display success in the application
-            if load_config_success:
+            if device_name:
                 self.config_found_box.value = True
                 self.continue_button.disabled = False
                 # overwrite the text field with the real name from the config
-                self.device_name.value = f"{load_config_success} (code: {output.strip()})"
+                self.device_name.value = f"{device_name} (code: {device_code})"
             else:
-                # show alternative configs here
-                # select a new path and load again
-                pass
-        except CalledProcessError:
-            logger.info(f"Did not detect a device.")
-            if DEVELOPMENT:
-                path = CONFIG_PATH.joinpath(Path(f"{DEVELOPMENT_CONFIG}.yaml"))
-                load_config_success = self.load_config(path)
-                if load_config_success:
-                    self.config_found_box.value = True
-                    self.continue_button.disabled = False
-            else:
-                self.device_name.value = (
-                    "No device detected! Connect to USB and try again."
-                )
+                # failed to load config
+                logger.info(f"Failed to load config from {path}.")
         self.view.update()
 
 
@@ -422,7 +391,7 @@ def confirm(self, e):
             self.view.controls.append(self.final_view)
         self.view.update()
 
-    def load_config(self, path: str):
+    def load_config(self, path: str) -> Optional[str]:
         """Function to load a config file from path."""
         try:
             self.config = InstallerConfig.from_file(path)
@@ -432,7 +401,7 @@ def load_config(self, path: str):
             return self.config.metadata.get("devicename", "No device name in config.")
         except FileNotFoundError:
             logger.info(f"No device config found for {path}.")
-            return False
+            return None 
 
     def pick_image_result(self, e: FilePickerResultEvent):
         self.selected_image.value = (

openandroidinstaller/tool_utils.py

@@ -0,0 +1,61 @@
+"""This module contains functions to deal with tools like adb, fastboot and heimdall."""
+
+# This file is part of OpenAndroidInstaller.
+# OpenAndroidInstaller is free software: you can redistribute it and/or modify it under the terms of
+# the GNU General Public License as published by the Free Software Foundation,
+# either version 3 of the License, or (at your option) any later version.
+
+# OpenAndroidInstaller is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License along with OpenAndroidInstaller.
+# If not, see <https://www.gnu.org/licenses/>."""
+# Author: Tobias Sterbak
+
+from typing import Optional
+from loguru import logger
+from pathlib import Path
+from subprocess import STDOUT, CalledProcessError, call, check_output
+
+
+def call_tool_with_command(command: str, bin_path: Path):
+    """Call an executable with a specific command."""
+    
+
+def search_device(platform: str, bin_path: Path) -> Optional[str]:
+    """Search for a connected device."""
+    logger.info(f"Search devices on {platform} with {bin_path}...")
+    try:
+        # read device properties
+        # TODO: This is not windows ready...
+        if platform in ("linux", "darwin"):
+            output = check_output(
+                [
+                    str(bin_path.joinpath(Path("adb"))),
+                    "shell",
+                    "getprop",
+                    "|",
+                    "grep",
+                    "ro.product.device"
+                ],
+                stderr=STDOUT,
+            ).decode()
+        elif platform == "windows":
+            output = check_output(
+                [
+                    str(bin_path.joinpath(Path("adb"))),
+                    "shell",
+                    "getprop",
+                    "|",
+                    "findstr",
+                    "ro.product.device"
+                ],
+                stderr=STDOUT,
+            ).decode()
+        else:
+            raise Exception(f"Unknown platform {platform}.")
+        return output.split("[")[-1][:-2].strip()
+    except CalledProcessError:
+        logger.info(f"Did not detect a device.")
+        return None

poetry.lock

@@ -17,6 +17,7 @@ PyYAML = "^6.0"
 isort = "^5.10.1"
 loguru = "^0.6.0"
 requests = "^2.28.1"
+pytest = "^7.1.3"
 
 [tool.poetry.dev-dependencies]