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 error handling to input_select integration #93940

Merged
merged 6 commits into from
Jun 5, 2023
Merged

Add error handling to input_select integration #93940

merged 6 commits into from
Jun 5, 2023

Conversation

j4n-e4t
Copy link
Contributor

@j4n-e4t j4n-e4t commented Jun 1, 2023

Proposed change

Added error handling to the async_select_option methon in InputSelect. This fixes this issue by @frenck.

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 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:

@j4n-e4t j4n-e4t requested a review from a team as a code owner June 1, 2023 21:18
@home-assistant
Copy link

home-assistant bot commented Jun 1, 2023

Hi @j4n-e4t

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

@home-assistant
Copy link

home-assistant bot commented Jun 1, 2023

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

Code owner commands

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

@home-assistant
Copy link

home-assistant bot commented Jun 1, 2023

Hi @j4n-e4t

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

@j4n-e4t j4n-e4t changed the title Add error handling to input_select integratio Add error handling to input_select integration Jun 2, 2023
@j4n-e4t
Copy link
Contributor Author

j4n-e4t commented Jun 2, 2023

Please forgive my question, this is my first contribution here, but I‘m a bit confused right now ;-)

So as you can see, the ci failed due to an error message while running pytest. But isn’t the error message exactly what should happen, when an invalid option is selected?
IMG_0189

@freeDom-
Copy link

freeDom- commented Jun 2, 2023

Did you ran the tests in your local environment? Because you checked the checkbox, but the tests are failing.

You can run the tests in your dev environment using pytest:
pytest tests/components/input_select

It looks like you adjusted some code which was tested and did not work right now. Now an exception is thrown, which is not expected by the test. You would need to adjust the unit test to match the new behavior!

Copy link

@freeDom- freeDom- left a comment

Choose a reason for hiding this comment

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

You could remove the log warning, because the raised Error should get logged anyways and thus the warning is redundant...
I did not test this, this is only an assumption, so you should test it before applying the change.

@j4n-e4t
Copy link
Contributor Author

j4n-e4t commented Jun 2, 2023

Thanks for your response! I probably missed running the corresponding tests for the input_select integration but I think, I know, where the problem is:

  • the existing test assumes that the state of the helper just doesn’t change on an invalid input
  • my change will throw an error when this happens
  • I will need to add the assert pytest.exception(HomeAssistantError) to the tests

And also thanks for the clarification on the log message. I’ll make my changes soon 😉

@j4n-e4t
Copy link
Contributor Author

j4n-e4t commented Jun 2, 2023

I now added the exception handler to the failing tests and in my environment (GitHub Codespaces) all tests related to the input_select integration are passing. I hope CI will pass this time as well.
Thank you for your advice @freeDom-

Copy link

@freeDom- freeDom- left a comment

Choose a reason for hiding this comment

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

Thanks for your PR!

Looks good to me now...

@j4n-e4t
Copy link
Contributor Author

j4n-e4t commented Jun 2, 2023

@dgomes Thanks for reviewing my work!

Just one little question: Right now, the CI pipeline ran successfully but skipped one step. The error message that GitHub Actions displays says that the maximum execution time has been exceeded.
What does that mean? Do I need to fix anything?

@freeDom-
Copy link

freeDom- commented Jun 3, 2023

It can happen sometimes that not all parts of CI run successfully when e.g. a server is not responding.

Usually closing and re-opening the PR should retrigger a CI run, but since this is your first PR you need to wait for someone with elevated rights to retrigger the CI run.

@dgomes
Copy link
Contributor

dgomes commented Jun 3, 2023

it's related to codecov, just as @freeDom- mentioned: close -> open the PR for the CI to run again

@j4n-e4t j4n-e4t closed this Jun 3, 2023
@j4n-e4t
Copy link
Contributor Author

j4n-e4t commented Jun 3, 2023

Closed and reopened PR to rerun ci

@j4n-e4t j4n-e4t reopened this Jun 3, 2023
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Thanks, @j4n-e4t 👍

Awesome first-time contribution 🥇

../Frenck

@frenck frenck merged commit 28f6062 into home-assistant:dev Jun 5, 2023
@github-actions github-actions bot locked and limited conversation to collaborators Jun 6, 2023
@raman325 raman325 added this to the 2023.6.1 milestone Jun 7, 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.

The input_select.select_option service, swallows errors when an invalid option is set
6 participants