switchbot-mqtt/tests/test_actor_base_device_info.py

# switchbot-mqtt - MQTT client controlling SwitchBot button & curtain automators,
# compatible with home-assistant.io's MQTT Switch & Cover platform
#
# Copyright (C) 2021 Fabian Peter Hammerle <fabian@hammerle.me>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.

import os
import re
import typing
import unittest.mock

import bluepy.btle
import pytest

from switchbot_mqtt._actors import _ButtonAutomator, _CurtainMotor
from switchbot_mqtt._actors._base import _MQTTControlledActor

# pylint: disable=protected-access

_LE_ON_PERMISSION_DENIED_ERROR = bluepy.btle.BTLEManagementError(
    "Failed to execute management command 'le on'",
    {
        "rsp": ["mgmt"],
        "code": ["mgmterr"],
        "estat": [20],
        "emsg": ["Permission Denied"],
    },
)


@pytest.mark.parametrize("actor_class", [_CurtainMotor, _ButtonAutomator])
def test__update_device_info_le_on_permission_denied_log(
    actor_class: typing.Type[_MQTTControlledActor],
) -> None:  # pySwitchbot>=v0.10.0
    actor = actor_class(mac_address="dummy", retry_count=0, password=None)
    with unittest.mock.patch(
        "bluepy.btle.Scanner.scan",
        side_effect=_LE_ON_PERMISSION_DENIED_ERROR,
    ), pytest.raises(
        PermissionError, match=r"^bluepy-helper failed to enable low energy mode "
    ) as exc_info:
        actor._update_device_info()
    assert "sudo setcap cap_net_admin+ep /" in exc_info.exconly()
    assert exc_info.value.__cause__ == _LE_ON_PERMISSION_DENIED_ERROR


@pytest.mark.parametrize("actor_class", [_CurtainMotor, _ButtonAutomator])
def test__update_device_info_le_on_permission_denied_exc(
    actor_class: typing.Type[_MQTTControlledActor],
) -> None:  # pySwitchbot<v0.10.1
    actor = actor_class(mac_address="dummy", retry_count=21, password=None)
    with unittest.mock.patch.object(
        actor._get_device(),
        "update",
        side_effect=_LE_ON_PERMISSION_DENIED_ERROR,
    ) as update_mock, pytest.raises(
        PermissionError, match=r"^bluepy-helper failed to enable low energy mode "
    ) as exc_info:
        actor._update_device_info()
    update_mock.assert_called_once_with()
    bluepy_helper_path_match = re.search(
        r"sudo setcap cap_net_admin\+ep (\S+/bluepy-helper)\b",
        exc_info.exconly(),
    )
    assert bluepy_helper_path_match is not None
    assert os.path.isfile(bluepy_helper_path_match.group(1))
    assert exc_info.value.__cause__ == _LE_ON_PERMISSION_DENIED_ERROR


@pytest.mark.parametrize("actor_class", [_CurtainMotor, _ButtonAutomator])
def test__update_device_info_other_error(
    actor_class: typing.Type[_MQTTControlledActor],
) -> None:
    actor = actor_class(mac_address="dummy", retry_count=21, password=None)
    side_effect = bluepy.btle.BTLEManagementError("test")
    with unittest.mock.patch.object(
        actor._get_device(), "update", side_effect=side_effect
    ) as update_mock, pytest.raises(type(side_effect)) as exc_info:
        actor._update_device_info()
    update_mock.assert_called_once_with()
    assert exc_info.value == side_effect