Merge branch 'refactor_host_test' into 'master'

refactor: convert host test to pytest

Closes IDF-8219

See merge request espressif/esp-idf-monitor!42

.gitignore

@@ -1,6 +1,7 @@
 # IDF monitor test
-test/outputs
+test/host_test/outputs
 test/test_apps/*/build
+test/test_apps/**/build_*/
 test/test_apps/**/build_*_*/
 test/test_apps/**/sdkconfig
 test/test_apps/**/sdkconfig.old

.gitlab-ci.yml

@@ -44,7 +44,7 @@ workflow:
     - build
     - internet
   before_script:
-    - pip install -e .[dev] --prefer-binary
+    - pip install -e .[dev,host_test] --prefer-binary
 
 .build_template:
   stage: build
@@ -68,7 +68,7 @@ workflow:
 #
 .before_script_build_jobs:
   before_script:
-    - pip install .[dev,test] --prefer-binary
+    - pip install .[dev,target_test] --prefer-binary
 
 .build_pytest_template:
   stage: build
@@ -113,14 +113,10 @@ workflow:
 build_idf_latest:
   extends: .build_pytest_template
   image: espressif/idf:latest
-  variables:
-    TEST_TARGETS: "esp32 esp32s2 esp32s3 esp32c2 esp32c3 esp32c6 esp32h2"
 
 build_idf_v5.1:
   extends: .build_pytest_template
   image: espressif/idf:release-v5.1
-  variables:
-    TEST_TARGETS: "esp32 esp32s2 esp32s3 esp32c2 esp32c3"
 # ------------------------------------------------------------------------------------------------------
 
 
@@ -149,14 +145,16 @@ test_idf_monitor:
     # save artifacts always in order to access results which were retried without consequent failure
     when: always
     paths:
-      - test/outputs/*
+      - test/host_test/outputs/*
     expire_in: 1 week
   script:
-    - cd test
-    - ./run_test_idf_monitor.py
+    - cd test/host_test
+    # don't use the configuration file
+    - pytest -c /dev/null test_monitor.py
 
 .before_script_pytest_jobs:
   before_script:
+    - pip install .[target_test] --prefer-binary
     # Get ESP-IDF and install the tools (such as addr2line). We don't need the whole ESP-IDF, but it is easier for downloading required tools.
     # Dowloading just the tools would require recreating the directory structure and downloading dependencies one by one.
     - cd /opt/

esp_idf_monitor/idf_monitor.py

@@ -124,7 +124,7 @@ def __init__(
 
         if isinstance(self, SerialMonitor):
             # testing hook: when running tests, input from console is ignored
-            socket_test_mode = serial_instance.port.startswith('socket://') and os.environ.get('ESP_IDF_MONITOR_TEST') == '1'
+            socket_test_mode = os.environ.get('ESP_IDF_MONITOR_TEST') == '1'
             self.serial = serial_instance
             self.serial_reader = SerialReader(self.serial, self.event_queue, reset)  # type: Reader
 

setup.py

@@ -48,14 +48,20 @@ def get_long_description():
         'ide': [
             'websocket-client'
         ],
-        'test': [
+        'target_test': [
             'SimpleWebSocketServer',
+            'pytest',
             'pytest_embedded',
             'pytest_embedded_idf',
             'pytest_embedded_serial_esp',
             'idf_build_apps~=1.0.1',
             'idf-component-manager',
-        ]
+        ],
+        'host_test': [
+            'pytest',
+            'pytest-rerunfailures',
+            'esptool',  # for RFC2217 script
+        ],
     },
     keywords=['espressif', 'embedded', 'monitor', 'serial'],
     classifiers=[

test/host_test/conftest.py

@@ -0,0 +1,12 @@
+# SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD
+# SPDX-License-Identifier: Apache-2.0
+out_dir = ''
+
+
+def pytest_addoption(parser):
+    parser.addoption('--output', action='store', default='./outputs/', help='Output directory for writing STDOUT and STDERR from tests')
+
+
+def pytest_configure(config):
+    global out_dir
+    out_dir = config.getoption('--output')