[1.4] cable_guy: check if interface is valid BEFORE changing it

[patrickelectric]

Cherry-pick from #3612

Summary by Sourcery

Validate interface names before cleanup in set_configuration and extend the interface blacklist to include 'zt.*'.

Bug Fixes:

• Reorder non-watchdog cleanup to occur after interface name validation in set_configuration
• Add 'zt.*' pattern to the blacklist in is_valid_interface_name

[sourcery-ai]

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR reorders interface validation and cleanup in set_configuration to avoid cleaning up invalid interfaces, and extends the interface name blacklist to exclude zt.* interfaces.

Sequence diagram for reordered interface validation in set_configuration

sequenceDiagram
participant Manager
participant NetworkHandler
participant Logger
actor Caller
Caller->>Manager: set_configuration(interface, watchdog_call)
Manager->>Manager: get_interfaces()
Manager->>Manager: Check if interface.name in valid_names
alt Invalid interface name
    Manager->>Caller: raise ValueError
else Valid interface name
    alt Not watchdog_call
        Manager->>NetworkHandler: cleanup_interface_connections(interface.name)
    end
    Manager->>Logger: info("Setting configuration for interface ...")
    Manager->>Manager: (continue with configuration)
end

Loading

Class diagram for updated blacklist in is_valid_interface_name

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

Loading

File-Level Changes

Change	Details	Files
Interface validity check moved before cleanup in set_configuration	Removed cleanup_interface_connections call before validating interface name Added cleanup_interface_connections call after the interface validity check when not a watchdog call	core/services/cable_guy/api/manager.py
Extended blacklist in is_valid_interface_name	Added "zt.*" pattern to the blacklist array	core/services/cable_guy/api/manager.py

---

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.}