mDNS: test_app pytest migration

.github/workflows/test_apps.yml

@@ -0,0 +1,94 @@
+name: Build and Run Test apps
+
+on:
+   push:
+     paths:
+       - 'components/mdns/**'
+   pull_request:
+     paths:
+       - 'components/mdns/**'
+
+jobs:
+  build_mdns_app:
+    strategy:
+      matrix:
+        idf_ver: ["latest"]
+        idf_target: ["esp32", "esp32s2", "esp32c3"]
+    runs-on: ubuntu-20.04
+    container: espressif/idf:${{ matrix.idf_ver }}
+    steps:
+      - name: Checkout esp-protocols
+        uses: actions/checkout@v3
+        with:
+          submodules: recursive
+      - name: Setup Build Environment
+        working-directory: components/mdns/tests/test_apps
+        run: |
+          . ${IDF_PATH}/export.sh
+          pip install dpkt pytest idf_build_apps pytest-embedded-serial-esp
+      - name: Build ${{ matrix.example }} with IDF-${{ matrix.idf_ver }} for ${{ matrix.idf_target }}
+        env:
+          IDF_TARGET: ${{ matrix.idf_target }}
+        shell: bash
+        working-directory: components/mdns/tests/test_apps
+        run: |
+          . ${IDF_PATH}/export.sh
+          python $IDF_PATH/tools/ci/ci_build_apps.py . --target ${{ matrix.idf_target }} -vv --pytest-apps
+      - name: Merge binaries with IDF-${{ matrix.idf_ver }}
+        working-directory: components/mdns/tests/test_apps/build_${{ matrix.idf_target }}_default
+        env:
+          IDF_TARGET: ${{ matrix.idf_target }}
+        shell: bash
+        run: |
+          . ${IDF_PATH}/export.sh
+          esptool.py --chip ${{ matrix.idf_target }} merge_bin --fill-flash-size 4MB -o flash_image.bin @flash_args
+      - uses: actions/upload-artifact@v2
+        with:
+          name: examples_app_bin_${{ matrix.idf_target }}_${{ matrix.idf_ver }}
+          path: |
+            components/mdns/tests/test_apps/build_${{ matrix.idf_target }}_default/bootloader/bootloader.bin
+            components/mdns/tests/test_apps/build_${{ matrix.idf_target }}_default/partition_table/partition-table.bin
+            components/mdns/tests/test_apps/build_${{ matrix.idf_target }}_default/*.bin
+            components/mdns/tests/test_apps/build_${{ matrix.idf_target }}_default/*.elf
+            components/mdns/tests/test_apps/build_${{ matrix.idf_target }}_default/flasher_args.json
+            components/mdns/tests/test_apps/build_${{ matrix.idf_target }}_default/config/sdkconfig.h
+            components/mdns/tests/test_apps/build_${{ matrix.idf_target }}_default/config/sdkconfig.json
+          if-no-files-found: error
+
+  run-target-mdns-app:
+    strategy:
+      matrix:
+        idf_ver: ["latest"]
+        idf_target: ["esp32"]
+    name: Run mDNS Test apps on target
+    needs: build_mdns_app
+    runs-on:
+      - self-hosted
+      - ESP32-ETHERNET-KIT
+    # Skip running on forks since it won't have access to secrets
+    if: github.repository == 'espressif/esp-protocols'
+    steps:
+      - name: Clear repository
+        run: sudo rm -fr $GITHUB_WORKSPACE && mkdir $GITHUB_WORKSPACE
+      - uses: actions/checkout@v3
+      - uses: actions/download-artifact@v2
+        with:
+          name: examples_app_bin_${{ matrix.idf_target }}_${{ matrix.idf_ver }}
+          path: components/mdns/tests/test_apps/build
+      - name: Install Python packages
+        env:
+          PIP_EXTRA_INDEX_URL: "https://www.piwheels.org/simple"
+        run: |
+            sudo apt-get install -y dnsutils
+      - name: Download Test apps to target
+        run: |
+            python -m esptool --chip ${{ matrix.idf_target }} write_flash 0x0 components/mdns/tests/test_apps/build/flash_image.bin
+      - name: Run Example Test on target
+        working-directory: components/mdns/tests/test_apps
+        run: |
+            python -m pytest --log-cli-level DEBUG --junit-xml=./examples_results_${{ matrix.idf_target }}_${{ matrix.idf_ver }}.xml --target=${{matrix.idf_target}}
+      - uses: actions/upload-artifact@v2
+        if: always()
+        with:
+          name: test_apps_results_${{ matrix.idf_target }}_${{ matrix.idf_ver }}
+          path: components/mdns/tests/test_apps/*.xml

components/mdns/tests/test_apps/CMakeLists.txt

@@ -8,4 +8,4 @@ set(EXTRA_COMPONENT_DIRS ../../ ../../../../common_components/protocol_examples_
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 
-project(mdns)
+project(mdns_test_app)

components/mdns/tests/test_apps/pytest.ini

@@ -0,0 +1,26 @@
+[pytest]
+# only the files with prefix `pytest_` would be recognized as pytest test scripts.
+python_files = pytest_*.py
+
+# ignore PytestExperimentalApiWarning for record_xml_attribute
+# set traceback to "short" to prevent the overwhelming tracebacks
+addopts =
+  -s
+  --embedded-services esp,idf
+  --tb short
+  --skip-check-coredump y
+
+# ignore DeprecationWarning
+filterwarnings =
+  ignore:Call to deprecated create function (.*)\(\):DeprecationWarning
+
+# log related
+log_cli = True
+log_cli_level = INFO
+log_cli_format = %(asctime)s %(levelname)s %(message)s
+log_cli_date_format = %Y-%m-%d %H:%M:%S
+
+log_file = test.log
+log_file_level = INFO
+log_file_format = %(asctime)s %(levelname)s %(message)s
+log_file_date_format = %Y-%m-%d %H:%M:%S

components/mdns/tests/test_apps/pytest_mdns_app.py

@@ -10,8 +10,7 @@ from threading import Event, Thread
 
 import dpkt
 import dpkt.dns
-import ttfw_idf
-from tiny_test_fw.Utility import console_log
+import pytest
 
 UDP_PORT = 5353
 MCAST_GRP = '224.0.0.251'
@@ -37,6 +36,7 @@ esp_host_answered = Event()
 esp_delegated_host_answered = Event()
 
 
+@pytest.mark.skip
 # Get query of ESP32-WebServer._http._tcp.local service
 def get_mdns_service_query(service):  # type:(str) -> dpkt.dns.Msg
     dns = dpkt.dns.DNS()
@@ -49,10 +49,11 @@ def get_mdns_service_query(service):  # type:(str) -> dpkt.dns.Msg
     arr.target = socket.inet_aton('127.0.0.1')
     arr.srvname = service
     dns.qd.append(arr)
-    console_log('Created mdns service query: {} '.format(dns.__repr__()))
+    print('Created mdns service query: {} '.format(dns.__repr__()))
     return dns.pack()
 
 
+@pytest.mark.skip
 # Get query of _server_.sub._http._tcp.local sub service
 def get_mdns_sub_service_query(sub_service):  # type:(str) -> dpkt.dns.Msg
     dns = dpkt.dns.DNS()
@@ -65,11 +66,11 @@ def get_mdns_sub_service_query(sub_service):  # type:(str) -> dpkt.dns.Msg
     arr.target = socket.inet_aton('127.0.0.1')
     arr.ptrname = sub_service
     dns.qd.append(arr)
-    console_log('Created mdns subtype service query: {} '.format(
-        dns.__repr__()))
+    print('Created mdns subtype service query: {} '.format(dns.__repr__()))
     return dns.pack()
 
 
+@pytest.mark.skip
 # Get query for host resolution
 def get_dns_query_for_esp(esp_host):  # type:(str) -> dpkt.dns.Msg
     dns = dpkt.dns.DNS()
@@ -77,10 +78,11 @@ def get_dns_query_for_esp(esp_host):  # type:(str) -> dpkt.dns.Msg
     arr.cls = dpkt.dns.DNS_IN
     arr.name = esp_host + u'.local'
     dns.qd.append(arr)
-    console_log('Created query for esp host: {} '.format(dns.__repr__()))
+    print('Created query for esp host: {} '.format(dns.__repr__()))
     return dns.pack()
 
 
+@pytest.mark.skip
 # Get mdns answer for host resoloution
 def get_dns_answer_to_mdns(tester_host):  # type:(str) -> dpkt.dns.Msg
     dns = dpkt.dns.DNS()
@@ -92,10 +94,11 @@ def get_dns_answer_to_mdns(tester_host):  # type:(str) -> dpkt.dns.Msg
     arr.name = tester_host
     arr.ip = socket.inet_aton('127.0.0.1')
     dns.an.append(arr)
-    console_log('Created answer to mdns query: {} '.format(dns.__repr__()))
+    print('Created answer to mdns query: {} '.format(dns.__repr__()))
     return dns.pack()
 
 
+@pytest.mark.skip
 # Get mdns answer for service query
 def get_dns_answer_to_service_query(
         mdns_service):  # type:(str) -> dpkt.dns.Msg
@@ -112,10 +115,11 @@ def get_dns_answer_to_service_query(
     arr.srvname = mdns_service
     arr.ip = socket.inet_aton('127.0.0.1')
     dns.an.append(arr)
-    console_log('Created answer to mdns query: {} '.format(dns.__repr__()))
+    print('Created answer to mdns query: {} '.format(dns.__repr__()))
     return dns.pack()
 
 
+@pytest.mark.skip
 def mdns_listener(esp_host):  # type:(str) -> None
     print('mdns_listener thread started')
 
@@ -145,40 +149,36 @@ def mdns_listener(esp_host):  # type:(str) -> None
             # Receives queries from esp board and sends answers
             if len(dns.qd) > 0:
                 if dns.qd[0].name == HOST_NAME:
-                    console_log('Received query: {} '.format(dns.__repr__()))
+                    print('Received query: {} '.format(dns.__repr__()))
                     sock.sendto(get_dns_answer_to_mdns(HOST_NAME),
                                 (MCAST_GRP, UDP_PORT))
                 if dns.qd[0].name == HOST_NAME:
-                    console_log('Received query: {} '.format(dns.__repr__()))
+                    print('Received query: {} '.format(dns.__repr__()))
                     sock.sendto(get_dns_answer_to_mdns(HOST_NAME),
                                 (MCAST_GRP, UDP_PORT))
                 if dns.qd[0].name == MDNS_HOST_SERVICE:
-                    print(dns.qd[0].name)
-                    console_log('Received query: {} '.format(dns.__repr__()))
+                    print('Received query: {} '.format(dns.__repr__()))
                     sock.sendto(
                         get_dns_answer_to_service_query(MDNS_HOST_SERVICE),
                         (MCAST_GRP, UDP_PORT))
             # Receives answers from esp board and sets event flags for python test cases
             if len(dns.an) == 1:
                 if dns.an[0].name.startswith(SERVICE_NAME):
-                    console_log('Received answer to service query: {}'.format(
+                    print('Received answer to service query: {}'.format(
                         dns.__repr__()))
                     esp_service_answered.set()
             if len(dns.an) > 1:
                 if dns.an[1].name.startswith(SUB_SERVICE_NAME):
-                    console_log(
-                        'Received answer for sub service query: {}'.format(
+                    print('Received answer for sub service query: {}'.format(
                         dns.__repr__()))
                     esp_sub_service_answered.set()
             if len(dns.an) > 0 and dns.an[0].type == dpkt.dns.DNS_A:
                 if dns.an[0].name == esp_host + u'.local':
-                    console_log(
-                        'Received answer to esp32-mdns query: {}'.format(
+                    print('Received answer to esp32-mdns query: {}'.format(
                         dns.__repr__()))
                     esp_host_answered.set()
                 if dns.an[0].name == esp_host + u'-delegated.local':
-                    console_log(
-                        'Received answer to esp32-mdns-delegate query: {}'.
+                    print('Received answer to esp32-mdns-delegate query: {}'.
                           format(dns.__repr__()))
                     esp_delegated_host_answered.set()
         except socket.timeout:
@@ -187,6 +187,7 @@ def mdns_listener(esp_host):  # type:(str) -> None
             continue
 
 
+@pytest.mark.skip
 def create_socket():  # type:() -> socket.socket
     UDP_IP = '0.0.0.0'
     sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
@@ -199,6 +200,7 @@ def create_socket():  # type:() -> socket.socket
     return sock
 
 
+@pytest.mark.skip
 def test_query_dns_http_service(service):  # type: (str) -> None
     print('SRV: Query {}'.format(service))
     sock = create_socket()
@@ -212,6 +214,7 @@ def test_query_dns_http_service(service):  # type: (str) -> None
             'Test has failed: did not receive mdns answer within timeout')
 
 
+@pytest.mark.skip
 def test_query_dns_sub_service(sub_service):  # type: (str) -> None
     print('PTR: Query {}'.format(sub_service))
     sock = create_socket()
@@ -225,6 +228,7 @@ def test_query_dns_sub_service(sub_service):  # type: (str) -> None
             'Test has failed: did not receive mdns answer within timeout')
 
 
+@pytest.mark.skip
 def test_query_dns_host(esp_host):  # type: (str) -> None
     print('A: {}'.format(esp_host))
     sock = create_socket()
@@ -238,6 +242,7 @@ def test_query_dns_host(esp_host):  # type: (str) -> None
             'Test has failed: did not receive mdns answer within timeout')
 
 
+@pytest.mark.skip
 def test_query_dns_host_delegated(esp_host):  # type: (str) -> None
     print('A: {}'.format(esp_host))
     sock = create_socket()
@@ -251,29 +256,30 @@ def test_query_dns_host_delegated(esp_host):  # type: (str) -> None
             'Test has failed: did not receive mdns answer within timeout')
 
 
-@ttfw_idf.idf_custom_test(env_tag='Example_WIFI', group='test-apps')
-def test_app_esp_mdns(env, _):  # type: (ttfw_idf.TinyFW.Env, None) -> None
-    dut1 = env.get_dut('mdns',
-                       'tools/test_apps/protocols/mdns',
-                       dut_class=ttfw_idf.ESP32DUT)
+@pytest.mark.esp32
+@pytest.mark.esp32s2
+@pytest.mark.esp32c3
+@pytest.mark.generic
+def test_app_esp_mdns(dut):
 
-    # 1. start mdns application
-    dut1.start_app()
-    # 2. get the dut host name (and IP address)
-    specific_host = dut1.expect(
-        re.compile(r'mdns hostname set to: \[([^\]]+)\]'), timeout=30)[0]
+    # 1. get the dut host name (and IP address)
+    specific_host = dut.expect(
+        re.compile(b'mdns hostname set to: \[([^\]]+)\]'),  # noqa: W605
+        timeout=30).group(1).decode()
 
-    esp_ip = dut1.expect(
-        re.compile(r' IPv4 address: ([0-9]+\.[0-9]+\.[0-9]+\.[0-9]+)'),
-        timeout=30)
-    print('Got IP={}'.format(esp_ip[0]))
+    esp_ip = dut.expect(
+        re.compile(
+            b' IPv4 address: ([0-9]+\.[0-9]+\.[0-9]+\.[0-9]+)'),  # noqa: W605
+        timeout=30).group(1).decode()
+    print('Got IP={}'.format(esp_ip))
 
     mdns_responder = Thread(target=mdns_listener, args=(str(specific_host), ))
 
     def start_case(case, desc, result):  # type: (str, str, str) -> None
         print('Starting {}: {}'.format(case, desc))
-        dut1.write(case)
-        dut1.expect(re.compile(result), timeout=30)
+        dut.write(case)
+        res = bytes(result, encoding='utf8')
+        dut.expect(re.compile(res), timeout=30)
 
     try:
         # start dns listener thread
@@ -312,7 +318,3 @@ def test_app_esp_mdns(env, _):  # type: (ttfw_idf.TinyFW.Env, None) -> None
     finally:
         stop_mdns_listener.set()
         mdns_responder.join()
-
-
-if __name__ == '__main__':
-    test_app_esp_mdns()

components/mdns/tests/test_apps/sdkconfig.ci

@@ -0,0 +1,15 @@
+CONFIG_IDF_TARGET="esp32"
+CONFIG_MDNS_RESOLVE_TEST_SERVICES=y
+CONFIG_MDNS_ADD_MAC_TO_HOSTNAME=y
+CONFIG_MDNS_PUBLISH_DELEGATE_HOST=y
+CONFIG_LWIP_DNS_SUPPORT_MDNS_QUERIES=y
+CONFIG_EXAMPLE_CONNECT_ETHERNET=y
+CONFIG_EXAMPLE_CONNECT_WIFI=n
+CONFIG_EXAMPLE_USE_INTERNAL_ETHERNET=y
+CONFIG_EXAMPLE_ETH_PHY_IP101=y
+CONFIG_EXAMPLE_ETH_MDC_GPIO=23
+CONFIG_EXAMPLE_ETH_MDIO_GPIO=18
+CONFIG_EXAMPLE_ETH_PHY_RST_GPIO=5
+CONFIG_EXAMPLE_ETH_PHY_ADDR=1
+CONFIG_EXAMPLE_CONNECT_IPV6=y
+CONFIG_MDNS_BUTTON_GPIO=32