Release/0.4.0 beta (#74)

This Release adds:
- install view and allow to circle back to flash a recovery
- enable selecting addons
- enable installing addons
- download buttons for Google apps, f-droid and microg

Improvements:
- typehints
- better views handling 

Fixes:
- remove error messages after retry

Author: tsterbak

Makefile

@@ -14,6 +14,9 @@ format:
 lint:
 	poetry run ruff openandroidinstaller/ --ignore E501
 
+typing:
+	poetry run mypy openandroidinstaller/. --ignore-missing-imports
+
 test: format lint
 	PYTHONPATH=openandroidinstaller:$(PYTHONPATH) poetry run pytest --cov=openandroidinstaller tests/
 

README.md

@@ -26,7 +26,7 @@
   </p>
 </div>
 
-> **Warning**: This application is currently in alpha state, so use at your own risk! While many people tested the application so far and we heard of no bricked devices, thinks might still go wrong.
+> **Warning**: This application is currently in beta state, so use at your own risk! While many people tested the application so far and we heard of no bricked devices, thinks might still go wrong.
 
 > **Note**: Unlocking the bootloader will erase all data on your device!
 This also includes your DRM keys, which are stored in the Trim Area partition (also called TA).
@@ -40,16 +40,23 @@ Linux is currently the best supported platform (tested with Ubuntu 20.04/22.04 L
 
 1. Download the AppImage, .exe or appropriate executable file for your OS. You might need to change permissions to run the executable.
     - On Windows also [install the Universal USB Drivers](https://adb.clockworkmod.com/) and other potentially drivers needed for your device.
-2. Download the custom ROM image and the TWRP recovery image for your device. A source for files can be found on the following websites:
-  - some custom ROMs:
-    - [LineageOS](https://wiki.lineageos.org/devices/)
-    - [/e/OS](https://doc.e.foundation/devices)
-    - [LineageOS for microg](https://download.lineage.microg.org/)
-    - [BlissRoms](https://blissroms.org/)
-    - [PixelExperience](https://download.pixelexperience.org/)
-  - TWRP Recovery:
-    - [TWRP recovery](https://twrp.me/Devices/)
-  - or you can just search the web or the [xda-developers forum](https://forum.xda-developers.com) for an appropriate version for your device.
+2. Download the custom ROM image and the TWRP recovery image for your device and optionally some addons. A source for files can be found on the following websites:
+    - some custom ROMs:
+      - [LineageOS](https://wiki.lineageos.org/devices/)
+      - [/e/OS](https://doc.e.foundation/devices)
+      - [LineageOS for microg](https://download.lineage.microg.org/)
+      - [BlissRoms](https://blissroms.org/)
+      - [PixelExperience](https://download.pixelexperience.org/)
+    - TWRP Recovery:
+      - [TWRP recovery](https://twrp.me/Devices/)
+    - Optional Addons:
+      - There are different packages of *Google Apps* available.
+        - [MindTheGapps](https://wiki.lineageos.org/gapps#downloads)  
+        - [NikGApps](https://nikgapps.com/)
+      - [MicroG](https://microg.org/)
+        - The recommended way to install MicroG is to use the zip file provided here: [https://github.com/FriendlyNeighborhoodShane/MinMicroG_releases/releases](https://github.com/FriendlyNeighborhoodShane/MinMicroG_releases/releases).
+      - [F-Droid App-Store](https://f-droid.org/en/packages/org.fdroid.fdroid.privileged.ota/).
+    - or you can just search the web or the [xda-developers forum](https://forum.xda-developers.com) for an appropriate version for your device.
 3. Start the desktop app and follow the instructions.
 
 
@@ -218,7 +225,7 @@ If you build the application for your platform and want to contribute the build,
 #### On unlocking the bootloader
 Devices by *Samsung*, *Google* and *Fairphone* make it fairly easy to unlock the bootloader and receive good support in the installer.
 
-Some devices with require manual steps to unlock the bootloader. In general you will need to create an account at a vendor website and receive some code from there. OpenAndroidInstaller will try to guide you as far as possible. These vendors include *Sony, Motorola, Xiaomi* among others.
+Some devices with require manual steps to unlock the bootloader. In general you will need to create an account at a vendor website and receive some code from there. OpenAndroidInstaller will try to guide you as far as possible. These vendors include *Sony, Motorola, Xiaomi* and *OnePlus* among others.
 
 Other phone vendors stops allowing to unlock the bootloader all together. There is nothing to be done if you didn't unlock your device in time. These vendors include *Huawei and LG* among others. Support for these vendors will always be very limited.
 

openandroidinstaller/app_state.py

@@ -13,7 +13,9 @@
 # If not, see <https://www.gnu.org/licenses/>."""
 # Author: Tobias Sterbak
 
+import copy
 from pathlib import Path
+from typing import List, Optional
 
 from installer_config import _load_config
 
@@ -27,7 +29,7 @@ def __init__(
         config_path: Path,
         bin_path: Path,
         test: bool = False,
-        test_config: str = None,
+        test_config: Optional[str] = None,
     ):
         self.platform = platform
         self.config_path = config_path
@@ -37,19 +39,33 @@ def __init__(
 
         # placeholders
         self.advanced = False
+        self.install_addons = False
         self.config = None
         self.image_path = None
         self.recovery_path = None
+        self.is_ab = None
 
-        # is this still needed?
-        self.steps = None
+        # store views
+        self.default_views: List = []
+        self.addon_views: List = []
+        self.final_default_views: List = []
+
+    def add_default_views(self, views: List):
+        """Add default views to store"""
+        self.default_views.extend(views)
+
+    def add_addon_views(self, views: List):
+        """Add addon views to store"""
+        self.addon_views.extend(views)
+
+    def add_final_default_views(self, views: List):
+        """Add final default views to store"""
+        self.final_default_views.extend(views)
 
     def load_config(self, device_code: str):
         """Load the config from file to state by device code."""
         self.config = _load_config(device_code, self.config_path)
         if self.config:
-            self.steps = (
-                self.config.unlock_bootloader
-                + self.config.flash_recovery
-                + self.config.install_os
+            self.steps = copy.deepcopy(self.config.unlock_bootloader) + copy.deepcopy(
+                self.config.flash_recovery
             )

openandroidinstaller/assets/configs/FP2.yaml

@@ -18,12 +18,4 @@ steps:
     - type: confirm_button 
       content: >
         Now reboot into recovery to verify the installation. Do not reboot into the existing OS, since it will overwrite the recovery you just installed!
-        With the device powered off, hold 'Volume Up + Power'. Release when boot logo appears.
-  install_os:
-    - type: call_button 
-      content: >
-        In the next steps, you finally flash the selected OS image.
-        Wait until the TWRP screen appears. Then run the command.
-        This step will format your phone and wipe all the data. It will also remove encryption and delete all files stored 
-        in the internal storage. Then the OS image will be installed. This might take a while. At the end your phone will boot into the new OS.
-      command: adb_twrp_wipe_and_install
+        With the device powered off, hold 'Volume Up + Power'. Release when boot logo appears.

openandroidinstaller/assets/configs/FP3.yaml

@@ -43,12 +43,4 @@ steps:
     - type: confirm_button 
       content: >
         Now reboot into recovery to verify the installation. Do not reboot into the existing OS, since it will overwrite the recovery you just installed!
-        With the device powered off, hold 'Volume Up + Power'. Release when boot logo appears.
-  install_os:
-    - type: call_button 
-      content: >
-        In the next steps, you finally flash the selected OS image.
-        Wait until the TWRP screen appears. Then run the command.
-        This step will format your phone and wipe all the data. It will also remove encryption and delete all files stored 
-        in the internal storage. Then the OS image will be installed. This might take a while. At the end your phone will boot into the new OS.
-      command: adb_twrp_wipe_and_install
+        With the device powered off, hold 'Volume Up + Power'. Release when boot logo appears.

openandroidinstaller/assets/configs/FP4.yaml

@@ -43,12 +43,4 @@ steps:
     - type: confirm_button 
       content: >
         Now reboot into recovery to verify the installation. Do not reboot into the existing OS, since it will overwrite the recovery you just installed!
-        With the device powered off, hold 'Volume Up + Power'. Release when boot logo appears.
-  install_os:
-    - type: call_button 
-      content: >
-        In the next steps, you finally flash the selected OS image.
-        Wait until the TWRP screen appears. Then run the command.
-        This step will format your phone and wipe all the data. It will also remove encryption and delete all files stored 
-        in the internal storage. Then the OS image will be installed. This might take a while. At the end your phone will boot into the new OS.
-      command: adb_twrp_wipe_and_install
+        With the device powered off, hold 'Volume Up + Power'. Release when boot logo appears.

openandroidinstaller/assets/configs/a3y17lte.yaml

@@ -21,12 +21,4 @@ steps:
       content: >
         Unplug the USB cable from your device. Then manually reboot into recovery by pressing the *Volume Down* + *Power buttons* for 
         8~10 seconds until the screen turns black & release the buttons immediately when it does, then boot to recovery with the device powered off, 
-        hold *Volume Up* + *Home* + *Power*. Confirm when the recovery screen appears.
-  install_os:
-    - type: call_button 
-      content: >
-        In the next steps, you finally flash the selected OS image.
-        Connect your device with your computer with the USB-Cable.
-        This step will format your phone and wipe all the data. It will also remove encryption and delete all files stored 
-        in the internal storage. Then the OS image will be installed. Confirm to run. This might take a while. At the end your phone will boot into the new OS.
-      command: adb_twrp_wipe_and_install
+        hold *Volume Up* + *Home* + *Power*. Confirm when the recovery screen appears.

openandroidinstaller/assets/configs/a5xelte.yaml

@@ -19,12 +19,4 @@ steps:
       content: >
         Unplug the USB cable from your device. Then manually reboot into recovery by pressing the *Volume Down* + *Power buttons* for 8~10 seconds 
         until the screen turns black & release the buttons immediately when it does, then boot to recovery with the device powered off, 
-        hold *Volume Up* + *Home* + *Power button*.
-  install_os:
-    - type: call_button 
-      content: >
-        In the next steps, you finally flash the selected OS image.
-        Connect your device with your computer with the USB-Cable.
-        This step will format your phone and wipe all the data. It will also remove encryption and delete all files stored 
-        in the internal storage. Then the OS image will be installed. Confirm to run. This might take a while. At the end your phone will boot into the new OS.
-      command: adb_twrp_wipe_and_install
+        hold *Volume Up* + *Home* + *Power button*.

openandroidinstaller/assets/configs/a72q.yaml

@@ -19,12 +19,4 @@ steps:
       content: >
         Unplug the USB cable from your device. Then manually reboot into recovery by pressing the *Volume Down* + *Power* for 8~10 seconds 
         until the screen turns black & release the buttons immediately when it does, then boot to recovery with the device powered off, 
-        hold *Volume Up* + *Power button*.
-  install_os:
-    - type: call_button 
-      content: >
-        In the next steps, you finally flash the selected OS image.
-        Connect your device with your computer with the USB-Cable.
-        This step will format your phone and wipe all the data. It will also remove encryption and delete all files stored 
-        in the internal storage. Then the OS image will be installed. Confirm to run. This might take a while. At the end your phone will boot into the new OS.
-      command: adb_twrp_wipe_and_install
+        hold *Volume Up* + *Power button*.

openandroidinstaller/assets/configs/a7xelte.yaml

@@ -19,12 +19,4 @@ steps:
       content: >
         Unplug the USB cable from your device. Then manually reboot into recovery by pressing the *Volume Down* + *Power buttons* for 8~10 seconds 
         until the screen turns black & release the buttons immediately when it does, then boot to recovery with the device powered off, 
-        hold *Volume Up* + *Home* + *Power button*.
-  install_os:
-    - type: call_button 
-      content: >
-        In the next steps, you finally flash the selected OS image.
-        Connect your device with your computer with the USB-Cable.
-        This step will format your phone and wipe all the data. It will also remove encryption and delete all files stored 
-        in the internal storage. Then the OS image will be installed. Confirm to run. This might take a while. At the end your phone will boot into the new OS.
-      command: adb_twrp_wipe_and_install
+        hold *Volume Up* + *Home* + *Power button*.