Overhaul test harness documentation. #643
Conversation
jbarrick-mesosphere
requested review from
kensipe,
gkleiman,
alenkacz,
gerred and
fabianbaier
|
|
||
| To write a test case: | ||
| Now that the kudo CLI is installed, we can write a test. The KUDO test CLI organizes tests into suites: |
There was a problem hiding this comment.
maybe say somewhere that a suite has to always live in a separate directory?
There was a problem hiding this comment.
oh or the first level of folders is actually cases and one more level is suites, right? okay, that was not obvious to me on first read :) (just noting, in case you know how to improve on that)
There was a problem hiding this comment.
Hmm, so a test suite could actually be multiple directories since testDirs is a list, so I was avoiding talking about directories in the definitions section. I'm gonna think about this one some more.
| * [Getting a resource from the cluster](#getting-a-resource-from-the-cluster) | ||
| * [Listing resources in the cluster](#listing-resources-in-the-cluster) | ||
|
|
||
| # Format |
There was a problem hiding this comment.
shouldn't this be ## ? as a sub-section
There was a problem hiding this comment.
Incidentally, the only reason I included a title at the top is our Hugo style omits the page title. Should I maybe fix the style and drop the titles at the top of the page (I wasn't sure if that was intentional or not)?
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: alenkacz, jbarrick-mesosphere, kensipe The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Use a nested menu for testing docs Make a note about the assertion timeout Make a note that test steps and asserts are both optional talk about how objects in a test step are operated on simultaneously. specify that deletion expects objects to not exist update tips about CRD
jbarrick-mesosphere
force-pushed
the
docs
branch
from
c12ceb6
to
d5d91f7
Compare
What type of PR is this?
/kind documentation
What this PR does / why we need it:
This overhauls the test harness documentation to be better.
Special notes for your reviewer:
These docs are for 0.4.0 release. So, some of the things in here are aspirational:
Does this PR introduce a user-facing change?: