Relax Unique ID logic

[Snuffy2]

This pull request enhances the handling and validation of device unique IDs throughout the OPNsense Home Assistant integration. The main improvement is the addition of an expected_id parameter to the get_device_unique_id method, allowing the system to prefer a specific device ID if present. This change is propagated across the core integration logic, configuration flow, coordinator, and test suite to ensure consistent device identification and smoother configuration updates.

Device Unique ID Handling and Validation:

• custom_components/opnsense/pyopnsense/__init__.py: Updated get_device_unique_id to accept an expected_id parameter. If the expected ID is present among physical MAC addresses, it is returned; otherwise, the first MAC address is used.
• custom_components/opnsense/__init__.py, custom_components/opnsense/config_flow.py, custom_components/opnsense/coordinator.py: Propagated the expected_id parameter through setup, validation, and coordinator logic to ensure the correct device ID is used during configuration and runtime. [1] [2] [3] [4] [5] [6] [7] [8]

Test Suite Updates:

• tests/conftest.py, tests/test_integration.py: Updated test client mocks to support the new expected_id parameter in get_device_unique_id. [1] [2] [3] [4]
• tests/test_pyopnsense.py: Added a new test to verify that get_device_unique_id returns the expected ID when present, and falls back to the default when not.

Code Quality Improvements:

• custom_components/opnsense/coordinator.py: Improved type annotations and variable naming for clarity when dynamically invoking client methods. [1] [2]

Fixes #480

[github-actions]

Coverage report

Click to see where and how coverage changed

File	Statements	Missing	Coverage	Coverage (new stmts)	Lines missing
custom_components/opnsense
__init__.py
config_flow.py
coordinator.py
custom_components/opnsense/pyopnsense
__init__.py					684
Project Total

This report was generated by python-coverage-comment-action