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

Refactor config flow tests in generic camera #134385

Merged

Conversation

davet2001
Copy link
Contributor

Proposed change

Clean up of existing tests:

  • One redundant test removed.
  • Use fixtures more to reduce total code size
  • Rename some tests for consistency

Should be no functional change and no reduction in test coverage.

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:

tests/components/generic/conftest.py Show resolved Hide resolved
tests/components/generic/test_config_flow.py Outdated Show resolved Hide resolved
tests/components/generic/test_config_flow.py Outdated Show resolved Hide resolved
@home-assistant
Copy link

home-assistant bot commented Jan 1, 2025

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@home-assistant home-assistant bot marked this pull request as draft January 1, 2025 11:25
@davet2001 davet2001 marked this pull request as ready for review January 1, 2025 11:58
@home-assistant home-assistant bot requested a review from joostlek January 1, 2025 11:58
@davet2001 davet2001 force-pushed the generic_config_flow_tests_refactor1 branch from e9f19a7 to 767d2de Compare January 9, 2025 22:30
Comment on lines 96 to 102
@pytest.fixture(name="mock_setup_entry")
def mock_async_setup_entry_fixture() -> _patch:
"""Mock setup entry."""
return patch(
"homeassistant.components.generic.async_setup_entry",
return_value=True,
)
Copy link
Member

Choose a reason for hiding this comment

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

A common fixture for this is

@pytest.fixture
def mock_setup_entry() -> Generator[AsyncMock]:
    """Override async_setup_entry."""
    with patch(
        "homeassistant.components.airgradient.async_setup_entry",
        return_value=True,
    ) as mock_setup_entry:
        yield mock_setup_entry

This way you only need to load the fixture and its already patch. With the current solution, you would need to always do with mock_setup_entry (and I personally try to avoid them if possible)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok thanks! Yes that makes sense. Will update tonight and check it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It works well, thanks!

Note: That has reduced the code but resulted in a lot of outdenting in facfe9e, so the diff looks a lot bigger. I suggest reviewing with whitespace ignored:
facfe9e?w=1

@joostlek joostlek dismissed their stale review January 10, 2025 12:05

just a small nit, rest is ok

@joostlek joostlek merged commit 9b55faa into home-assistant:dev Jan 13, 2025
34 checks passed
dotvav pushed a commit to dotvav/home-assistant-core that referenced this pull request Jan 13, 2025
Co-authored-by: Dave T <17680170+davet2001@users.noreply.github.com>
Co-authored-by: Allen Porter <allen.porter@gmail.com>
@davet2001 davet2001 deleted the generic_config_flow_tests_refactor1 branch January 13, 2025 18:27
@github-actions github-actions bot locked and limited conversation to collaborators Jan 14, 2025
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.

3 participants