Fwutil Auto-update support

fwutil/lib.py

@@ -287,6 +287,7 @@ class PlatformComponentsParser(object):
  MODULE_KEY = "module"
  COMPONENT_KEY = "component"
  FIRMWARE_KEY = "firmware"
+ UTILITY_KEY = "utility"
  VERSION_KEY = "version"
 
  UTF8_ENCODING = "utf-8"
@@ -538,8 +539,9 @@ def __validate_platform_schema(self, pcp):
  pcp.module_component_map
  )
 
- def get_status(self):
+ def get_updates_status(self):
  status_table = [ ]
+ update_status_table = [ ]
 
  append_chassis_name = self.is_chassis_has_components()
  append_module_na = not self.is_modular_chassis()
@@ -583,6 +585,17 @@ def get_status(self):
  ]
  )
 
+ update_status_table.append(
+ [
+ chassis_name,
+ module_name,
+ chassis_component_name,
+ firmware_path,
+ firmware_version,
+ status
+ ]
+ )
+
  if append_chassis_name:
  append_chassis_name = False
 
@@ -633,17 +646,41 @@ def get_status(self):
  ]
  )
 
+ update_status_table.append(
+ [
+ chassis_name,
+ module_name,
+ chassis_component_name,
+ firmware_path,
+ firmware_version,
+ status
+ ]
+ )
+
  if append_chassis_name:
  append_chassis_name = False
 
  if append_module_name:
  append_module_name = False
 
+ return status_table, update_status_table
+
+ def get_status(self):
+ status_table, update_status_table = self.get_updates_status()
  if not status_table:
  return None
 
  return tabulate(status_table, self.STATUS_HEADER, tablefmt=self.FORMAT)
 
+ def get_update_available_components(self):
+ update_available_components = []
+ status_table, update_status_table = self.get_updates_status()
+ for component_status in update_status_table:
+ if component_status[-1] is self.FW_STATUS_UPDATE_REQUIRED:
+ update_available_components.append(component_status)
+
+ return update_available_components
+
  def get_notification(self, chassis_name, module_name, component_name):
  if self.is_modular_chassis():
  component = self.module_component_map[module_name][component_name]
@@ -695,6 +732,43 @@ def update_firmware(self, chassis_name, module_name, component_name):
  log_helper.log_fw_update_end(component_path, firmware_path, False, e)
  raise
 
+ def auto_update_firmware(self, component, boot):
+ chassis_name = component[-6]
+ module_name = component[-5]
+ component_name = component[-4]
+
+ if self.is_modular_chassis():
+ component = self.module_component_map[module_name][component_name]
+ parser = self.__pcp.module_component_map[module_name][component_name]
+
+ component_path = "{}/{}/{}".format(chassis_name, module_name, component_name)
+ else:
+ component = self.chassis_component_map[chassis_name][component_name]
+ parser = self.__pcp.chassis_component_map[chassis_name][component_name]
+
+ component_path = "{}/{}".format(chassis_name, component_name)
+
+ if not parser:
+ return
+
+ firmware_path = parser[self.__pcp.FIRMWARE_KEY]
+
+ if self.__root_path is not None:
+ firmware_path = self.__root_path + firmware_path
+
+ try:
+ click.echo("Autoupdating firmware for {} with boot action {}".format(component_name, boot))
+ click.echo(TAB + firmware_path)
+ log_helper.log_fw_auto_update_start(component_path, firmware_path, boot)
+ component.auto_update_firmware(firmware_path, boot)
+ log_helper.log_fw_auto_update_end(component_path, firmware_path, True, boot)
+ except KeyboardInterrupt:
+ log_helper.log_fw_auto_update_end(component_path, firmware_path, False, "Keyboard interrupt", boot)
+ raise
+ except Exception as e:
+ log_helper.log_fw_auto_update_end(component_path, firmware_path, False, e, boot)
+ raise
+
  def is_firmware_update_available(self, chassis_name, module_name, component_name):
  if self.is_modular_chassis():
  component = self.__pcp.module_component_map[module_name][component_name]

fwutil/log.py

@@ -28,11 +28,12 @@ class LogHelper(object):
  FW_ACTION_DOWNLOAD = "download"
  FW_ACTION_INSTALL = "install"
  FW_ACTION_UPDATE = "update"
+ FW_ACTION_AUTO_UPDATE = "auto-update"
 
  STATUS_SUCCESS = "success"
  STATUS_FAILURE = "failure"
 
- def __log_fw_action_start(self, action, component, firmware):
+ def __log_fw_action_start(self, action, component, firmware, boot=None):
  caption = "Firmware {} started".format(action)
  template = "{}: component={}, firmware={}"
 
@@ -44,41 +45,77 @@ def __log_fw_action_start(self, action, component, firmware):
  )
  )
 
- def __log_fw_action_end(self, action, component, firmware, status, exception=None):
+ def __log_fw_action_end(self, action, component, firmware, status, exception=None, boot=None):
  caption = "Firmware {} ended".format(action)
 
  status_template = "{}: component={}, firmware={}, status={}"
+ status_boot_template = "{}: component={}, firmware={}, boot={}, status={}"
  exception_template = "{}: component={}, firmware={}, status={}, exception={}"
+ exception_boot_template = "{}: component={}, firmware={}, boot={}, status={}, exception={}"
 
  if status:
- log.log_info(
- status_template.format(
- caption,
- component,
- firmware,
- self.STATUS_SUCCESS
- )
- )
- else:
- if exception is None:
- log.log_error(
+ if boot is None:
+ log.log_info(
  status_template.format(
  caption,
  component,
  firmware,
- self.STATUS_FAILURE
+ self.STATUS_SUCCESS
  )
  )
  else:
- log.log_error(
- exception_template.format(
+ log.log_info(
+ status_boot_template.format(
  caption,
  component,
  firmware,
- self.STATUS_FAILURE,
- str(exception)
+ boot,
+ self.STATUS_SUCCESS
  )
  )
+ else:
+ if exception:
+ if boot is None:
+ log.log_error(
+ status_template.format(
+ caption,
+ component,
+ firmware,
+ self.STATUS_FAILURE
+ )
+ )
+ else:
+ log.log_info(
+ status_boot_template.format(
+ caption,
+ component,
+ firmware,
+ boot,
+ self.STATUS_FAILURE
+ )
+ )
+ else:
+ if boot is None:
+ log.log_error(
+ status_template.format(
+ caption,
+ component,
+ firmware,
+ self.STATUS_FAILURE,
+ str(exception)
+ )
+ )
+ else:
+ log.log_error(
+ exception_boot_template.format(
+ caption,
+ component,
+ firmware,
+ boot,
+ self.STATUS_FAILURE,
+ str(exception)
+ )
+ )
 
  def log_fw_download_start(self, component, firmware):
  self.__log_fw_action_start(self.FW_ACTION_DOWNLOAD, component, firmware)
@@ -98,6 +135,12 @@ def log_fw_update_start(self, component, firmware):
  def log_fw_update_end(self, component, firmware, status, exception=None):
  self.__log_fw_action_end(self.FW_ACTION_UPDATE, component, firmware, status, exception)
 
+ def log_fw_auto_update_start(self, component, firmware, boot):
+ self.__log_fw_action_start(self.FW_ACTION_AUTO_UPDATE, component, firmware, boot)
+
+ def log_fw_auto_update_end(self, component, firmware, status, exception=None, boot=None):
+ self.__log_fw_action_end(self.FW_ACTION_AUTO_UPDATE, component, firmware, status, exception, boot)
+
  def print_error(self, msg):
  click.echo("Error: {}.".format(msg))
 

fwutil/main.py

@@ -10,6 +10,7 @@
  import click
 
  from lib import PlatformDataProvider, ComponentStatusProvider, ComponentUpdateProvider
+ #from lib import URL, SquashFs, FwPackage
  from lib import URL, SquashFs
  from log import LogHelper
 except ImportError as e:
@@ -89,6 +90,14 @@ def update(ctx):
  ctx.obj[COMPONENT_PATH_CTX_KEY] = [ ]
 
 
+# 'auto_update' group
+@cli.group()
+@click.pass_context
+def auto_update(ctx):
+ """Auto-update platform firmware"""
+ pass
+
+
 def chassis_handler(ctx):
  ctx.obj[CHASSIS_NAME_CTX_KEY] = pdp.chassis.get_name()
  ctx.obj[COMPONENT_PATH_CTX_KEY].append(pdp.chassis.get_name())
@@ -334,6 +343,41 @@ def fw_update(ctx, yes, force, image):
  cli_abort(ctx, str(e))
 
 
+# 'fw' subcommand
+@auto_update.command(name='fw')
+@click.option('-i', '--image', 'image', type=click.Choice(["current", "next"]), default="current", show_default=True, help="Update firmware using current/next SONiC image")
+@click.option('-f', '--fw_image', 'fw_image', help="Custom FW package path")
+@click.option('-b', '--boot', 'boot', type=click.Choice(["any", "cold", "fast", "warm", "none"]), default="none", show_default=True, help="Necessary boot option after the firmware update")
+@click.pass_context
+def fw_auto_update(ctx, boot, image=None, fw_image=None):
+ """Update firmware from SONiC image"""
+ component_list = {}
+ squashfs = None
+
+ try:
+ if image == IMAGE_NEXT:
+ squashfs = SquashFs()
+
+ if squashfs.is_next_boot_set():
+ fs_path = squashfs.mount_next_image_fs()
+ cup = ComponentUpdateProvider(fs_path)
+ else:
+ log_helper.print_warning("Next boot is set to current: fallback to defaults")
+ cup = ComponentUpdateProvider()
+ else:
+ cup = ComponentUpdateProvider()
+
+ component_list = cup.get_update_available_components()
+ if component_list:
+ for component in component_list:
+ cup.auto_update_firmware(component, boot)
+ else:
+ log_helper.print_warning("All components: {}".format(cup.FW_STATUS_UP_TO_DATE))
+ finally:
+ if squashfs is not None:
+ squashfs.umount_next_image_fs()
+
+
 # 'show' subgroup
 @cli.group()
 def show():