xref: /openbmc/bmcweb/CLIENTS.md (revision a90d6630)
12c615dffSEd Tanousbmcweb being a user and network facing daemon, is subject to a vast array of
22c615dffSEd Tanoustests and clients that could target it.  The below attempts to provide a
32c615dffSEd Tanousnon-exhaustive list of tests and clients that bmcweb is expected to be
42c615dffSEd Tanouscompatible with, they are split into a couple categories.  Entries in the test
52c615dffSEd Tanouscategory are intended to be qualification tests to ensure the bmcweb meets the
62c615dffSEd Tanousspecification.  Entries in the clients category are intended to host user-facing
72c615dffSEd Tanousfunctionality.
82c615dffSEd Tanous
92c615dffSEd TanousThe base expectation is that for master versions of bmcweb, and master versions
102c615dffSEd Tanousof these tools, the tests pass 100%.  There may be cases where we workaround
112c615dffSEd Tanouslimitations in the testing tools behavior within bmcweb to make the tools pass,
122c615dffSEd Tanousregardless of whether there is user impact.
132c615dffSEd Tanous
14*a90d6630SNan Zhou## Tests
152c615dffSEd Tanous
162c615dffSEd TanousRedfish-Service-Validator: A tool to verify through GET requests that bmcweb
172c615dffSEd Tanousproperly implements the Redfish schemas in the responded Resource.
182c615dffSEd Tanousgit@github.com:DMTF/Redfish-Service-Validator.git
192c615dffSEd Tanous
202c615dffSEd TanousStatus: 100% passing.  Integrated with CI to ensure no regressions.
212c615dffSEd Tanous
222c615dffSEd TanousRedfish-Protocol-Validator: A tool to verify the protocol-level interactions
232c615dffSEd Tanouswith the Redfish wire-protocol, and checks those against the Redfish
242c615dffSEd Tanousspecification.
252c615dffSEd Tanousgit@github.com:DMTF/Redfish-Protocol-Validator.git
262c615dffSEd Tanous
272c615dffSEd TanousStatus: 95+% of assertions passing.  No CI integration.
282c615dffSEd Tanous
292c615dffSEd Tanous
302c615dffSEd TanousOpenBMC-test-automation: A tool based on robot framework for testing some
312c615dffSEd Tanousportion of the OpenBMC Redfish use cases.
322c615dffSEd Tanous
332c615dffSEd TanousStatus: Passing for some machines with CI integration.
342c615dffSEd Tanous
352c615dffSEd Tanous
362c615dffSEd Tanousslowloris: A tool to verify timeouts and DOS attack mitigation is implemented properly.
372c615dffSEd Tanoushttps://github.com/gkbrk/slowloris
382c615dffSEd Tanous
392c615dffSEd TanousStatus: Passing, no automated enforcement.
402c615dffSEd Tanous
412c615dffSEd Tanous
422c615dffSEd Tanoustestssl.sh: A tool for verifying the corectness of the bmcweb cipher suites
432c615dffSEd Tanousagainst current recommended security standards
442c615dffSEd Tanoushttps://github.com/drwetter/testssl.sh
452c615dffSEd Tanous
462c615dffSEd TanousStatus: Unknown
472c615dffSEd Tanous
482c615dffSEd Tanous
49*a90d6630SNan Zhou## Clients
502c615dffSEd Tanous
512c615dffSEd Tanousfwupd: Is a client implementation that allows updating firmware components in a
522c615dffSEd Tanousgeneric way, and includes redfish as one of its plugins.
532c615dffSEd Tanousgit@github.com:fwupd/fwupd.git
542c615dffSEd Tanous
552c615dffSEd TanousStatus: Unknown
562c615dffSEd Tanous
572c615dffSEd Tanous
582c615dffSEd Tanouspython-redfish-library: A python library used by a number of tools.
592c615dffSEd Tanousgit@github.com:DMTF/python-redfish-library.git
602c615dffSEd Tanous
612c615dffSEd TanousStatus: Compatible
622c615dffSEd Tanous
632c615dffSEd Tanous
642c615dffSEd TanousRedfish-Event-Listener: An example client for testing and implementing
652c615dffSEd TanousEventService handlers.
662c615dffSEd Tanoushttps://github.com/DMTF/Redfish-Event-Listener
672c615dffSEd Tanous
682c615dffSEd TanousStatus: Compatible.  No CI integration.
692c615dffSEd Tanous
702c615dffSEd Tanous
712c615dffSEd TanousRedfish-Tacklebox: A collection of common utilities for managing redfish servers
722c615dffSEd Tanousgit@github.com:DMTF/Redfish-Tacklebox.git
732c615dffSEd Tanous
742c615dffSEd TanousStatus: Unknown.
752c615dffSEd Tanous
762c615dffSEd Tanous
772c615dffSEd Tanousredfishtool: A generic command line tool for reading and writing operations to
782c615dffSEd Tanousthe Redfish server.
792c615dffSEd Tanoushttps://github.com/DMTF/Redfishtool
802c615dffSEd Tanous
812c615dffSEd TanousStatus: Compatible.  No automated testing.
822c615dffSEd Tanous
83