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

Renovate Airvisual tests #84892

Merged
merged 4 commits into from
Jan 4, 2023
Merged

Conversation

bachya
Copy link
Contributor

@bachya bachya commented Dec 31, 2022

Proposed change

The AirVisual test suite needed a little love. This PR cleans it up:

  1. We ensure all tests finish with either data_entry_flow.FlowResultType.CREATE_ENTRY or data_entry_flow.FlowResultType.ABORT.
  2. We remove various overlapping functionality (patching, etc.).
  3. We rename some fixtures for maximum clarity.
  4. Per recommendation, we move config entry migration tests into test_init.py.

In so doing, I discovered a bug where the config flow would "see" an API key even if that API key failed.

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: N/A
  • This PR is related to issue: N/A
  • Link to documentation pull request: N/A

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.

To help with the load of incoming pull requests:

valid_keys.add(user_input[CONF_API_KEY])
if errors:
return self.async_show_form(
step_id=error_step, data_schema=error_schema, errors=errors
Copy link
Member

Choose a reason for hiding this comment

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

This looks like we can and are moving directly to the form of another step. That's not good. The form is private to its step method. We should only move to another step by awaiting that step method.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@MartinHjelmare Absolutely. Renovating the config flow itself will make this PR bigger; would you be open to approving this one's focus on tests, then I can follow up with an additional PR to fix ^^^?

Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Ok, thanks!

tests/components/airvisual/test_config_flow.py Outdated Show resolved Hide resolved
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
@bachya bachya merged commit 6e9d3bf into home-assistant:dev Jan 4, 2023
@bachya bachya deleted the airvisual-config-flow-tests branch January 4, 2023 20:05
@github-actions github-actions bot locked and limited conversation to collaborators Jan 5, 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.

2 participants