openbmc/openbmc-test-automation/README.md

1 ## Features of OpenBMC Test Automation
8 - [Legacy REST](https://github.com/openbmc/openbmc-test-automation/releases/tag/v4.0-stable)
45 - Miscellaneous Packages required to be installed for OpenBmc Automation.
63 you'll find this file once your clone openbmc-test-automation repository.
66 the OpenBMC GUI Test Setup Guide. Note: GUI test cases under `gui/` will not
68 [OpenBMC GUI Test Setup Guide](https://github.com/openbmc/openbmc-test-automation/blob/master/docs/gui_setup_reference.md)
82 ## OpenBMC Test Development
84 These documents contain details on developing OpenBMC test code and debugging.
86 - [MAINTAINERS](OWNERS): OpenBMC test code maintainers information.
88 - [Code Check Tools](https://github.com/openbmc/openbmc-test-automation/blob/master/docs/code_standards_check.md):
90 - [Redfish Coding Guidelines](https://github.com/openbmc/openbmc-test-automation/blob/master/docs/redfish_coding_guidelines.md):
92 - [REST-cheatsheet.md](https://github.com/openbmc/docs/blob/master/REST-cheatsheet.md):
95 - [REDFISH-cheatsheet.md](https://github.com/openbmc/docs/blob/master/REDFISH-cheatsheet.md):
97 - [README.md](https://github.com/openbmc/webui-vue/blob/master/README.md): Web
99 - [Redfish Request Via mTLS](https://github.com/openbmc/openbmc-test-automation/blob/master/docs/redfish_request_via_mTLS.md):
101 - [Corporate CLA and Individual CLA](https://github.com/openbmc/docs/blob/master/CONTRIBUTING.md#submitting-changes-via-gerrit-server):
104 ## OpenBMC Test Documentation
106 - [OpenBMC Test Architecture](https://github.com/openbmc/openbmc-test-automation/blob/master/docs/openbmc_test_architecture.md):
107   Reference for OpenBMC Test Architecture.
108 - [Tools](https://github.com/openbmc/openbmc-test-automation/blob/master/docs/openbmc_test_tools.md):
110 - [Code Update](https://github.com/openbmc/openbmc-test-automation/blob/master/docs/code_update.md):
112 - [Certificate Generate](https://github.com/openbmc/openbmc-test-automation/blob/master/docs/certificate_generate.md):
114 - [Boot Test](https://github.com/openbmc/openbmc-test-automation/blob/master/docs/boot_test.md):
115   Boot test for OpenBMC.
119 OpenBMC test infrastructure is proven capable of running on:
122 - x86 systems running OpenBMC firmware stack.
128 - Download the openbmc-test-automation repository:
131   $ git clone https://github.com/openbmc/openbmc-test-automation
132   $ cd openbmc-test-automation
145 There are several sub-directories within the openbmc-test-automation base which
149 `docs/`: Contains the documentation related to OpenBMC.
151 `redfish/`: Contains the general test cases for OpenBMC stack functional
182 OpenBMC is moving steadily towards DTMF Redfish, which is an open industry
187 OpenBMC.
190 feature supported on OpenBMC. Some of the test will be deprecated.
198 To run openbmc-automation first you need to install the prerequisite Python
222   $ export OPENBMC_HOST=<openbmc machine IP address/hostname>
223   $ export OPENBMC_USERNAME=<openbmc username>
224   $ export OPENBMC_PASSWORD=<openbmc password>
235   -v OPENBMC_HOST:<openbmc machine IP address/hostname>
236   -v OPENBMC_USERNAME:<openbmc username>
237   -v OPENBMC_PASSWORD:<openbmc password>
383   By default openbmc-test-automation framework assumes that host CPU is based on