Skip to content

[Nexthop] Distro CLI: Integration tests for device update CLI#994

Open
raghav-nexthop wants to merge 8 commits intofacebook:mainfrom
nexthop-ai:distro_cli_3.4_device_update
Open

[Nexthop] Distro CLI: Integration tests for device update CLI#994
raghav-nexthop wants to merge 8 commits intofacebook:mainfrom
nexthop-ai:distro_cli_3.4_device_update

Conversation

@raghav-nexthop
Copy link
Contributor

@raghav-nexthop raghav-nexthop commented Mar 11, 2026

Pre-submission checklist

  • I've ran the linters locally and fixed lint errors related to the files I modified in this PR. You can install the linters by running pip install -r requirements-dev.txt && pre-commit install
  • pre-commit run

Summary

This PR adds integration tests for end-to-end validation of the device update functionality. The following integration tests are added:

  • Topology initialization
  • Device connectivity
  • Service runtime status
  • Btrfs subvolume structure
  • Version tracking
  • Update workflow

Test Plan

python3 -m pytest tests/device_integration_test.py -v
============================================================== test session starts ===============================================================
platform linux -- Python 3.12.3, pytest-7.4.4, pluggy-1.4.0 -- /usr/bin/python3
cachedir: .pytest_cache
rootdir: /home/raghav/work/upstream/fboss/fboss-image/distro_cli
collected 6 items                                                                                                                                

tests/device_integration_test.py::TestDeviceTopologyIntegration::test_integration_device_has_ip PASSED                                     [ 16%]
tests/device_integration_test.py::TestDeviceTopologyIntegration::test_integration_per_service_btrfs_subvolumes PASSED                      [ 33%]
tests/device_integration_test.py::TestDeviceTopologyIntegration::test_integration_services_have_base_version PASSED                        [ 50%]
tests/device_integration_test.py::TestDeviceTopologyIntegration::test_integration_services_running PASSED                                  [ 66%]
tests/device_integration_test.py::TestDeviceTopologyIntegration::test_integration_topology_running PASSED                                  [ 83%]
tests/device_integration_test.py::TestDeviceTopologyIntegration::test_integration_update_changes_version PASSED                            [100%]

=============================================================== 6 passed in 13.26s ===============================================================

travisb-nexthop and others added 8 commits March 4, 2026 00:01
@travisb-nexthop
[Nexthop] Distro CLI: Add getip and ssh commands
bf4be96 
The Distro CLI getip and ssh commands make a best-effort attempt to
determine an IP for the given switch based on its MAC address and then
either return that IP or directly ssh to it.

It does so by connecting to the Distro Infra container and checking on
the configured interface for pre-existing IP neighbor/ARP entries. If
no such entries are found it will attempt a subnet ping to refresh the
Linux kernel neighbor entries.

In most cases this is sufficient after the system has PXE booted and
therefore the neighbor cache is filled.

Testing is as easy as starting the Distro Infra container:
```
$ ./distro_infra.sh --intf eth1 --persist-dir data
```

Then running the fboss-image device getip command with the appropriate
MAC address:
```
$ ./fboss-image device dc:da:4d:fc:ad:2d getip
[0.00s] Getting IP for device dc:da:4d:fc:ad:2d
10.250.33.2
```
@travisb-nexthop
Distro CLI image command
0b14af0 
The fboss-image device image command configures the Distro
Infrastructure to PXE boot the given image file for the given device
on the next reboot.

This replaces the manual steps previously necessary with the MVP
Distro Infrastucture.

Testing:

```
$ ./fboss-image device dc:da:4d:fc:ad:2d image nh-fboss-broadcom-xgs.tar
[0.00s] Setting image for device dc:da:4d:fc:ad:2d: nh-fboss-broadcom-xgs.tar
[0.07s] Using persistent directory: /home/travisb/work/upstream/fboss/fboss-image/distro_infra/data
[0.07s] Extracting image tarball to /home/travisb/work/upstream/fboss/fboss-image/distro_infra/data/dc-da-4d-fc-ad-2d...
[1.96s] Image extracted successfully to /home/travisb/work/upstream/fboss/fboss-image/distro_infra/data/dc-da-4d-fc-ad-2d
[1.96s] Enabling PXE boot for MAC address: dc-da-4d-fc-ad-2d
[2.09s] Successfully configured device dc:da:4d:fc:ad:2d with image nh-fboss-broadcom-xgs.tar
[2.09s] Device is ready for PXE boot
```

Then watch the switch PXE boot on the next boot:
```
>>Checking Media Presence......
>>Media Present......
>>Start PXE over IPv6 on MAC: DC-DA-4D-FC-AD-2D. Press ESC key to abort PXE boot..
  Station IP address is FC00:33:0:0:0:FB05:5030:774C
  Server IP address is FC00:33:0:0:0:0:0:1000
  NBP filename is ipxev6.efi
  NBP filesize is 1158144 Bytes

>>Checking Media Presence......
>>Media Present......
 Downloading NBP file...

  NBP file downloaded successfully.
iPXE initialising devices...
```
@travisb-nexthop
Merge remote-tracking branch 'origin/main' into distro_cli_2.2_image
086afac
@travisb-nexthop
Merge branch 'main' into distro_cli_2.2_image
60b07b2
@raghav-nexthop
Add DeviceUpdater skeleton with validation logic
ca4a933 
- Add DeviceUpdater class with component validation
- Add COMPONENT_SERVICES mapping for updatable components
- Add test manifest and unit tests for validation logic
- Stub implementations for artifact acquisition, package creation, and transfer

This is the first step in implementing device update functionality.
@raghav-nexthop
Implement DeviceUpdater update logic
eb9d7b6 
- Implement full update workflow in DeviceUpdater.update()
- Add artifact acquisition via build or download
- Add update package creation with update_service.sh script
- Add SSH-based transfer and execution on device
- Add integration with distro_infra for device IP resolution
- Add comprehensive unit tests for update workflow
- Add fboss_init.sh support for distro-base snapshot creation
@raghav-nexthop
Distro CLI: Add proxy device infrastructure for testing
44e87d6 
- Add Docker-based proxy device container simulating FBOSS services
- Add btrfs snapshot support for service root directories
- Add systemd service templates for FBOSS services
- Add device initialization and entrypoint scripts
- Update device_test.py with proxy device integration tests

This enables end-to-end testing of device update functionality.
@raghav-nexthop
Distro CLI: Add integration tests and test topology
d7c80e1 
- Add device_integration_test.py with end-to-end update tests
- Add test topology infrastructure with start.sh script
- Add integration test data (manifest, build scripts, dummy artifacts)
- Update update_service.sh to resolve symlinks for systemd RootDirectory

This completes the device update feature with integration testing.
@raghav-nexthop raghav-nexthop requested a review from a team as a code owner March 11, 2026 20:29
@meta-cla meta-cla bot added the CLA Signed label Mar 11, 2026
@raghav-nexthop raghav-nexthop marked this pull request as draft March 11, 2026 20:30
@raghav-nexthop raghav-nexthop force-pushed the distro_cli_3.4_device_update branch from d96981a to d7c80e1 Compare March 11, 2026 20:30
@raghav-nexthop raghav-nexthop marked this pull request as ready for review March 11, 2026 20:31
@raghav-nexthop raghav-nexthop marked this pull request as draft March 11, 2026 20:31
@raghav-nexthop raghav-nexthop changed the title [Nexthop] [Nexthop] Distro CLI: integration tests for device update CLI Mar 11, 2026
@raghav-nexthop raghav-nexthop changed the title [Nexthop] Distro CLI: integration tests for device update CLI [Nexthop] Distro CLI: Integration tests for device update CLI Mar 11, 2026
@raghav-nexthop raghav-nexthop marked this pull request as ready for review March 11, 2026 20:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

CLA Signed nexthop

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@raghav-nexthop @travisb-nexthop