python-kasa/tests/test_readme_examples.py

import asyncio

import pytest
import xdoctest
from pytest_mock import MockerFixture

from .conftest import (
    get_device_for_fixture_protocol,
    get_fixture_info,
    patch_discovery,
)


def test_bulb_examples(mocker: MockerFixture) -> None:
    """Use KL130 (bulb with all features) to test the doctests."""
    p = asyncio.run(get_device_for_fixture_protocol("KL130(US)_1.0_1.8.11.json", "IOT"))
    asyncio.run(p.set_alias("Bedroom Bulb"))
    asyncio.run(p.update())

    mocker.patch("kasa.iot.iotbulb.IotBulb", return_value=p)
    mocker.patch("kasa.iot.iotbulb.IotBulb.update")
    res = xdoctest.doctest_module("kasa.iot.iotbulb", "all")
    assert not res["failed"]


def test_iotdevice_examples(mocker: MockerFixture) -> None:
    """Use HS110 for emeter examples."""
    p = asyncio.run(get_device_for_fixture_protocol("HS110(EU)_1.0_1.2.5.json", "IOT"))
    asyncio.run(p.set_alias("Bedroom Lamp Plug"))
    asyncio.run(p.update())

    mocker.patch("kasa.iot.iotdevice.IotDevice", return_value=p)
    mocker.patch("kasa.iot.iotdevice.IotDevice.update")
    res = xdoctest.doctest_module("kasa.iot.iotdevice", "all")
    assert not res["failed"]


def test_plug_examples(mocker: MockerFixture) -> None:
    """Test plug examples."""
    p = asyncio.run(get_device_for_fixture_protocol("HS110(EU)_1.0_1.2.5.json", "IOT"))
    asyncio.run(p.set_alias("Bedroom Lamp Plug"))
    asyncio.run(p.update())
    mocker.patch("kasa.iot.iotplug.IotPlug", return_value=p)
    mocker.patch("kasa.iot.iotplug.IotPlug.update")
    res = xdoctest.doctest_module("kasa.iot.iotplug", "all")
    assert not res["failed"]


def test_strip_examples(readmes_mock) -> None:
    """Test strip examples."""
    res = xdoctest.doctest_module("kasa.iot.iotstrip", "all")
    assert not res["failed"]


def test_dimmer_examples(mocker: MockerFixture) -> None:
    """Test dimmer examples."""
    p = asyncio.run(get_device_for_fixture_protocol("HS220(US)_1.0_1.5.7.json", "IOT"))
    mocker.patch("kasa.iot.iotdimmer.IotDimmer", return_value=p)
    mocker.patch("kasa.iot.iotdimmer.IotDimmer.update")
    res = xdoctest.doctest_module("kasa.iot.iotdimmer", "all")
    assert not res["failed"]


def test_lightstrip_examples(mocker: MockerFixture) -> None:
    """Test lightstrip examples."""
    p = asyncio.run(get_device_for_fixture_protocol("KL430(US)_1.0_1.0.10.json", "IOT"))
    asyncio.run(p.set_alias("Bedroom Lightstrip"))
    asyncio.run(p.update())
    mocker.patch("kasa.iot.iotlightstrip.IotLightStrip", return_value=p)
    mocker.patch("kasa.iot.iotlightstrip.IotLightStrip.update")
    res = xdoctest.doctest_module("kasa.iot.iotlightstrip", "all")
    assert not res["failed"]


def test_discovery_examples(readmes_mock) -> None:
    """Test discovery examples."""
    res = xdoctest.doctest_module("kasa.discover", "all")
    assert res["n_passed"] > 0
    assert res["n_warned"] == 0
    assert not res["failed"]


def test_deviceconfig_examples(readmes_mock) -> None:
    """Test discovery examples."""
    res = xdoctest.doctest_module("kasa.deviceconfig", "all")
    assert res["n_passed"] > 0
    assert res["n_warned"] == 0
    assert not res["failed"]


def test_device_examples(readmes_mock) -> None:
    """Test device examples."""
    res = xdoctest.doctest_module("kasa.device", "all")
    assert res["n_passed"] > 0
    assert res["n_warned"] == 0
    assert not res["failed"]


def test_light_examples(readmes_mock) -> None:
    """Test device examples."""
    res = xdoctest.doctest_module("kasa.interfaces.light", "all")
    assert res["n_passed"] > 0
    assert res["n_warned"] == 0
    assert not res["failed"]


def test_light_preset_examples(readmes_mock) -> None:
    """Test device examples."""
    res = xdoctest.doctest_module("kasa.interfaces.lightpreset", "all")
    assert res["n_passed"] > 0
    assert res["n_warned"] == 0
    assert not res["failed"]


def test_light_effect_examples(readmes_mock) -> None:
    """Test device examples."""
    res = xdoctest.doctest_module("kasa.interfaces.lighteffect", "all")
    assert res["n_passed"] > 0
    assert res["n_warned"] == 0
    assert not res["failed"]


def test_child_examples(readmes_mock) -> None:
    """Test device examples."""
    res = xdoctest.doctest_module("kasa.smart.modules.childdevice", "all")
    assert res["n_passed"] > 0
    assert res["n_warned"] == 0
    assert not res["failed"]


def test_module_examples(readmes_mock) -> None:
    """Test device examples."""
    res = xdoctest.doctest_module("kasa.module", "all")
    assert res["n_passed"] > 0
    assert res["n_warned"] == 0
    assert not res["failed"]


def test_feature_examples(readmes_mock) -> None:
    """Test device examples."""
    res = xdoctest.doctest_module("kasa.feature", "all")
    assert res["n_passed"] > 0
    assert res["n_warned"] == 0
    assert not res["failed"]


def test_tutorial_examples(readmes_mock) -> None:
    """Test discovery examples."""
    res = xdoctest.doctest_module("docs/tutorial.py", "all")
    assert res["n_passed"] > 0
    assert res["n_warned"] == 0
    assert not res["failed"]


def test_childsetup_examples(readmes_mock, mocker: MockerFixture) -> None:
    """Test device examples."""
    pair_resp = [
        {
            "device_id": "SCRUBBED_CHILD_DEVICE_ID_5",
            "category": "subg.trigger.button",
            "device_model": "S200B",
            "name": "I01BU0tFRF9OQU1FIw====",
        }
    ]
    mocker.patch(
        "kasa.smartcam.modules.childsetup.ChildSetup.pair", return_value=pair_resp
    )
    res = xdoctest.doctest_module("kasa.interfaces.childsetup", "all")
    assert res["n_passed"] > 0
    assert res["n_warned"] == 0
    assert not res["failed"]


@pytest.fixture
async def readmes_mock(mocker: MockerFixture):
    fixture_infos = {
        "127.0.0.1": get_fixture_info("KP303(UK)_1.0_1.0.3.json", "IOT"),  # Strip
        "127.0.0.2": get_fixture_info("HS110(EU)_1.0_1.2.5.json", "IOT"),  # Plug
        "127.0.0.3": get_fixture_info("L530E(EU)_3.0_1.1.6.json", "SMART"),  # Bulb
        "127.0.0.4": get_fixture_info("KL430(US)_1.0_1.0.10.json", "IOT"),  # Lightstrip
        "127.0.0.5": get_fixture_info("HS220(US)_1.0_1.5.7.json", "IOT"),  # Dimmer
        "127.0.0.6": get_fixture_info("H200(US)_1.0_1.3.6.json", "SMARTCAM"),  # Hub
    }
    fixture_infos["127.0.0.1"].data["system"]["get_sysinfo"]["alias"] = (
        "Bedroom Power Strip"
    )
    for index, child in enumerate(
        fixture_infos["127.0.0.1"].data["system"]["get_sysinfo"]["children"]
    ):
        child["alias"] = f"Plug {index + 1}"
    fixture_infos["127.0.0.2"].data["system"]["get_sysinfo"]["alias"] = (
        "Bedroom Lamp Plug"
    )
    fixture_infos["127.0.0.3"].data["get_device_info"]["nickname"] = (
        "TGl2aW5nIFJvb20gQnVsYg=="  # Living Room Bulb
    )
    fixture_infos["127.0.0.4"].data["system"]["get_sysinfo"]["alias"] = (
        "Bedroom Lightstrip"
    )
    fixture_infos["127.0.0.5"].data["system"]["get_sysinfo"]["alias"] = (
        "Living Room Dimmer Switch"
    )
    fixture_infos["127.0.0.6"].data["getDeviceInfo"]["device_info"]["basic_info"][
        "device_alias"
    ] = "Tapo Hub"
    return patch_discovery(fixture_infos, mocker)