core icon indicating copy to clipboard operation
core copied to clipboard

Refactor todo tests

Open Lesekater opened this issue 1 year ago • 4 comments

Proposed change

Basic refactoring of tests for the todo component. For tests for additional Intents like in https://github.com/home-assistant/core/pull/127046 or https://github.com/home-assistant/core/pull/127806, I had to do the same setup in the intent test file that already existed in the test_init file. To prevent duplicated code, I moved the common setup to a shared location. This pull request just helps keep other requests clean and simple.

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)
  • [x] 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

  • [x] The code change is tested and works locally.
  • [X] Local tests pass. Your PR cannot be merged unless tests pass
  • [x] There is no commented out code in this PR.
  • [x] I have followed the development checklist
  • [x] I have followed the perfect PR recommendations
  • [x] 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:

Lesekater avatar Oct 12 '24 17:10 Lesekater

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (todo) you are listed as a code owner for? Thanks!

Code owner commands

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

home-assistant[bot] avatar Oct 12 '24 17:10 home-assistant[bot]

Please explain why we need to do this refactor.

MartinHjelmare avatar Oct 12 '24 17:10 MartinHjelmare

Please explain why we need to do this refactor.

Sure. I found that for tests for additional Intents like in #127046 or #127806, I had to do the same setup in the intent test file that already existed in the test_init file. To prevent duplicated code, I moved the common setup to a shared location. This pull request just helps keep other requests clean and simple.

  • I could also add the missing tests for the already existing ListAddItemIntent, but I was thinking about opening another pull request for that that builds on this.

Lesekater avatar Oct 12 '24 17:10 Lesekater

Please add the explanation to the PR description.

Basic refactoring of tests for the todo component.

The current PR description doesn't answer the question Why?, which is the most important question to answer when describing a PR.

MartinHjelmare avatar Oct 12 '24 20:10 MartinHjelmare