xref: /openbmc/bmcweb/CLIENTS.md (revision dfa3fdc3)
1bmcweb being a user and network facing daemon, is subject to a vast array of
2tests and clients that could target it. The below attempts to provide a
3non-exhaustive list of tests and clients that bmcweb is expected to be
4compatible with, they are split into a couple categories. Entries in the test
5category are intended to be qualification tests to ensure the bmcweb meets the
6specification. Entries in the clients category are intended to host user-facing
7functionality.
8
9The base expectation is that for master versions of bmcweb, and master versions
10of these tools, the tests pass 100%. There may be cases where we workaround
11limitations in the testing tools behavior within bmcweb to make the tools pass,
12regardless of whether there is user impact.
13
14## Tests
15
16Redfish-Service-Validator: A tool to verify through GET requests that bmcweb
17properly implements the Redfish schemas in the responded Resource.
18git@github.com:DMTF/Redfish-Service-Validator.git
19
20Status: 100% passing. Integrated with CI to ensure no regressions.
21
22Redfish-Protocol-Validator: A tool to verify the protocol-level interactions
23with the Redfish wire-protocol, and checks those against the Redfish
24specification. git@github.com:DMTF/Redfish-Protocol-Validator.git
25
26Status: 95+% of assertions passing. No CI integration.
27
28OpenBMC-test-automation: A tool based on robot framework for testing some
29portion of the OpenBMC Redfish use cases.
30
31Status: Passing for some machines with CI integration.
32
33slowloris: A tool to verify timeouts and DOS attack mitigation is implemented
34properly. https://github.com/gkbrk/slowloris
35
36Status: Passing, no automated enforcement.
37
38testssl.sh: A tool for verifying the corectness of the bmcweb cipher suites
39against current recommended security standards
40https://github.com/drwetter/testssl.sh
41
42Status: Unknown
43
44## Clients
45
46fwupd: Is a client implementation that allows updating firmware components in a
47generic way, and includes redfish as one of its plugins.
48git@github.com:fwupd/fwupd.git
49
50Status: Unknown
51
52python-redfish-library: A python library used by a number of tools.
53git@github.com:DMTF/python-redfish-library.git
54
55Status: Compatible
56
57Redfish-Event-Listener: An example client for testing and implementing
58EventService handlers. https://github.com/DMTF/Redfish-Event-Listener
59
60Status: Compatible. No CI integration.
61
62Redfish-Tacklebox: A collection of common utilities for managing redfish servers
63git@github.com:DMTF/Redfish-Tacklebox.git
64
65Status: Unknown.
66
67redfishtool: A generic command line tool for reading and writing operations to
68the Redfish server. https://github.com/DMTF/Redfishtool
69
70Status: Compatible. No automated testing.
71