ci: Test git patches in CI

Build and test patches documentated in the customization guide in CI
to verify that they always work.

Signed-off-by: Simen S. Røstad <simen.rostad@nordicsemi.no>

Author: simensrostad

.github/workflows/build.yml

@@ -157,6 +157,23 @@ jobs:
           version: ${{ env.VERSION }}
           path: asset-tracker-template/app
 
+    # Asset Tracker Template firmware build with patches for Thingy91x
+      - name: Apply patches for Thingy91x firmware
+        if: ${{ github.event_name != 'pull_request' }}
+        run: |
+          git apply docs/patches/magnetometer.patch
+          git apply docs/patches/dummy-module.patch
+        working-directory: asset-tracker-template/app
+
+      - name: Build patched thingy91x firmware
+        if: ${{ github.event_name != 'pull_request' }}
+        uses: ./asset-tracker-template/.github/actions/build-step
+        with:
+          board: thingy91x/nrf9151/ns
+          short_board: thingy91x
+          version: ${{ env.VERSION }}-patched
+          path: asset-tracker-template/app
+
       # Asset Tracker Template debug firmware build
       - name: Build thingy91x debug firmware
         if: ${{ github.event_name != 'pull_request' }}

.github/workflows/target-test.yml

@@ -185,6 +185,27 @@ jobs:
           MEMFAULT_PROJECT_SLUG: ${{ vars.MEMFAULT_PROJECT_SLUG }}
           APP_BUNDLEID: ${{ env.APP_BUNDLEID }}
 
+      - name: Test Patched Firmware
+        if: ${{ matrix.device == 'thingy91x' && endsWith(inputs.artifact_fw_version, '-patched') }}
+        working-directory: asset-tracker-template/tests/on_target
+        run: |
+          pytest -v \
+            --junit-xml=results/test-results-patched.xml \
+            --html=results/test-results-patched.html --self-contained-html \
+            tests/test_functional/test_patched.py
+        shell: bash
+        env:
+          SEGGER: ${{ env.RUNNER_SERIAL_NUMBER }}
+          DUT_DEVICE_TYPE: ${{ vars.DUT_DEVICE_TYPE }}
+          UUID: ${{ env.UUID }}
+          NRFCLOUD_API_KEY: ${{ secrets.NRF_CLOUD_API_KEY }}
+          LOG_FILENAME: att_test_log_patched
+          TEST_REPORT_NAME: ATT Patched Firwmare Test Report
+          MEMFAULT_ORGANIZATION_TOKEN: ${{ secrets.MEMFAULT_ORGANIZATION_TOKEN }}
+          MEMFAULT_ORGANIZATION_SLUG: ${{ vars.MEMFAULT_ORGANIZATION_SLUG }}
+          MEMFAULT_PROJECT_SLUG: ${{ vars.MEMFAULT_PROJECT_SLUG }}
+          APP_BUNDLEID: ${{ env.APP_BUNDLEID }}
+
       - name: Generate and Push Power Badge
         if: ${{ matrix.device }} == ppk_thingy91x
         continue-on-error: true

tests/on_target/tests/test_functional/test_patched.py

@@ -0,0 +1,55 @@
+##########################################################################################
+# Copyright (c) 2024 Nordic Semiconductor
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+##########################################################################################
+
+import os
+from utils.flash_tools import flash_device, reset_device
+import sys
+import pytest
+from utils.flash_tools import flash_device, reset_device
+
+sys.path.append(os.getcwd())
+from utils.logger import get_logger
+
+logger = get_logger()
+
+def test_patched_firmware(dut_board, hex_file):
+    """Test the patched firmware with magnetometer functionality."""
+    # Only run this test for thingy91x devices
+    devicetype = os.getenv("DUT_DEVICE_TYPE")
+    if devicetype != "thingy91x":
+        pytest.skip("This test is only for thingy91x devices")
+
+    # Flash the patched firmware
+    flash_device(os.path.abspath(hex_file))
+    dut_board.uart.xfactoryreset()
+
+    # Log patterns to check
+    pattern_magnetometer = "Magnetic field data:"
+    pattern_cloud = "Connected to Cloud"
+    pattern_shadow = "Requesting device shadow from the device"
+
+    # Cloud connection
+    dut_board.uart.flush()
+    reset_device()
+    dut_board.uart.wait_for_str(pattern_cloud, timeout=120)
+
+    # Wait for shadow request
+    dut_board.uart.wait_for_str(pattern_shadow, timeout=30)
+
+    # Wait for magnetometer readings
+    dut_board.uart.wait_for_str(pattern_magnetometer, timeout=30)
+
+    # Extract magnetometer values from UART output
+    values = dut_board.uart.extract_value(
+        r"Magnetic field data: X: ([\d.-]+) G, Y: ([\d.-]+) G, Z: ([\d.-]+) G"
+    )
+    assert values, "Failed to extract magnetometer values"
+
+    x, y, z = map(float, values)
+    # Basic validation of magnetometer values
+    # These ranges are typical for magnetometer readings in microtesla
+    assert -1000 <= x <= 1000, f"Magnetometer X value {x} out of expected range"
+    assert -1000 <= y <= 1000, f"Magnetometer Y value {y} out of expected range"
+    assert -1000 <= z <= 1000, f"Magnetometer Z value {z} out of expected range"