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

Jump to bottom

Adjust reauth/reconfigure documentation to highlight expected result #2352

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Adjust reauth/reconfigure documentation to highlight expected result #2352

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3b5ef0b
Adjust reauth/reconfigure documentation to highlight expected result
epenet Oct 4, 2024
0ae39aa
Update config_entries_config_flow_handler.md
epenet Oct 4, 2024
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
16 changes: 13 additions & 3 deletions docs/config_entries_config_flow_handler.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,15 +283,23 @@ class ExampleConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):

async def async_step_reconfigure(self, user_input: dict[str, Any] | None = None):
if user_input is not None:
pass # TODO: process user input
# TODO: process user input
return self.async_update_reload_and_abort(
self._get_reauth_entry(),
data=data,
)

return self.async_show_form(
step_id="reconfigure",
data_schema=vol.Schema({vol.Required("input_parameter"): str}),
)
```

Please note that checking whether you are in a reconfigure flow can be done using `if self.source == SOURCE_RECONFIGURE`.
On success, reconfiguration flows are expected to update the current entry and abort; they should not create a new entry.
This is usually done with the `return self.async_update_reload_and_abort` helper.
Automated tests should verify that the reconfigure flow updates the existing config entry and does not create additional entries.

Checking whether you are in a reconfigure flow can be done using `if self.source == SOURCE_RECONFIGURE`.
It is also possible to access the corresponding config entry using `self._get_reconfigure_entry()`.


Expand Down Expand Up @@ -385,9 +393,11 @@ See [Translations](#translations) local development instructions.

Authentication failures (such as a revoked oauth token) can be a little tricky to manually test. One suggestion is to make a copy of `config/.storage/core.config_entries` and manually change the values of `access_token`, `refresh_token`, and `expires_at` depending on the scenario you want to test. You can then walk advance through the reauth flow and confirm that the values get replaced with new valid tokens.

On success, reauth flows are expected to update the current entry and abort; they should not create a new entry.
This is usually done with the `return self.async_update_reload_and_abort` helper.
Automated tests should verify that the reauth flow updates the existing config entry and does not create additional entries.

Please note that checking whether you are in a reauthentication flow can be done using `if self.source == SOURCE_REAUTH`.
Checking whether you are in a reauthentication flow can be done using `if self.source == SOURCE_REAUTH`.
It is also possible to access the corresponding config entry using `self._get_reauth_entry()`.

## Testing your config flow
Expand Down