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

Add more resources and studies to flaky tests page in docs #13250

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

gewenyu99
Copy link

Hi there.

I found the flaky tests page in the Pytest docs, and the studies/resources here were helpful, some of which I've not seen.

I wanted to return the favor and share some newer resources and studies that I've found useful while building my solutions.

@gewenyu99
Copy link
Author

Two questions:

  • for a PR like this, should I create and issue first and attach change logs?
  • I have some other studies that aren't publically available in PDF form (as in you need access from the journal publishers), would it be helpful to include them still? Some of them are quite good.

@nicoddemus
Copy link
Member

nicoddemus commented Feb 24, 2025

Thanks! 🙇

for a PR like this, should I create and issue first and attach change logs?

No need, but if you want, you can add a 13250.doc.rst file to CHANGELOG -- but small changes like this are probably not worth it.

I have some other studies that aren't publically available in PDF form (as in you need access from the journal publishers), would it be helpful to include them still? Some of them are quite good.

I think it is fine, thanks! Perhaps add a *(requires account at X)* or *(paid access)* (something like that) to the end to warn readers.

* Bell, Jonathan, Owolabi Legunsen, Michael Hilton, Lamyaa Eloussi, Tifany Yung, and Darko Marinov. "DeFlaker: Automatically detecting flaky tests." In *Proceedings of the 2018 International Conference on Software Engineering*. 2018. `PDF <https://www.jonbell.net/icse18-deflaker.pdf>`__
* Dutta, Saikat and Shi, August and Choudhary, Rutvik and Zhang, Zhekun and Jain, Aryaman and Misailovic, Sasa. "Detecting flaky tests in probabilistic and machine learning applications." In *Proceedings of the 29th ACM SIGSOFT International Symposium on Software Testing and Analysis (ISSTA)*, pp. 211-224. ACM, 2020. `PDF <https://www.cs.cornell.edu/~saikatd/papers/flash-issta20.pdf>`__
* Habchi, Sarra and Haben, Guillaume and Sohn, Jeongju and Franci, Adriano and Papadakis, Mike and Cordy, Maxime and Le Traon, Yves. "What Made This Test Flake? Pinpointing Classes Responsible for Test Flakiness." In Proceedings of the 38th IEEE International Conference on Software Maintenance and Evolution (ICSME), IEEE, 2022. `PDF <https://arxiv.org/abs/2207.10143>`__
* Lamprou, Sokrates. "Non-deterministic tests and where to find them: Empirically investigating the relationship between flaky tests and test smells by examining test order dependency." Bachelor thesis, Department of Computer and Information Science, Linköping University, 2022. LIU-IDA/LITH-EX-G–19/056–SE. `PDF <https://www.diva-portal.org/smash/get/diva2:1713691/FULLTEXT01.pdf>`__
Copy link
Member

Choose a reason for hiding this comment

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

I can't access this link: https://www.diva-portal.org/smash/get/diva2:1713691/FULLTEXT01.pdf

Can you double check please?

Copy link
Author

Choose a reason for hiding this comment

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

Screenshot 2025-02-27 at 3 09 53 PM Hey, I can actually access this link fine, is it a regional access issue?

Copy link
Member

Choose a reason for hiding this comment

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

I can't access this link: diva-portal.org/smash/get/diva2:1713691/FULLTEXT01.pdf

It opens for me (from a Czech IP address).

Comment on lines 144 to 145
* `Athena: Our automated build health management system <https://mill-build.org/blog/4-flaky-tests.html>`_ by Utsav Shah, 2019
* `How To Manage Flaky Tests in your CI Workflows <https://mill-build.org/blog/4-flaky-tests.html>`_ by Li Haoyi, 2025
Copy link
Member

Choose a reason for hiding this comment

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

These two are the same link?

Copy link
Author

Choose a reason for hiding this comment

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

🤦 Yeah let me fix these

@gewenyu99 gewenyu99 requested a review from nicoddemus February 27, 2025 20:15
@gewenyu99
Copy link
Author

Hey, I've fixed up the duplicate link. I can access the Divaportal link fine; it might be a case where the paper restricts access by region, but I can't seem to pinpoint it.

@webknjaz webknjaz added the skip news used on prs to opt out of the changelog requirement label Feb 28, 2025
@@ -117,8 +117,11 @@ This is a limited list, please submit an issue or pull request to expand it!

* Gao, Zebao, Yalan Liang, Myra B. Cohen, Atif M. Memon, and Zhen Wang. "Making system user interactive tests repeatable: When and what should we control?." In *Software Engineering (ICSE), 2015 IEEE/ACM 37th IEEE International Conference on*, vol. 1, pp. 55-65. IEEE, 2015. `PDF <http://www.cs.umd.edu/~atif/pubs/gao-icse15.pdf>`__
* Palomba, Fabio, and Andy Zaidman. "Does refactoring of test smells induce fixing flaky tests?." In *Software Maintenance and Evolution (ICSME), 2017 IEEE International Conference on*, pp. 1-12. IEEE, 2017. `PDF in Google Drive <https://drive.google.com/file/d/10HdcCQiuQVgW3yYUJD-TSTq1NbYEprl0/view>`__
* Bell, Jonathan, Owolabi Legunsen, Michael Hilton, Lamyaa Eloussi, Tifany Yung, and Darko Marinov. "DeFlaker: Automatically detecting flaky tests." In *Proceedings of the 2018 International Conference on Software Engineering*. 2018. `PDF <https://www.jonbell.net/icse18-deflaker.pdf>`__
* Dutta, Saikat and Shi, August and Choudhary, Rutvik and Zhang, Zhekun and Jain, Aryaman and Misailovic, Sasa. "Detecting flaky tests in probabilistic and machine learning applications." In *Proceedings of the 29th ACM SIGSOFT International Symposium on Software Testing and Analysis (ISSTA)*, pp. 211-224. ACM, 2020. `PDF <https://www.cs.cornell.edu/~saikatd/papers/flash-issta20.pdf>`__
* Bell, Jonathan, Owolabi Legunsen, Michael Hilton, Lamyaa Eloussi, Tifany Yung, and Darko Marinov. "DeFlaker: Automatically detecting flaky tests." In *Proceedings of the 2018 International Conference on Software Engineering*. 2018. `PDF <https://www.jonbell.net/icse18-deflaker.pdf>`__
Copy link
Member

Choose a reason for hiding this comment

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

When I first opened it, the bio section took the entire screen and I thought that the link was entirely broken. Let's add the anchor so it scrolls to actual content on click.

Suggested change
* Bell, Jonathan, Owolabi Legunsen, Michael Hilton, Lamyaa Eloussi, Tifany Yung, and Darko Marinov. "DeFlaker: Automatically detecting flaky tests." In *Proceedings of the 2018 International Conference on Software Engineering*. 2018. `PDF <https://www.jonbell.net/icse18-deflaker.pdf>`__
* Bell, Jonathan, Owolabi Legunsen, Michael Hilton, Lamyaa Eloussi, Tifany Yung, and Darko Marinov. "DeFlaker: Automatically detecting flaky tests." In *Proceedings of the 2018 International Conference on Software Engineering*. 2018. `PDF <https://www.jonbell.net/icse18-deflaker.pdf#section-Research>`__

@webknjaz
Copy link
Member

@nicoddemus as many of these are whitepapers, would it make sense to integrate sphinxcontrib-bibtex?

@webknjaz webknjaz added the type: docs documentation improvement, missing or needing clarification label Feb 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip news used on prs to opt out of the changelog requirement type: docs documentation improvement, missing or needing clarification
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants