WordPress / openverse-api

The Openverse API allows programmatic access to search for CC-licensed and public domain digital media.
https://api.openverse.engineering/v1
MIT License
77 stars 51 forks source link

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

Closed sarayourfriend closed 1 year ago

sarayourfriend commented 1 year ago

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

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. ```
github-actions[bot] commented 1 year ago

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.