Joan Olguy Canéus

This commit **enhances the test coverage** for the **firmware utility's pre-upgrade operations** by adding new unit tests for `doPreUpgradeOperation()` in `FwUtilPreUpgrade.cpp`. It specifically verifies the early return path for empty command types and thoroughly tests the JTAG command type, including argument validation and the content written to a file. This **maintenance** work improves the robustness and reliability of critical pre-upgrade logic, ensuring correct behavior for various command inputs within the `FwUtil` subsystem.

This commit significantly **improves test coverage** for the **`fboss/platform/fw_util` module**, specifically targeting `FwUtilImpl.cpp`. It introduces several new unit tests in `FwUtilImplTest.cpp` to validate the behavior of functions like `printVersion` and `getFpdNameList`. These tests cover scenarios such as FPD name retrieval, case-insensitivity, invalid inputs, and version auditing, boosting coverage from 19% to 60%. This **maintenance** effort enhances the robustness and reliability of the firmware utility functionalities by ensuring their correct operation across various conditions.

This commit **enhances the test suite** for the **firmware utility version handling logic** by adding comprehensive unit tests for `FwUtilVersionHandler.cpp`. The new tests cover various scenarios, including handling "Not Applicable" versions, exceptions for non-existent devices, empty sysfs paths, and specific Darwin version printing with multiple devices. This **significantly increases code coverage** from 35% to 60%, improving the reliability and confidence in the firmware version retrieval and reporting functionality within the `fboss/platform/fw_util` module.

This commit significantly **enhances the robustness of firmware configuration validation** by adding comprehensive unit tests for the `ConfigValidator` component within the `fboss/platform/fw_util` module. This **testing and quality improvement effort** increases code coverage from 51% to 60%, ensuring more reliable parsing of firmware upgrade, read, and verify configurations. The new tests cover a wide array of invalid scenarios, such as missing arguments for tools like `flashrom` and `jtag`, empty fields, and invalid values, preventing potential runtime errors. A `BUCK` file update was also included to enable support for parameterized tests (`TEST_P`).

This commit provides a **bug fix** for **flaky tests** within the **`FwUtilFlashromTest`** suite, specifically `AddLayoutFileValid` and `AddCommonFlashromArgsWithLayout`. These tests were prone to failure when run in parallel due to a race condition caused by multiple test instances attempting to write to and delete the same hardcoded temporary file path. The fix involves modifying the test cases to generate **unique temporary file paths** using timestamps, thereby preventing interference and ensuring reliable execution. This **test maintenance** improves the overall stability and trustworthiness of the firmware utility tests.

This commit **enhances the test suite** for the **fboss platform's firmware utility helpers** by adding comprehensive unit tests for `fw_util_helpers.cpp`. Specifically, it introduces new tests for `verifySha1sum` to cover both matching and mismatching SHA1 scenarios, and for `getUpgradeToolBinaryPath` to validate its behavior when finding the upgrade tool binary, including cases where it's not found. This **maintenance work** significantly **improves code coverage** for these critical utility functions, increasing it from 22% to 60%, thereby bolstering the reliability of firmware-related operations.

This commit introduces **CMake build support** for the **Open Source Software (OSS) build system**. It specifically adds configurations within `cmake/PlatformRackmon.cmake` to enable the compilation of a **new firmware update library** and two associated **executable tools** for PSU and device updates. This work represents a **new capability** for the project's build infrastructure, allowing these critical update components to be built and integrated within an OSS environment.

This commit **adds comprehensive documentation** for the **`rack_firmware_update`** tool, located at `fboss/platform/rackmon/rack_firmware_update`. It introduces a detailed `README.md` file that covers the architecture overview, `MEI` and `Mailbox` protocol specifics, usage instructions, a troubleshooting guide, and implementation notes with examples. This **documentation enhancement** aims to significantly improve the understanding and usability of the firmware update process for developers and users interacting with this platform component.

This commit **introduces a new Mailbox protocol implementation** within the `fboss/platform/rackmon/rack_firmware_update` subsystem. It provides a robust mechanism for **Battery Backup Unit (BBU) firmware upgrades**, handling vendor-specific parameters for devices like Panasonic and Delta. The new `MailboxFirmwareUpdater` class facilitates block-by-block firmware transfer, manages boot modes, polls for status, and includes workarounds for firmware verification. This **new capability** significantly enhances the platform's ability to perform reliable and vendor-aware BBU firmware updates.

This commit introduces a **new capability** by implementing the `RackmonClient` wrapper class, which establishes and maintains a **persistent Thrift connection** to the **rackmon service**. This new **platform component** ensures that the **monitoring pause state is preserved** across various operations, which is critical for the stability and reliability of **MEI protocol firmware updates**. The `RackmonClient` provides methods for Modbus operations and explicit control over monitoring via `pauseMonitoring` and `resumeMonitoring`, streamlining interactions with the rackmon service within the `fboss/platform/rackmon/rack_firmware_update` subsystem.

This commit **enhances the build system** by **adding Buck build configurations** for the **firmware update tools** within the `fboss/platform/rackmon/rack_firmware_update` subsystem. It defines necessary Buck rules for both core utility libraries and their associated CLI tool binaries. This **infrastructure update** establishes proper dependencies on critical external libraries such as `Thrift` and `Folly`, as well as internal `rackmon` components. The change ensures that the firmware update utilities can be reliably built and integrated into the project's build pipeline.

This commit **introduces a new capability** by implementing the **Modbus Encapsulated Interface (MEI) protocol** for **Delta PSU firmware updates**. It adds the `MEIFirmwareUpdater` class, defined in `fboss/platform/rackmon/rack_firmware_update/MEIFirmwareUpdater.h` and implemented in `fboss/platform/rackmon/rack_firmware_update/MEIFirmwareUpdater.cpp`, to the **rackmon firmware update subsystem**. This new protocol handles crucial steps such as security authentication (e.g., `getChallenge`, `sendKey`), block data transfer with CRC validation (e.g., `writeData`), and post-update verification (e.g., `verifyFlash`), ensuring reliable and secure updates for **Delta rack power supply units** via a persistent `RackmonClient` connection.

This commit introduces **new API capabilities** to the **Rackmon service**, extending the `rackmonsvc.thrift` interface to support raw Modbus commands. It adds the `sendRawCommand` method to the `RackmonCtrl` service, along with new `RawCommandRequest` and `RawCommandResponse` structs. This **new feature** enables the execution of **raw Modbus commands** directly through the Thrift API, with the implementation provided in `RackmonThriftHandler.cpp` and `RackmonThriftHandler.h`. The added functionality is crucial for facilitating **firmware update operations** and advanced monitoring control for Rackmon devices.

This commit introduces a **new CLI tool**, `psu_update_delta_orv3`, specifically designed to **update firmware on Delta ORv3 Power Supply Units (PSUs)**. This **new capability** integrates into the `fboss/platform/rackmon/rack_firmware_update` subsystem, providing a robust mechanism for managing hardware. The tool utilizes the **MEI protocol** to perform essential functions such as device validation, version checking, and displaying update progress, alongside a `--list-devices` option for device discovery.

This commit introduces a **new capability** by adding the `device_update_mailbox` **CLI tool** to support **BBU firmware upgrades** using the Mailbox protocol. This tool enables firmware updates for multiple vendors, including Delta, Murata, and Flex, enhancing the platform's hardware maintenance capabilities. It incorporates essential features such as device validation, version checking, and a `--list-devices` flag for improved manageability. This addition significantly expands the **firmware management subsystem**, allowing for more robust and flexible updates of **BBU devices**.

This commit **establishes the core infrastructure for firmware updates** within the **rackmon** subsystem. It introduces the abstract base class `FirmwareUpdater` to define common interfaces for update operations, along with an `HexFileParser` for robust parsing of Intel HEX files, including checksum verification and segment handling. A comprehensive set of `UpdaterExceptions` is added for various error scenarios, complemented by `UpdaterUtils` providing essential functions for progress reporting, data conversion, and device interaction. This work represents a **new capability**, laying a common and extensible foundation for future firmware update protocols such as MEI and Mailbox.

This commit **enhances the test coverage** for the **`FwUtilFlashrom` utility** by introducing **new unit tests** for its programmer and layout configuration functionalities. Specifically, it adds tests for the `setProgrammerAndChip` and `addLayoutFile` methods within `fboss/platform/fw_util/tests/FwUtilFlashromTest.cpp`, along with a new `readFileContents` helper. To facilitate these tests, `FRIEND_TEST` declarations were added to `fboss/platform/fw_util/FwUtilImpl.h`, allowing access to private members. This **maintenance** work improves the reliability and correctness of **firmware programming and layout operations** by ensuring the utility functions behave as expected.

This commit introduces **new unit tests** for the **`FwUtil` platform utility**, specifically targeting **GPIO operations** and direct port writes. It adds four tests to `FwUtilOperationsTest.cpp` to validate the `doGpiosetOperation()`, `doGpiogetOperation()`, and `doWriteToPortOperation()` methods, covering both successful command construction and error handling for invalid GPIO chips. These tests enhance the **quality assurance** of the `FwUtil`'s hardware interaction capabilities, ensuring the correct behavior of GPIO control and byte-level port manipulation. The `FwUtilImpl.h` file was updated with `FRIEND_TEST` declarations to facilitate testing of private members. This work improves the **robustness and reliability** of the platform's low-level hardware interaction functions.

This commit **adds new unit tests** for the **firmware utility (FwUtil)**, specifically targeting the `performFlashromUpgrade` and `performFlashromRead` methods within `FwUtilFlashrom`. The tests cover critical scenarios including successful operations, dry runs, and cases where the flashrom binary is missing, thereby **enhancing the test coverage and reliability** of these flashrom operations. This work ensures the robustness of firmware upgrade and read functionalities, improving confidence in the platform's ability to manage firmware.

This commit **adds new unit tests** to the **`fboss/platform/fw_util`** module, specifically for the `getUpgradeToolBinaryPath()` and `verifySha1sum()` helper functions within `FwUtilHelpersTests.cpp`. These tests validate critical logic such as tool path resolution in `/usr/local/bin` and via environment variables, as well as accurate SHA1 checksum verification using temporary files. This **maintenance** work significantly improves the **robustness and reliability** of these firmware utility functions by ensuring their correct behavior across diverse operational scenarios.