Extending wpa supplicant mock with paf support by introducing nan simulator (project-chip#42481)

* commissioning and connectivity improvements related to wifi-paf

* brought back original signal name

* removed unused emits from NaN simulator

* removed the c-like size store

* Restyled by isort

* fixes in type hints

* cleanup in sdk files. added BSS list

* Too much changes in one PR

* Restyled by autopep8

* Removed not used signals

* Improved quality of python code

* refactor

* do not store reference to mock in wpa supplicant mock

* Updates after review:

- Tuple -> tuple
- Dict -> dict
- No timeouts
- interfaces_info -> interfaces_names

* Better python, removed not needed GVariant checks

* fix: scan done emited from scan method

* fix: moved network creation to interface to avoid indices

* Simplifications

* further simplifications

* Introducing Scanning property to WpaSupplicantMock

* Extra debug info when started scanning

* Restyled by autopep8

* fixing mypy issues

* mypy fixes - constructors

* Restyled by autopep8

* reverted constructor changes

* Update src/python_testing/matter_testing_infrastructure/matter/testing/linux/wifi.py

Co-authored-by: Arkadiusz Bokowy <arkadiusz.bokowy@gmail.com>

---------

Co-authored-by: Restyled.io <commits@restyled.io>
Co-authored-by: Arkadiusz Bokowy <arkadiusz.bokowy@gmail.com>

Author: 3 people

.github/workflows/tests.yaml

@@ -466,6 +466,28 @@ jobs:
                      --summary-file test-summaries/ble-wifi.json \
                   "
 
+            - name: Run WiFiPAF-WiFi commissioning test
+              env:
+                # Disable TSAN bug reporting, as it reports tons of (hopefully) false positives.
+                # The reason for that is WPA supplicant integration which involves GIO globals
+                # (glib internals) that TSAN does not understand...
+                TSAN_OPTIONS: report_bugs=0
+              run: |
+                  ./scripts/run_in_build_env.sh \
+                  "./scripts/tests/run_test_suite.py \
+                     --find-path $PWD/objdir-clone \
+                     --find-path $PWD/scripts \
+                     --runner chip_tool_python \
+                     --target TestOperationalState \
+                     --test-order random \
+                     run \
+                     --iterations 1 \
+                     --test-timeout-seconds 120 \
+                     --tool-path chip-tool:./objdir-clone/linux-x64-chip-tool${CHIP_TOOL_VARIANT}-${BUILD_VARIANT}/chip-tool \
+                     --app-path all-clusters:./objdir-clone/linux-x64-all-clusters-${BUILD_VARIANT}/chip-all-clusters-app \
+                     --commissioning-method wifipaf-wifi \
+                  "
+
             - name: Run Tests using matter-repl (skip slow)
               if: github.event_name == 'pull_request'
               run: |

scripts/tests/chiptest/test_definition.py

@@ -468,6 +468,7 @@ def Run(self, runner: Runner, apps_register: AppsRegister, subproc_info_repo: Su
             op_network: str = 'WiFi',
             thread_ba_host: str | None = None,
             thread_ba_port: int | None = None,
+            wifipaf_wifi: bool = False
             ):
         """
         Executes the given test case using the provided runner for execution.
@@ -476,7 +477,8 @@ def Run(self, runner: Runner, apps_register: AppsRegister, subproc_info_repo: Su
         for target in self.targets:
             log.info('Executing %s::%s', self.name, target.name)
             self._RunImpl(target, runner, apps_register, subproc_info_repo, pics_file, timeout_seconds, dry_run,
-                          test_runtime, ble_controller_app, ble_controller_tool, op_network, thread_ba_host, thread_ba_port)
+                          test_runtime, ble_controller_app, ble_controller_tool, op_network, thread_ba_host, thread_ba_port,
+                          wifipaf_wifi)
 
     def _RunImpl(self, target: TestTarget, runner: Runner, apps_register: AppsRegister, subproc_info_repo: SubprocessInfoRepo,
                  pics_file: Path, timeout_seconds: int | None, dry_run: bool = False,
@@ -485,7 +487,8 @@ def _RunImpl(self, target: TestTarget, runner: Runner, apps_register: AppsRegist
                  ble_controller_tool: int | None = None,
                  op_network: str = 'WiFi',
                  thread_ba_host: str | None = None,
-                 thread_ba_port: int | None = None):
+                 thread_ba_port: int | None = None,
+                 wifipaf_wifi: bool = False):
         runner.capture_delegate = ExecutionCapture()
 
         tool_storage_dir = None
@@ -515,6 +518,8 @@ def _RunImpl(self, target: TestTarget, runner: Runner, apps_register: AppsRegist
                         subproc = subproc.with_args("--ble-controller", str(ble_controller_app))
                         if op_network == 'WiFi':
                             subproc = subproc.with_args("--wifi")
+                    elif wifipaf_wifi:
+                        subproc = subproc.with_args("--wifi", "--wifipaf", "freq_list=2437")
 
                     app = App(runner, subproc)
                     # Add the App to the register immediately, so if it fails during
@@ -575,6 +580,9 @@ def _RunImpl(self, target: TestTarget, runner: Runner, apps_register: AppsRegist
                         pairing_cmd = pairing_cmd.with_args(
                             "pairing", "code-thread", TEST_NODE_ID, f"hex:{TEST_THREAD_DATASET}", TEST_SETUP_QR_CODE)
                         pairing_server_args = ["--ble-controller", str(ble_controller_tool)]
+                elif wifipaf_wifi:
+                    pairing_cmd = pairing_cmd.with_args("pairing", "wifipaf-wifi", TEST_NODE_ID,
+                                                        "MatterAP", "MatterAPPassword", TEST_PASSCODE, TEST_DISCRIMINATOR)
                 elif op_network == 'Thread' and thread_ba_host is not None and thread_ba_port is not None:
                     pairing_cmd = pairing_cmd.with_args(
                         "pairing", "thread-meshcop", TEST_NODE_ID, f"hex:{TEST_THREAD_DATASET}", setupCode,

scripts/tests/run_test_suite.py

@@ -297,10 +297,11 @@ class CommissioningMethod(enum.StrEnum):
     BLE_WIFI = "ble-wifi"
     BLE_THREAD = "ble-thread"
     THREAD_MESHCOP = "thread-meshcop"
+    WIFIPAF_WIFI = "wifipaf-wifi"
 
     @property
     def wifi_required(self) -> bool:
-        return self in {CommissioningMethod.BLE_WIFI}
+        return self in {CommissioningMethod.BLE_WIFI, CommissioningMethod.WIFIPAF_WIFI}
 
     @property
     def thread_required(self) -> bool:
@@ -520,20 +521,24 @@ def handle_deprecated_pathopt(key, path, kind):
 
     try:
         if sys.platform == 'linux':
+            app_name = 'wlx-app' if wifi_required else 'eth-app'
+            tool_name = 'wlx-tool' if commissioning_method == 'wifipaf-wifi' else 'eth-tool'
+
             to_terminate.append(ns := chiptest.linux.IsolatedNetworkNamespace(
                 index=0,
                 # Do not bring up the app interface link automatically when doing BLE-WiFi commissioning.
                 app_link_up=not wifi_required,
                 add_ula=not thread_required,
                 # Change the app link name so the interface will be recognized as WiFi or Ethernet
                 # depending on the commissioning method used.
-                app_link_name='wlx-app' if wifi_required else 'eth-app'))
+                app_link_name='wlx-app' if wifi_required else 'eth-app',
+                tool_link_name=tool_name))
 
             match commissioning_method:
                 case CommissioningMethod.BLE_WIFI:
                     to_terminate.append(chiptest.linux.DBusTestSystemBus())
                     to_terminate.append(chiptest.linux.BluetoothMock())
-                    to_terminate.append(chiptest.linux.WpaSupplicantMock("MatterAP", "MatterAPPassword", ns))
+                    to_terminate.append(chiptest.linux.WpaSupplicantMock([app_name], "MatterAP", "MatterAPPassword", ns))
                     ble_controller_app = 0   # Bind app to the first BLE controller
                     ble_controller_tool = 1  # Bind tool to the second BLE controller
                 case CommissioningMethod.BLE_THREAD:
@@ -546,6 +551,9 @@ def handle_deprecated_pathopt(key, path, kind):
                     to_terminate.append(tbr := chiptest.linux.ThreadBorderRouter(TEST_THREAD_DATASET, ns))
                     thread_ba_host = tbr.get_border_agent_host()
                     thread_ba_port = tbr.get_border_agent_port()
+                case CommissioningMethod.WIFIPAF_WIFI:
+                    to_terminate.append(chiptest.linux.DBusTestSystemBus())
+                    to_terminate.append(chiptest.linux.WpaSupplicantMock([app_name, tool_name], "MatterAP", "MatterAPPassword", ns))
 
             to_terminate.append(executor := chiptest.linux.LinuxNamespacedExecutor(ns))
         elif sys.platform == 'darwin':
@@ -576,6 +584,7 @@ def handle_deprecated_pathopt(key, path, kind):
                             op_network='Thread' if thread_required else 'WiFi',
                             thread_ba_host=thread_ba_host,
                             thread_ba_port=thread_ba_port,
+                            wifipaf_wifi=commissioning_method == CommissioningMethod.WIFIPAF_WIFI
                         )))
                     if result.exception is not None:
                         if isinstance(result.exception, BaseException):