adding backend support for nfc-wifi command

[ArnoldBraine]

Summary

Adding support for nfc-wifi using the reference pull requests from @OlivierGre

• Add nfc-thread pairing mode #185

• Change to be able to use NFC Commissioning in YAML test. #201

• Disable Polkit in chip-cert-bins #269

[CLAassistant]

All committers have signed the CLA.

[gemini-code-assist]

Summary of Changes

Hello @ArnoldBraine, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces full backend support for NFC-WiFi commissioning, enabling devices to be paired using a combination of Near Field Communication and Wi-Fi. The changes integrate this new pairing mode across various utility functions, configuration enums, and testing frameworks, ensuring a robust and testable implementation for NFC-WiFi based device commissioning.

Highlights

• New Pairing Mode: Added NFC_WIFI as a new device under test (DUT) pairing mode in the DutPairingModeEnum.
• Backend Support for NFC-WiFi: Implemented comprehensive backend support for NFC-WiFi pairing, including handling WiFi SSID and passphrase arguments for commissioning commands.
• MatterYAMLRunner Extension: Introduced a new pairing_nfc_wifi asynchronous method in MatterYAMLRunner to facilitate NFC-WiFi pairing commands.
• Chip Suite Integration: Extended the chip_suite to correctly handle NFC-WiFi pairing, including disabling polkit for PCSC reader usage in Docker environments when this pairing mode is active.
• New Test Cases: Added dedicated unit tests (test_generate_command_arguments_nfc_wifi and test_pairing_NFC_wifi_command_params) to ensure the correct functionality and parameter generation for NFC-WiFi pairing.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• test_collections/matter/sdk_tests/support/python_testing/models/utils.py
  • Extended generate_command_arguments to include NFC_WIFI when appending WiFi SSID and passphrase arguments.
• test_collections/matter/sdk_tests/support/tests/python_tests/test_utils.py
  • Added test_generate_command_arguments_nfc_wifi to verify command argument generation for NFC-WiFi pairing.
• test_collections/matter/sdk_tests/support/tests/yaml_tests/test_matter_yaml_runner.py
  • Added test_pairing_NFC_wifi_command_params to validate the command parameters generated for NFC-WiFi pairing.
• test_collections/matter/sdk_tests/support/yaml_tests/matter_yaml_runner.py
  • Defined PAIRING_MODE_NFC_WIFI constant.
  • Implemented the pairing_nfc_wifi asynchronous method to handle NFC-WiFi pairing logic.
• test_collections/matter/sdk_tests/support/yaml_tests/models/chip_suite.py
  • Modified the setup method to disable polkit for NFC_WIFI pairing mode, similar to NFC_THREAD.
  • Updated __pair_with_dut to dispatch to the new __pair_with_dut_nfc_wifi method for NFC-WiFi pairing.
  • Added __pair_with_dut_nfc_wifi method to encapsulate the specific pairing logic for NFC-WiFi.
• test_collections/matter/test_environment_config.py
  • Added NFC_WIFI to the DutPairingModeEnum enumeration.

Activity

• No human activity has been recorded on this pull request yet.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request adds backend support for the nfc-wifi command, which is a good extension of the existing functionality. The changes are logical and cover configuration, command generation, and testing. I've identified a bug in one of the new tests where an incorrect value is being asserted, which needs to be fixed. Additionally, I've provided several suggestions to improve code readability, consistency, and maintainability by reducing code duplication and adhering to Python's style conventions. Addressing these points will enhance the overall quality of the code.

[gemini-code-assist]

For improved readability and conciseness, you can use the in operator with a tuple to check if pairing_mode is one of the specified values.

    if pairing_mode in (DutPairingModeEnum.BLE_WIFI, DutPairingModeEnum.NFC_WIFI):

[gemini-code-assist]

According to PEP 8 naming conventions, function names should be in snake_case. To maintain consistency with other tests in this file, please rename test_pairing_NFC_wifi_command_params.

Suggested change

	async def test_pairing_NFC_wifi_command_params() -> None:
	async def test_pairing_nfc_wifi_command_params() -> None:

[gemini-code-assist]

This blank line is unnecessary and can be removed for cleaner code.

[gemini-code-assist]

For improved readability and conciseness, you can use the in operator with a tuple to check if pairing_mode is one of the specified values.

        if self.config_matter.dut_config.pairing_mode in (DutPairingModeEnum.NFC_THREAD, DutPairingModeEnum.NFC_WIFI):

[gemini-code-assist]

This new method __pair_with_dut_nfc_wifi is very similar to __pair_with_dut_ble_wifi and __pair_with_dut_wifipaf_wifi, leading to code duplication. To improve maintainability, consider refactoring this logic into a shared private helper method.

For example, you could create a helper that takes the specific pairing function as an argument:

from typing import Callable

async def __pair_with_dut_wifi(self, pairing_method: Callable) -> bool:
    if self.config_matter.network.wifi is None:
        raise DUTCommissioningError("Tool config is missing wifi config.")

    return await pairing_method(
        ssid=self.config_matter.network.wifi.ssid,
        password=self.config_matter.network.wifi.password,
        setup_code=self.config_matter.dut_config.setup_code,
        discriminator=self.config_matter.dut_config.discriminator,
    )

Then, this method and the others could be simplified to:

async def __pair_with_dut_nfc_wifi(self) -> bool:
    return await self.__pair_with_dut_wifi(self.runner.pairing_nfc_wifi)

This would reduce code duplication and make the code easier to maintain. While this change would also affect other methods outside this diff, it's a good opportunity to consider this refactoring.

[antonio-amjr]

Hi @ArnoldBraine,

Can you please rebase the PR to point to the appropriate release branch?
Since we're working on the Matter 1.6, the base should be v2.15-develop branch.

[ArnoldBraine]

Hi @ArnoldBraine,

Can you please rebase the PR to point to the appropriate release branch? Since we're working on the Matter 1.6, the base should be v2.15-develop branch.

I had trouble with rebasing the PR, so i created a new one with the right base: #294