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 some myuplink tests #110521

Merged
merged 8 commits into from Feb 15, 2024

Conversation

astrandb
Copy link
Contributor

Breaking change

Proposed change

Add some more test to myuplink.

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 @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.

@astrandb
Copy link
Contributor Author

@MartinHjelmare

I'd break out all the fixture loading to separate pytest fixtures that are marked with scope "session". Then they will only be loaded once per test session instead of loaded every test.

The json.loads call should be done per test so that we can modify the Python objects in the tests without changing the loaded data from the session fixture.

I have broken out the fixture loading with session scope. But I don't get exactly what you mean by the second paragraph. Can you give a little example?

PS I messed up my branch in #110426 and i found it easiest to close and start over with this PR.

@astrandb astrandb marked this pull request as ready for review February 14, 2024 06:16
@home-assistant home-assistant bot marked this pull request as draft February 14, 2024 08:23
@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.

@astrandb astrandb marked this pull request as ready for review February 14, 2024 10:02
tests/components/myuplink/conftest.py Outdated Show resolved Hide resolved
tests/components/myuplink/conftest.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 14, 2024 13:48
@astrandb astrandb marked this pull request as ready for review February 14, 2024 14:20
@astrandb
Copy link
Contributor Author

Thank you for the assistance. Setting up the tests is a bit outside my comfort zone.

tests/components/myuplink/conftest.py Outdated Show resolved Hide resolved
tests/components/myuplink/conftest.py Outdated Show resolved Hide resolved
tests/components/myuplink/conftest.py Outdated Show resolved Hide resolved
tests/components/myuplink/conftest.py Outdated Show resolved Hide resolved
tests/components/myuplink/conftest.py Outdated Show resolved Hide resolved
tests/components/myuplink/conftest.py Outdated Show resolved Hide resolved
tests/components/myuplink/conftest.py Outdated Show resolved Hide resolved
tests/components/myuplink/conftest.py Show resolved Hide resolved
tests/components/myuplink/conftest.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 15, 2024 10:06
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.

Only the fixtures that return strings should be marked as scope session. The fixtures that return mutable objects should be scoped per test so we can modify the fixture data without risking affecting other tests.

tests/components/myuplink/conftest.py Outdated Show resolved Hide resolved
tests/components/myuplink/conftest.py Outdated Show resolved Hide resolved
tests/components/myuplink/conftest.py Outdated Show resolved Hide resolved
tests/components/myuplink/conftest.py Outdated Show resolved Hide resolved
@astrandb
Copy link
Contributor Author

I think I am starting to understand the background...

@astrandb astrandb marked this pull request as ready for review February 15, 2024 11:56
tests/components/myuplink/test_init.py Outdated Show resolved Hide resolved
tests/components/myuplink/test_init.py Outdated Show resolved Hide resolved
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!

@astrandb
Copy link
Contributor Author

Thank you @MartinHjelmare, I have learned a lot during this review and I hope that we soon will see more thorough tests for this integration.

@MartinHjelmare MartinHjelmare merged commit fd0f093 into home-assistant:dev Feb 15, 2024
23 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Feb 16, 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