github/ha-core
1
Fork 0
mirror of https://github.com/home-assistant/core synced 2024-10-04 07:58:43 +02:00
Code Releases Activity

Add confirmation to Cast/Sonos/iOS config entries (#16769)

Browse Source 
* Add confirmation to Cast/Sonos/iOS config entries

* Remove redundant code
This commit is contained in:
Paulus Schoutsen 2018-09-21 16:34:37 +02:00 committed by Pascal Vizeli
parent 213171769d
commit 8b42d0c471
5 changed files with 59 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
homeassistant/helpers/config_entry_flow.py
View File

@ -31,40 +31,39 @@ class DiscoveryFlowHandler(config_entries.ConfigFlow):
reason='single_instance_allowed'
)
# Get current discovered entries.
in_progress = self._async_in_progress()
return await self.async_step_confirm()
has_devices = in_progress
if not has_devices:
has_devices = await self.hass.async_add_job(
self._discovery_function, self.hass)
if not has_devices:
return self.async_abort(
reason='no_devices_found'
async def async_step_confirm(self, user_input=None):
"""Confirm setup."""
if user_input is None:
return self.async_show_form(
step_id='confirm',
)
# Cancel the discovered one.
for flow in in_progress:
self.hass.config_entries.flow.async_abort(flow['flow_id'])
if self.context and self.context.get('source') != \
config_entries.SOURCE_DISCOVERY:
# Get current discovered entries.
in_progress = self._async_in_progress()
has_devices = in_progress
if not has_devices:
has_devices = await self.hass.async_add_job(
self._discovery_function, self.hass)
if not has_devices:
return self.async_abort(
reason='no_devices_found'
)
# Cancel the discovered one.
for flow in in_progress:
self.hass.config_entries.flow.async_abort(flow['flow_id'])
return self.async_create_entry(
title=self._title,
data={},
)
async def async_step_confirm(self, user_input=None):
"""Confirm setup."""
if user_input is not None:
return self.async_create_entry(
title=self._title,
data={},
)
return self.async_show_form(
step_id='confirm',
)
async def async_step_discovery(self, discovery_info):
"""Handle a flow initialized by discovery."""
if self._async_in_progress() or self._async_current_entries():

6
tests/components/cast/test_init.py
View File

@ -17,6 +17,12 @@ async def test_creating_entry_sets_up_media_player(hass):
return_value=True):
result = await hass.config_entries.flow.async_init(
cast.DOMAIN, context={'source': config_entries.SOURCE_USER})
# Confirmation form
assert result['type'] == data_entry_flow.RESULT_TYPE_FORM
result = await hass.config_entries.flow.async_configure(
result['flow_id'], {})
assert result['type'] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
await hass.async_block_till_done()

6
tests/components/ios/test_init.py
View File

@ -30,6 +30,12 @@ async def test_creating_entry_sets_up_sensor(hass):
return_value=mock_coro(True)) as mock_setup:
result = await hass.config_entries.flow.async_init(
ios.DOMAIN, context={'source': config_entries.SOURCE_USER})
# Confirmation form
assert result['type'] == data_entry_flow.RESULT_TYPE_FORM
result = await hass.config_entries.flow.async_configure(
result['flow_id'], {})
assert result['type'] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
await hass.async_block_till_done()

6
tests/components/sonos/test_init.py
View File

@ -15,6 +15,12 @@ async def test_creating_entry_sets_up_media_player(hass):
patch('pysonos.discover', return_value=True):
result = await hass.config_entries.flow.async_init(
sonos.DOMAIN, context={'source': config_entries.SOURCE_USER})
# Confirmation form
assert result['type'] == data_entry_flow.RESULT_TYPE_FORM
result = await hass.config_entries.flow.async_configure(
result['flow_id'], {})
assert result['type'] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
await hass.async_block_till_done()

25
tests/helpers/test_config_entry_flow.py
View File

@ -42,22 +42,24 @@ async def test_user_no_devices_found(hass, flow_conf):
"""Test if no devices found."""
flow = config_entries.HANDLERS['test']()
flow.hass = hass
result = await flow.async_step_user()
flow.context = {
'source': config_entries.SOURCE_USER
}
result = await flow.async_step_confirm(user_input={})
assert result['type'] == data_entry_flow.RESULT_TYPE_ABORT
assert result['reason'] == 'no_devices_found'
async def test_user_no_confirmation(hass, flow_conf):
"""Test user requires no confirmation to set up."""
async def test_user_has_confirmation(hass, flow_conf):
"""Test user requires no confirmation to setup."""
flow = config_entries.HANDLERS['test']()
flow.hass = hass
flow_conf['discovered'] = True
result = await flow.async_step_user()
assert result['type'] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
assert result['type'] == data_entry_flow.RESULT_TYPE_FORM
async def test_discovery_single_instance(hass, flow_conf):
@ -100,7 +102,7 @@ async def test_multiple_discoveries(hass, flow_conf):
assert result['type'] == data_entry_flow.RESULT_TYPE_ABORT
async def test_user_init_trumps_discovery(hass, flow_conf):
async def test_only_one_in_progress(hass, flow_conf):
"""Test a user initialized one will finish and cancel discovered one."""
loader.set_component(hass, 'test', MockModule('test'))
@ -112,9 +114,16 @@ async def test_user_init_trumps_discovery(hass, flow_conf):
# User starts flow
result = await hass.config_entries.flow.async_init(
'test', context={'source': config_entries.SOURCE_USER}, data={})
assert result['type'] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
# Discovery flow has been aborted
assert result['type'] == data_entry_flow.RESULT_TYPE_FORM
# Discovery flow has not been aborted
assert len(hass.config_entries.flow.async_progress()) == 2
# Discovery should be aborted once user confirms
result = await hass.config_entries.flow.async_configure(
result['flow_id'], {})
assert result['type'] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
assert len(hass.config_entries.flow.async_progress()) == 0