Refactor (#47)

This PR adds:
- a debug mode (addressing #27)
- basic tests for the full app
- Open Feedback page when finishing the install process

Author: tsterbak

Makefile

@@ -8,17 +8,21 @@ install:
 export:
 	poetry export -f requirements.txt --output requirements.txt
 
+format:
+	poetry run black .
+
 lint:
 	poetry run ruff openandroidinstaller/ --ignore E501
 
-test:
-	poetry run black .
-	poetry run ruff openandroidinstaller/ --ignore E501
+test: format lint
 	PYTHONPATH=openandroidinstaller:$(PYTHONPATH) poetry run pytest --cov=openandroidinstaller tests/
 
 app:
 	poetry run python openandroidinstaller/openandroidinstaller.py
 
+test-app:
+	poetry run python openandroidinstaller/openandroidinstaller.py --test --test_config sargo
+
 build-app:
 	poetry run python scripts/build.py
 

openandroidinstaller/openandroidinstaller.py

@@ -16,6 +16,8 @@
 import os
 import sys
 import webbrowser
+import click
+import functools
 from pathlib import Path
 
 import flet as ft
@@ -50,11 +52,8 @@
 # where to write the logs
 logger.add("openandroidinstaller.log")
 
-# Toggle to True for development purposes
-DEVELOPMENT = False
-DEVELOPMENT_CONFIG = "sargo"  # "a3y17lte"  # "sargo"
-
 
+# detect platform
 PLATFORM = sys.platform
 # Define asset paths
 CONFIG_PATH = (
@@ -64,15 +63,9 @@
 
 
 class MainView(UserControl):
-    def __init__(self):
+    def __init__(self, state: AppState):
         super().__init__()
-        self.state = AppState(
-            platform=PLATFORM,
-            config_path=CONFIG_PATH,
-            bin_path=BIN_PATH,
-            test=DEVELOPMENT,
-            test_config=DEVELOPMENT_CONFIG,
-        )
+        self.state = state
         # create the main columns
         self.view = Column(expand=True, width=1200)
 
@@ -132,6 +125,18 @@ def confirm(self, e):
         self.view.update()
 
 
+def configure(page: Page):
+    """Configure the application."""
+    # Configure the application base page
+    page.title = "OpenAndroidInstaller"
+    page.window_height = 900
+    page.window_width = int(1.5 * page.window_height)
+    page.window_top = 100
+    page.window_left = 120
+    page.scroll = "adaptive"
+    page.horizontal_alignment = "center"
+
+
 def log_version_infos(bin_path):
     """Log the version infos of adb, fastboot and heimdall."""
     # adb
@@ -146,18 +151,13 @@ def log_version_infos(bin_path):
     logger.info(f"Heimdall version: {hdversion[0]}")
 
 
-def main(page: Page):
+def main(page: Page, test: bool = False, test_config: str = "sargo"):
     logger.info(f"Running OpenAndroidInstaller on {PLATFORM}")
     log_version_infos(bin_path=BIN_PATH)
     logger.info(100 * "-")
-    # Configure the application base page
-    page.title = "OpenAndroidInstaller"
-    page.window_height = 900
-    page.window_width = int(1.5 * page.window_height)
-    page.window_top = 100
-    page.window_left = 120
-    page.scroll = "adaptive"
-    page.horizontal_alignment = "center"
+
+    # configure the page
+    configure(page)
 
     # header
     page.appbar = AppBar(
@@ -203,26 +203,35 @@ def close_banner(e):
     page.banner.open = True
     page.update()
 
+    # create the State object
+    state = AppState(
+        platform=PLATFORM,
+        config_path=CONFIG_PATH,
+        bin_path=BIN_PATH,
+        test=test,
+        test_config=test_config,
+    )
     # create application instance
-    app = MainView()
-
-    # add a button that restarts the process
-    # def restart_process(e):
-    #    logger.info("Restarted the process. Reset everything.")
-    #    page.controls.pop()
-    #    app = MainView()
-    #    page.add(app)
-    #    page.update()
-
-    # page.floating_action_button = FloatingActionButton(
-    #    text="Restart the process",
-    #    icon=icons.RESTART_ALT_OUTLINED,
-    #    tooltip="You can safely restart if you missed a step or didn't make it.",
-    #    on_click=restart_process,
-    # )
+    app = MainView(state=state)
 
     # add application's root control to the page
     page.add(app)
 
 
-ft.app(target=main, assets_dir="assets")
+@click.command()
+@click.option(
+    "--test", is_flag=True, default=False, help="Start the application in testing mode."
+)
+@click.option(
+    "--test_config", default="sargo", type=str, help="Config to use for testing"
+)
+def startup(test: bool, test_config: str):
+    "Main entrypoint to the app."
+    ft.app(
+        target=functools.partial(main, test=test, test_config=test_config),
+        assets_dir="assets",
+    )
+
+
+if __name__ == "__main__":
+    startup()

openandroidinstaller/views/success_view.py

@@ -13,6 +13,7 @@
 # If not, see <https://www.gnu.org/licenses/>."""
 # Author: Tobias Sterbak
 
+import webbrowser
 from loguru import logger
 from flet import (
     ElevatedButton,
@@ -35,6 +36,10 @@ def build(
     ):
         def close_window(e):
             logger.success("Success! Close the window.")
+            # open the feedback page
+            feedback_url = "https://openandroidinstaller.org/feedback.html"
+            webbrowser.open(feedback_url)
+            # close the window
             self.page.window_close()
 
         # right view header

tests/test_app.py

@@ -0,0 +1,46 @@
+"""Test if the main app starts up."""
+
+# 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
+
+import flet as ft
+from openandroidinstaller.openandroidinstaller import main
+
+
+class MockResult:
+    def __init__(
+        self,
+    ):
+        self.results = "testtesttest"
+
+
+class MockConn:
+    def __init__(self):
+        self.page_name = "Test page"
+        self.pubsubhub = "Pub"
+
+    def send_commands(self, command, other):
+        return MockResult()
+
+
+def test_app():
+    page = ft.Page(conn=MockConn(), session_id=1)
+    # test if it would start up
+    main(page=page, test=True, test_config="sargo")
+
+    # test if you can go through all views
+    state = page.controls[0].state
+    state.load_config(device_code="sargo")
+    for _ in range(len(state.steps) + 5):
+        page.controls[0].confirm(None)
+    assert "SuccessView" in str(page.controls[0].view.controls[0])