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 now requires
asyncio_mode = autoconfig, see https://github.com/MatthewFlamm/pytest-homeassistant-custom-component/issues/129 and https://github.com/MatthewFlamm/pytest-homeassistant-custom-component/issues/247. - 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
Metadata
1 maintainer
Release files for pytest-homeassistant-custom-component 0.13.373
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pytest_homeassistant_custom_component-0.13.373.tar.gz | 82.2 kB | Without provenance | Details for pytest_homeassistant_custom_component-0.13.373.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pytest_homeassistant_custom_component-0.13.373-py3-none-any.whl | Python 3 | none | any | Details for pytest_homeassistant_custom_component-0.13.373-py3-none-any.whl |
Total release size: 170.4 kB
Release files / pytest_homeassistant_custom_component-0.13.373.tar.gz
| Download URL | pytest_homeassistant_custom_component-0.13.373.tar.gz |
|---|---|
| Size | 82.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9f60c292a3482a500e246e45f895660a198341ffd57658191899fa06885feeef
|
|
BLAKE2b-256 checksum How to use checksums |
b35fa49ca00554245f120fcc9dcf227132820b3cafacabeee1fe9d606b454618
|
| 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-0.13.373-py3-none-any.whl
| Download URL | pytest_homeassistant_custom_component-0.13.373-py3-none-any.whl |
|---|---|
| Size | 88.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bdd22816780122def0451564c46b536c9889c14c04da98782ea5db4a40994dab
|
|
BLAKE2b-256 checksum How to use checksums |
bff98834c497ceb427d4dfa8fc7f87de66d8c28c26fc930168c83d2cd835d424
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Security for pytest-homeassistant-custom-component 0.13.373
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
