Add example for CLI tests with temporary directories and setting the current working directory (CWD) #284
Conversation
|
src/tutorial/testing.md
Outdated
|
|
||
| </aside> | ||
|
|
||
| ## Executing tests in a temporary directory |
There was a problem hiding this comment.
This is all focusing on teaching an API and is not fitting it within the narrative of the book
There was a problem hiding this comment.
I will rewrite the section intro to fit better with the style of the section before and after.
For example, by connecting the newly introduced APIs to what the book has explored so far.
There was a problem hiding this comment.
It also needs to be tied into the application we are testing
There was a problem hiding this comment.
Hi again! Please review the combined diff for this PR to see the latest version :)
1: I rewrote the section and created a new test case to describe the new concepts in a way that fits better with the rest of the book. I opted to make the test and description slightly verbose and more explicit to give a better understanding. This way, we clearly show what happens when you set the current working directory, and explain why it works in one case but not the other.
This could technically be rewritten in a shorter format, skipping the nested directory. However, then we wouldn't have such a clear visual example with a directory structure when we should explain how the current working directory works.
I think it's worth a longer description and example, because the CWD is a very important concept for CLI tools, especially when accepting paths as CLI arguments.
2: I also removed the changes that were moved to a separate PR.
|
Thanks for the review. Update: I split the unrelated changes into a separate commit, and combined the main changes into a single commit. Will think about how to get the example to fit better with the book's narrative. |
Greenheart
force-pushed
the
feature/add-cli-testing-with-tmp-directory-and-cwd
branch
2 times, most recently
from
3fe28f9 to
26b2faf
Compare
test with a specific current working directory (CWD). This expands on the basic examples and ensures the common needs for CLI app testing are covered. Hopefully, this will make testing more accessible to people reading the book.
Greenheart
force-pushed
the
feature/add-cli-testing-with-tmp-directory-and-cwd
branch
3 times, most recently
from
d64a758 to
9c9b572
Compare
2 participants
Main changes
Describe how to create temporary directories, and how to execute the CLI test with a specific current working directory (CWD).
This expands on the basic examples and ensures the common needs for CLI app testing are covered. Hopefully, this will make testing more accessible to people reading the book.