From 9162de1150d1ed8966647c90d59dafbd5e2d7f3d Mon Sep 17 00:00:00 2001
From: David Cermak <cermak@espressif.com>
Date: Wed, 8 Jan 2025 11:29:48 +0100
Subject: [PATCH] fix(mosq): Remove temp modification of IDF files

---
 .github/workflows/mosq__build.yml             | 20 ++++-----
 components/mosquitto/test/README.md           |  5 +++
 .../mosquitto/test/replace_decorators.py      | 42 +++++++++++++++++++
 3 files changed, 54 insertions(+), 13 deletions(-)
 create mode 100644 components/mosquitto/test/README.md
 create mode 100644 components/mosquitto/test/replace_decorators.py

diff --git a/.github/workflows/mosq__build.yml b/.github/workflows/mosq__build.yml
index 9e69a1ce2..5a12bc30f 100644
--- a/.github/workflows/mosq__build.yml
+++ b/.github/workflows/mosq__build.yml
@@ -123,25 +123,18 @@ jobs:
         run: |
           . ${IDF_PATH}/export.sh
           pip install idf-component-manager idf-build-apps --upgrade
-          export OVERRIDE_PATH=`pwd`/components/mosquitto
-          echo ${OVERRIDE_PATH}
-          sed -i '/espressif\/mosquitto:/a \ \ \ \ override_path: "${OVERRIDE_PATH}"' ${IDF_PATH}/${{matrix.test.path}}/main/idf_component.yml
-          cat ${IDF_PATH}/${{matrix.test.path}}/main/idf_component.yml
+          export MOSQUITTO_PATH=`pwd`/components/mosquitto
+          # to use the actual version of mosquitto
+          sed -i '/espressif\/mosquitto:/a \ \ \ \ override_path: "${MOSQUITTO_PATH}"' ${IDF_PATH}/${{matrix.test.path}}/main/idf_component.yml
           export PEDANTIC_FLAGS="-DIDF_CI_BUILD -Werror -Werror=deprecated-declarations -Werror=unused-variable -Werror=unused-but-set-variable -Werror=unused-function"
           export EXTRA_CFLAGS="${PEDANTIC_FLAGS} -Wstrict-prototypes"
           export EXTRA_CXXFLAGS="${PEDANTIC_FLAGS}"
           cd ${IDF_PATH}/${{matrix.test.path}}
-          sed -i  's/4096, /5\*1024, /' main/publish_connect_test.c
-          cat main/publish_connect_test.c
           idf-build-apps find --config sdkconfig.ci.local_broker -vv --target ${{ matrix.idf_target }} --build-dir=${TARGET_TEST_DIR}
           idf-build-apps build --config sdkconfig.ci.local_broker -vv --target ${{ matrix.idf_target }} --build-dir=${TARGET_TEST_DIR}
           ${GITHUB_WORKSPACE}/ci/clean_build_artifacts.sh `pwd`/${TARGET_TEST_DIR}
-          sed '/@pytest.mark.parametrize.*config.*/{
-          s/@pytest.mark.parametrize.*config.*local_broker.*/@pytest.mark.protocols/
-          t
-          d
-          }' pytest_mqtt_publish_app.py > ${TARGET_TEST_DIR}/pytest_local_mosq.py
-          cat ${TARGET_TEST_DIR}/pytest_local_mosq.py
+          # to replace mqtt test configs with specific mosquitto markers
+          python ${MOSQUITTO_PATH}/test/replace_decorators.py pytest_mqtt_publish_app.py ${TARGET_TEST_DIR}/pytest_mosquitto.py
           zip -qur ${GITHUB_WORKSPACE}/artifacts.zip ${TARGET_TEST_DIR}
       - uses: actions/upload-artifact@v4
         with:
@@ -179,5 +172,6 @@ jobs:
           rm -rf build sdkconfig.defaults
           mv $dir build
           mv build/*.py .
-          python -m pytest --log-cli-level DEBUG --junit-xml=./results_esp32_${{ matrix.idf_ver }}_${dir#"ci/build_"}.xml --target=esp32 -m protocols
+          # Run only "test_mosquitto" marked tests
+          python -m pytest --log-cli-level DEBUG --junit-xml=./results_esp32_${{ matrix.idf_ver }}_${dir#"ci/build_"}.xml --target=esp32 -m test_mosquitto
           done
diff --git a/components/mosquitto/test/README.md b/components/mosquitto/test/README.md
new file mode 100644
index 000000000..eef6b4ea5
--- /dev/null
+++ b/components/mosquitto/test/README.md
@@ -0,0 +1,5 @@
+# ESP32 mosquitto tests
+
+Mosquitto component doesn't have any tests yet, but we upcycle IDF mqtt tests and run them with the current version of mosquitto.
+For that we need to update the IDF test project's `idf_component.yml` file to reference this actual version of mosquitto.
+We also need to update some pytest decorators to run only relevant test cases. See the [replacement](./replace_decorators.py) script.
diff --git a/components/mosquitto/test/replace_decorators.py b/components/mosquitto/test/replace_decorators.py
new file mode 100644
index 000000000..6c842bedd
--- /dev/null
+++ b/components/mosquitto/test/replace_decorators.py
@@ -0,0 +1,42 @@
+# SPDX-FileCopyrightText: 2025 Espressif Systems (Shanghai) CO LTD
+# SPDX-License-Identifier: Unlicense OR CC0-1.0
+
+# This script replaces the `@pytest` decorators in the test files
+# based on the value of the `config` parameter in the `@pytest` decorator.
+# to reuse mqtt test cases for mosquitto broker.
+
+import re
+import sys
+
+
+def replace_decorators(in_file: str, out_file: str) -> None:
+    with open(in_file, 'r') as file:
+        content = file.read()
+
+    # we replace config decorators to differentiate between local mosquitto based tests
+    pattern = r"@pytest\.mark\.parametrize\(\s*'config'\s*,\s*\[\s*'(.*?)'\s*\]\s*,.*\)"
+
+    def replacement(match):
+        config_value = match.group(1)
+        if config_value == 'local_broker':
+            return '@pytest.mark.test_mosquitto'
+        else:
+            return '@pytest.mark.test_mqtt'
+
+    # Replace occurrences
+    updated_content = re.sub(pattern, replacement, content)
+
+    with open(out_file, 'w') as file:
+        file.write(updated_content)
+
+
+# Main function to handle arguments
+if __name__ == '__main__':
+    if len(sys.argv) != 3:
+        print('Usage: python replace_decorators.py <in_file> <out_file>')
+        sys.exit(1)
+
+    in_file = sys.argv[1]
+    out_file = sys.argv[2]
+    replace_decorators(in_file, out_file)
+    print(f'Replacements completed')