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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Continue on template error during yaml import for generic #69440

Merged
merged 2 commits into from Apr 6, 2022

Conversation

davet2001
Copy link
Contributor

Proposed change

During yaml import for generic (camera), a check is done on the still_image_url. But the check can fail if this url contains a template referring to an entity which is not yet initialized at that point in the startup.

This change is to allow TemplateErrors to occur during yaml import, on the assumption that the original yaml was valid.

If it turns out to be invalid after all, it is not a huge problem. The user can still tinker with it in the configuration section of the UI, and the checks will be done (the errors are only ignored during yaml import).

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)
  • 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
  • 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.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 馃 Silver
  • 馃 Gold
  • 馃弳 Platinum

To help with the load of incoming pull requests:

@project-bot project-bot bot added this to Needs review in Dev Apr 6, 2022
@project-bot project-bot bot moved this from Needs review to By Code Owner in Dev Apr 6, 2022
@bdraco bdraco added this to the 2022.4.1 milestone Apr 6, 2022
Comment on lines +286 to +287
if errors.get(CONF_STILL_IMAGE_URL) == "template_error":
_LOGGER.warning(
Copy link
Member

Choose a reason for hiding this comment

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

Why do we even care if the template renders to something valid? We can just import it and the errors will show up when it tries to render the initialized entity.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For YAML import I don't think it matters to ignore it. For when a user just typed it in the UI, my aim was to tell them if it was invalid with a UI message (so they can see the error on the UI rather than having to watch the log).

Co-authored-by: Paulus Schoutsen <paulus@home-assistant.io>
Dev automation moved this from By Code Owner to Reviewer approved Apr 6, 2022
@balloob balloob merged commit c6bba19 into home-assistant:dev Apr 6, 2022
Dev automation moved this from Reviewer approved to Done Apr 6, 2022
balloob added a commit that referenced this pull request Apr 7, 2022
Co-authored-by: Paulus Schoutsen <paulus@home-assistant.io>
@balloob balloob mentioned this pull request Apr 7, 2022
@github-actions github-actions bot locked and limited conversation to collaborators Apr 8, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
Dev
  
Done
Development

Successfully merging this pull request may close these issues.

YAML import can fail if there are templates in still_image_url for generic
4 participants