Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a helpful message to the config_entries.OperationNotAllowed exception #78631

Merged
merged 1 commit into from
Sep 17, 2022
Merged

Add a helpful message to the config_entries.OperationNotAllowed exception #78631

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions homeassistant/config_entries.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1039,7 +1039,10 @@ async def async_setup(self, entry_id: str) -> bool:
raise UnknownEntry

if entry.state is not ConfigEntryState.NOT_LOADED:
raise OperationNotAllowed
raise OperationNotAllowed(
f"The config entry {entry.title} ({entry.domain}) with entry_id {entry.entry_id}"
f" cannot be setup because is already loaded in the {entry.state} state"
)

# Setup Component if not set up yet
if entry.domain in self.hass.config.components:
Expand All @@ -1061,7 +1064,10 @@ async def async_unload(self, entry_id: str) -> bool:
raise UnknownEntry

if not entry.state.recoverable:
raise OperationNotAllowed
raise OperationNotAllowed(
f"The config entry {entry.title} ({entry.domain}) with entry_id "
f"{entry.entry_id} cannot be unloaded because it is not in a recoverable state ({entry.state})"
)

return await entry.async_unload(self.hass)

Expand Down
16 changes: 11 additions & 5 deletions tests/test_config_entries.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1141,7 +1141,7 @@ async def test_entry_setup_invalid_state(hass, manager, state):
MockModule("comp", async_setup=mock_setup, async_setup_entry=mock_setup_entry),
)

with pytest.raises(config_entries.OperationNotAllowed):
with pytest.raises(config_entries.OperationNotAllowed, match=str(state)):
assert await manager.async_setup(entry.entry_id)

assert len(mock_setup.mock_calls) == 0
Expand Down Expand Up @@ -1201,7 +1201,7 @@ async def test_entry_unload_invalid_state(hass, manager, state):

mock_integration(hass, MockModule("comp", async_unload_entry=async_unload_entry))

with pytest.raises(config_entries.OperationNotAllowed):
with pytest.raises(config_entries.OperationNotAllowed, match=str(state)):
assert await manager.async_unload(entry.entry_id)

assert len(async_unload_entry.mock_calls) == 0
Expand Down Expand Up @@ -1296,7 +1296,7 @@ async def test_entry_reload_error(hass, manager, state):
),
)

with pytest.raises(config_entries.OperationNotAllowed):
with pytest.raises(config_entries.OperationNotAllowed, match=str(state)):
assert await manager.async_reload(entry.entry_id)

assert len(async_unload_entry.mock_calls) == 0
Expand Down Expand Up @@ -1370,7 +1370,10 @@ async def test_entry_disable_without_reload_support(hass, manager):
assert entry.state is config_entries.ConfigEntryState.FAILED_UNLOAD

# Enable
with pytest.raises(config_entries.OperationNotAllowed):
with pytest.raises(
config_entries.OperationNotAllowed,
match=str(config_entries.ConfigEntryState.FAILED_UNLOAD),
):
await manager.async_set_disabled_by(entry.entry_id, None)
assert len(async_setup.mock_calls) == 0
assert len(async_setup_entry.mock_calls) == 0
Expand Down Expand Up @@ -3270,7 +3273,10 @@ async def test_disallow_entry_reload_with_setup_in_progresss(hass, manager):
)
entry.add_to_hass(hass)

with pytest.raises(config_entries.OperationNotAllowed):
with pytest.raises(
config_entries.OperationNotAllowed,
match=str(config_entries.ConfigEntryState.SETUP_IN_PROGRESS),
):
assert await manager.async_reload(entry.entry_id)
assert entry.state is config_entries.ConfigEntryState.SETUP_IN_PROGRESS

Expand Down