Test for TerminalBox and absolute imports

Author: tsterbak

openandroidinstaller/app_state.py

@@ -16,7 +16,7 @@
 from pathlib import Path
 
 from flet import ProgressBar
-from installer_config import _load_config
+from openandroidinstaller.installer_config import _load_config
 
 
 class AppState:

openandroidinstaller/views/__init__.py

@@ -1,6 +1,6 @@
-from .base import BaseView  # noqa
-from .start_view import StartView  # noqa
-from .requirements_view import RequirementsView  # noqa
-from .select_view import SelectFilesView  # noqa
-from .step_view import StepView  # noqa
-from .success_view import SuccessView  # noqa
+from openandroidinstaller.views.base import BaseView  # noqa
+from openandroidinstaller.views.start_view import StartView  # noqa
+from openandroidinstaller.views.requirements_view import RequirementsView  # noqa
+from openandroidinstaller.views.select_view import SelectFilesView  # noqa
+from openandroidinstaller.views.step_view import StepView  # noqa
+from openandroidinstaller.views.success_view import SuccessView  # noqa

openandroidinstaller/views/base.py

@@ -13,7 +13,7 @@
 # If not, see <https://www.gnu.org/licenses/>."""
 # Author: Tobias Sterbak
 
-from app_state import AppState
+from openandroidinstaller.app_state import AppState
 
 from flet import (
     Column,

openandroidinstaller/views/requirements_view.py

@@ -28,9 +28,9 @@
     icons,
 )
 
-from views import BaseView
-from app_state import AppState
-from widgets import get_title
+from openandroidinstaller.views import BaseView
+from openandroidinstaller.app_state import AppState
+from openandroidinstaller.widgets import get_title
 
 
 class RequirementsView(BaseView):

openandroidinstaller/views/select_view.py

@@ -29,10 +29,13 @@
     FilePickerResultEvent,
 )
 
-from views import BaseView
-from app_state import AppState
-from widgets import get_title, confirm_button
-from utils import get_download_link, image_recovery_works_with_device
+from openandroidinstaller.views import BaseView
+from openandroidinstaller.app_state import AppState
+from openandroidinstaller.widgets import get_title, confirm_button
+from openandroidinstaller.utils import (
+    get_download_link,
+    image_recovery_works_with_device,
+)
 
 
 class SelectFilesView(BaseView):

openandroidinstaller/views/start_view.py

@@ -31,10 +31,10 @@
     icons,
 )
 
-from views import BaseView
-from app_state import AppState
-from widgets import get_title
-from tooling import search_device
+from openandroidinstaller.views import BaseView
+from openandroidinstaller.app_state import AppState
+from openandroidinstaller.widgets import get_title
+from openandroidinstaller.tooling import search_device
 
 
 class StartView(BaseView):

openandroidinstaller/views/step_view.py

@@ -16,7 +16,6 @@
 from loguru import logger
 from time import sleep
 from typing import Callable
-from pathlib import Path
 from functools import partial
 
 from flet import (
@@ -34,10 +33,10 @@
     ProgressBar,
 )
 
-from views import BaseView
-from installer_config import Step
-from app_state import AppState
-from tooling import (
+from openandroidinstaller.views import BaseView
+from openandroidinstaller.installer_config import Step
+from openandroidinstaller.app_state import AppState
+from openandroidinstaller.tooling import (
     adb_reboot,
     adb_reboot_bootloader,
     adb_reboot_download,
@@ -50,7 +49,12 @@
     fastboot_unlock_with_code,
     heimdall_flash_recovery,
 )
-from widgets import call_button, confirm_button, get_title, link_button
+from openandroidinstaller.widgets import (
+    call_button,
+    confirm_button,
+    get_title,
+    link_button,
+)
 
 
 class StepView(BaseView):
@@ -110,16 +114,18 @@ def check_advanced_switch(e):
             self.call_button = call_button(
                 self.call_to_phone, command=self.step.command
             )
-            self.right_view.controls.extend([
-                Row([self.error_text]),
-                Column(
-                    [
-                        self.advanced_switch,
-                        Row([self.call_button, self.confirm_button]),
-                    ]
-                ),
-                Row([self.terminal_box])
-            ])
+            self.right_view.controls.extend(
+                [
+                    Row([self.error_text]),
+                    Column(
+                        [
+                            self.advanced_switch,
+                            Row([self.call_button, self.confirm_button]),
+                        ]
+                    ),
+                    Row([self.terminal_box]),
+                ]
+            )
         elif self.step.type == "call_button_with_input":
             self.confirm_button.disabled = True
             self.call_button = call_button(
@@ -135,7 +141,7 @@ def check_advanced_switch(e):
                             Row([self.call_button, self.confirm_button]),
                         ]
                     ),
-                    Row([self.terminal_box])
+                    Row([self.terminal_box]),
                 ]
             )
         elif self.step.type == "link_button_with_confirm":
@@ -189,13 +195,23 @@ def call_to_phone(self, e, command: str):
             "adb_reboot_bootloader": adb_reboot_bootloader,
             "adb_reboot_download": adb_reboot_download,
             "adb_sideload": partial(adb_sideload, target=self.state.image_path),
-            "adb_twrp_wipe_and_install": partial(adb_twrp_wipe_and_install, target=self.state.image_path, config_path=self.state.config_path),
+            "adb_twrp_wipe_and_install": partial(
+                adb_twrp_wipe_and_install,
+                target=self.state.image_path,
+                config_path=self.state.config_path,
+            ),
             "fastboot_unlock": fastboot_unlock,
-            "fastboot_unlock_with_code": partial(fastboot_unlock_with_code, unlock_code=self.inputtext.value),
+            "fastboot_unlock_with_code": partial(
+                fastboot_unlock_with_code, unlock_code=self.inputtext.value
+            ),
             "fastboot_oem_unlock": fastboot_oem_unlock,
-            "fastboot_flash_recovery": partial(fastboot_flash_recovery, recovery=self.state.recovery_path),
+            "fastboot_flash_recovery": partial(
+                fastboot_flash_recovery, recovery=self.state.recovery_path
+            ),
             "fastboot_reboot": fastboot_reboot,
-            "heimdall_flash_recovery": partial(heimdall_flash_recovery, recovery=self.state.recovery_path),
+            "heimdall_flash_recovery": partial(
+                heimdall_flash_recovery, recovery=self.state.recovery_path
+            ),
         }
 
         # run the right command
@@ -229,12 +245,11 @@ def call_to_phone(self, e, command: str):
 
 
 class TerminalBox(UserControl):
-
     def __init__(self, expand: bool = True):
         super().__init__(expand=expand)
 
     def build(self):
-        self.box = Container(
+        self._box = Container(
             content=Column(scroll="auto", expand=True),
             margin=10,
             padding=10,
@@ -243,28 +258,30 @@ def build(self):
             height=300,
             border_radius=2,
             expand=True,
-            visible=False
+            visible=False,
         )
-        return self.box
+        return self._box
 
     def write_line(self, line: str):
         """
         Write the line to the window box and update.
-        
+
         Ignores empty lines.
         """
         if (type(line) == str) and line.strip():
-            self.box.content.controls.append(
-                Text(f">{line.strip()}", selectable=True)
-            )
-            self.box.update()
-    
+            self._box.content.controls.append(Text(f">{line.strip()}", selectable=True))
+            self.update()
+
     def toggle_visibility(self):
         """Toogle the visibility of the terminal box."""
-        self.box.visible = not self.box.visible
-        self.box.update()
+        self._box.visible = not self._box.visible
+        self.update()
 
     def clear(self):
         """Clear terminal output."""
-        self.box.content.controls = []
-        self.box.update()
+        self._box.content.controls = []
+        self.update()
+
+    def update(self):
+        """Update the view."""
+        self._box.update()

openandroidinstaller/views/success_view.py

@@ -20,9 +20,9 @@
     Text,
 )
 
-from views import BaseView
-from app_state import AppState
-from widgets import get_title
+from openandroidinstaller.views import BaseView
+from openandroidinstaller.app_state import AppState
+from openandroidinstaller.widgets import get_title
 
 
 class SuccessView(BaseView):

tests/test_terminal_box.py

@@ -0,0 +1,91 @@
+"""Test the TerminalBox class."""
+
+# 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 pytest
+from flet import Container, Page
+
+from openandroidinstaller.views.step_view import TerminalBox
+
+
+def test_init_box():
+    """Test if the box can be initialized properly."""
+    terminal_box = TerminalBox(expand=True)
+    build_box = terminal_box.build()
+
+    assert isinstance(build_box, Container)
+
+
+def test_write_lines(mocker):
+    """Test if we can write lines to the terminal and bools are ignored."""
+    mocker.patch(
+        "openandroidinstaller.views.step_view.TerminalBox.update",
+        return_value=True,
+        new_callable=mocker.Mock,
+    )
+
+    terminal_box = TerminalBox(expand=True)
+    _ = terminal_box.build()
+
+    # write some lines
+    for line in ["test", "test_line2", True]:
+        terminal_box.write_line(line)
+
+    # two text elements should appear
+    assert len(terminal_box._box.content.controls) == 2
+
+
+def test_toggle_visibility(mocker):
+    """Test if the visibility toggle method works."""
+    mocker.patch(
+        "openandroidinstaller.views.step_view.TerminalBox.update",
+        return_value=True,
+        new_callable=mocker.Mock,
+    )
+
+    terminal_box = TerminalBox(expand=True)
+    _ = terminal_box.build()
+
+    # should be non-visible at the beginning
+    assert terminal_box._box.visible == False
+    # now toggle
+    terminal_box.toggle_visibility()
+    # now should be visible
+    assert terminal_box._box.visible == True
+    # now toggle again
+    terminal_box.toggle_visibility()
+    # now it should be non-visible again
+    assert terminal_box._box.visible == False
+
+
+def test_clear_terminal(mocker):
+    """Test if the terminal can be cleared properly."""
+    mocker.patch(
+        "openandroidinstaller.views.step_view.TerminalBox.update",
+        return_value=True,
+        new_callable=mocker.Mock,
+    )
+
+    terminal_box = TerminalBox(expand=True)
+    _ = terminal_box.build()
+
+    # write some lines
+    for line in ["test", "test_line2", True]:
+        terminal_box.write_line(line)
+
+    # now clear
+    terminal_box.clear()
+
+    # two text elements should appear
+    assert len(terminal_box._box.content.controls) == 0