Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Use environment variable to determine whether to filter dead links by default; fix flaky tests #1043

Merged
merged 2 commits into from
Dec 13, 2022

Conversation

sarayourfriend
Copy link
Contributor

@sarayourfriend sarayourfriend commented Dec 13, 2022

Fixes

Fixes #1041 by @AetherUnbound

Description

The cause of the test failure described in the issue is the dead link filtering. Luckily, for basically all tests and local applications, we do not need to filter dead links by default. Enabling the default to be modified by an environment variable is the quickest solution for this that allows us to clean up tests that were explicitly disabling the dead link filtering, as a bonus.

The default in settings.py is True, which matches the original setting (before the variable existed, before this PR), so there will not need to be additional changes to the deployment configuration to keep the behaviour the same in staging and production.

Testing Instructions

Run the tests locally and confirm they run. Also confirm they pass in CI.

Checklist

  • My pull request has a descriptive title (not a vague title like Update 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.

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 requested a review from a team as a code owner December 13, 2022 03:01
@openverse-bot openverse-bot added 🕹 aspect: interface Concerns end-users' experience with the software 🛠 goal: fix Bug fix 🟥 priority: critical Must be addressed ASAP labels Dec 13, 2022
@github-actions
Copy link

github-actions bot commented Dec 13, 2022

API Developer Docs Preview: Ready

https://wordpress.github.io/openverse-api/_preview/1043

Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again.

You can check the GitHub pages deployment action list to see the current status of the deployments.

@sarayourfriend sarayourfriend changed the title Stop filtering dead links in tests unless necessary Use environment variable to determine whether to filter dead links by default; fix flaky tests Dec 13, 2022
Copy link
Contributor

@AetherUnbound AetherUnbound left a comment

Choose a reason for hiding this comment

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

Allowing this to be set wholesale by env var is a great idea! Tests passed on my machine and code looks good, thanks for the quick fix 🚀

Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

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

This makes sense to me! 👍

Copy link
Contributor

@stacimc stacimc left a comment

Choose a reason for hiding this comment

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

Very smart and quick fix for the testing issue 🚀

@sarayourfriend sarayourfriend merged commit f9b43fd into main Dec 13, 2022
@sarayourfriend sarayourfriend deleted the fix/exact-match-test-result-count branch December 13, 2022 21:57
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
🕹 aspect: interface Concerns end-users' experience with the software 🛠 goal: fix Bug fix 🟥 priority: critical Must be addressed ASAP
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Freesound results are timing out
5 participants