Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-host-ipmid / 7a4ebde330d44114ccd85aa0c668b3c84c531335
commit7a4ebde330d44114ccd85aa0c668b3c84c531335[log] [tgz]
authorEmily Shaffer <emilyshaffer@google.com>Mon Jun 24 19:08:26 2019 -0700
committerEmily Shaffer <emilyshaffer@google.com>Tue Jun 25 18:05:14 2019 -0700
treebae869d2da5d4dc3d3ddccec1f017da33689025a
parenta3a1cdc299fbeee366fee925dc08fa3eaf8b63f2 [diff]
docs: add chapter on running tests

Add instructions for installing and setting up Docker, modifying the
setup for phosphor-host-ipmid, and running the tests. This also covers
reading the .log files generated during the testing run.

These instructions cover how to use `git worktree` to make a copy of
your working repo which is usable by Docker, but still up-to-date with
the hacking you've been doing. There's also a brief method of coming up
with a similar setup using a local remote or symlink. The worktree
method was selected because it is impossible to make the code you're
testing out-of-sync with the code you will submit to Gerrit for review.
However, we need to mount the working repo to the Docker container too
to make this work (since Git will look there for the .git/ dir).

Tested: Viewed in Chrome

Change-Id: I684664e2580637b34fbb79eceb838986425852c0
1 file changed
tree: bae869d2da5d4dc3d3ddccec1f017da33689025a
  1. app/
  2. docs/
  3. include/
  4. libipmid/
  5. libipmid-host/
  6. scripts/
  7. softoff/
  8. test/
  9. user_channel/
  10. xyz/
  11. .build.sh
  12. .clang-format
  13. .gitignore
  14. .travis.yml
  15. apphandler.cpp
  16. apphandler.hpp
  17. bootstrap.sh
  18. chassishandler.cpp
  19. chassishandler.hpp
  20. configure.ac
  21. dcmihandler.cpp
  22. dcmihandler.hpp
  23. elog-errors.hpp
  24. error-HostEvent.hpp
  25. fruread.hpp
  26. generate_whitelist.sh
  27. globalhandler.cpp
  28. globalhandler.hpp
  29. groupext.cpp
  30. host-cmd-manager.cpp
  31. host-cmd-manager.hpp
  32. host-interface.cpp
  33. host-interface.hpp
  34. host-ipmid-whitelist.conf
  35. ipmi_fru_info_area.cpp
  36. ipmi_fru_info_area.hpp
  37. ipmid-new.cpp
  38. ipmisensor.cpp
  39. ipmiwhitelist.hpp
  40. LICENSE
  41. MAINTAINERS
  42. Makefile.am
  43. oemrouter.cpp
  44. read_fru_data.cpp
  45. read_fru_data.hpp
  46. README.md
  47. sample.cpp
  48. sample.h
  49. selutility.cpp
  50. selutility.hpp
  51. sensordatahandler.cpp
  52. sensordatahandler.hpp
  53. sensorhandler.cpp
  54. sensorhandler.hpp
  55. settings.cpp
  56. settings.hpp
  57. storageaddsel.cpp
  58. storageaddsel.hpp
  59. storagehandler.cpp
  60. storagehandler.hpp
  61. sys_info_param.cpp
  62. sys_info_param.hpp
  63. systemintfcmds.cpp
  64. systemintfcmds.hpp
  65. testaddsel.cpp
  66. testit.cpp
  67. transporthandler.cpp
  68. transporthandler.hpp
  69. whitelist-filter.cpp
README.md

To build this package, do the following steps:

1. ./bootstrap.sh
2. ./configure ${CONFIGURE_FLAGS}
3. make

To clean the repository run ./bootstrap.sh clean.