feature: Add --rename option to rename partitions.

Includes a simple test in `test_firmware.py`.

Closes: #5

Author: glenn20

src/mp_image_tool_esp32/main.py

@@ -81,6 +81,7 @@ class TypedNamespace(argparse.Namespace):
     table: PartList
     delete: ArgList
     add: PartList
+    rename: ArgList
     resize: PartList
     erase: ArgList
     erase_fs: ArgList
@@ -131,6 +132,8 @@ class TypedNamespace(argparse.Namespace):
                         | resize partitions \
                             eg. --resize factory=2M,nvs=5B,vfs=0. \
                             If SIZE is 0, expand partition to available space
+    --rename NAME1=NEW1[,NAME2=NEW2,...] \
+                        | rename partitions, eg. --rename ffat=vfs,factory=app
     --erase NAME1[,NAME2,...] | erase the named partitions
     --erase-fs NAME1[,NAME2,...] \
                         | erase first 4 blocks of a partition on flash storage.\
@@ -295,6 +298,13 @@ def run_commands(argv: Sequence[str] | None = None) -> None:
         new_table.check()
         extension += f"-resize={args.resize}"
 
+    if args.rename:  # --rename NAME1=NEW1[,NAME2=NEW2,...] : Rename partitions
+        for name, new_name in args.rename:
+            log.action(f"Renaming partition '{name}' to '{new_name}'...")
+            new_table.rename_part(name, new_name)
+        new_table.check()
+        extension += f"-rename={args.rename}"
+
     if args.add:  # --add NAME1=SUBTYPE:OFFSET:SIZE[,..] : Add new partitions
         for name, subtype, offset, size in args.add:
             subtype = layouts.get_subtype(name, subtype)

src/mp_image_tool_esp32/partition_table.py

@@ -301,6 +301,21 @@ def resize_part(self, name: str, new_size: int) -> int:
                 self[j] = self[j]._replace(size=self.max_size - self[j].offset)
         return new_size
 
+    def rename_part(self, name: str, new_name: str) -> None:
+        """Rename a partition in the partition table.
+        Raises:
+            PartitionError: If the partition with `old_name` does not exist or
+                if `new_name` already exists in the table.
+        """
+        i = self.index(self.by_name(name))
+        if any(p for p in self if p.name == new_name):
+            raise PartitionError(
+                f"Partition '{new_name}' already exists in table.", self
+            )
+        self[i] = self[i]._replace(
+            label=new_name.encode().ljust(PART_NAME_LEN, b"\x00")
+        )
+
     def check(self, app_size: int = 0) -> None:
         """Check the partition table for consistency.
         Raises `PartError` if any inconsistencies found."""

tests/test_firmware.py

@@ -50,6 +50,10 @@ def test_resize(firmware: Path) -> None:
     mpi_check_output(firmware, "--resize vfs=1M")
 
 
+def test_rename(firmware: Path) -> None:
+    mpi_check_output(firmware, "--rename vfs=vfs2,factory=app")
+
+
 def test_add(firmware: Path) -> None:
     mpi_check_output(firmware, "--resize vfs=1M --add data=fat:50B")
 

tests/test_outputs.yaml

@@ -70,6 +70,14 @@
     factory          app      factory     0x10000   0x1f0000   0x200000   0x0   (1.9 MB)
     vfs              data     fat        0x200000   0x100000   0x300000   0x0   (1.0 MB)
 
+--rename vfs=vfs2,factory=app: |
+  Partition table (flash size: 4MB):
+  # Name             Type     SubType      Offset       Size        End Flags
+    nvs              data     nvs          0x9000     0x6000     0xf000   0x0  (24.0 kB)
+    phy_init         data     phy          0xf000     0x1000    0x10000   0x0   (4.0 kB)
+    app              app      factory     0x10000   0x1f0000   0x200000   0x0   (1.9 MB)
+    vfs2             data     fat        0x200000   0x200000   0x400000   0x0   (2.0 MB)
+
 --resize vfs=1M --add data=fat:50B: |
   Partition table (flash size: 4MB):
   # Name             Type     SubType      Offset       Size        End Flags