pytest-homeassistant-custom-component
Package to automatically extract testing plugins from Home Assistant for custom component testing. The goal is to provide the same functionality as the tests in home-assistant/core. pytest-homeassistant-custom-component is updated daily according to the latest homeassistant release including beta.
Usage:
- All pytest fixtures can be used as normal, like
hass - For helpers:
- home-assistant/core native test:
from tests.common import MockConfigEntry - custom component test:
from pytest_homeassistant_custom_component.common import MockConfigEntry
- home-assistant/core native test:
- If your integration is inside a
custom_componentsfolder, acustom_components/__init__.pyfile or changes tosys.pathmay be required. enable_custom_integrationsfixture is required (versions >=2021.6.0b0)- Some fixtures, e.g.
recorder_mock, need to be initialized beforeenable_custom_integrations. See https://github.com/MatthewFlamm/pytest-homeassistant-custom-component/issues/132.
- Some fixtures, e.g.
- pytest-asyncio might now require
asyncio_mode = autoconfig, see #129. - If using
load_fixture, the files need to be in afixturesfolder colocated with the tests. For example, a test intest_sensor.pycan load data fromsome_data.jsonusingload_fixturefrom this structure:
tests/
fixtures/
some_data.json
test_sensor.py
- When using syrupy snapshots, add a
snapshotfixture to conftest.py to make sure the snapshots are loaded from snapshot folder colocated with the tests.
from pytest_homeassistant_custom_component.syrupy import HomeAssistantSnapshotExtension
from syrupy.assertion import SnapshotAssertion
@pytest.fixture
def snapshot(snapshot: SnapshotAssertion) -> SnapshotAssertion:
"""Return snapshot assertion fixture with the Home Assistant extension."""
return snapshot.use_extension(HomeAssistantSnapshotExtension)
Examples:
- See list of custom components as examples that use this package.
- Also see tests for
simple_integrationin this repository. - Use cookiecutter-homeassistant-custom-component to create a custom component with tests by using cookiecutter.
- The github-custom-component-tutorial explaining in details how to create a custom componenent with a test suite using this package.
More Info
This repository is set up to be nearly fully automatic.
- Version of home-assistant/core is given in
ha_version,pytest_homeassistant_custom_component.const, and in the README above. - This package is generated against published releases of homeassistant and updated daily.
- PRs should not include changes to the
pytest_homeassistant_custom_componentfiles. CI testing will automatically generate the new files.
Version Strategy
- When changes in extraction are required, there will be a change in the minor version.
- A change in the patch version indicates that it was an automatic update with a homeassistant version.
- This enables tracking back to which versions of pytest-homeassistant-custom-component can be used for extracting testing utilities from which version of homeassistant.
This package was inspired by pytest-homeassistant by @boralyl, but is intended to more closely and automatically track the home-assistant/core library.
1 maintainer
Release files for pytest-homeassistant-custom-component-framework 1.0.51
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pytest_homeassistant_custom_component_framework-1.0.51.tar.gz | 63.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pytest_homeassistant_custom_component_framework-1.0.51-py3-none-any.whl | Python 3 | none | any | Details |
Total release size:131.8 kB
Release files / pytest_homeassistant_custom_component_framework-1.0.51.tar.gz
| Download URL | pytest_homeassistant_custom_component_framework-1.0.51.tar.gz |
|---|---|
| Size | 63.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
14bee94ff5af19f4c59f9668fba095b40f40ff6988403644d9e0cbfd31a6bc94
|
|
BLAKE2b-256 checksum How to use checksums |
a2bd5915c292d5d8af3f3cf4c23ae0d86712a6a708b893e50754f11daa7798ce
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pytest_homeassistant_custom_component_framework-1.0.51-py3-none-any.whl
| Download URL | pytest_homeassistant_custom_component_framework-1.0.51-py3-none-any.whl |
|---|---|
| Size | 68.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0cf304059835bb80bee41087d727236c4ab4e301822f4adcb64342504a89299e
|
|
BLAKE2b-256 checksum How to use checksums |
6d396ced9efd8d4794c71af06677e3e5e0062891e8b99e90f306e594fc70a59f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
