Decorate potentially flaky tests with @pytest.mark.flaky from pytest-rerunfailures

[namurphy]

Description

This PR adds pytest-rerunfailures to the pytest extensions and adds it to some tests of the downloader.

This PR makes it so that test_optical_density_histogram gets rerun when it fails.

Motivation and context

We can use pytest-rerunfailures to repeat flaky tests, including tests that download stuff.

I learned about from episode 213 of the Python Test podcast!

Related issues

This PR was originally related to #1458.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.36%. Comparing base (20e60aa) to head (c5ad7b0).
Report is 56 commits behind head on main.

❗ Current head c5ad7b0 differs from pull request most recent head 7d5f9f7. Consider uploading reports for the commit 7d5f9f7 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2483      +/-   ##
==========================================
+ Coverage   96.93%   97.36%   +0.42%     
==========================================
  Files         104      104              
  Lines        9163     9361     +198     
==========================================
+ Hits         8882     9114     +232     
+ Misses        281      247      -34     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[namurphy]

pre-commit.ci autofix

[namurphy]

pre-commit.ci autofix

[namurphy]

Putting this on hold for the time being since it may not be needed with #2487.

[namurphy]

Closing this since #2487 was merged and hopefully fixed the problem in #1458. If it recurs, we can try this again.

[namurphy]

@pheuer — One of the tests in this file failed intermittently in a different PR, so I figured it would be worth using the @pytest.mark.flaky decorator here so that the test will get repeated in case of a failure. It'd probably be worth adding this decorator to all unit tests that require an internet connection.

[ejohnson-96]

👍