From 368be8976e8f2cc41fc348247637c40224311715 Mon Sep 17 00:00:00 2001
From: Mike Szczys <mike@golioth.io>
Date: Fri, 27 Sep 2024 17:06:39 -0500
Subject: [PATCH] hil: espidf: fix suite name for espidf samples

ESP-IDF uses the pytest-hil plugin for both integration tests and sample
tests. Add an optional --custom-suitename flag so the sample test gets a
different suite name than the default "hil." name assigned by the plugin to
all integration tests.

Signed-off-by: Mike Szczys <mike@golioth.io>
---
 .github/workflows/hil_sample_esp-idf.yml | 5 +++--
 tests/hil/scripts/pytest-hil/plugin.py   | 9 ++++++++-
 2 files changed, 11 insertions(+), 3 deletions(-)

diff --git a/.github/workflows/hil_sample_esp-idf.yml b/.github/workflows/hil_sample_esp-idf.yml
index bba9a7377..a5588adba 100644
--- a/.github/workflows/hil_sample_esp-idf.yml
+++ b/.github/workflows/hil_sample_esp-idf.yml
@@ -108,7 +108,7 @@ jobs:
           for sample in $(find examples/esp_idf -type d -name pytest -exec dirname "{}" \;)
           do
             pytest --rootdir . $sample                                          \
-              --board ${{ inputs.hil_board }}_espidf                                                   \
+              --board ${{ inputs.hil_board }}_espidf                            \
               --port ${!PORT_VAR}                                               \
               --fw-image $(basename $sample).bin                                \
               --api-url ${{ inputs.api-url }}                                   \
@@ -118,8 +118,9 @@ jobs:
               --mask-secrets                                                    \
               --timeout=600                                                     \
               --alluredir=allure-reports                                        \
-              --platform esp-idf                                                \
+              --platform=esp-idf                                                \
               --runner-name ${{ runner.name }}                                  \
+              --custom-suitename=sample                                         \
               || EXITCODE=$?
           done
           exit $EXITCODE
diff --git a/tests/hil/scripts/pytest-hil/plugin.py b/tests/hil/scripts/pytest-hil/plugin.py
index 1bbcd70f9..66754b0d9 100644
--- a/tests/hil/scripts/pytest-hil/plugin.py
+++ b/tests/hil/scripts/pytest-hil/plugin.py
@@ -27,6 +27,8 @@ def pytest_addoption(parser):
             help="Serial number to identify on-board debugger")
     parser.addoption("--bmp-port", type=str,
             help="Serial port of a BlackMagicProbe programmer")
+    parser.addoption("--custom-suitename", type=str,
+            help="Use a custom suite name when generating Allure reports")
     parser.addoption("--wifi-ssid", type=str, help="WiFi SSID")
     parser.addoption("--wifi-psk", type=str, help="WiFi PSK")
 
@@ -66,6 +68,10 @@ def bmp_port(request):
     else:
         return os.environ.get('CI_BLACKMAGICPROBE_PORT')
 
+@pytest.fixture(scope="session")
+def custom_suitename(request):
+    return request.config.getoption("--custom-suitename")
+
 @pytest.fixture(scope="session")
 def wifi_ssid(request):
     return request.config.getoption("--wifi-ssid")
@@ -106,12 +112,13 @@ async def board(board_name, port, baud, wifi_ssid, wifi_psk, fw_image, serial_nu
 def pytest_runtest_setup(item):
     board_name = item.config.getoption("--board")
     platform_name = item.config.getoption("--platform")
+    suitename = item.config.getoption("--custom-suitename") or "hil"
 
     allure.dynamic.tag(board_name)
     allure.dynamic.tag(platform_name)
     allure.dynamic.parameter("board_name", board_name)
     allure.dynamic.parameter("platform_name", platform_name)
-    allure.dynamic.parent_suite(f"hil.{platform_name}.{board_name}")
+    allure.dynamic.parent_suite(f"{suitename}.{platform_name}.{board_name}")
 
     if runner_name is not None:
         allure.dynamic.tag(item.config.getoption("--runner-name"))