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

Refactor zwave_js.cover #93433

Merged
merged 9 commits into from May 24, 2023
Merged

Refactor zwave_js.cover #93433

merged 9 commits into from May 24, 2023

Conversation

raman325
Copy link
Contributor

Proposed change

In this PR we:

  • Improved test coverage for the cover platform
  • Don't assume constants for open and close values and use min and max instead
  • Use constants in tests
  • Refactor logic into mixins that will make the Window Covering CC PR much simpler to write

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 @home-assistant/z-wave, mind taking a look at this pull request as it has been labeled with an integration (zwave_js) you are listed as a code owner for? Thanks!

Code owner commands

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

@raman325 raman325 mentioned this pull request May 24, 2023
20 tasks
@jbouwh
Copy link
Contributor

jbouwh commented May 24, 2023

Can you split the refactoring and test coverage parts in separate PR's, and start with the coverage PR. This will help us to avoid introducing new regressions due while refactoring.

@raman325
Copy link
Contributor Author

For tests do you mean the switch to constants? I only added an additional test case, everything else changed in the tests is just a conversion to a constant. I specifically avoided updating existing tests to avoid a possible regression

@jbouwh
Copy link
Contributor

jbouwh commented May 24, 2023

For tests do you mean the switch to constants? I only added an additional test case, everything else changed in the tests is just a conversion to a constant. I specifically avoided updating existing tests to avoid a possible regression

I mean to separate the added tests. The new tests should also work with the current code base.
The constants can be added with the second PR, or in a separate PR.
It makes it easier to review.

@raman325 raman325 changed the title Refactor zwave_js.cover and improve test coverage Refactor zwave_js.cover May 24, 2023
@raman325 raman325 mentioned this pull request May 24, 2023
20 tasks
@jbouwh
Copy link
Contributor

jbouwh commented May 24, 2023

I think we should rebase and first merge #93458

tests/components/zwave_js/conftest.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft May 24, 2023 14: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.

@raman325 raman325 marked this pull request as ready for review May 24, 2023 16:44
@home-assistant home-assistant bot requested a review from jbouwh May 24, 2023 16:44
@jbouwh
Copy link
Contributor

jbouwh commented May 24, 2023

Now the tests have been merged we should rebase rerun the CI tests.

Copy link
Contributor

@jbouwh jbouwh left a comment

Choose a reason for hiding this comment

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

Looks good thnx @raman325 !

@raman325 raman325 marked this pull request as ready for review May 24, 2023 19:37
@home-assistant home-assistant bot requested a review from jbouwh May 24, 2023 19:37
@raman325 raman325 merged commit f087479 into home-assistant:dev May 24, 2023
41 checks passed
@raman325 raman325 deleted the refactor branch May 24, 2023 19:37
@github-actions github-actions bot locked and limited conversation to collaborators May 25, 2023
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

2 participants