Skip to content

Fix cloud support package snapshots with verbose logging - #181399

Draft
JamieMagee wants to merge 1 commit into
home-assistant:devfrom
JamieMagee:fix-cloud-support-package-snapshots
Draft

Fix cloud support package snapshots with verbose logging#181399
JamieMagee wants to merge 1 commit into
home-assistant:devfrom
JamieMagee:fix-cloud-support-package-snapshots

Conversation

@JamieMagee

Copy link
Copy Markdown
Contributor

Breaking change

Proposed change

Verbose pytest runs add event-bus DEBUG messages with changing timestamps to two cloud support package snapshots.

Set hass_nabucasa.events.bus to INFO in those tests with caplog, which restores the logger level afterwards. The existing snapshots remain unchanged.

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:

All 501 cloud tests pass normally and with -vvv. The three support package tests also pass with -v and --log-level=DEBUG. Ruff, Pylint and the applicable commit hooks pass.

Checklist

  • I understand the code I am submitting and can explain how it works.
  • 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.
  • Any generated code has been carefully reviewed for correctness and compliance with project standards.

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 diff between library versions and ideally a link to the changelog/release notes is added to the PR description.

To help with the load of incoming pull requests:

Copilot AI balanced review requested due to automatic review settings September 5, 2026 19:59
@home-assistant

home-assistant Bot commented Sep 5, 2026

Copy link
Copy Markdown
Contributor

Hey there @home-assistant/cloud, mind taking a look at this pull request as it has been labeled with an integration (cloud) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of cloud can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant mark-draft Mark the pull request as draft.
  • @home-assistant ready-for-review Remove the draft status from the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign cloud Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant update-branch Update the pull request branch with the base branch.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) on the pull request.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟢 Approval recommended

The focused test-only changes correctly suppress unstable logs without persistent side effects.

Review tier: Balanced
Findings: None

What changed in this PR

Stabilizes cloud support-package snapshots during verbose pytest runs.

Changes:

  • Raises the event-bus logger threshold to INFO in two snapshot tests.
  • Uses caplog to restore logger state automatically.
File Description
tests/​components/​cloud/​test_http_api.py Prevents nondeterministic DEBUG logs from altering snapshots.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@justanotherariel justanotherariel left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hm. Have a look at test_download_support_package. I think this decorator is missing for the two tests you patched. This will also get rid of the This message will be dropped since this test patches MAX_RECORDS line in the snapshots which shouldn't have been there in the first place.

@patch("homeassistant.components.cloud.helpers.FixedSizeQueueLogHandler.MAX_RECORDS", 3)

Comment on lines 2918 to 2919

@pytest.mark.usefixtures("enable_custom_integrations")

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
@patch("homeassistant.components.cloud.helpers.FixedSizeQueueLogHandler.MAX_RECORDS", 3)
@pytest.mark.usefixtures("enable_custom_integrations")

Comment on lines +2928 to 2935
caplog: pytest.LogCaptureFixture,
) -> None:
"""Test download support package when async_get_custom_components fails."""

# Exclude setup logs with nondeterministic timestamps in verbose runs.
caplog.set_level(logging.INFO, logger="hass_nabucasa.events.bus")

aioclient_mock.get("https://cloud.bla.com/status", text="")

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
caplog: pytest.LogCaptureFixture,
) -> None:
"""Test download support package when async_get_custom_components fails."""
# Exclude setup logs with nondeterministic timestamps in verbose runs.
caplog.set_level(logging.INFO, logger="hass_nabucasa.events.bus")
aioclient_mock.get("https://cloud.bla.com/status", text="")
) -> None:
"""Test download support package when async_get_custom_components fails."""
aioclient_mock.get("https://cloud.bla.com/status", text="")

@home-assistant

home-assistant Bot commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@home-assistant
home-assistant Bot marked this pull request as draft September 7, 2026 15:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants