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

Prevent real network requests in TLS cleanup test #3715

Merged
merged 2 commits into from Jan 29, 2024
Merged

Conversation

sarayourfriend
Copy link
Contributor

Fixes

Fixes flaky failure present in https://github.com/WordPress/openverse/actions/runs/7699638405/job/20983733877

Description

The flakiness is caused by making real outbound network requests and relying on Flickr responding with a success status code. If Flickr is down, or anything else causes Flickr to not respond with a success (unrelated to our SSL testing method) the test fails in a flaky way.

This change prevents those outbound requests entirely.

Marked critical in line with the flaky test policy.

Testing Instructions

The updated test should pass CI.

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • [N/A] I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • [N/A] I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@sarayourfriend sarayourfriend added 🟥 priority: critical Must be addressed ASAP 🛠 goal: fix Bug fix 💻 aspect: code Concerns the software code in the repository 🧱 stack: ingestion server Related to the ingestion/data refresh server skip-changelog labels Jan 29, 2024
@sarayourfriend sarayourfriend requested a review from a team as a code owner January 29, 2024 17:56
Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

Wonder if something like https://github.com/miketheman/pytest-socket could be used to detect all other network requests .

@sarayourfriend sarayourfriend requested a review from a team as a code owner January 29, 2024 18:13
@sarayourfriend
Copy link
Contributor Author

Pook is able to do that, if we turned it on globally for all tests. It will complain if any requests do not have a corresponding matcher and fail the test. We can add pook.on to pytest setup and pook.off to tear down. That could make things more complicated though.

Case in point, that failure for tldextract which pook didn't have any matchers for. Hopefully pre-populating the cache before running the tests prevents that failure.

@sarayourfriend
Copy link
Contributor Author

Oh, the other issue with blocking all network requests during tests is that we have lots of valid network requests in most of our tests: requests to postgres, elasticsearch, and redis. A blanket disallowal of network requests is essentially impossible.

Pook might be able to handle this if we use "enable_network" and filter requests to our support services out of pook's matching using the filter functions.

@sarayourfriend sarayourfriend merged commit 6f2cc97 into main Jan 29, 2024
40 checks passed
@sarayourfriend sarayourfriend deleted the fix/flaky-tests branch January 29, 2024 22:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository 🛠 goal: fix Bug fix 🟥 priority: critical Must be addressed ASAP skip-changelog 🧱 stack: ingestion server Related to the ingestion/data refresh server
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

3 participants