From 15870abd87a64779cdb15d7ab8a7d8d45e2230a3 Mon Sep 17 00:00:00 2001 From: Konstantin Kondrashov Date: Sat, 21 Dec 2024 12:08:27 +0200 Subject: [PATCH] feat(app_update): Adds test for invalidating OTA data slot of last boot app --- .../test_app_update/.build-test-rules.yml | 1 + .../test_app_update/main/test_switch_ota.c | 81 +++++++++++++++++++ .../test_app_update/pytest_app_update_ut.py | 16 ++++ .../test_app_update/sdkconfig.ci.rollback | 1 + 4 files changed, 99 insertions(+) create mode 100644 components/app_update/test_apps/test_app_update/sdkconfig.ci.rollback diff --git a/components/app_update/test_apps/test_app_update/.build-test-rules.yml b/components/app_update/test_apps/test_app_update/.build-test-rules.yml index c6913f0010..fd369785df 100644 --- a/components/app_update/test_apps/test_app_update/.build-test-rules.yml +++ b/components/app_update/test_apps/test_app_update/.build-test-rules.yml @@ -3,6 +3,7 @@ components/app_update/test_apps: enable: - if: CONFIG_NAME == "defaults" and IDF_TARGET in ["esp32", "esp32c2", "esp32c3", "esp32c5", "esp32c6", "esp32c61", "esp32h2", "esp32p4", "esp32s2", "esp32s3"] + - if: CONFIG_NAME == "rollback" and IDF_TARGET in ["esp32", "esp32c3", "esp32s3", "esp32p4"] - if: CONFIG_NAME == "xip_psram" and IDF_TARGET in ["esp32s2", "esp32s3", "esp32p4"] # S2 doesn't have ROM for flash - if: CONFIG_NAME == "xip_psram_with_rom_impl" and IDF_TARGET in ["esp32s3", "esp32p4"] diff --git a/components/app_update/test_apps/test_app_update/main/test_switch_ota.c b/components/app_update/test_apps/test_app_update/main/test_switch_ota.c index 0136855381..b1bbb832bd 100644 --- a/components/app_update/test_apps/test_app_update/main/test_switch_ota.c +++ b/components/app_update/test_apps/test_app_update/main/test_switch_ota.c @@ -849,3 +849,84 @@ TEST_CASE("Test bootloader_common_get_sha256_of_partition returns ESP_ERR_IMAGE_ TEST_ESP_ERR(ESP_ERR_IMAGE_INVALID, bootloader_common_get_sha256_of_partition(other_app->address, other_app->size, other_app->type, sha_256_other_app)); TEST_ASSERT_EQUAL_MEMORY_MESSAGE(sha_256_cur_app, sha_256_other_app, sizeof(sha_256_cur_app), "must be the same"); } + +static void test_rollback3(void) +{ + uint8_t boot_count = get_boot_count_from_nvs(); + boot_count++; + set_boot_count_in_nvs(boot_count); + ESP_LOGI(TAG, "boot count %d", boot_count); + const esp_partition_t *cur_app = get_running_firmware(); + const esp_partition_t* update_partition = NULL; + switch (boot_count) { + case 2: + ESP_LOGI(TAG, "Factory"); + TEST_ASSERT_EQUAL(ESP_PARTITION_SUBTYPE_APP_FACTORY, cur_app->subtype); + update_partition = app_update(); + reboot_as_deep_sleep(); + break; + case 3: + ESP_LOGI(TAG, "OTA0"); + TEST_ASSERT_EQUAL(ESP_PARTITION_SUBTYPE_APP_OTA_0, cur_app->subtype); + TEST_ESP_OK(esp_ota_mark_app_valid_cancel_rollback()); + TEST_ASSERT_NULL(esp_ota_get_last_invalid_partition()); + update_partition = app_update(); + reboot_as_deep_sleep(); + break; + case 4: + ESP_LOGI(TAG, "OTA1"); + TEST_ASSERT_EQUAL(ESP_PARTITION_SUBTYPE_APP_OTA_1, cur_app->subtype); + TEST_ESP_OK(esp_ota_mark_app_valid_cancel_rollback()); + + update_partition = esp_ota_get_next_update_partition(NULL); +#ifdef CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE + // two partitions are valid + TEST_ASSERT_NULL(esp_ota_get_last_invalid_partition()); + esp_ota_img_states_t ota_state; + TEST_ESP_OK(esp_ota_get_state_partition(update_partition, &ota_state)); + TEST_ASSERT_EQUAL(ESP_OTA_IMG_VALID, ota_state); +#endif + + esp_ota_handle_t update_handle = 0; + TEST_ESP_OK(esp_ota_begin(update_partition, OTA_SIZE_UNKNOWN, &update_handle)); + +#ifdef CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE + // After esp_ota_begin, the only one partition is valid + // ota data slots do not have an entry about the update_partition. + TEST_ESP_ERR(ESP_ERR_NOT_FOUND, esp_ota_get_state_partition(update_partition, &ota_state)); +#endif + copy_app_partition(update_handle, get_running_firmware()); + TEST_ESP_OK(esp_ota_end(update_handle)); + // esp_ota_set_boot_partition is not called, so the running app will not be changed after reboot + reboot_as_deep_sleep(); + break; + default: + erase_ota_data(); + TEST_FAIL_MESSAGE("Unexpected stage"); + break; + } +} + +static void test_rollback3_1(void) +{ + set_boot_count_in_nvs(5); + uint8_t boot_count = get_boot_count_from_nvs(); + esp_ota_img_states_t ota_state = 0x5555AAAA; + ESP_LOGI(TAG, "boot count %d", boot_count); + const esp_partition_t *cur_app = get_running_firmware(); + ESP_LOGI(TAG, "OTA1"); + TEST_ASSERT_EQUAL(ESP_PARTITION_SUBTYPE_APP_OTA_1, cur_app->subtype); + TEST_ESP_OK(esp_ota_get_state_partition(cur_app, &ota_state)); + TEST_ASSERT_EQUAL(ESP_OTA_IMG_VALID, ota_state); + + TEST_ASSERT_NULL(esp_ota_get_last_invalid_partition()); + const esp_partition_t* next_update_partition = esp_ota_get_next_update_partition(NULL); + TEST_ASSERT_NOT_NULL(next_update_partition); +#ifdef CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE + // ota data slots do not have an entry about the next_update_partition. + TEST_ESP_ERR(ESP_ERR_NOT_FOUND, esp_ota_get_state_partition(next_update_partition, &ota_state)); +#endif + erase_ota_data(); +} + +TEST_CASE_MULTIPLE_STAGES("Test rollback. Updated partition invalidated after esp_ota_begin", "[app_update][timeout=90][reset=DEEPSLEEP_RESET, DEEPSLEEP_RESET, DEEPSLEEP_RESET, SW_CPU_RESET]", start_test, test_rollback3, test_rollback3, test_rollback3, test_rollback3_1); diff --git a/components/app_update/test_apps/test_app_update/pytest_app_update_ut.py b/components/app_update/test_apps/test_app_update/pytest_app_update_ut.py index e9d9633e33..087216c2ad 100644 --- a/components/app_update/test_apps/test_app_update/pytest_app_update_ut.py +++ b/components/app_update/test_apps/test_app_update/pytest_app_update_ut.py @@ -50,3 +50,19 @@ def test_app_update_xip_psram(dut: Dut) -> None: ) def test_app_update_xip_psram_rom_impl(dut: Dut) -> None: dut.run_all_single_board_cases(timeout=90) + + +@pytest.mark.esp32 +@pytest.mark.esp32c3 +@pytest.mark.esp32s3 +@pytest.mark.esp32p4 +@pytest.mark.generic +@pytest.mark.parametrize( + 'config', + [ + 'rollback', + ], + indirect=True, +) +def test_app_update_with_rollback(dut: Dut) -> None: + dut.run_all_single_board_cases(timeout=90) diff --git a/components/app_update/test_apps/test_app_update/sdkconfig.ci.rollback b/components/app_update/test_apps/test_app_update/sdkconfig.ci.rollback new file mode 100644 index 0000000000..2303570b85 --- /dev/null +++ b/components/app_update/test_apps/test_app_update/sdkconfig.ci.rollback @@ -0,0 +1 @@ +CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE=y