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.

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 config flow to CalDAV #103215

Merged
merged 9 commits into from Nov 3, 2023

Conversation

allenporter
Copy link
Contributor

@allenporter allenporter commented Nov 2, 2023

Proposed change

Configure caldav from the UI. This is part of a larger series of PRs to prepare caldav to support other platforms (todo).

Error handling was determined based on manual testing of various problems and the client library error codes for various conditions (invalid urls, invalid passwords, invalid hostnames, etc).

Updates test fixtures, moving them to conftest for use during config flow and init tests.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Black (black --fast homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@joostlek joostlek changed the title Configure caldav from the UI Add config flow to CalDAV Nov 2, 2023
homeassistant/components/caldav/__init__.py Outdated Show resolved Hide resolved
homeassistant/components/caldav/__init__.py Outdated Show resolved Hide resolved
if self._supports_offset:
self._attr_extra_state_attributes = {
"offset_reached": is_offset_reached(
self._event.start_datetime_local, self.coordinator.offset
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we going to deprecate the is_offset_reached for the legacy entities or deprecate the legacy entities? If so, I think this is ok, but otherwise our standard nowadays is to set the state attribute to None when we don't know it for the entity.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I would generally like to make it go away slowly, given its weird and hacky and triggers should be the new way to handle this. My thought was to no longer support it from the UI but preserve it for existing yaml users. We could technically support it here since its just pulled from the titles of the calendars.

I was thinking this needed to be announced when making yaml go away, but perhaps i need to start shifting the docs since I kind of punted on what to do about existing yaml for now, assuming it will be possible to deprecate in the future. (I think we may need a better solution for search still like a calendar helper to fully make it go away)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We probably need to at least say in the docs if it's not supported when setting up the integration from the UI.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, i've added a documentation PR (which was missing in the first place) and have addressed this.

homeassistant/components/caldav/config_flow.py Outdated Show resolved Hide resolved
homeassistant/components/caldav/config_flow.py Outdated Show resolved Hide resolved
tests/components/caldav/conftest.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft November 2, 2023 09:08
@home-assistant
Copy link

home-assistant bot commented Nov 2, 2023

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@allenporter allenporter marked this pull request as ready for review November 2, 2023 15:04
@allenporter allenporter merged commit a95aa4e into home-assistant:dev Nov 3, 2023
23 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Nov 4, 2023
@bdraco
Copy link
Member

bdraco commented Nov 4, 2023

Tested and working as expected 👍

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants