feat(esp_delta_ota): Added pytest for the delta OTA example

1. Added pytest for the delta OTA example

Author: hrushikesh430

.github/workflows/build_and_run_apps.yml

@@ -235,7 +235,61 @@ jobs:
         run: |
           python3 .github/get_pytest_args.py --target=${{ matrix.runner.target }} -v 'build_info*.json' pytest-args.txt
           cat pytest-args.txt
-          pytest --suppress-no-test-exit-code $(cat pytest-args.txt) --ignore-glob '*/managed_components/*' --ignore=.github --junit-xml=${{ env.TEST_RESULT_FILE }} --target=${{ matrix.runner.target }} -m ${{ matrix.runner.marker }} --build-dir=build_${{ matrix.runner.target }} ${{ matrix.runner.pytest_args }}
+          pytest --suppress-no-test-exit-code $(cat pytest-args.txt) --ignore-glob '*/managed_components/*' --ignore=.github --ignore=esp_delta_ota/examples/https_delta_ota/pytest_https_delta_ota.py --junit-xml=${{ env.TEST_RESULT_FILE }} --target=${{ matrix.runner.target }} -m ${{ matrix.runner.marker }} --build-dir=build_${{ matrix.runner.target }} ${{ matrix.runner.pytest_args }}
+      - name: Upload test results
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: ${{ env.TEST_RESULT_NAME }}
+          path: ${{ env.TEST_RESULT_FILE }}
+
+  run-target-delta-ota:
+    name: Run esp_delta_ota on ESP-IDF image
+    if: github.repository_owner == 'espressif' && needs.prepare.outputs.build_only != '1'
+    needs: [build]
+    strategy:
+      fail-fast: false
+      matrix:
+        idf_ver:
+          - "release-v5.1"
+          - "release-v5.2"
+          - "release-v5.3"
+          - "release-v5.4"
+          - "release-v5.5"
+          - "latest"
+        runner:
+          - runs-on: "ESP32-ETHERNET-KIT"
+            marker: "ethernet"
+            target: "esp32"
+            runner-labels: [self-hosted, linux, docker, "ESP32-ETHERNET-KIT"]
+    env:
+      TEST_RESULT_NAME: test_results_delta_ota_${{ matrix.runner.target }}_${{ matrix.runner.marker }}_${{ matrix.idf_ver }}
+      TEST_RESULT_FILE: test_results_delta_ota_${{ matrix.runner.target }}_${{ matrix.runner.marker }}_${{ matrix.idf_ver }}.xml
+    runs-on: ${{ matrix.runner.runner-labels }}
+    container:
+      image: espressif/idf:${{ matrix.idf_ver }}
+      options: --privileged # Privileged mode has access to serial ports
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: app_binaries_${{ matrix.idf_ver }}_*
+          merge-multiple: true
+      - name: Install dependencies
+        shell: bash
+        run: |
+          export IDF_PYTHON_CHECK_CONSTRAINTS=yes
+          ${IDF_PATH}/install.sh --enable-ci
+          . ${IDF_PATH}/export.sh
+          pip install --prefer-binary cryptography pytest-embedded pytest-embedded-serial-esp pytest-embedded-idf pytest-custom_exit_code
+      - name: Run esp_delta_ota tests
+        shell: bash
+        run: |
+          . ${IDF_PATH}/export.sh
+          python3 .github/get_pytest_args.py --target=${{ matrix.runner.target }} -v 'build_info*.json' pytest-args.txt
+          cat pytest-args.txt
+          # Use build_esp*_base directory for flashing (base binary), test will find both base and new binaries for patch generation
+          pytest --suppress-no-test-exit-code $(cat pytest-args.txt) esp_delta_ota/examples/https_delta_ota/pytest_https_delta_ota.py --ignore-glob '*/managed_components/*' --ignore=.github --junit-xml=${{ env.TEST_RESULT_FILE }} --target=${{ matrix.runner.target }} -m ${{ matrix.runner.marker }} --build-dir=build_${{ matrix.runner.target }}_base
       - name: Upload test results
         uses: actions/upload-artifact@v4
         if: always()
@@ -308,6 +362,7 @@ jobs:
     name: Publish Test results
     needs:
       - run-target
+      - run-target-delta-ota
       - run-target-linux
     if: github.repository_owner == 'espressif' && always() && github.event_name == 'pull_request' && needs.prepare.outputs.build_only == '0'
     runs-on: ubuntu-22.04

esp_delta_ota/examples/https_delta_ota/CMakeLists.txt

@@ -1,7 +1,7 @@
 # The following lines of boilerplate have to be in your project's CMakeLists
 # in this exact order for cmake to work correctly
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.16)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-set(COMPONENTS main)
+set(COMPONENTS main esp_eth)
 project(https_delta_ota)

esp_delta_ota/examples/https_delta_ota/main/CMakeLists.txt

@@ -1,4 +1,4 @@
 idf_component_register(SRCS "main.c"
                     INCLUDE_DIRS "."
                     EMBED_TXTFILES ca_cert.pem
-                    PRIV_REQUIRES esp_http_client esp_partition nvs_flash app_update esp_timer esp_wifi console)
+                    PRIV_REQUIRES esp_http_client esp_partition nvs_flash app_update esp_timer esp_wifi console esp_eth)

esp_delta_ota/examples/https_delta_ota/main/Kconfig.projbuild

@@ -24,4 +24,15 @@ menu "Example Configuration"
         help
             Maximum time for reception
 
+    config EXAMPLE_FIRMWARE_UPG_URL_FROM_STDIN
+        bool
+        default y if EXAMPLE_FIRMWARE_UPG_URL = "FROM_STDIN"
+
+    config EXAMPLE_TEST_DELTA_OTA
+        bool "Enable test delta OTA success message"
+        default n
+        help
+            When enabled, app_main will log "OTA performed successfully" message.
+            This is used for testing delta OTA functionality.
+
 endmenu

esp_delta_ota/examples/https_delta_ota/main/main.c

@@ -36,6 +36,7 @@
 #define BUFFSIZE 1024
 #define PATCH_HEADER_SIZE 64
 #define DIGEST_SIZE 32
+#define OTA_URL_SIZE 256
 static uint32_t esp_delta_ota_magic = 0xfccdde10;
 
 static const char *TAG = "https_delta_ota_example";
@@ -156,6 +157,20 @@ static void ota_example_task(void *pvParameter)
     config.skip_cert_common_name_check = true;
 #endif
 
+#ifdef CONFIG_EXAMPLE_FIRMWARE_UPG_URL_FROM_STDIN
+    char url_buf[OTA_URL_SIZE];
+    if (strcmp(config.url, "FROM_STDIN") == 0) {
+        example_configure_stdin_stdout();
+        fgets(url_buf, OTA_URL_SIZE, stdin);
+        int len = strlen(url_buf);
+        url_buf[len - 1] = '\0';
+        config.url = url_buf;
+    } else {
+        ESP_LOGE(TAG, "Configuration mismatch: wrong firmware upgrade image url");
+        abort();
+    }
+#endif
+
     esp_http_client_handle_t client = esp_http_client_init(&config);
     if (client == NULL) {
         ESP_LOGE(TAG, "Failed to initialise HTTP connection");
@@ -262,6 +277,9 @@ static void ota_example_task(void *pvParameter)
 
 void app_main(void)
 {
+#ifdef CONFIG_EXAMPLE_TEST_DELTA_OTA
+    ESP_LOGI(TAG, "OTA performed successfully");
+#endif
     ESP_LOGI(TAG, "Initialising WiFi Connection...");
 
     ESP_ERROR_CHECK(nvs_flash_init());