Skip to content
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

Use MockConfigEntry in hue tests #117237

Merged
merged 1 commit into from May 12, 2024
Merged

Use MockConfigEntry in hue tests #117237

merged 1 commit into from May 12, 2024

Conversation

emontnemery
Copy link
Contributor

Proposed change

Use MockConfigEntry in hue tests

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:

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.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@home-assistant
Copy link

Hey there @balloob, @marcelveldt, mind taking a look at this pull request as it has been labeled with an integration (hue) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of hue 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 hue 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.

balloob
balloob reviewed May 11, 2024
View reviewed changes
tests/components/hue/test_services.py
@@ -49,11 +50,8 @@

async def test_hue_activate_scene(hass: HomeAssistant, mock_api_v1) -> None:
"""Test successful hue_activate_scene."""
config_entry = config_entries.ConfigEntry(
version=1,
minor_version=1,
Copy link
Member

Choose a reason for hiding this comment

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

You're losing out on minor_version=1, does that matter ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's the default, it was only added because ConfigEntry requires passing the minor version, the point of this PR is to not have to update the hue tests when we make changes to config entries.

balloob
balloob reviewed May 11, 2024
View reviewed changes
tests/components/hue/test_services.py
config_entry = config_entries.ConfigEntry(
version=1,
minor_version=1,
config_entry = MockConfigEntry(
Copy link
Member

Choose a reason for hiding this comment

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

I wonder if this can be a fixture? It's all the same .

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I guess. The point of this PR is not really to improve the hue tests though, it's to not have to change hue tests when there are unrelated changes.

OK to merge as is, or do you want a fixture?

@balloob balloob merged commit 0acf392 into dev May 12, 2024
23 of 24 checks passed
@balloob balloob deleted the hue_tests_mockconfigentry branch May 12, 2024 03:36
@github-actions github-actions bot locked and limited conversation to collaborators May 13, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@balloob balloob balloob left review comments

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

Assignees

@balloob balloob

@marcelveldt marcelveldt

Labels
cla-signed has-tests integration: hue Quality Scale: platinum small-pr PRs with less than 30 lines.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@emontnemery @balloob @marcelveldt