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.

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

Use SnapshotAssertion in bmw_connected_drive tests #90128

Merged
merged 3 commits into from Mar 26, 2023

Conversation

rikroe
Copy link
Contributor

@rikroe rikroe commented Mar 22, 2023

Proposed change

As requested in #88759 (comment), this PR implements SnapshotAssertion for BMW Connected Drive diagnostic tests in a separate PR.

Depending if this or #90127 gets merged first, the other PR will need a quick refactoring due to changing fixtures/diagnostic snapshots.

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 Black (black --fast 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 @gerard33, mind taking a look at this pull request as it has been labeled with an integration (bmw_connected_drive) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of bmw_connected_drive 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 bmw_connected_drive Removes the current integration label and assignees on the pull request, add the integration domain after the command.

@frenck frenck added the smash Indicator this PR is close to finish for merging or closing label Mar 23, 2023
@epenet epenet marked this pull request as draft March 23, 2023 09:25
@epenet
Copy link
Contributor

epenet commented Mar 23, 2023

Needs to be rebased over #90127

@epenet epenet removed the smash Indicator this PR is close to finish for merging or closing label Mar 23, 2023
@rikroe rikroe marked this pull request as ready for review March 23, 2023 09:33
@rikroe
Copy link
Contributor Author

rikroe commented Mar 23, 2023

Rebased and updated snapshot for new dependency version.

Comment on lines 30 to 32

Could fail after every change (either to HA or the library). If so, regenerate using
pytest --snapshot-update tests/components/bmw_connected_drive/ and check the output.
Copy link
Member

Choose a reason for hiding this comment

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

I don't think this is the right place to document how snapshotting works 😉

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed. You're right, it was rather a convenience feature for myself to have it stored somewhere quickly available.

Comment on lines 57 to 58
Could fail after every change (either to HA or the library). If so, regenerate using
pytest --snapshot-update tests/components/bmw_connected_drive/ and check the output.
Copy link
Member

Choose a reason for hiding this comment

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

same

Comment on lines 89 to 90
Could fail after every change (either to HA or the library). If so, regenerate using
pytest --snapshot-update tests/components/bmw_connected_drive/ and check the output.
Copy link
Member

Choose a reason for hiding this comment

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

Same

@home-assistant home-assistant bot marked this pull request as draft March 23, 2023 09:40
@home-assistant
Copy link

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.

@rikroe rikroe marked this pull request as ready for review March 23, 2023 11:14
@home-assistant home-assistant bot requested a review from frenck March 23, 2023 11:14
Copy link
Contributor

@epenet epenet left a comment

Choose a reason for hiding this comment

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

LGTM 👍
@frenck are you ok with the latest changes?

@epenet epenet added the smash Indicator this PR is close to finish for merging or closing label Mar 24, 2023
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, @rikroe 👍

../Frenck

@frenck frenck merged commit bec7bbe into home-assistant:dev Mar 26, 2023
23 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Mar 27, 2023
@rikroe rikroe deleted the bmw-snapshotassertion branch December 21, 2023 14:19
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants