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

Add myuplink diagnostics download #109925

Merged
merged 12 commits into from Feb 12, 2024
Merged

Conversation

astrandb
Copy link
Contributor

@astrandb astrandb commented Feb 7, 2024

Breaking change

Proposed change

Add module for diagnostics download. All relevant data from the myUplink API is captured and dumped.

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

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

home-assistant bot commented Feb 7, 2024

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

Code owner commands

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

Copy link
Contributor

@elupus elupus left a comment

Choose a reason for hiding this comment

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

I think the system id should be redacted too. I think the info may contain house address, at least the old nibeuplink data could do that.

We also need to see an example of the diagnostic info to see if more things should be redacted. Preferably as some test case.

@astrandb
Copy link
Contributor Author

astrandb commented Feb 8, 2024

I cannot find any sensitive data in the output from the API, system id and device id are UUID-style strings. Please have a look at the file from my unit. (I dont know any emmy ;-) )

config_entry-myuplink-8016ca074b552af9dca334f133abb752 (9).json

@elupus
Copy link
Contributor

elupus commented Feb 8, 2024

Serial number, and preferably device/system id. But it looks hard to filter. At least redact serial number.

@astrandb
Copy link
Contributor Author

astrandb commented Feb 8, 2024

Hiding serialNumber. Keeping the id:s for the moment. After all, the output file is private to the end-user unless he/she publishes it somewhere.

Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Please add tests. Look at other integrations for examples.

@home-assistant
Copy link

home-assistant bot commented Feb 9, 2024

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 February 9, 2024 04:05
@astrandb astrandb marked this pull request as ready for review February 10, 2024 11:34
@astrandb
Copy link
Contributor Author

astrandb commented Feb 10, 2024

@MartinHjelmare

Please add tests. Look at other integrations for examples.

It took a while to make it work. I couldn't find a good example that just worked. The trick was to bypass all OAuth stuff in the optimal place. I think it became pretty clean in the end.

@home-assistant home-assistant bot marked this pull request as draft February 10, 2024 20:01
@astrandb astrandb marked this pull request as ready for review February 11, 2024 13:25
@MartinHjelmare MartinHjelmare marked this pull request as draft February 11, 2024 13:39
@astrandb astrandb marked this pull request as ready for review February 11, 2024 14:07
@MartinHjelmare MartinHjelmare marked this pull request as draft February 11, 2024 20:37
@astrandb astrandb marked this pull request as ready for review February 11, 2024 23:13
homeassistant/components/myuplink/diagnostics.py Outdated Show resolved Hide resolved
tests/components/myuplink/conftest.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft February 12, 2024 08:32
@astrandb astrandb marked this pull request as ready for review February 12, 2024 09:03
Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Thanks!

@@ -0,0 +1,22 @@
"""Tests for myuplink update module."""
Copy link
Member

Choose a reason for hiding this comment

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

Normally this should be a separate PR. But since it's small and just tests it's ok this time.

@MartinHjelmare MartinHjelmare merged commit 8376c07 into home-assistant:dev Feb 12, 2024
23 checks passed
@astrandb
Copy link
Contributor Author

Thank you @MartinHjelmare for your thorough review and all constructive suggestions.

@github-actions github-actions bot locked and limited conversation to collaborators Feb 13, 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.

None yet

3 participants