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

Fix CI test_invalid_rrule_fix test by freezing the time #105294

Merged
merged 1 commit into from
Dec 8, 2023

Conversation

jbouwh
Copy link
Contributor

@jbouwh jbouwh commented Dec 8, 2023

Proposed change

Fix CI test_invalid_rrule_fix test by freezing the time. The test used the current time, but that fails if the current time falls outside of the event scope. Freezing the time fixes consistency the test.

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

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

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 Ruff (ruff format 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:

@home-assistant
Copy link

home-assistant bot commented Dec 8, 2023

Hey there @allenporter, mind taking a look at this pull request as it has been labeled with an integration (google) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of google can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign google Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

Copy link
Member

@jpbede jpbede left a comment

Choose a reason for hiding this comment

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

Looks good, thanks 👍

@@ -1301,6 +1301,7 @@ async def test_event_differs_timezone(
}


@pytest.mark.freeze_time("2023-11-30 12:15:00 +00:00")
Copy link
Member

Choose a reason for hiding this comment

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

How was the datetime selected? It doesn't match any of the recurrence dates, which seem to be one Friday a month. Is that correct?

Copy link
Member

Choose a reason for hiding this comment

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

It overlaps with one of the Fridays. Is that the idea?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The tests takes the current time, I guess that is the reason why this test could pass before. So I picked a time in the past.
Possible the test it self needs improvements too, as this might be a bug. But that is something to be addressed in an other PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It overlaps with one of the Fridays. Is that the idea?

I was just lucky to find a date and time that made the test pass to be honest.

Copy link
Member

@frenck frenck Dec 8, 2023

Choose a reason for hiding this comment

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

The thing that went wrong is the calendar entity that was on or off based if the current time fell into the calendar event rule or not.

This made the test flaky by design. This is a correct adjustment IMHO, as it time outside of the event (which was validated by assert state.state == STATE_OFF).

Copy link
Member

Choose a reason for hiding this comment

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

Ok, I guess we can merge for now if it passes, but @allenporter should follow up and check if this is intended.

@jbouwh jbouwh merged commit 8721327 into dev Dec 8, 2023
23 checks passed
@jbouwh jbouwh deleted the jbouwh-fix-google-calendar-test branch December 8, 2023 13:35
@frenck frenck added this to the 2023.12.2 milestone Dec 8, 2023
@frenck frenck mentioned this pull request Dec 8, 2023
@github-actions github-actions bot locked and limited conversation to collaborators Dec 9, 2023
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.

5 participants