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 check for integration config schema to hassfest #93587

Merged
merged 8 commits into from Jun 12, 2023

Conversation

emontnemery
Copy link
Contributor

@emontnemery emontnemery commented May 26, 2023

Proposed change

Add check for integration config schema to hassfest

Background:

Integrations which can be setup via YAML but don't support any configuration parameters commonly don't declare any CONFIG_SCHEMA. This means useless configurations such as this won't be warned against:

api:
   blah # Not supported by the `api` integration

Also, there is no warning if integrations which can not be setup via YAML are referenced in the configuration.
There are two cases, integrations which define an async_setup or setup but can't be setup via YAML and integrations which don't declare async_setup or setup.

Suggestion:

  • Enforce that integrations with async_setup or setup has either of CONFIG_SCHEMA, PLATFORM_SCHEMA, PLATFORM_SCHEMA_BASE or a config platform
    • Implemented in this PR
    • Existing integrations which fail the new check should either declare an empty schema if setup via yaml is possible (for example api), or a schema which logs a warning / repair saying yaml configuration is not supported (for example discord)
      Updating integrations will be handled in separate PRs
  • For integrations which do not have async_setup or setup but are referenced in the config we log a warning / repair

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 home-assistant bot added cla-signed small-pr PRs with less than 30 lines. labels May 26, 2023
@emontnemery emontnemery marked this pull request as draft May 26, 2023 10:47
script/hassfest/config_schema.py Outdated Show resolved Hide resolved
script/hassfest/config_schema.py Outdated Show resolved Hide resolved
script/hassfest/config_schema.py Outdated Show resolved Hide resolved
@emontnemery emontnemery force-pushed the hassfest_enforce_config_schema branch from f1ed98c to b461faa Compare June 7, 2023 14:44
@emontnemery emontnemery marked this pull request as ready for review June 7, 2023 16:36
@frenck frenck merged commit f177732 into dev Jun 12, 2023
52 checks passed
@frenck frenck deleted the hassfest_enforce_config_schema branch June 12, 2023 08:26
mover85 pushed a commit to mover85/core that referenced this pull request Jun 12, 2023
…3587)

Co-authored-by: epenet <6771947+epenet@users.noreply.github.com>
@github-actions github-actions bot locked and limited conversation to collaborators Jun 13, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla-signed small-pr PRs with less than 30 lines.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants