Update the code for flashing additional partitions and improve the layout a bit

Author: tsterbak

doc/how_to_contribute_your_own_installation_configurations.md

@@ -16,6 +16,7 @@ Every config file should have `metadata` with the following fields:
 - `device_code`: str; The official device code.
 - `supported_device_codes`: List[str]; A list of supported device codes for the config. The config will be loaded based on this field.
 - `twrp-link`: [OPTIONAL] str; name of the corresponding twrp page.
+- `additional_steps` : [OPTIONAL] List[str]; A list of additional steps. Can be `dtbo`, `vbmeta`, `vendor_boot` or `super_empty`.
 
 In addition to these metadata, every config can have optional `requirements`. If these are set, the user is asked to check if they are meet.
 - `android`: [OPTIONAL] int|str; Android version to install prior to installing a custom ROM.
@@ -32,7 +33,7 @@ Every step in the config file corresponds to one view in the application. These
 - `img`: [OPTIONAL] Display an image on the left pane of the step view. Images are loaded from `openandroidinstaller/assets/imgs/`.
 - `content`: str; The content text displayed alongside the action of the step. Used to inform the user about what's going on. For consistency and better readability the text should be moved into the next line using `>`.
 - `link`: [OPTIONAL] Link to use for the link button if type is `link_button_with_confirm`.
-- `command`: [ONLY for call_button* steps] str; The command to run. One of `adb_reboot`, `adb_reboot_bootloader`, `adb_reboot_download`, `adb_sideload`, `adb_twrp_wipe_and_install`, `adb_twrp_copy_partitions`, `fastboot_boot_recovery`, `fastboot_unlock_with_code`, `fastboot_unlock`, `fastboot_oem_unlock`, `fastboot_get_unlock_data`, `fastboot_reboot`, `heimdall_flash_recovery`.
+- `command`: [ONLY for call_button* steps] str; The command to run. One of `adb_reboot`, `adb_reboot_bootloader`, `adb_reboot_download`, `adb_sideload`, `adb_twrp_wipe_and_install`, `adb_twrp_copy_partitions`, `fastboot_boot_recovery`, `fastboot_flash_additional_partitions`, `fastboot_unlock_with_code`, `fastboot_unlock`, `fastboot_unlock_critical`, `fastboot_oem_unlock`, `fastboot_get_unlock_data`, `fastboot_reboot`, `heimdall_flash_recovery`.
 - `allow_skip`: [OPTIONAL] boolean; If a skip button should be displayed to allow skipping this step. Can be useful when the bootloader is already unlocked.
 
 **Please try to retain this order of these fields in your config to ensure consistency.**

openandroidinstaller/tooling.py

@@ -416,7 +416,7 @@ def fastboot_boot_recovery(
 
 
 def fastboot_flash_boot(bin_path: Path, recovery: str) -> TerminalResponse:
-    """Temporarily, flash custom recovery with fastboot to boot partition."""
+    """Flash custom recovery with fastboot to boot partition."""
     logger.info("Flash custom recovery with fastboot.")
     for line in run_command(
         "fastboot flash boot", target=f"{recovery}", bin_path=bin_path
@@ -440,6 +440,54 @@ def fastboot_flash_boot(bin_path: Path, recovery: str) -> TerminalResponse:
         yield True
 
 
+@add_logging("Flash additional partitions with fastboot")
+def fastboot_flash_additional_partitions(
+    bin_path: Path, dtbo: Optional[str], vbmeta: Optional[str], super_empty: Optional[str], is_ab: bool = True
+) -> TerminalResponse:
+    """Flash additional partitions (dtbo, vbmeta, super_empty) with fastboot."""
+    logger.info("Flash additional partitions with fastboot.")
+    if dtbo:
+        logger.info("dtbo selected. Flashing dtbo partition.")
+        for line in run_command(
+            "fastboot flash dtbo ", target=f"{dtbo}", bin_path=bin_path
+        ):
+            yield line
+        if not is_ab:
+            if (type(line) == bool) and not line:
+                logger.error("Flashing dtbo failed.")
+                yield False
+            else:
+                yield True
+    else:
+        yield True
+
+    if vbmeta:
+        logger.info("vbmeta selected. Flashing vbmeta partition.")
+        for line in run_command(
+            "fastboot flash vbmeta ", target=f"{vbmeta}", bin_path=bin_path
+        ):
+            yield line
+        if not is_ab:
+            if (type(line) == bool) and not line:
+                logger.error("Flashing vbmeta failed.")
+                yield False
+            else:
+                yield True
+
+    if super_empty:
+        logger.info("super_empty selected. Wiping super partition.")
+        for line in run_command(
+            "fastboot wipe-super ", target=f"{super_empty}", bin_path=bin_path
+        ):
+            yield line
+        if not is_ab:
+            if (type(line) == bool) and not line:
+                logger.error("Wiping super failed.")
+                yield False
+            else:
+                yield True
+
+
 def heimdall_wait_for_download_available(bin_path: Path) -> bool:
     """Use heimdall detect to wait for download mode to become available on the device."""
     logger.info("Wait for download mode to become available.")
@@ -496,55 +544,4 @@ def search_device(platform: str, bin_path: Path) -> Optional[str]:
         return device_code
     except CalledProcessError:
         logger.error("Failed to detect a device.")
-        return None
-
-
-@add_logging("Flash additional partitions with fastboot")
-def fastboot_flash_additional_partitions(
-    bin_path: Path, dtbo: str, vbmeta: str, super_empty: str, is_ab: bool = True
-) -> TerminalResponse:
-    """Flash additional partitions (dtbo, vbmeta, super_empty) with fastboot."""
-    if dtbo:
-        for line in run_command(
-            "fastboot flash dtbo ", target=f"{dtbo}", bin_path=bin_path
-        ):
-            yield line
-        if not is_ab:
-            if (type(line) == bool) and not line:
-                logger.error("Flashing dtbo failed.")
-                yield False
-            else:
-                yield True
-    else:
-        logger.info("No dtbo selected. Skipping")
-        yield True
-
-    if vbmeta:
-        for line in run_command(
-            "fastboot flash vbmeta ", target=f"{vbmeta}", bin_path=bin_path
-        ):
-            yield line
-        if not is_ab:
-            if (type(line) == bool) and not line:
-                logger.error("Flashing vbmeta failed.")
-                yield False
-            else:
-                yield True
-    else:
-        logger.info("No vbmeta selected. Skipping")
-        yield True
-
-    if super_empty:
-        for line in run_command(
-            "fastboot wipe-super ", target=f"{super_empty}", bin_path=bin_path
-        ):
-            yield line
-        if not is_ab:
-            if (type(line) == bool) and not line:
-                logger.error("Wiping super failed.")
-                yield False
-            else:
-                yield True
-    else:
-        logger.info("No super_empty selected. Skipping")
-        yield True
+        return None

openandroidinstaller/utils.py

@@ -61,9 +61,10 @@ def image_works_with_device(supported_device_codes: List[str], image_path: str)
 
 
 def image_sdk_level(image_path: str) -> int:
-    """
-    Determine Android version of the selected image.
-    Android 13 : 33
+    """Determine Android version of the selected image.
+
+    Example: 
+        Android 13: 33
     """
     with zipfile.ZipFile(image_path) as image_zip:
         with image_zip.open(