GET better at testing your package!
👋 Bonjour !
Code of Conduct
Code of Conduct including how to make reports.
Recording
I’ll be recording from now.
You can turn your camera off and change your display name if you want.
Why test your package?
wow who knew there was actually a robust way to test functions besides trying random examples and seeing if they work and then not remembering them once you clear your console
— Sharla Gelfand (@sharlagelfand) January 15, 2019
Why test your package?
If you use software that lacks automated tests, you are the tests.
— Jenny Bryan (@JennyBryan) September 22, 2018
Why test your package?
rOpenSci guidance for package development.
All packages should have a test suite that covers major functionality of the package. The tests should also cover the behavior of the package in case of errors.
Why test your package?
rOpenSci guidance for package development.
It is good practice to write unit tests for all functions, and all package code in general, ensuring key functionality is covered. Test coverage below 75% will likely require additional tests or explanation before being sent for review.
How to test?
-
Set up via
usethis::use_testthat()(once per package) andusethis::use_test()(once per test file). -
Formalize your random examples.
Now what?
Testing is often demonstrated with cute little tests and functions where all the inputs and expected results can be inlined. But in real packages, things aren’t always so simple
Jenny Bryan in a testthat vignette.
Now what?
Today we will explore less cute tests. 👻
Picture by Daisy Anderson on Pexels.
HTTP things are hard to test
- Slow tests?
- Overburdening the web resource?
- Using credits for testing?
- Impossible to trigger errors?
Good use case for learning more about testing techniques! 🎉
Our goals today
Gaining specific knowledge about HTTP testing via vcr, general knowledge about testing R packages with testthat!
Website tour
Get to know applepie
Client for R-universe API. 🚀
R-universe is a new platform by rOpenSci for publishing and discovering R packages, Rmd articles, and other R based content.
And it has an API! 🎉
Demo
📦 Load, use, check our (cute?) little package.
🐥 Add a cute little test to it.
☂️ Explore its test coverage.
🚥 Set up continuous integration.
Demo 🚀
Back from the demo
A package with two functions, non zero test coverage, continuous integration… 💐
But what if our internet connection gets fragile? 😱
Test fixtures
“A test fixture is an environment used to consistently test some item, device, or piece of software.”
Text fixtures in general in R
withr😍 e.g.withr::local_options(). Change then clean!
- Put example data you put in
tests/testthat/test-data, locate it in tests viatestthat::test_path("test-data").
What about fixtures for HTTP testing?
💡 How about we create a test fixture with stored or faked API responses?
This is the idea behind vcr and httptest. (webfakes is a bit different).
Let’s try vcr!
Demo 🚀
Back from the demo
Now our package has a test that can work when internet is down.
Time for a break! ☕
05:00