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.

Sign up for GitHub

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

Jump to bottom

Improve trigger schema validation to ask for trigger instead of platform #126750

Merged
merged 4 commits into from
Sep 25, 2024
Merged

Improve trigger schema validation to ask for trigger instead of platform #126750

merged 4 commits into from
Sep 25, 2024

Conversation

joostlek
Copy link
Member

@joostlek joostlek commented Sep 25, 2024 •
edited by emontnemery
Loading

Proposed change

Improve trigger schema validation to ask for trigger instead of platform

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.

To help with the load of incoming pull requests:

@joostlek joostlek requested a review from a team as a code owner September 25, 2024 12:47
@home-assistant
Copy link

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

Code owner commands

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

@emontnemery emontnemery changed the title Add check for missing trigger Improve trigger schema validation to ask for trigger instead of platform Sep 25, 2024
emontnemery
emontnemery reviewed Sep 25, 2024
View reviewed changes
homeassistant/helpers/config_validation.py Outdated
@@ -1790,6 +1790,8 @@ def _backward_compat_trigger_schema(value: Any | None) -> Any:
)
value = dict(value)
value[CONF_PLATFORM] = value.pop(CONF_TRIGGER)
elif CONF_PLATFORM not in value:
raise vol.Invalid("required key not provided", ["trigger"])
Copy link
Contributor

Choose a reason for hiding this comment

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

It should be like this, sorry for the bad suggestion

Suggested change
raise vol.Invalid("required key not provided", ["trigger"])
raise vol.Invalid("required key not provided", [CONF_TRIGGER])

@emontnemery emontnemery added this to the 2024.10.0b0 milestone Sep 25, 2024
@joostlek joostlek merged commit 3810c3c into home-assistant:dev Sep 25, 2024
44 checks passed
@joostlek joostlek deleted the trigger-pre-validator branch September 25, 2024 14:44
zxdavb pushed a commit to zxdavb/hass that referenced this pull request Sep 25, 2024
@joostlek @zxdavb
Improve trigger schema validation to ask for trigger instead of `pl…
58c0800 
…atform` (home-assistant#126750)

* Add check for missing trigger

* Fix

* Fix

* Escape
@github-actions github-actions bot locked and limited conversation to collaborators Sep 26, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@emontnemery emontnemery emontnemery approved these changes

Assignees
No one assigned
Labels
bugfix cla-signed core integration: device_automation Quality Scale: internal small-pr PRs with less than 30 lines.
Projects
None yet
Milestone
2024.10.0b0
Development

Successfully merging this pull request may close these issues.
2 participants
@joostlek @emontnemery