Refactor tests in GIOS #155756

mik-laj · 2025-11-03T19:58:51Z

Proposed change

This refactoring makes the tests mock the whole Gios object instead of individual methods, as requested in https://github.com/home-assistant/core/pull/155603/files#r2483768993. I also created fixtures for tests to reduce duplication.

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:
Link to developer documentation pull request:
Link to frontend pull request:

Checklist

I understand the code I am submitting and can explain how it works.
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.
Any generated code has been carefully reviewed for correctness and compliance with project standards.

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated for www.home-assistant.io

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:

I have reviewed two other open pull requests in this repository.

home-assistant · 2025-11-03T19:58:58Z

Hey there @bieniu, mind taking a look at this pull request as it has been labeled with an integration (gios) you are listed as a code owner for? Thanks!

Code owner commands

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

tests/components/gios/conftest.py

mik-laj · 2025-11-03T22:22:50Z

tests/components/gios/test_config_flow.py

-        result = await hass.config_entries.flow.async_configure(
-            result["flow_id"], CONFIG
-        )
-        await hass.async_block_till_done()


It is not needed here.

mik-laj · 2025-11-03T22:23:30Z

tests/components/gios/test_config_flow.py

-            return_value={},
-        ),
-    ):
-        flow = config_flow.GiosFlowHandler()


This looked weird to me, so I used the hass.config_entries.flow.async_init method that creates this object.

mik-laj · 2025-11-03T22:27:17Z

tests/components/gios/test_sensor.py

    assert state.state == "good"
-
-
-async def test_invalid_indexes(hass: HomeAssistant) -> None:


This doesn't look like a test of our code, but a test of the gios library.

I checked this again and it was reason of decrease of test coverage.

tests/components/gios/test_config_flow.py

Copilot

Pull Request Overview

This PR modernizes the GIOS integration test suite by refactoring it to use modern pytest fixtures and patterns instead of manually loading JSON fixtures and patching API calls. The changes improve test maintainability and align with current Home Assistant testing best practices.

Key changes:

Introduces a centralized conftest.py with reusable fixtures (mock_gios, mock_config_entry, init_integration)
Replaces JSON fixture files with in-code test data using gios.model dataclasses
Migrates tests to use modern mocking patterns with MagicMock and cleaner setup/teardown
Adds freezegun for time-based testing instead of manual time manipulation

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
`tests/components/gios/conftest.py`	New file introducing shared fixtures with mocked GIOS client and test data
`tests/components/gios/__init__.py`	Replaced `init_integration` helper with simpler `setup_integration` function
`tests/components/gios/test_sensor.py`	Refactored tests to use fixtures and split `test_availability` into separate test functions
`tests/components/gios/test_init.py`	Updated all tests to use new fixture pattern, removed manual mocking
`tests/components/gios/test_config_flow.py`	Simplified by using `mock_gios` fixture and removing JSON loading
`tests/components/gios/test_diagnostics.py`	Updated to use new fixture pattern
`tests/components/gios/fixtures/*.json`	Removed obsolete JSON fixture files

tests/components/gios/conftest.py

tests/components/gios/__init__.py

tests/components/gios/conftest.py

bieniu · 2025-11-04T15:36:59Z

tests/components/gios/__init__.py

-        data={"station_id": 123, "name": "Home"},
-        entry_id="86129426118ae32020417a53712d6eef",
-    )
+from tests.common import MockConfigEntry


Test coverage has decreased

Name Stmts Miss Cover Missing ------------------------------------------------------------------------------ homeassistant/components/gios/__init__.py 43 1 98% 33 homeassistant/components/gios/config_flow.py 37 0 100% homeassistant/components/gios/const.py 20 0 100% homeassistant/components/gios/coordinator.py 28 0 100% homeassistant/components/gios/diagnostics.py 8 0 100% homeassistant/components/gios/sensor.py 58 1 98% 210 homeassistant/components/gios/system_health.py 10 0 100% ------------------------------------------------------------------------------ TOTAL 204 2 99%

Fixed.

Name Stmts Miss Cover Missing ------------------------------------------------------------------------------ homeassistant/components/gios/__init__.py 43 0 100% homeassistant/components/gios/config_flow.py 37 0 100% homeassistant/components/gios/const.py 20 0 100% homeassistant/components/gios/coordinator.py 28 0 100% homeassistant/components/gios/diagnostics.py 8 0 100% homeassistant/components/gios/sensor.py 58 0 100% homeassistant/components/gios/system_health.py 10 0 100% ------------------------------------------------------------------------------ TOTAL 204 0 100%

Two problems:

Refactor tests in GIOS #155756 (comment)

and missing tests for unique_id int -> str migration

bieniu · 2025-11-04T15:39:17Z

tests/components/gios/test_config_flow.py

+    )
+
+    assert result["type"] is FlowResultType.FORM
    assert result["errors"] == {"base": "cannot_connect"}


Here it is also necessary to prove that recovery flow after an error is possible.

bieniu · 2025-11-04T15:42:01Z

tests/components/gios/test_sensor.py

+@pytest.fixture(autouse=True)
+def override_platforms() -> Generator[None]:
+    """Override PLATFORMS."""
+    with patch("homeassistant.components.gios.PLATFORMS", [Platform.SENSOR]):
+        yield


Why patch PLATFORMS if the integration only supports the SENSOR platform?

This is old code and I extended it to cover the entire module.

core/tests/components/gios/test_sensor.py

Line 27 in 4cdfa3b

with patch("homeassistant.components.gios.PLATFORMS", [Platform.SENSOR]):

tests/components/gios/conftest.py

tests/components/gios/test_sensor.py

home-assistant · 2025-11-04T15:56:56Z

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.

Refactor tests in GIOS

eeb7314

home-assistant bot added cla-signed has-tests integration: gios small-pr PRs with less than 30 lines. labels Nov 3, 2025

home-assistant bot assigned bieniu Nov 3, 2025

home-assistant bot added the Quality Scale: No score label Nov 3, 2025

mik-laj added 3 commits November 3, 2025 22:14

fixup! Refactor tests in GIOS

e1b7499

fixup! fixup! Refactor tests in GIOS

07e3b24

fixup! fixup! fixup! Refactor tests in GIOS

8f35686

mik-laj commented Nov 3, 2025

View reviewed changes

tests/components/gios/conftest.py Outdated Show resolved Hide resolved

mik-laj commented Nov 3, 2025

View reviewed changes

tests/components/gios/test_config_flow.py Show resolved Hide resolved

mik-laj marked this pull request as ready for review November 3, 2025 22:42

mik-laj requested a review from bieniu as a code owner November 3, 2025 22:42

Copilot AI review requested due to automatic review settings November 3, 2025 22:42

Copilot AI reviewed Nov 3, 2025

View reviewed changes

tests/components/gios/conftest.py Outdated Show resolved Hide resolved

tests/components/gios/__init__.py Outdated Show resolved Hide resolved

mik-laj mentioned this pull request Nov 3, 2025

Set station name as device name in GIOS #155762

Draft

21 tasks

fixup! fixup! fixup! fixup! Refactor tests in GIOS

935d6d2

mik-laj force-pushed the gios-fix-4 branch from 51fdcd8 to 935d6d2 Compare November 3, 2025 23:31

fixup! fixup! fixup! fixup! fixup! Refactor tests in GIOS

14220e9

bieniu added the code-quality label Nov 4, 2025

bieniu requested changes Nov 4, 2025

View reviewed changes

home-assistant bot marked this pull request as draft November 4, 2025 15:56

mik-laj and others added 2 commits November 5, 2025 00:08

fixup! fixup! fixup! fixup! fixup! fixup! Refactor tests in GIOS

bcd6fb7

Merge branch 'dev' into gios-fix-4

e16e2b3

		assert state.state == "good"


		async def test_invalid_indexes(hass: HomeAssistant) -> None:

Uh oh!

Refactor tests in GIOS #155756

Are you sure you want to change the base?

Refactor tests in GIOS #155756

Conversation

mik-laj commented Nov 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Type of change

Additional information

Checklist

Uh oh!

home-assistant bot commented Nov 3, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mik-laj Nov 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

home-assistant bot commented Nov 4, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mik-laj commented Nov 3, 2025 •

edited

Loading

mik-laj Nov 3, 2025 •

edited

Loading