New extended tutorial for test jobs (infra) #1405
Conversation
Hook25
force-pushed
the
new_ext_tutorial_test_case
branch
from
87b024f to
0adcbfc
Compare
There was a problem hiding this comment.
Very cool stuff indeed!
I only reviewed until the Template Jobs section.
Writing tutorials is very hard. It's tempting to try to explain many things at once, but this might become too hard to read for a newcomer. If you feel that you have to explain a concept while explaining another one, this might be better to split this into another section, later.
Co-authored-by: Pierre Equoy <[email protected]>
Hook25
force-pushed
the
new_ext_tutorial_test_case
branch
from
5d1d68b to
5f05d54
Compare
There was a problem hiding this comment.
Brilliant work, really! This is a long tutorial, and you introduce a lot of concepts that are unique to Checkbox in a easy-to-follow way. Congratulations!
You even include obscure stuff like the ability to compile source code... impressive!
I've made a bunch of suggestions and typo fixes as well as other general comments. Once these land, we can merge this PR.
Thanks again, great work!
There was a problem hiding this comment.
Kudos for devising such a thorough tutorial!!
It's easy to follow, clearly explains what/why we are doing so in each step, and all the tips/suggestions are very useful. I left a bunch of comments but most of them are nitpicks. Feel free to adapt as needed
And a thought for future consideration (for me):
This tutorial is a good candidate for documentation testing - all the code samples are executable and already in the repository. Instead of duplicating the code in the doc, maybe we can include the snippet from source files into the document, so the tutorial can be validated as well.
Co-authored-by: Pierre Equoy <[email protected]> Update docs/tutorial/writing-tests/test-case.rst Co-authored-by: Pierre Equoy <[email protected]> Update docs/tutorial/writing-tests/test-case.rst Co-authored-by: Pierre Equoy <[email protected]> Update docs/tutorial/writing-tests/test-case.rst Co-authored-by: Pierre Equoy <[email protected]> Update docs/tutorial/writing-tests/test-case.rst Co-authored-by: Pierre Equoy <[email protected]> Update docs/tutorial/writing-tests/test-case.rst Co-authored-by: Pierre Equoy <[email protected]> Update docs/tutorial/writing-tests/test-case.rst Co-authored-by: Pierre Equoy <[email protected]> Update docs/tutorial/writing-tests/test-case.rst Co-authored-by: Pierre Equoy <[email protected]> Update docs/tutorial/writing-tests/test-case.rst Co-authored-by: Pierre Equoy <[email protected]> Update docs/tutorial/writing-tests/test-case.rst Co-authored-by: Pierre Equoy <[email protected]> Update docs/tutorial/writing-tests/test-case.rst Co-authored-by: Pierre Equoy <[email protected]> Update docs/tutorial/writing-tests/test-case.rst Co-authored-by: Pierre Equoy <[email protected]> Update docs/tutorial/writing-tests/test-case.rst Co-authored-by: Pierre Equoy <[email protected]> Update docs/tutorial/writing-tests/test-case.rst Co-authored-by: Pierre Equoy <[email protected]> Update docs/tutorial/writing-tests/test-case.rst Co-authored-by: Pierre Equoy <[email protected]> Apply suggestions from code review Co-authored-by: tang-mm <[email protected]> Co-authored-by: Pierre Equoy <[email protected]>
Hook25
force-pushed
the
new_ext_tutorial_test_case
branch
from
53b32d0 to
26651a5
Compare
Description
We are currently lacking a tutorial to get started with test authoring.
This is an attempt to give a comprehensive introduction to everything one may want to know about automated tests via a tutorial that guides the user through creating a new provider with:
This tutorial is only about tests, so the absence of test plans is intentional. This is meant to be the first in a chain of "advanced/extended" tutorials (this is why it also contains the instructions to create the provider and provision Checkbox from source)
Resolved issues
Fixes: https://warthogs.atlassian.net/browse/CHECKBOX-761
Documentation
N/A
Tests
N/A