ESPSomfy-RTS/test/e2e
cjkas 92cd54f097 fix: review fixes for the shades.cfg records
- A group in a backup from before version 23 has no rolling code, and a
  restore wrote 0 to NVS for it.  It keeps the code NVS has.
- A restore reads each record into one that starts as the shade, group
  or settings it replaces, so what an older version lacks stays as it
  was (the update check below version 20 among them), as before.
- restoreFile and loadFile read the rooms, shades and groups through one
  readModel(); the settings, network and radio are applied by helpers.
- The shade's tilt is forgotten where the shades are written, not in the
  conversion to a record.
- rollingCodeAfterLoad moves to RollingCode.h and its tests to
  test_rollingcode.
- The topics a deleted shade or group clears are one list each
  (MqttTopics.h), tested against what is published.
- e2e: a restore of the shades brings back every shade and group, and
  the README has the rollback check by hand.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-29 17:25:07 +01:00
..
conftest.py test: e2e firmware update, and restarts told apart by boot time 2026-10-29 16:59:53 +01:00
proto_client.py feat!: the token on every route, Secure Config Only goes (step 4b) 2026-10-27 23:03:59 +01:00
README.md fix: review fixes for the shades.cfg records 2026-10-29 17:25:07 +01:00
test_auth.py fix: review findings on the token key 2026-10-27 20:39:08 +01:00
test_commands.py feat: command ops for socket protocol 2 2026-10-24 13:42:41 +02:00
test_edits.py fix: edit ops second review findings 2026-10-24 18:29:34 +02:00
test_messages.py fix: protocol 2 core review findings 2026-10-24 13:17:15 +02:00
test_restore.py fix: review fixes for the shades.cfg records 2026-10-29 17:25:07 +01:00
test_routes.py fix: review fixes for the restore fix 2026-10-28 21:10:47 +01:00
test_settings.py test: e2e firmware update, and restarts told apart by boot time 2026-10-29 16:59:53 +01:00
test_survival.py test(e2e): the slot tests fill the free slots 2026-10-27 22:24:48 +01:00
test_sync.py feat!: remove the old API, ports 8081 and 8080 (step 4a) 2026-10-27 21:49:38 +01:00
test_update.py fix: review fixes for the shades.cfg records 2026-10-29 17:25:07 +01:00

e2e suite

Runs against a real device on your network, by hand, never in CI. It checks socket protocol 2 (PROTOCOL.md) and that the device survives the loads that used to run its heap out.

~/.platformio/penv/Scripts/uv run --no-project --with pytest -- pytest test/e2e --device 192.168.1.120
Option Use
--device the device's address (required)
--password, --username / --pin the credentials of a Secured device
--radio --shade <id> also send real commands: that shade moves a little and back
--edit also add a room and delete it again
--reboot also reboot the device and wait for it to come back, and restore the settings from a backup taken a moment before (it changes the NTP server, which the restore puts back), and restore the radio settings alone
--firmware <firmware.bin> also update the device to that firmware, built for its chip, and check it is still running a minute later, after it marks the update good. Needs a build with an OTA slot
--lockout on a Secured device, also fail /login until this PC is refused, then wait out the 30 s lockout
--record save hello, the sync and the schema to test/fixtures/proto2/, for the web UI and Home Assistant tests

A plain run sends nothing on air, changes no setting (it saves only values the device already has) and doesn't reboot the device. The command tests send ops that are refused before they reach the radio, and one setPositions that sets a shade to the position the sync gave: that drops the fraction of a percent the shade's believed position may have had. The edit tests send edits that are refused, and one shade sort order set to the order it has, which saves the shades again unchanged. The settings tests send saves that are refused, and one that saves the NTP server and time zone the device already has. The restore test sends options that aren't JSON with a file that isn't a backup, so nothing is restored. The frequency scan test pauses the radio's sending for a second or two, as a scan does. It does fill every socket slot for a few seconds, and replays a page load.

The web UI holds one of the device's 5 socket slots for each open tab, and Home Assistant holds one. The tests that fill every slot fill the ones left, so close the UI's tabs for the full load.

A rollback is checked by hand, on a release build with an OTA slot:

  1. Note the version the web UI shows.
  2. Build firmware that restarts before it is marked good: add abort(); at the end of setup() in src/SomfyController.cpp, and change data-src/appversion so the two versions differ.
  3. Update to it through the web UI, with the serial monitor open.
  4. The crash restarts the device, and the bootloader boots the old firmware (ADR 0003). The web UI shows the version from step 1 again.

The tests run in whatever security mode the device is in; the suite never changes it. To test both modes, run the suite once in each.