Skip to content

Fix config schema to make credentials optional in NUT flows #147593

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Jun 27, 2025
Merged

Fix config schema to make credentials optional in NUT flows #147593

merged 1 commit into from
Jun 27, 2025

Conversation

mib1185
Copy link
Contributor

@mib1185 mib1185 commented Jun 26, 2025 •
edited
Loading

Proposed change

As a regression of #142127 we were not able to add a NUT server without credentials anymore, as it always sets the username and the password field to an empty string which causes the resulting schema always contains some string, instead of None when keep the fields blank ... those the library tries to send an empty USERNAME command:

2025-06-26 13:56:22.112 DEBUG (MainThread) [aionut.client] [192.168.100.200:3493] Sending: b'USERNAME \n'
2025-06-26 13:56:22.113 DEBUG (MainThread) [aionut.client] [192.168.100.200:3493] Received: b'ERR INVALID-ARGUMENT\n'
2025-06-26 13:56:22.113 DEBUG (MainThread) [aionut.client] [192.168.100.200:3493] NUTCommandError: Error running: USERNAME: ERR INVALID-ARGUMENT

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • 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 #
  • This PR is related to issue:
  • Link to documentation pull request:
  • Link to developer documentation pull request:
  • Link to frontend 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
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

@mib1185 mib1185 added this to the 2025.7.0 milestone Jun 26, 2025
@mib1185 mib1185 requested a review from bdraco as a code owner June 26, 2025 13:06
@home-assistant
Copy link

Hey there @bdraco, @ollo69, @pestevez, @tdfountain, mind taking a look at this pull request as it has been labeled with an integration (nut) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of nut can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign nut Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@frenck frenck requested a review from Copilot June 26, 2025 21:03
Copilot
Copilot AI reviewed Jun 26, 2025
View reviewed changes
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR fixes a regression in the NUT integration’s config flow by making the username and password fields truly optional (using vol.UNDEFINED defaults instead of empty strings), preventing invalid USERNAME commands when credentials are omitted.

  • Change default for CONF_USERNAME from "" to vol.UNDEFINED
  • Change default for CONF_PASSWORD (when not changed) from "" to vol.UNDEFINED
Comments suppressed due to low confidence (1)

homeassistant/components/nut/config_flow.py:44

  • Add a config flow test that verifies leaving username and password blank results in no credentials being sent (i.e., fields remain undefined) to cover this new optional behavior.
        ): str,

frenck
frenck approved these changes Jun 27, 2025
View reviewed changes
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @mib1185 👍

../Frenck

@frenck frenck merged commit 21131d0 into dev Jun 27, 2025
34 checks passed
@frenck frenck deleted the nut/fix-config-schema-when-no-credentials-used branch June 27, 2025 07:51
frenck pushed a commit that referenced this pull request Jun 27, 2025
@mib1185 @frenck
Fix config schema to make credentials optional in NUT flows (#147593)
263823c
@github-actions github-actions bot locked and limited conversation to collaborators Jun 28, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

Copilot code review Copilot Copilot left review comments

@frenck frenck frenck approved these changes

@bdraco bdraco Awaiting requested review from bdraco bdraco is a code owner

Assignees

@bdraco bdraco

Labels
bugfix cherry-picked cla-signed integration: nut Quality Scale: No score small-pr PRs with less than 30 lines.
Projects
None yet
Milestone
2025.7.0
Development

Successfully merging this pull request may close these issues.
3 participants
@mib1185 @frenck @bdraco