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

Update pyvesync version #131433

Merged
merged 7 commits into from
Dec 24, 2024
Merged

Update pyvesync version #131433

merged 7 commits into from
Dec 24, 2024

Conversation

cdnninja
Copy link
Contributor

@cdnninja cdnninja commented Nov 24, 2024

Proposed change

Bumping version of pyvesync library.

https://github.com/webdjoe/pyvesync/releases/tag/2.1.14
webdjoe/pyvesync@2.1.12...2.1.14

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.

To help with the load of incoming pull requests:

@home-assistant
Copy link

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

Code owner commands

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

@cdnninja cdnninja marked this pull request as ready for review November 24, 2024 04:04
Copy link
Member

@gjohansson-ST gjohansson-ST left a comment

Choose a reason for hiding this comment

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

Please run python3 -m script.gen_requirements_all to update the requirements in all places. It seems to missing for tests.

@home-assistant home-assistant bot marked this pull request as draft November 24, 2024 10:45
@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.

@cdnninja cdnninja marked this pull request as ready for review December 10, 2024 20:30
@cdnninja
Copy link
Contributor Author

I have corrected the missing file.

Copy link
Member

@gjohansson-ST gjohansson-ST left a comment

Choose a reason for hiding this comment

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

Tests are failing so something has changed which probably needs fixing given it seems all devices are now being removed from snapshots.

@home-assistant home-assistant bot marked this pull request as draft December 11, 2024 18:40
@ncd7
Copy link

ncd7 commented Dec 17, 2024

Has this PR now stalled? Any suggestions how we can debug the tests, if I find the time around the holidays I might sync and try that. This is a really popular device model so a lot of people are trying to get support in HA

@cdnninja
Copy link
Contributor Author

Any support on why tests fail would be great! I haven't had time to dig in an am struggling to understand that part.

@ncd7
Copy link

ncd7 commented Dec 20, 2024

gjohansson-ST

@gjohansson-ST , do you think you could offer @cdnninja some guidance?

@gjohansson-ST
Copy link
Member

Something changed in the library so it's no longer adding all the devices as before.
So some code needs to be changed (I have no idea since I don't use this myself) and you have likely not tested the code either (the checklist is completely empty).

@webdjoe
Copy link
Contributor

webdjoe commented Dec 20, 2024

The issue is webdjoe/pyvesync@2.1.12...2.1.13#diff-ad4ecc16e9072e06d14ee98652e539c2712cb6a793a9f49b369ba4bfbb38a159R64 , configModule should be a mandatory property because it is required for some device functionality. I believe the HA tests do not include it in the testing data. This is stylistic and only going to impact testing, so I can roll it back in a new release. Unless you would like to add configModule to the devices in tests/components/vesync/fixtures/vesync-devices.json

@gjohansson-ST
Copy link
Member

Tests should be as similar as possible to reality so if it's missing in the tests I would really prefer to see it added 👍

@gjohansson-ST gjohansson-ST mentioned this pull request Dec 20, 2024
19 tasks
@webdjoe
Copy link
Contributor

webdjoe commented Dec 20, 2024

I agree, API calls are documented here

@cdnninja I am going upload a new pyvesync release in a few moments, so you might as well bump to the new version in this PR.

@webdjoe
Copy link
Contributor

webdjoe commented Dec 23, 2024

Released 2.1.14

@webdjoe
Copy link
Contributor

webdjoe commented Dec 24, 2024

The tests are failing due to the configModule attribute, it should be added each device in the device list. You should be able to make a stub value for all, e.g. "configModule": "configModule" https://github.com/home-assistant/core/blob/dev/tests/components/vesync/fixtures/vesync-devices.json

@cdnninja cdnninja marked this pull request as ready for review December 24, 2024 16:48
@cdnninja
Copy link
Contributor Author

Tests have been updated and now pass. Let me know if it is preferred to move the tests to a separate PR.

Copy link
Member

@gjohansson-ST gjohansson-ST left a comment

Choose a reason for hiding this comment

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

Thanks @cdnninja 👍

@gjohansson-ST gjohansson-ST merged commit 0020c48 into home-assistant:dev Dec 24, 2024
65 checks passed
@cdnninja cdnninja deleted the patch-3 branch December 24, 2024 16:52
@github-actions github-actions bot locked and limited conversation to collaborators Dec 25, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants