Create decorator to check service permissions (#22667)
* Create decorator to check service permissions * Typing * Linting * Member comments * Linting * Member comments * Updated import * Owner comments * Linting * Linting * More work * Fixed tests * Removed service helper tests in RainMachine * Linting * Owner comments * Linting * Owner comments Co-Authored-By: bachya <bachya1208@gmail.com>
This commit is contained in:
1 parent
7a6950fd72
commit
fc481133e7
5 files changed
+177
-118
No files matched your search
@@ -1,23 +0,0 @@
|
||||
"""Configuration for Rainmachine tests."""
|
||||
import pytest
|
||||
|
||||
from homeassistant.components.rainmachine.const import DOMAIN
|
||||
from homeassistant.const import (
|
||||
CONF_IP_ADDRESS, CONF_PASSWORD, CONF_PORT, CONF_SCAN_INTERVAL, CONF_SSL)
|
||||
|
||||
from tests.common import MockConfigEntry
|
||||
|
||||
|
||||
@pytest.fixture(name="config_entry")
|
||||
def config_entry_fixture():
|
||||
"""Create a mock RainMachine config entry."""
|
||||
return MockConfigEntry(
|
||||
domain=DOMAIN,
|
||||
title='192.168.1.101',
|
||||
data={
|
||||
CONF_IP_ADDRESS: '192.168.1.101',
|
||||
CONF_PASSWORD: '12345',
|
||||
CONF_PORT: 8080,
|
||||
CONF_SSL: True,
|
||||
CONF_SCAN_INTERVAL: 60,
|
||||
})
|
||||
@@ -1,41 +0,0 @@
|
||||
"""Define tests for permissions on RainMachine service calls."""
|
||||
import asynctest
|
||||
import pytest
|
||||
|
||||
from homeassistant.components.rainmachine.const import DOMAIN
|
||||
from homeassistant.core import Context
|
||||
from homeassistant.exceptions import Unauthorized, UnknownUser
|
||||
from homeassistant.setup import async_setup_component
|
||||
|
||||
from tests.common import mock_coro
|
||||
|
||||
|
||||
async def setup_platform(hass, config_entry):
|
||||
"""Set up the media player platform for testing."""
|
||||
with asynctest.mock.patch('regenmaschine.login') as mock_login:
|
||||
mock_client = mock_login.return_value
|
||||
mock_client.restrictions.current.return_value = mock_coro()
|
||||
mock_client.restrictions.universal.return_value = mock_coro()
|
||||
config_entry.add_to_hass(hass)
|
||||
assert await async_setup_component(hass, DOMAIN)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
|
||||
async def test_services_authorization(
|
||||
hass, config_entry, hass_read_only_user):
|
||||
"""Test that a RainMachine service is halted on incorrect permissions."""
|
||||
await setup_platform(hass, config_entry)
|
||||
|
||||
with pytest.raises(UnknownUser):
|
||||
await hass.services.async_call(
|
||||
'rainmachine',
|
||||
'unpause_watering', {},
|
||||
blocking=True,
|
||||
context=Context(user_id='fake_user_id'))
|
||||
|
||||
with pytest.raises(Unauthorized):
|
||||
await hass.services.async_call(
|
||||
'rainmachine',
|
||||
'unpause_watering', {},
|
||||
blocking=True,
|
||||
context=Context(user_id=hass_read_only_user.id))
|
||||
@@ -38,12 +38,14 @@ def mock_entities():
|
||||
available=True,
|
||||
should_poll=False,
|
||||
supported_features=1,
|
||||
platform='test_domain',
|
||||
)
|
||||
living_room = Mock(
|
||||
entity_id='light.living_room',
|
||||
available=True,
|
||||
should_poll=False,
|
||||
supported_features=0,
|
||||
platform='test_domain',
|
||||
)
|
||||
entities = OrderedDict()
|
||||
entities[kitchen.entity_id] = kitchen
|
||||
@@ -461,3 +463,116 @@ async def test_register_admin_service(hass, hass_read_only_user,
|
||||
))
|
||||
assert len(calls) == 1
|
||||
assert calls[0].context.user_id == hass_admin_user.id
|
||||
|
||||
|
||||
async def test_domain_control_not_async(hass, mock_entities):
|
||||
"""Test domain verification in a service call with an unknown user."""
|
||||
calls = []
|
||||
|
||||
def mock_service_log(call):
|
||||
"""Define a protected service."""
|
||||
calls.append(call)
|
||||
|
||||
with pytest.raises(exceptions.HomeAssistantError):
|
||||
hass.helpers.service.verify_domain_control(
|
||||
'test_domain')(mock_service_log)
|
||||
|
||||
|
||||
async def test_domain_control_unknown(hass, mock_entities):
|
||||
"""Test domain verification in a service call with an unknown user."""
|
||||
calls = []
|
||||
|
||||
async def mock_service_log(call):
|
||||
"""Define a protected service."""
|
||||
calls.append(call)
|
||||
|
||||
with patch('homeassistant.helpers.entity_registry.async_get_registry',
|
||||
return_value=mock_coro(Mock(entities=mock_entities))):
|
||||
protected_mock_service = hass.helpers.service.verify_domain_control(
|
||||
'test_domain')(mock_service_log)
|
||||
|
||||
hass.services.async_register(
|
||||
'test_domain', 'test_service', protected_mock_service, schema=None)
|
||||
|
||||
with pytest.raises(exceptions.UnknownUser):
|
||||
await hass.services.async_call(
|
||||
'test_domain',
|
||||
'test_service', {},
|
||||
blocking=True,
|
||||
context=ha.Context(user_id='fake_user_id'))
|
||||
assert len(calls) == 0
|
||||
|
||||
|
||||
async def test_domain_control_unauthorized(
|
||||
hass, hass_read_only_user, mock_entities):
|
||||
"""Test domain verification in a service call with an unauthorized user."""
|
||||
calls = []
|
||||
|
||||
async def mock_service_log(call):
|
||||
"""Define a protected service."""
|
||||
calls.append(call)
|
||||
|
||||
with patch('homeassistant.helpers.entity_registry.async_get_registry',
|
||||
return_value=mock_coro(Mock(entities=mock_entities))):
|
||||
protected_mock_service = hass.helpers.service.verify_domain_control(
|
||||
'test_domain')(mock_service_log)
|
||||
|
||||
hass.services.async_register(
|
||||
'test_domain', 'test_service', protected_mock_service, schema=None)
|
||||
|
||||
with pytest.raises(exceptions.Unauthorized):
|
||||
await hass.services.async_call(
|
||||
'test_domain',
|
||||
'test_service', {},
|
||||
blocking=True,
|
||||
context=ha.Context(user_id=hass_read_only_user.id))
|
||||
|
||||
|
||||
async def test_domain_control_admin(hass, hass_admin_user, mock_entities):
|
||||
"""Test domain verification in a service call with an admin user."""
|
||||
calls = []
|
||||
|
||||
async def mock_service_log(call):
|
||||
"""Define a protected service."""
|
||||
calls.append(call)
|
||||
|
||||
with patch('homeassistant.helpers.entity_registry.async_get_registry',
|
||||
return_value=mock_coro(Mock(entities=mock_entities))):
|
||||
protected_mock_service = hass.helpers.service.verify_domain_control(
|
||||
'test_domain')(mock_service_log)
|
||||
|
||||
hass.services.async_register(
|
||||
'test_domain', 'test_service', protected_mock_service, schema=None)
|
||||
|
||||
await hass.services.async_call(
|
||||
'test_domain',
|
||||
'test_service', {},
|
||||
blocking=True,
|
||||
context=ha.Context(user_id=hass_admin_user.id))
|
||||
|
||||
assert len(calls) == 1
|
||||
|
||||
|
||||
async def test_domain_control_no_user(hass, mock_entities):
|
||||
"""Test domain verification in a service call with no user."""
|
||||
calls = []
|
||||
|
||||
async def mock_service_log(call):
|
||||
"""Define a protected service."""
|
||||
calls.append(call)
|
||||
|
||||
with patch('homeassistant.helpers.entity_registry.async_get_registry',
|
||||
return_value=mock_coro(Mock(entities=mock_entities))):
|
||||
protected_mock_service = hass.helpers.service.verify_domain_control(
|
||||
'test_domain')(mock_service_log)
|
||||
|
||||
hass.services.async_register(
|
||||
'test_domain', 'test_service', protected_mock_service, schema=None)
|
||||
|
||||
await hass.services.async_call(
|
||||
'test_domain',
|
||||
'test_service', {},
|
||||
blocking=True,
|
||||
context=ha.Context(user_id=None))
|
||||
|
||||
assert len(calls) == 1
|
||||
Reference in new issue
Block a user