Skip to main content

A pytest plugin for use with homeassistant custom components.

Project description

PyPI version Python versions GitHub Workflow Status

A pytest plugin for use with Home Assistant custom components.

This pytest plugin provides several pytest fixtures and utils to make testing Home Assistant custom components easier.

The plugin allows you to use a subset of fixtures and helpers from the Home Assistant test code to allow you to test your own custom components.



  • hass - Used to mock a hass instance. This is primarily useful in testing your config_flow code. Examples of it’s usage can be found in the Home Assistant tests.

from custom_components.steam_wishlist import config_flow

async def test_flow_init(hass):
    """Test the initial flow."""
    result = await hass.config_entries.flow.async_init(
        config_flow.DOMAIN, context={"source": "user"}

    expected = {
        "data_schema": config_flow.DATA_SCHEMA,
        "description_placeholders": None,
        "errors": {},
        "flow_id": mock.ANY,
        "handler": "steam_wishlist",
        "step_id": "user",
        "type": "form",
    assert expected == result
  • aioclient_mock - Used to mock responses from homeassistant.helpers.aiohttp_client.async_get_clientsession in your test code.

You can find example usage of both of these fixtures in the Home Assistant tests directory.


  • pytest_homeassistant.async_mock - Contains all mock methods that can handle async calls.

from pytest_homeassistant.async_mock import AsyncMock
from custom_components.steam_wishlist import sensor_manager

async def test_sensormanager_async_register_component(
    hass, coordinator_mock
"""Test that we add listeners and referesh data if all platforms were registered."""
    manager = sensor_manager.SensorManager(hass, url="")
    mock_async_add_entities = AsyncMock()
    await manager.async_register_component("sensor", mock_async_add_entities)

    assert mock_async_add_entities.called is True


  • homeassistant


You can install “pytest-homeassistant” via pip from PyPI:

$ pip install pytest-homeassistant


Contributions are very welcome. I only incldued fixtures and test helpers that were useful to me when testing my custom components. If there are others that would be useful to you, pull requests are welcome!


Distributed under the terms of the MIT license, “pytest-homeassistant” is free and open source software.


If you encounter any problems, please file an issue along with a detailed description.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytest-homeassistant-0.1.1.tar.gz (12.1 kB view hashes)

Uploaded Source

Built Distribution

pytest_homeassistant-0.1.1-py3.7.egg (24.8 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page