Add use_test_helper()
#1978
Merged
Add use_test_helper()
#1978
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…e is `tests/testthat/helper.R`
olivroy
commented
Apr 11, 2024
Closed
|
As per the discussion in #1822, let's strip this down to just creating/opening a test helper file. |
|
Should it be documented with |
|
It looks hard to document with |
Merge commit '1909b25e110f5a97b2d1c393d0218a2768078a46' #Conflicts: # NEWS.md
Merge commit '875aa503ae50d29e37293d85c98656a72cfbbd43' #Conflicts: # NEWS.md
olivroy
commented
Jul 25, 2024
olivroy
commented
Jul 25, 2024
olivroy
commented
Jul 25, 2024
Merged
jennybc
reviewed
Jul 26, 2024
| Condition | ||
| Error in `use_test_helper()`: | ||
| x Your package must use testthat to use a helper file. | ||
| Call `usethis::use_testthat()` to set up testthat. |
There was a problem hiding this comment.
This should be a "todo" bullet, so I'm going to open a separate issue about that. Has nothing to do with this PR.
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix #1822
Probably better to merge #1990 first.
If merged, I will add some pointer in https://testthat.r-lib.org/articles/special-files.html#helper-files.
Considerations:
Test interactively: be able to jump the 3 files easily R/mocks.R, tests/testthat/test-mocks.R and tests/testthat/helper-mocks.R
.
use_test_helper() # will go to specific associated helper file if exists or tests/testthat/helper.R otherwiseIn usethis, I'd type the 3 functions successively starting with mocks.R to see that the 3 way workflow works as expected.
A case I have not considered:
if multiple
tests/testthat/helper-{file}.Rexist, but nottests/testthat/helper.R, but nottests/testthat/helper-foofy.R, it would probably be better to have it than what I currently implemented (tests/testthat/helper.R)Harder to jump back to test files or R from
tests/testthat/helper.R, will create a possibly unwanted file. I added a condition to prevent that.. 31d68a2