phosphor-host-ipmid/docs/testing.md

21 `sudo docker run hello-world`.
29 mkdir openbmc-ci-tests
30 cd openbmc-ci-tests
31 git clone https://github.com/openbmc/openbmc-build-scripts.git
34 ## Add `phosphor-host-ipmid`
39 basic idea is that it's like having a second copy of your repo - but the second
46 `run-unit-test-docker.sh`, you can't run the CI with untracked changes anyways,
54 cd /my/dir/for/phosphor-host-ipmid
55 git worktree add /path/to/openbmc-ci-tests/phosphor-host-ipmid
58 Now, if you `cd /path/to/openbmc-ci-tests`, you should see a directory
59 `phosphor-host-ipmid/`, and if you enter it and run `git status` you will see
60 that you're likely on a new branch named `phosphor-host-ipmid`. This is just for
65 (`/my/dir/for/phosphor-host-ipmid`), so we'll need to mount it when we run. Open
66 up `/path/to/openbmc-ci-tests/openbmc-build-scripts/run-unit-test-docker.sh` and
71 PHOSPHOR_IPMI_HOST_PATH="/my/dir/for/phosphor-host-ipmid"
73 docker run --blah-blah-existing-flags \
74   -v ${PHOSPHOR_IPMI_HOST_PATH}:${PHOSPHOR_IPMI_HOST_PATH} \
75   -other \
76   -args
83 cd openbmc-build-scripts
84 git add run-unit-test-docker.sh
85 git commit -m "mount phosphor-host-ipmid"
94 cd openbmc-ci-tests
95 mkdir phosphor-host-ipmid
96 cd phosphor-host-ipmid
98 cd /my/dir/for/phosphor-host-ipmid
99 git remote add /path/to/openbmc-ci-tests/phosphor-host-ipmid ci
107 cd /my/dir/for/phosphor-host-ipmid
108 git commit -m "my changes to be tested"
110 cd /path/to/openbmc-ci-tests/phosphor-host-ipmid
111 git checkout topic-branch
114 You can also create a symlink from your Git workspace into `openbmc-ci-tests/`.
117 have untracked changes - which you're likely to have during active development.
125 sudo WORKSPACE=$(pwd) UNIT_TEST_PKG=phosphor-host-ipmid \
126   ./openbmc-build-scripts/run-unit-test-docker.sh
135 `openbmc-ci-tests/phosphor-host-ipmid/test/test-suite.log`, as well as being
138 human-readable and can be examined to determine why something failed
147 In `/my/dir/for/phosphor-host-ipmid`, create a new branch based on `master` (or
148 your current patchset). For this tutorial, let's call it `sensorhandler-tests`.
151 git checkout -b sensorhandler-tests master
154 This creates a new branch `sensorhandler-tests` which is based on `master`, then
185     return (req->reservation_id_lsb + (req->reservation_id_msb << 8));
190     return (req->record_id_lsb + (req->record_id_msb << 8));
211 scaffolding. We've only got two functions - `get_reservation_id()` and
214 - "Happy path" - in an ideal case, everything works correctly
215 - Error handling - when given bad input, things break as expected
216 - Edge cases - when given extremes (e.g. very large or very small numbers),
252 types of edge cases - like overflow/underflow - are prevented by C++'s strong
253 typing; other types - like passing the incorrect type - are impossible to
329     -Igtest \
336     -DBOOST_COROUTINES_NO_DEPRECATION_WARNING
338     -lgtest_main \
339     -lgtest \
340     -pthread \
351 `sensorhandler-tests` branch in your CI worktree, which will involve releasing
355 cd /my/dir/for/phosphor-host-ipmid
357 git commit -s
358 git checkout master   # Here you can use any branch except sensorhandler-tests
359 cd /path/to/openbmc-ci-tests/phosphor-host-ipmid
360 git checkout sensorhandler-tests
364 a linter error when you run, you can actually apply the cleaned-up code easily:
367 cd ./phosphor-host-ipmid
369 git add -u  # Apply the proposed changes
370 git commit --amend
379 poorly-written unit test can make life harder for contributors down the road.
382 Include both positive (happy-path) and negative (error) testing in your
385 edge-case testing helps us find bugs that may take years to occur (and
388 Keep your tests small. Avoid branching - if you feel a desire to, instead
395 `Object_NameCircumstanceResult` - for example,
402 `sdbusplus` when you're supposed to be testing `phosphor-host-ipmid`.
410 dependency injection and small functions make your code more testable - you'll
414 for code that wasn't previously unit-tested. It's okay to check in a bugfix
419 master -> fix Foo.Abc() -> fix Foo.Def() -> Fix Foo.Ghi() -> test Foo class
439 the test is more prone to error - ask!
453 cd openbmc-ci-tests/phosphor-host-ipmid
454 git fetch "https://gerrit.openbmc-project.xyz/openbmc/phosphor-host-ipmid" \
459 worktree into detached-HEAD mode pointing to the commit that's under review. You
465 - Jenkins isn't responding
466 - The Jenkins build is broken for a reason beyond the committer's control
467 - The committer doesn't have "Ok-To-Test" permission, and you don't have