kpt icon indicating copy to clipboard operation
kpt copied to clipboard
verified publisher icon kptdev

All examples in documentation need to have e2e testing

Open frankfarzan opened this issue 4 years ago • 4 comments

This includes examples in the book and in the reference docs.

frankfarzan avatar Apr 01 '21 00:04 frankfarzan

I believe this is already done. @etefera can you comment? This was supposed to be a part of the Q1 OKRs.

mikebz avatar Apr 01 '21 16:04 mikebz

Yes, https://raw.githubusercontent.com/GoogleContainerTools/kpt/next/site/guides/consumer/get/README.md is an example of where we're validating the shell commands we're presenting. Is there something missing in that functionality?

etefera avatar Apr 01 '21 17:04 etefera

This includes testing all packages in package-examples directory. Currently we have multiple methods for testing:

  1. Tests embedded in documentation.
  2. Hydration-only: test harness using .expected directory
  3. Live e2e
  4. Packaging e2e?

We need to decide how to get coverage here. 2) is an easy low-hanging fruit.

frankfarzan avatar May 04 '21 20:05 frankfarzan

@etefera second part in the above list is a good first issue to ramp up on the codebase, so assigning it you. Let's have a chat about how this needs to be done.

droot avatar Jul 09 '21 05:07 droot