xref: /openbmc/telemetry/redfish-tests/README.md (revision 53fb7855)
1# Redfish Tests
2
3## Requirements
4
5At least python3.6 is required and following two python packages installed -
6requests, pytest.
7
8```sh
9$ python3 --version
10Python 3.6.8
11
12$ pytest --version
13This is pytest version 5.4.2, imported from /usr/local/lib/python3.6/site-packages/pytest/__init__.py
14
15$ sudo pip3 install request pytest
16```
17
18## Config
19
20There are few options included to tests:
21
22- `--host_addr` - address of an OpenBMC together with protocol and port, ex.
23  `https://localhost:443`, default: `https://localhost:4443`
24- `--username` - name of the user that is used during tests, user should have
25  'ConfigureManager' privilege, default: 'root'
26- `--password` - plain password, default: '0penBmc'
27- `--metric_limit` - allows to limit number of detected metrics in system,
28  default: 200
29
30SSL verification is disabled during tests.
31
32## Run
33
34```sh
35# To run all tests in verbose mode and with stop on first failed test (s option direct all print to stdout)
36 pytest test_telemetry.py -xsv
37
38# To run specific test using statement
39 pytest test_telemetry.py -xsv -k 'test_get_telemetry_service or test_get_metric_report'
40```
41