IGD review fixes (#17400)

* Fix discovery-dependency for upnp

* Only delete port mappings on EVENT_HOMEASSISTANT_STOP + refactoring MockDevice

* Call and store local_ip from async_setup

* Don't depend on http-component

* Remove discovery dependency
This commit is contained in:
Steven Looman 2018-10-23 21:52:01 +02:00 committed by Paulus Schoutsen
parent 0f69be117f
commit fc8af22191
3 changed files with 118 additions and 67 deletions

View file

@ -9,6 +9,7 @@ from homeassistant.components.upnp.device import Device
from homeassistant.const import EVENT_HOMEASSISTANT_STOP
from tests.common import MockConfigEntry
from tests.common import MockDependency
from tests.common import mock_coro
@ -17,7 +18,7 @@ class MockDevice(Device):
def __init__(self, udn):
"""Initializer."""
super().__init__(None)
super().__init__(MagicMock())
self._udn = udn
self.added_port_mappings = []
self.removed_port_mappings = []
@ -49,7 +50,15 @@ class MockDevice(Device):
async def test_async_setup_no_auto_config(hass):
"""Test async_setup."""
# setup component, enable auto_config
await async_setup_component(hass, 'upnp')
config = {
'discovery': {},
# no upnp
}
with MockDependency('netdisco.discovery'), \
patch('homeassistant.components.upnp.get_local_ip',
return_value='192.168.1.10'):
await async_setup_component(hass, 'upnp', config)
await hass.async_block_till_done()
assert hass.data[upnp.DOMAIN]['auto_config'] == {
'active': False,
@ -62,7 +71,15 @@ async def test_async_setup_no_auto_config(hass):
async def test_async_setup_auto_config(hass):
"""Test async_setup."""
# setup component, enable auto_config
await async_setup_component(hass, 'upnp', {'upnp': {}, 'discovery': {}})
config = {
'discovery': {},
'upnp': {},
}
with MockDependency('netdisco.discovery'), \
patch('homeassistant.components.upnp.get_local_ip',
return_value='192.168.1.10'):
await async_setup_component(hass, 'upnp', config)
await hass.async_block_till_done()
assert hass.data[upnp.DOMAIN]['auto_config'] == {
'active': True,
@ -75,12 +92,18 @@ async def test_async_setup_auto_config(hass):
async def test_async_setup_auto_config_port_mapping(hass):
"""Test async_setup."""
# setup component, enable auto_config
await async_setup_component(hass, 'upnp', {
config = {
'discovery': {},
'upnp': {
'port_mapping': True,
'ports': {'hass': 'hass'},
},
'discovery': {}})
}
with MockDependency('netdisco.discovery'), \
patch('homeassistant.components.upnp.get_local_ip',
return_value='192.168.1.10'):
await async_setup_component(hass, 'upnp', config)
await hass.async_block_till_done()
assert hass.data[upnp.DOMAIN]['auto_config'] == {
'active': True,
@ -93,9 +116,15 @@ async def test_async_setup_auto_config_port_mapping(hass):
async def test_async_setup_auto_config_no_sensors(hass):
"""Test async_setup."""
# setup component, enable auto_config
await async_setup_component(hass, 'upnp', {
config = {
'discovery': {},
'upnp': {'sensors': False},
'discovery': {}})
}
with MockDependency('netdisco.discovery'), \
patch('homeassistant.components.upnp.get_local_ip',
return_value='192.168.1.10'):
await async_setup_component(hass, 'upnp', config)
await hass.async_block_till_done()
assert hass.data[upnp.DOMAIN]['auto_config'] == {
'active': True,
@ -115,18 +144,23 @@ async def test_async_setup_entry_default(hass):
'port_mapping': False,
})
# ensure hass.http is available
await async_setup_component(hass, 'upnp')
config = {
'http': {},
'discovery': {},
# no upnp
}
with MockDependency('netdisco.discovery'), \
patch('homeassistant.components.upnp.get_local_ip',
return_value='192.168.1.10'):
await async_setup_component(hass, 'http', config)
await async_setup_component(hass, 'upnp', config)
await hass.async_block_till_done()
# mock homeassistant.components.upnp.device.Device
mock_device = MagicMock()
mock_device.udn = udn
mock_device.async_add_port_mappings.return_value = mock_coro()
mock_device.async_delete_port_mappings.return_value = mock_coro()
with patch.object(Device, 'async_create_device') as mock_create_device:
mock_create_device.return_value = mock_coro(
return_value=mock_device)
with patch('homeassistant.components.upnp.device.get_local_ip',
mock_device = MockDevice(udn)
with patch.object(Device, 'async_create_device') as create_device:
create_device.return_value = mock_coro(return_value=mock_device)
with patch('homeassistant.components.upnp.get_local_ip',
return_value='192.168.1.10'):
assert await upnp.async_setup_entry(hass, entry) is True
@ -136,12 +170,9 @@ async def test_async_setup_entry_default(hass):
hass.bus.async_fire(EVENT_HOMEASSISTANT_STOP)
await hass.async_block_till_done()
# ensure cleaned up
assert udn not in hass.data[upnp.DOMAIN]['devices']
# ensure no port-mapping-methods called
assert len(mock_device.async_add_port_mappings.mock_calls) == 0
assert len(mock_device.async_delete_port_mappings.mock_calls) == 0
# ensure no port-mappings created or removed
assert not mock_device.added_port_mappings
assert not mock_device.removed_port_mappings
async def test_async_setup_entry_port_mapping(hass):
@ -154,35 +185,37 @@ async def test_async_setup_entry_port_mapping(hass):
'port_mapping': True,
})
# ensure hass.http is available
await async_setup_component(hass, 'upnp', {
config = {
'http': {},
'discovery': {},
'upnp': {
'port_mapping': True,
'ports': {'hass': 'hass'},
},
'discovery': {},
})
}
with MockDependency('netdisco.discovery'), \
patch('homeassistant.components.upnp.get_local_ip',
return_value='192.168.1.10'):
await async_setup_component(hass, 'http', config)
await async_setup_component(hass, 'upnp', config)
await hass.async_block_till_done()
mock_device = MockDevice(udn)
with patch.object(Device, 'async_create_device') as mock_create_device:
mock_create_device.return_value = mock_coro(return_value=mock_device)
with patch('homeassistant.components.upnp.device.get_local_ip',
return_value='192.168.1.10'):
assert await upnp.async_setup_entry(hass, entry) is True
with patch.object(Device, 'async_create_device') as create_device:
create_device.return_value = mock_coro(return_value=mock_device)
# ensure device is stored/used
assert hass.data[upnp.DOMAIN]['devices'][udn] == mock_device
assert await upnp.async_setup_entry(hass, entry) is True
# ensure add-port-mapping-methods called
assert mock_device.added_port_mappings == [
[8123, ip_address('192.168.1.10'), 8123]
]
# ensure device is stored/used
assert hass.data[upnp.DOMAIN]['devices'][udn] == mock_device
hass.bus.async_fire(EVENT_HOMEASSISTANT_STOP)
await hass.async_block_till_done()
# ensure add-port-mapping-methods called
assert mock_device.added_port_mappings == [
[8123, ip_address('192.168.1.10'), 8123]
]
# ensure cleaned up
assert udn not in hass.data[upnp.DOMAIN]['devices']
hass.bus.async_fire(EVENT_HOMEASSISTANT_STOP)
await hass.async_block_till_done()
# ensure delete-port-mapping-methods called
assert mock_device.removed_port_mappings == [8123]