Ignore dns-data field in network settings update

[mdegat01]

Proposed change

The dns-data field replaces the now deprecated dns field in Network Manager's connection settings. As with the other -data fields both the new and the old get populated automatically no matter which you use. So also like the others, it needs to be added to our ignore list when generating the object for the dbus call so the old value does not get merged in.

This would appear to be a problem for disabling an ipv4 or ipv6 interface though so far we only have a report on ipv6. I think it's relatively new as dns-data wasn't in our test fixture which was generated from the dbus calls directly. I think it was added when we updated NM a couple OS releases ago which happened after the fixtures were made.

Type of change

• Dependency upgrade
• Bugfix (non-breaking change which fixes an issue)
• New feature (which adds functionality to the supervisor)
• Breaking change (fix/feature causing existing functionality to break)
• Code quality improvements to existing code or addition of tests

Additional information

• This PR fixes or closes issue: fixes Cant disable IPv6 #5132
• This PR is related to issue:
• Link to documentation pull request:
• Link to cli pull request:

Checklist

• The code change is tested and works locally.
• Local tests pass. Your PR cannot be merged unless tests pass
• There is no commented out code in this PR.
• I have followed the development checklist
• The code has been formatted using Ruff (ruff format supervisor tests)
• Tests have been added to verify that the new code works.

If API endpoints of add-on configuration are added/changed:

• Documentation added/updated for developers.home-assistant.io

Summary by CodeRabbit

• New Features
  • Added support for dns-data in network settings, enhancing DNS configuration capabilities.

[coderabbitai]

Walkthrough

Walkthrough

The updates involve adding a new entity, dns-data, to the exported settings in the network module and introducing tests to confirm proper handling of this new entity. This change addresses an issue with managing IPv6 settings, which previously led to configuration errors when disabling IPv6.

Changes

File	Change Summary
supervisor/dbus/network/setting/__init__.py	Added "dns-data" to the list of exported entities.
tests/dbus/network/setting/test_init.py	Added assertions for the absence of "dns-data" in settings for both ipv4 and ipv6.
tests/dbus_service_mocks/network_connection_settings.py	Introduced a new field dns-data of type as with the value ["192.168.2.1"] in the network connection settings configuration.

Assessment against linked issues

Objective	Addressed	Explanation
Correctly handle the addition of dns-data (solution to #5132)	✅
Ensure disabling IPv6 does not cause errors (solution to #5132)	✅

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between c37b5ef and 4aaa3a9.

Files selected for processing (3)

• supervisor/dbus/network/setting/init.py (1 hunks)
• tests/dbus/network/setting/test_init.py (2 hunks)
• tests/dbus_service_mocks/network_connection_settings.py (1 hunks)

Additional comments not posted (4)

tests/dbus/network/setting/test_init.py (2)

70-70: Ensure dns-data is not present in IPv4 settings.

The added assertion checks that dns-data is not included in the IPv4 settings, aligning with the PR's objective to ignore this field. This is crucial to ensure that the system behaves correctly after the changes to the network manager.

---

87-87: Ensure dns-data is not present in IPv6 settings.

Similar to the IPv4 settings, this assertion ensures that dns-data is correctly excluded from the IPv6 settings. This change is necessary to prevent potential configuration errors when disabling IPv6 interfaces, as described in the PR.

tests/dbus_service_mocks/network_connection_settings.py (1)

34-34: Addition of dns-data to mock settings.

The dns-data field has been added to the IPv4 settings in the mock data. This ensures that the tests can validate the behavior of the system with this new field present. It's important to keep the mock data updated with the actual data structure used by the system.

supervisor/dbus/network/setting/__init__.py (1)

47-47: Addition of dns-data to ignore fields during updates.

Adding dns-data to the list of fields to ignore during updates is a direct implementation of the PR's objective. This ensures that changes to this field do not affect the network configuration, particularly when disabling IPv4 or IPv6 interfaces. This is a crucial change for maintaining stability in network configurations.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.