Skip to main content

Experimental package to automatically extract test plugins for Home Assistant custom components

Project description

pytest-homeassistant-custom-component

HA core version

Open in Gitpod

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
  • If your integration is inside a custom_components folder, a custom_components/__init__.py file or changes to sys.path may be required.
  • enable_custom_integrations fixture is required (versions >=2021.6.0b0)
  • pytest-asyncio might now require asyncio_mode = auto config, see #129.
  • If using load_fixture, the files need to be in a fixtures folder colocated with the tests. For example, a test in test_sensor.py can load data from some_data.json using load_fixture from this structure:
tests/
   fixtures/
      some_data.json
   test_sensor.py
  • When using syrupy snapshots, add a snapshot fixture 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:

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_component files. 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.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

Built Distribution

File details

Details for the file pytest_homeassistant_custom_component-0.13.261.tar.gz.

File metadata

File hashes

Hashes for pytest_homeassistant_custom_component-0.13.261.tar.gz
Algorithm Hash digest
SHA256 290ea5aa7e6a6217f30f516f1f6a7fae2153f7f4b86b5d6aded6d31e06aed3ee
MD5 16c96988b0d43bf0998feeaa5c0711e4
BLAKE2b-256 14f952c30fafbace763ee2f56756ae036c84405e7a59dd42493c7a2241717815

See more details on using hashes here.

File details

Details for the file pytest_homeassistant_custom_component-0.13.261-py3-none-any.whl.

File metadata

File hashes

Hashes for pytest_homeassistant_custom_component-0.13.261-py3-none-any.whl
Algorithm Hash digest
SHA256 26da125f2bf26f5a04da0a8719f655641afccf4fc62d686dd03e86809758658f
MD5 5c253f1be9c820d894d545c761c8a22c
BLAKE2b-256 c4af24ddd4c2295f0b86aaf77ea3c43116d7b4f22d48a1ec6190d1bee6106ca3

See more details on using hashes here.

Supported by

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