Skip to content

Commit

Permalink
refactor: boot_control: remove and not use the deprecated get_standby…
Browse files Browse the repository at this point in the history 
…_boot_dir API (#461)

This PR removes the deprecated boot_control API get_standby_boot_dir from boot_control implementations, as this API always returns <standby_slot_mnt>/boot since them.

Since 20230907, each boot_control implementation will not expect files under /boot dir to be directly downloaded on separated boot partition anymore. Instead, all the files, including files under /boot folder, will be saved directly to standby slot, and then the boot_control implementation takes the responsibility to copy the required files at /boot folder to separate boot partitions if any at post-update stage.

Note that this PR doesn't change create_standby implementation, which still expects boot_dir param on init, but the behavior will not change as the boot_dir param will still be provided with <standby_slot_mnt>/boot.
  • Loading branch information
@Bodong-Yang
Bodong-Yang authored Dec 20, 2024
1 parent 42e1906 commit de7d39c
Show file tree
Hide file tree
Showing 8 changed files with 8 additions and 44 deletions.
5 changes: 1 addition & 4 deletions src/otaclient/boot_control/_grub.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -848,7 +848,7 @@ def _cleanup_standby_ota_partition_folder(self):
def _copy_boot_files_from_standby_slot(self):
"""Copy boot files under <standby_slot_mp>/boot to standby ota-partition folder."""
standby_ota_partition_dir = self._ota_status_control.standby_ota_status_dir
for f in self._mp_control.standby_boot_dir.iterdir():
for f in (self._mp_control.standby_slot_mount_point / "boot").iterdir():
if f.is_file() and not f.is_symlink():
shutil.copy(f, standby_ota_partition_dir)

Expand All @@ -857,9 +857,6 @@ def _copy_boot_files_from_standby_slot(self):
def get_standby_slot_path(self) -> Path: # pragma: no cover
return self._mp_control.standby_slot_mount_point

def get_standby_boot_dir(self) -> Path: # pragma: no cover
return self._mp_control.standby_boot_dir

def load_version(self) -> str: # pragma: no cover
return self._ota_status_control.load_active_slot_version()

Expand Down
3 changes: 0 additions & 3 deletions src/otaclient/boot_control/_jetson_cboot.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -584,9 +584,6 @@ def _firmware_update(self) -> bool | None:
def get_standby_slot_path(self) -> Path: # pragma: no cover
return self._mp_control.standby_slot_mount_point

def get_standby_boot_dir(self) -> Path: # pragma: no cover
return self._mp_control.standby_boot_dir

def pre_update(self, version: str, *, standby_as_ref: bool, erase_standby: bool):
try:
logger.info("jetson-cboot: pre-update ...")
Expand Down
3 changes: 0 additions & 3 deletions src/otaclient/boot_control/_jetson_uefi.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -962,9 +962,6 @@ def _firmware_update(self) -> bool:
def get_standby_slot_path(self) -> Path: # pragma: no cover
return self._mp_control.standby_slot_mount_point

def get_standby_boot_dir(self) -> Path: # pragma: no cover
return self._mp_control.standby_boot_dir

def pre_update(self, version: str, *, standby_as_ref: bool, erase_standby: bool):
try:
logger.info("jetson-uefi: pre-update ...")
Expand Down
3 changes: 0 additions & 3 deletions src/otaclient/boot_control/_rpi_boot.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -479,9 +479,6 @@ def _write_standby_fstab(self):
def get_standby_slot_path(self) -> Path: # pragma: no cover
return self._mp_control.standby_slot_mount_point

def get_standby_boot_dir(self) -> Path: # pragma: no cover
return self._mp_control.standby_boot_dir

def pre_update(self, version: str, *, standby_as_ref: bool, erase_standby: bool):
try:
logger.info("rpi_boot: pre-update setup...")
Expand Down
12 changes: 1 addition & 11 deletions src/otaclient/boot_control/_slot_mnt_helper.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
from pathlib import Path

from otaclient.configs.cfg import cfg
from otaclient_common import cmdhelper, replace_root
from otaclient_common import cmdhelper
from otaclient_common.typing import StrOrPath

logger = logging.getLogger(__name__)
Expand All @@ -46,16 +46,6 @@ def __init__(
self.standby_slot_mount_point = Path(standby_slot_mount_point)
self.active_slot_mount_point = Path(active_slot_mount_point)

# standby slot /boot dir
# NOTE(20230907): this will always be <standby_slot_mp>/boot,
# in the future this attribute will not be used by
# standby slot creater.
self.standby_boot_dir = Path(
replace_root(
cfg.BOOT_DPATH, cfg.CANONICAL_ROOT, self.standby_slot_mount_point
)
)

# ensure the each mount points being umounted at termination
atexit.register(
partial(
Expand Down
18 changes: 0 additions & 18 deletions src/otaclient/boot_control/protocol.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@
from pathlib import Path
from typing import Protocol

from typing_extensions import deprecated

from otaclient._types import OTAStatus


Expand All @@ -39,22 +37,6 @@ def get_booted_ota_status(self) -> OTAStatus:
def get_standby_slot_path(self) -> Path:
"""Get the Path points to the standby slot mount point."""

@deprecated(
"standby slot creator doesn't need to treat the files under /boot specially"
)
@abstractmethod
def get_standby_boot_dir(self) -> Path:
"""Get the Path points to the standby slot's boot folder.
NOTE(20230907): this will always return the path to
<standby_slots_mount_point>/boot.
DEPRECATED(20230907): standby slot creator doesn't need to
treat the files under /boot specially, it is
boot controller's responsibility to get the
kernel/initrd.img from standby slot and prepare
them to actual boot dir.
"""

@abstractmethod
def load_version(self) -> str:
"""Read the version info from the current slot."""
Expand Down
7 changes: 6 additions & 1 deletion src/otaclient/ota_core.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -489,9 +489,14 @@ def _execute_update(self):
self._ota_tmp_image_meta_dir_on_standby.mkdir(exist_ok=True)

# ------ in-update ------ #
# NOTE(20230907): standby slot creator doesn't need to
# treat the files under /boot specially, it is
# boot controller's responsibility to get the
# kernel/initrd.img from standby slot and prepare
# them to actual boot dir.
standby_slot_creator = self._create_standby_cls(
ota_metadata=otameta,
boot_dir=str(self._boot_controller.get_standby_boot_dir()),
boot_dir=str(Path(cfg.STANDBY_SLOT_MNT) / "boot"),
active_slot_mount_point=cfg.ACTIVE_SLOT_MNT,
standby_slot_mount_point=cfg.STANDBY_SLOT_MNT,
status_report_queue=self._status_report_queue,
Expand Down
1 change: 0 additions & 1 deletion tests/test_otaclient/test_create_standby.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,6 @@ def mock_setup(self, mocker: MockerFixture, prepare_ab_slots):
self._boot_control = typing.cast(
BootControllerProtocol, mocker.MagicMock(spec=BootControllerProtocol)
)
self._boot_control.get_standby_boot_dir.return_value = self.slot_b_boot_dir # type: ignore

# ------ mock otaclient cfg ------ #
mocker.patch(f"{OTA_CORE_MODULE}.cfg.STANDBY_SLOT_MNT", str(self.slot_b))
Expand Down

1 comment on commit de7d39c

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage

Coverage Report
FileStmtsMissCoverMissing
src/ota_metadata/file_table
   __init__.py40100% 
   _orm.py160100% 
   _table.py80890%170, 188–193, 195
   _types.py31487%47, 54–56
src/ota_metadata/legacy
   __init__.py10100% 
   parser.py3354885%106, 170, 175, 211–212, 222–223, 226, 238, 289–291, 295–298, 324–327, 396, 399, 407–409, 422, 431–432, 435–436, 601–603, 653–654, 657, 685–686, 689–690, 692, 696, 698–699, 753, 756–758
   types.py841384%37, 40–42, 112–116, 122–125
src/ota_metadata/utils
   cert_store.py86890%58–59, 73, 87, 91, 102, 123, 127
src/ota_proxy
   __init__.py15660%48, 50, 52, 61, 71–72
   __main__.py880%16, 18–20, 22, 24–25, 27
   _consts.py170100% 
   cache_control_header.py68494%71, 91, 113, 121
   cache_streaming.py1442284%154–156, 184–186, 211, 225, 229–230, 265–266, 268, 280, 349, 355–356, 359, 367–370
   config.py200100% 
   db.py801877%103, 109, 167, 173–174, 177, 183, 185, 209–216, 218–219
   errors.py50100% 
   external_cache.py282028%31, 35, 40–42, 44–45, 48–49, 51–53, 60, 63–65, 69–72
   lru_cache_helper.py48295%95–96
   ota_cache.py2346472%71–72, 143, 146–147, 159–160, 192–193, 210, 231, 250–254, 258–260, 262, 264–271, 273–275, 278–279, 283–284, 288, 335, 343–345, 418, 445, 448–449, 471–473, 477–479, 485, 487–489, 494, 520–522, 557–559, 586, 592, 607
   server_app.py1413972%79, 82, 88, 107, 111, 170, 179, 221–222, 224–226, 229, 234–235, 238, 241–242, 245, 248, 251, 254, 267–268, 271–272, 274, 277, 303–306, 309, 323–325, 331–333
   utils.py140100% 
src/otaclient
   __init__.py5260%17, 19
   __main__.py110%16
   _logging.py513335%43–44, 46–47, 49–54, 56–57, 59–60, 62–65, 67, 77, 80–82, 84–86, 89–90, 92–96
   _otaproxy_ctx.py43430%20, 22–30, 32–37, 39, 41–42, 45, 47–51, 54–57, 60–61, 63–64, 66–68, 70, 75–79, 81
   _status_monitor.py1851492%56–57, 169, 172, 192, 195, 211–212, 220, 223, 286, 308, 325–326
   _types.py960100% 
   _utils.py30293%80–81
   errors.py120199%97
   main.py25250%17, 19–29, 31–33, 35, 37, 41–42, 44–46, 48–50
   ota_core.py34213959%121, 123–124, 128–129, 131–133, 137–138, 143–144, 150, 152, 211–214, 337, 369–370, 372, 381, 384, 389–390, 393, 399, 401–405, 412, 418, 453–456, 459–470, 473–476, 517–520, 536–537, 541–542, 608–615, 620, 623–630, 655–656, 662, 666–667, 673, 698–700, 702, 742, 764, 791–793, 802–808, 822–828, 830–831, 836–837, 845, 847, 853, 855, 861, 863, 867, 873, 875, 881, 884–886, 896–897, 908–910, 912–913, 915, 917–918, 923, 925, 930
src/otaclient/boot_control
   __init__.py40100% 
   _firmware_package.py932276%82, 86, 136, 180, 186, 209–210, 213–218, 220–221, 224–229, 231
   _grub.py41812769%214, 262–265, 271–275, 312–313, 320–325, 328–334, 337, 340–341, 346, 348–350, 359–365, 367–368, 370–372, 381–383, 385–387, 466–467, 471–472, 524, 530, 556, 578, 582–583, 598–600, 624–627, 639, 643–645, 647–649, 708–711, 736–739, 762–765, 777–778, 781–782, 817, 823, 843–844, 846, 868–870, 888–891, 916–919, 926–929, 934–942, 947–954
   _jetson_cboot.py2612610%20, 22–25, 27–29, 35–40, 42, 58–60, 62, 64–65, 71, 75, 134, 137, 139–140, 143, 150–151, 159–160, 163, 169–170, 178, 187–191, 193, 199, 202–203, 209, 212–213, 218–219, 221, 227–228, 231–232, 235–237, 239, 245, 250–252, 254–256, 261, 263–266, 268–269, 278–279, 282–283, 288–289, 292–296, 299–300, 305–306, 309, 312–316, 321–324, 327, 330–331, 334, 337–338, 341, 345–350, 354–355, 359, 362–363, 366, 369–372, 374, 377–378, 382, 385, 388–391, 393, 400, 404–405, 408–409, 415–416, 422, 424–425, 429, 431, 433–435, 438, 442, 445, 448–449, 451, 454, 462–463, 470, 480, 483, 491–492, 497–500, 502, 509, 511–513, 519–520, 524–525, 528, 532, 535, 537, 544–548, 550, 562–565, 568, 571, 573, 580, 587–589, 591, 593, 596, 599, 602, 604–605, 608–612, 616–618, 620, 628–632, 634, 637, 641, 644, 655–656, 661, 671, 674–680, 684–690, 694–703, 707–715, 719, 721, 723–725
   _jetson_common.py1724573%132, 140, 288–291, 294, 311, 319, 354, 359–364, 382, 408–409, 411–413, 417–420, 422–423, 425–429, 431, 438–439, 442–443, 453, 456–457, 460, 462, 506–507
   _jetson_uefi.py40427432%124–126, 131–132, 151–153, 158–161, 328, 446, 448–451, 455, 459–460, 462–470, 472, 484–485, 488–489, 492–493, 496–498, 502–503, 508–510, 514, 518–519, 522–523, 526–527, 531, 534–535, 537, 542–543, 547, 550–551, 556, 560–561, 564, 568–570, 572, 576–579, 581–582, 604–605, 609–610, 612, 616, 620–621, 624–625, 632, 635–637, 640, 642–643, 648–649, 652–655, 657–658, 663, 665–666, 674, 677–680, 682–683, 685, 689–690, 694, 702–706, 709–710, 712, 715–719, 722, 725–729, 733–734, 737–742, 745–746, 749–752, 754–755, 762–763, 773–776, 779, 782–785, 788–792, 795–796, 799, 802–805, 808, 810, 815–816, 819, 822–825, 827, 833, 838–839, 858–859, 862, 870–871, 878, 888, 891, 898–899, 904–907, 915–918, 926–927, 939–942, 944, 947, 950, 958, 966–968, 970–972, 974–978, 983–984, 986, 999, 1003, 1006, 1016, 1021, 1029–1030, 1033, 1037, 1039–1041, 1047–1048, 1053, 1061–1066, 1071–1076, 1081–1089, 1094–1101, 1109–1111
   _ota_status_control.py1021189%117, 122, 127, 240, 244–245, 248, 255, 257–258, 273
   _rpi_boot.py28713353%53, 56, 120–121, 125, 133–136, 150–153, 158–159, 161–162, 167–168, 171–172, 181–182, 222, 228–232, 235, 253–255, 259–261, 266–268, 272–274, 284–285, 288, 291, 293–294, 296–297, 299–301, 307, 310–311, 321–324, 332–336, 338, 340–341, 346–347, 354, 357–362, 393, 395–398, 408–411, 415–416, 418–422, 450–453, 472–475, 498–501, 506–514, 519–526, 541–544, 551–554, 562–564
   _slot_mnt_helper.py100100% 
   configs.py510100% 
   protocol.py50100% 
   selecter.py412929%44–46, 49–50, 54–55, 58–60, 63, 65, 69, 77–79, 81–82, 84–85, 89, 91, 93–94, 96, 98–99, 101, 103
src/otaclient/configs
   __init__.py170100% 
   _cfg_configurable.py470100% 
   _cfg_consts.py47197%97
   _common.py80100% 
   _ecu_info.py56492%59, 64–65, 112
   _proxy_info.py50590%84, 86–87, 89, 100
   cfg.py190100% 
src/otaclient/create_standby
   __init__.py13192%36
   common.py2264480%59, 62–63, 67–69, 71, 75–76, 78, 126, 174–176, 178–180, 182, 185–188, 192, 203, 279–280, 282–287, 299, 339, 367, 370–372, 388–389, 403, 407, 429–430
   interface.py70100% 
   rebuild_mode.py1151091%98–100, 119, 150–155
src/otaclient/grpc/api_v2
   ecu_status.py145795%117, 142, 144, 275, 347–348, 384
   ecu_tracker.py54540%17, 19–22, 24–30, 32–33, 35, 46–47, 50, 52, 58–61, 63, 65, 67–70, 77, 81–84, 88–89, 91, 93, 95–103, 107–108, 110, 112–115
   main.py41410%17, 19–24, 26–27, 29, 32, 39, 41–42, 44–45, 47–48, 50–55, 57–59, 61, 64, 70, 72–73, 76–77, 79–82, 84–85, 87
   servicer.py1169518%57–61, 63–64, 66–67, 73–77, 81–82, 87, 90, 94–96, 100–102, 110–112, 115–119, 128–138, 145, 151, 154–156, 167–169, 172–174, 179, 186–189, 192, 196–197, 202, 205, 209–211, 215–217, 225–226, 229–233, 242–251, 258, 264, 267–269, 274–275, 278
   types.py44295%78–79
src/otaclient_api/v2
   api_caller.py39684%45–47, 83–85
   types.py2563287%61, 64, 67–70, 86, 89–92, 131, 209–210, 212, 259, 262–263, 506–508, 512–513, 515, 518–519, 522–523, 578, 585–586, 588
src/otaclient_common
   __init__.py341555%42–44, 61, 63, 68–77
   _io.py64198%41
   cmdhelper.py130100% 
   common.py1061090%148, 151–153, 168, 175–177, 271, 275
   downloader.py1991094%107–108, 126, 153, 369, 424, 428, 516–517, 526
   linux.py611575%51–53, 59, 69, 74, 76, 108–109, 133–134, 190, 195–196, 198
   logging.py29196%55
   persist_file_handling.py1181884%113, 118, 150–152, 163, 192–193, 228–232, 242–244, 246–247
   proto_streamer.py42880%33, 48, 66–67, 72, 81–82, 100
   proto_wrapper.py3985785%87, 134–141, 165, 172, 184–186, 189–190, 205, 210, 221, 257, 263, 268, 299, 303, 307, 402, 462, 469, 472, 492, 499, 501, 526, 532, 535, 537, 562, 568, 571, 573, 605, 609, 611, 625, 642, 669, 672, 676, 692, 707, 713, 762–763, 765, 803–805
   retry_task_map.py129993%134–135, 153–154, 207–208, 210, 230–231
   shm_status.py952177%79–80, 83–84, 105, 120–122, 134, 139, 156–160, 169–170, 172, 179, 192, 204
   typing.py31487%48, 97–98, 100
TOTAL6824189772% 

Tests Skipped Failures Errors Time
242 0 💤 0 ❌ 0 🔥 12m 0s ⏱️

Please sign in to comment.