Improve SmartThings test mocking (#25028)

* Migrate to asynctest

* Simplify mock access

* Use mocks
This commit is contained in:
Andrew Sayre authored and GitHub committed 2019-07-08 22:39:55 -04:00
1 parent 2fbbcafaed
commit a31e49c857
5 files changed
+186 -336

No files matched your search

+57 -127
View File
@@ -1,12 +1,11 @@
"""Test configuration and mocks for the SmartThings component."""
from collections import defaultdict
from unittest.mock import Mock, patch
from uuid import uuid4
from asynctest import Mock, patch
from pysmartthings import (
CLASSIFICATION_AUTOMATION, AppEntity, AppOAuthClient, AppSettings,
DeviceEntity, InstalledApp, Location, SceneEntity, SmartThings,
Subscription)
DeviceEntity, DeviceStatus, InstalledApp, InstalledAppStatus,
InstalledAppType, Location, SceneEntity, SmartThings, Subscription)
from pysmartthings.api import Api
import pytest
@@ -22,8 +21,6 @@ from homeassistant.config_entries import (
from homeassistant.const import CONF_ACCESS_TOKEN, CONF_WEBHOOK_ID
from homeassistant.setup import async_setup_component
from tests.common import mock_coro
COMPONENT_PREFIX = "homeassistant.components.smartthings."
@@ -58,11 +55,9 @@ async def setup_component(hass, config_file, hass_storage):
def _create_location():
loc = Location()
loc.apply_data({
'name': 'Test Location',
'locationId': str(uuid4())
})
loc = Mock(Location)
loc.name = 'Test Location'
loc.location_id = str(uuid4())
return loc
@@ -81,58 +76,50 @@ def locations_fixture(location):
@pytest.fixture(name="app")
def app_fixture(hass, config_file):
"""Fixture for a single app."""
app = AppEntity(Mock())
app.apply_data({
'appName': APP_NAME_PREFIX + str(uuid4()),
'appId': str(uuid4()),
'appType': 'WEBHOOK_SMART_APP',
'classifications': [CLASSIFICATION_AUTOMATION],
'displayName': 'Home Assistant',
'description':
hass.config.location_name + " at " + hass.config.api.base_url,
'singleInstance': True,
'webhookSmartApp': {
'targetUrl': webhook.async_generate_url(
hass, hass.data[DOMAIN][CONF_WEBHOOK_ID]),
'publicKey': ''}
})
app.refresh = Mock()
app.refresh.return_value = mock_coro()
app.save = Mock()
app.save.return_value = mock_coro()
settings = AppSettings(app.app_id)
settings.settings[SETTINGS_INSTANCE_ID] = config_file[CONF_INSTANCE_ID]
app.settings = Mock()
app.settings.return_value = mock_coro(return_value=settings)
app = Mock(AppEntity)
app.app_name = APP_NAME_PREFIX + str(uuid4())
app.app_id = str(uuid4())
app.app_type = 'WEBHOOK_SMART_APP'
app.classifications = [CLASSIFICATION_AUTOMATION]
app.display_name = 'Home Assistant'
app.description = hass.config.location_name + " at " + \
hass.config.api.base_url
app.single_instance = True
app.webhook_target_url = webhook.async_generate_url(
hass, hass.data[DOMAIN][CONF_WEBHOOK_ID])
settings = Mock(AppSettings)
settings.app_id = app.app_id
settings.settings = {SETTINGS_INSTANCE_ID: config_file[CONF_INSTANCE_ID]}
app.settings.return_value = settings
return app
@pytest.fixture(name="app_oauth_client")
def app_oauth_client_fixture():
"""Fixture for a single app's oauth."""
return AppOAuthClient({
'oauthClientId': str(uuid4()),
'oauthClientSecret': str(uuid4())
})
client = Mock(AppOAuthClient)
client.client_id = str(uuid4())
client.client_secret = str(uuid4())
return client
@pytest.fixture(name='app_settings')
def app_settings_fixture(app, config_file):
"""Fixture for an app settings."""
settings = AppSettings(app.app_id)
settings.settings[SETTINGS_INSTANCE_ID] = config_file[CONF_INSTANCE_ID]
settings = Mock(AppSettings)
settings.app_id = app.app_id
settings.settings = {SETTINGS_INSTANCE_ID: config_file[CONF_INSTANCE_ID]}
return settings
def _create_installed_app(location_id, app_id):
item = InstalledApp()
item.apply_data(defaultdict(str, {
'installedAppId': str(uuid4()),
'installedAppStatus': 'AUTHORIZED',
'installedAppType': 'UNKNOWN',
'appId': app_id,
'locationId': location_id
}))
item = Mock(InstalledApp)
item.installed_app_id = str(uuid4())
item.installed_app_status = InstalledAppStatus.AUTHORIZED
item.installed_app_type = InstalledAppType.WEBHOOK_SMART_APP
item.app_id = app_id
item.location_id = location_id
return item
@@ -161,10 +148,9 @@ def config_file_fixture():
@pytest.fixture(name='smartthings_mock')
def smartthings_mock_fixture(locations):
"""Fixture to mock smartthings API calls."""
def _location(location_id):
return mock_coro(
return_value=next(location for location in locations
if location.location_id == location_id))
async def _location(location_id):
return next(location for location in locations
if location.location_id == location_id)
smartthings_mock = Mock(SmartThings)
smartthings_mock.location.side_effect = _location
@@ -172,71 +158,23 @@ def smartthings_mock_fixture(locations):
with patch(COMPONENT_PREFIX + "SmartThings", new=mock), \
patch(COMPONENT_PREFIX + "config_flow.SmartThings", new=mock), \
patch(COMPONENT_PREFIX + "smartapp.SmartThings", new=mock):
yield mock
yield smartthings_mock
@pytest.fixture(name='device')
def device_fixture(location):
"""Fixture representing devices loaded."""
item = DeviceEntity(None)
item.status.refresh = Mock()
item.status.refresh.return_value = mock_coro()
item.apply_data({
"deviceId": "743de49f-036f-4e9c-839a-2f89d57607db",
"name": "GE In-Wall Smart Dimmer",
"label": "Front Porch Lights",
"deviceManufacturerCode": "0063-4944-3038",
"locationId": location.location_id,
"deviceTypeId": "8a9d4b1e3b9b1fe3013b9b206a7f000d",
"deviceTypeName": "Dimmer Switch",
"deviceNetworkType": "ZWAVE",
"components": [
{
"id": "main",
"capabilities": [
{
"id": "switch",
"version": 1
},
{
"id": "switchLevel",
"version": 1
},
{
"id": "refresh",
"version": 1
},
{
"id": "indicator",
"version": 1
},
{
"id": "sensor",
"version": 1
},
{
"id": "actuator",
"version": 1
},
{
"id": "healthCheck",
"version": 1
},
{
"id": "light",
"version": 1
}
]
}
],
"dth": {
"deviceTypeId": "8a9d4b1e3b9b1fe3013b9b206a7f000d",
"deviceTypeName": "Dimmer Switch",
"deviceNetworkType": "ZWAVE",
"completedSetup": False
},
"type": "DTH"
})
item = Mock(DeviceEntity)
item.device_id = "743de49f-036f-4e9c-839a-2f89d57607db"
item.name = "GE In-Wall Smart Dimmer"
item.label = "Front Porch Lights"
item.location_id = location.location_id
item.capabilities = [
"switch", "switchLevel", "refresh", "indicator", "sensor", "actuator",
"healthCheck", "light"
]
item.components = {"main": item.capabilities}
item.status = Mock(DeviceStatus)
return item
@@ -269,9 +207,8 @@ def subscription_factory_fixture():
@pytest.fixture(name="device_factory")
def device_factory_fixture():
"""Fixture for creating mock devices."""
api = Mock(spec=Api)
api.post_device_command.side_effect = \
lambda *args, **kwargs: mock_coro(return_value={})
api = Mock(Api)
api.post_device_command.return_value = {}
def _factory(label, capabilities, status: dict = None):
device_data = {
@@ -308,19 +245,12 @@ def device_factory_fixture():
@pytest.fixture(name="scene_factory")
def scene_factory_fixture(location):
"""Fixture for creating mock devices."""
api = Mock(spec=Api)
api.execute_scene.side_effect = \
lambda *args, **kwargs: mock_coro(return_value={})
def _factory(name):
scene_data = {
'sceneId': str(uuid4()),
'sceneName': name,
'sceneIcon': '',
'sceneColor': '',
'locationId': location.location_id
}
return SceneEntity(api, scene_data)
scene = Mock(SceneEntity)
scene.scene_id = str(uuid4())
scene.name = name
scene.location_id = location.location_id
return scene
return _factory