diff options
author | Emily Shaffer <emilyshaffer@google.com> | 2019-06-25 18:33:30 -0700 |
---|---|---|
committer | Emily Shaffer <emilyshaffer@google.com> | 2019-06-25 18:36:05 -0700 |
commit | 455ee0b99cdb2e438fd64fdcdd8b897cb617f249 (patch) | |
tree | 54cee6dbe8bbb7d00a38729dfe36d98d386c7860 /docs | |
parent | 00a553df9c0e01f01cd6761fcd9e7eb390545cd4 (diff) | |
download | phosphor-host-ipmid-455ee0b99cdb2e438fd64fdcdd8b897cb617f249.tar.gz phosphor-host-ipmid-455ee0b99cdb2e438fd64fdcdd8b897cb617f249.zip |
docs: add reviewing chapter to testing.md
Cover some best practices while reviewing a test suite, as well as how
to run tests locally without impacting your current environment.
Tested: Viewed in Chrome
Change-Id: I7356a90fcc9e6d2679e1f9e9a49515a1038a8914
Signed-off-by: Emily Shaffer <emilyshaffer@google.com>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/testing.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/testing.md b/docs/testing.md index cd48620..f5ed04b 100644 --- a/docs/testing.md +++ b/docs/testing.md @@ -424,10 +424,47 @@ message, you can state that you ran the new unit tests written. # Reviewing Tests +Tests are written primarily to be read. So when you review a test, you're the +first customer of that test! + ## Best Practices +First, all the best practices listed above for writing tests are things you +should check for and encourage when you're reading tests. + +Next, you should ensure that you can tell what's going on when you read the +test. If it's not clear to you, it's not going to be clear to someone else, and +the test is more prone to error - ask! + +Finally, think about what's _not_ being tested. If there's a case you're curious +about and it isn't covered, you should mention it to the committer. + ## Quickly Running At Home +Now that you've got a handy setup as described earlier in this document, you can +quickly download and run the tests yourself. Within the Gerrit change, you +should be able to find a button that says "Download", which will give you +commands for various types of downloads into an existing Git repo. Use +"Checkout", for example: + +```shell +cd openbmc-ci-tests/phosphor-host-ipmid +git fetch "https://gerrit.openbmc-project.xyz/openbmc/phosphor-host-ipmid" \ + refs/changes/43/23043/1 && git checkout FETCH_HEAD +``` + +This won't disturb the rest of your Git repo state, and will put your CI +worktree into detached-HEAD mode pointing to the commit that's under review. You +can then run your tests normally, and even make changes and push again if the +commit was abandoned or otherwise left to rot by its author. + +Doing so can be handy in a number of scenarios: + +- Jenkins isn't responding +- The Jenkins build is broken for a reason beyond the committer's control +- The committer doesn't have "Ok-To-Test" permission, and you don't have + permission to grant it to them + # Credits Thanks very much to Patrick Venture for his prior work putting together |