cable_guy: blacklist zerotier interfaces

[Williangalvani]

(shitty) fix for #3611

Summary by Sourcery

Blacklist ZeroTier interfaces from network configuration and ensure interface cleanup is only performed for valid non-watchdog calls

Bug Fixes:

• Defer cleanup of interface connections until after interface name validation for non-watchdog calls

Enhancements:

• Add "zt.*" pattern to the default interface blacklist

[sourcery-ai]

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR adjusts the order of the cleanup step in set_configuration to run after validating the interface name and updates the default blacklist to exclude Zerotier (zt.*) interfaces.

Sequence diagram for updated set_configuration interface validation and cleanup order

sequenceDiagram
    participant Caller
    participant Manager
    participant NetworkHandler
    Caller->>Manager: set_configuration(interface, watchdog_call)
    alt interface name is valid
        Manager->>Manager: get_interfaces()
        Manager->>Manager: validate interface.name
        alt not watchdog_call
            Manager->>NetworkHandler: cleanup_interface_connections(interface.name)
        end
        Manager->>Manager: set configuration
    else interface name is invalid
        Manager->>Caller: raise ValueError
    end

Loading

Class diagram for updated interface blacklist logic in Manager

classDiagram
    class Manager {
        +is_valid_interface_name(interface_name: str, filter_wifi: bool = False) bool
        blacklist = ["lo", "ham.*", "docker.*", "veth.*", "zt.*"]
    }
    class NetworkHandler {
        +cleanup_interface_connections(interface_name: str)
    }
    Manager --> NetworkHandler: uses

Loading

File-Level Changes

Change	Details	Files
Reorder cleanup_interface_connections call to follow interface name validation	Moved the cleanup call inside the watchdog_call guard to after the valid-names check Removed prior placement before fetching valid interfaces	core/services/cable_guy/api/manager.py
Add Zerotier interfaces to the default blacklist	Appended "zt.*" pattern to the blacklist array in is_valid_interface_name	core/services/cable_guy/api/manager.py

Possibly linked issues

• Cable-guy: startup routine is removing zerotier's ip addresses [Bookworm] #3611: The PR blacklists 'zt.*' interfaces in cable-guy's configuration, preventing the removal of Zerotier IP addresses as described in the issue.

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey there - I've reviewed your changes and they look great!

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}