Improve HIL (#754)

* ci: Use job.env to avoid duplications

* ci: Add erase-region, hold-in-reset, reset and checksum-md5 tests

* ci: Use bash scripts

* cI: Update workflow

* feat: Udpate testing elfs

* test: Read 0x2000 bytes of flash

* docs: Add TODOs for issue #697

* fix: Typo

Co-authored-by: Jesse Braham <[email protected]>

* docs: Improve the todo comment

---------

Co-authored-by: Jesse Braham <[email protected]>

Author: SergioGasquez

.github/workflows/hil.yml

@@ -32,13 +32,9 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - uses: actions/checkout@v4
-        if: github.event_name != 'workflow_dispatch'
-
-      - uses: actions/checkout@v4
-        if: github.event_name == 'workflow_dispatch'
         with:
-          repository: ${{ github.event.inputs.repository }}
-          ref: ${{ github.event.inputs.branch }}
+          repository: ${{ github.event.inputs.repository || github.repository }}
+          ref: ${{ github.event.inputs.branch || github.ref }}
 
       - uses: ./.github/actions/setup-target
         with:
@@ -57,15 +53,9 @@ jobs:
 
   run-target:
     name: ${{ matrix.board.mcu }}${{ matrix.board.freq }}
-    if: ${{ github.repository_owner == 'esp-rs' }}
+    if: github.repository_owner == 'esp-rs'
     needs: build-espflash
-    runs-on:
-      [
-        self-hosted,
-        linux,
-        x64,
-        "${{ matrix.board.mcu }}${{ matrix.board.freq }}",
-      ]
+    runs-on: [self-hosted, linux, x64, "${{ matrix.board.mcu }}${{ matrix.board.freq }}"]
     strategy:
       matrix:
         board:
@@ -79,88 +69,47 @@ jobs:
           - mcu: esp32s2
           - mcu: esp32s3
       fail-fast: false
+    env:
+      ESPFLASH_PORT: /dev/serial_ports/${{ matrix.board.mcu }}
+      ESPFLASH_APP: espflash/tests/data/${{ matrix.board.mcu }}
     steps:
       - uses: actions/checkout@v4
+
       - uses: actions/download-artifact@v4
         with:
           name: espflash
           path: espflash_app
 
-      - run: chmod +x espflash_app/espflash
+      - name: Set up espflash binary
+        run: |
+          chmod +x espflash_app/espflash
+          echo "$PWD/espflash_app" >> "$GITHUB_PATH"
 
       - name: board-info test
-        env:
-          ESPFLASH_PORT: /dev/serial_ports/${{ matrix.board.mcu }}
-        shell: bash
-        run: |
-          result=$(espflash_app/espflash board-info)
-          echo "$result"
-          if [[ $? -ne 0 || ! "$result" =~ "esp32" ]]; then
-            exit 1
-          fi
+        run: bash espflash/tests/scripts/board-info.sh
 
       - name: flash test
-        env:
-          ESPFLASH_PORT: /dev/serial_ports/${{ matrix.board.mcu }}
-          ESPFLASH_APP: espflash/tests/data/${{ matrix.board.mcu }}
-        shell: bash
-        run: |
-          result=$(espflash_app/espflash flash --no-skip ${{ env.ESPFLASH_APP }} 2>&1)
-          echo "$result"
-          if [[ ! $result =~ "Flashing has completed!" ]]; then
-            exit 1
-          fi
+        run: bash espflash/tests/scripts/flash.sh ${{ env.ESPFLASH_APP }}
 
       - name: monitor test
-        env:
-          ESPFLASH_PORT: /dev/serial_ports/${{ matrix.board.mcu }}
-        shell: bash
-        run: |
-          result=$(timeout 5s espflash_app/espflash monitor --non-interactive || true)
-          echo "$result"
-          if ! echo "$result" | grep -q "Hello world!"; then
-            exit 1
-          fi
-
-      - name: erase/read flash test
-        env:
-          ESPFLASH_PORT: /dev/serial_ports/${{ matrix.board.mcu }}
-        run: |
-          result=$(espflash_app/espflash erase-flash 2>&1)
-          echo "$result"
-          if [[ ! $result =~ "Flash has been erased!" ]]; then
-            exit 1
-          fi
-          result=$(espflash_app/espflash read-flash  0 0x200 flash_content.bin 2>&1)
-          echo "$result"
-          if [[ ! $result =~ "Flash content successfully read and written to" ]]; then
-            exit 1
-          fi
-          echo "Checking if flash is empty"
-          if hexdump -v -e '/1 "%02x"' "flash_content.bin" | grep -qv '^ff*$'; then
-              exit 1
-          fi
-          echo "Flash is empty!"
+        run: bash espflash/tests/scripts/monitor.sh
+
+      - name: erase-flash test
+        run: bash espflash/tests/scripts/erase-flash.sh
 
       - name: save-image/write-bin test
-        env:
-          ESPFLASH_PORT: /dev/serial_ports/${{ matrix.board.mcu }}
-          ESPFLASH_APP: espflash/tests/data/${{ matrix.board.mcu }}
         run: |
-          result=$(espflash_app/espflash save-image --merge --chip ${{ matrix.board.mcu }} ${{ matrix.board.flag }} ${{ env.ESPFLASH_APP }} app.bin 2>&1)
-          echo "$result"
-          if [[ ! $result =~ "Image successfully saved!" ]]; then
-            exit 1
-          fi
-          echo "Writting binary"
-          result=$(espflash_app/espflash write-bin 0x0 app.bin 2>&1)
-          echo "$result"
-          if [[ ! $result =~ "Binary successfully written to flash!" ]]; then
-            exit 1
-          fi
-          echo "Monitoring..."
-          result=$(timeout 5s espflash_app/espflash monitor --non-interactive || true)
-          echo "$result"
-          if ! echo "$result" | grep -q "Hello world!"; then
-            exit 1
-          fi
+          bash espflash/tests/scripts/save-image_write-bin.sh ${{ matrix.board.mcu }} ${{ env.ESPFLASH_APP }}
+          bash espflash/tests/scripts/monitor.sh
+
+      - name: erase-region test
+        run: bash espflash/tests/scripts/erase-region.sh
+
+      - name: hold-in-reset test
+        run: bash espflash/tests/scripts/hold-in-reset.sh
+
+      - name: reset test
+        run: bash espflash/tests/scripts/reset.sh
+
+      - name: checksum-md5 test
+        run: bash espflash/tests/scripts/checksum-md5.sh

espflash/tests/data/README.md

@@ -0,0 +1,7 @@
+The elf files under this folder have been generated using `[email protected]`:
+
+```
+esp-generate --chip=$CHIP --headless $CHIP
+cd $CHIP
+cargo build --release
+```

espflash/tests/data/esp32

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+result=$(espflash board-info)
+echo "$result"
+if [[ $? -ne 0 || ! "$result" =~ "esp32" ]]; then
+    exit 1
+fi