summaryrefslogtreecommitdiff
path: root/CLIENTS.md
diff options
context:
space:
mode:
authorPatrick Williams <patrick@stwcx.xyz>2022-12-07 16:14:21 +0300
committerPatrick Williams <patrick@stwcx.xyz>2022-12-07 16:14:26 +0300
commitdfa3fdc3dc1045babc67ecd7974c4d997006d9c4 (patch)
treee2b076f0b29cf031dbada80cb9cc265e657ad7e9 /CLIENTS.md
parent6f284d244124c54db4d6fad6063b2aced18a844b (diff)
downloadbmcweb-dfa3fdc3dc1045babc67ecd7974c4d997006d9c4.tar.xz
format: reformat with latest openbmc-build-scripts
Reformat the repository using the latest from openbmc-build-scripts. Add the `static/redfish` directory to be ignored by prettier since these files come from elsewhere and having the ability to do a direct diff is handy. Signed-off-by: Patrick Williams <patrick@stwcx.xyz> Change-Id: I74464d6f97047b4888a591e0d8a4f5ca970ac69e
Diffstat (limited to 'CLIENTS.md')
-rw-r--r--CLIENTS.md38
1 files changed, 13 insertions, 25 deletions
diff --git a/CLIENTS.md b/CLIENTS.md
index 010be31c2d..6e7091e7f5 100644
--- a/CLIENTS.md
+++ b/CLIENTS.md
@@ -1,13 +1,13 @@
bmcweb being a user and network facing daemon, is subject to a vast array of
-tests and clients that could target it. The below attempts to provide a
+tests and clients that could target it. The below attempts to provide a
non-exhaustive list of tests and clients that bmcweb is expected to be
-compatible with, they are split into a couple categories. Entries in the test
+compatible with, they are split into a couple categories. Entries in the test
category are intended to be qualification tests to ensure the bmcweb meets the
-specification. Entries in the clients category are intended to host user-facing
+specification. Entries in the clients category are intended to host user-facing
functionality.
The base expectation is that for master versions of bmcweb, and master versions
-of these tools, the tests pass 100%. There may be cases where we workaround
+of these tools, the tests pass 100%. There may be cases where we workaround
limitations in the testing tools behavior within bmcweb to make the tools pass,
regardless of whether there is user impact.
@@ -17,35 +17,30 @@ Redfish-Service-Validator: A tool to verify through GET requests that bmcweb
properly implements the Redfish schemas in the responded Resource.
git@github.com:DMTF/Redfish-Service-Validator.git
-Status: 100% passing. Integrated with CI to ensure no regressions.
+Status: 100% passing. Integrated with CI to ensure no regressions.
Redfish-Protocol-Validator: A tool to verify the protocol-level interactions
with the Redfish wire-protocol, and checks those against the Redfish
-specification.
-git@github.com:DMTF/Redfish-Protocol-Validator.git
-
-Status: 95+% of assertions passing. No CI integration.
+specification. git@github.com:DMTF/Redfish-Protocol-Validator.git
+Status: 95+% of assertions passing. No CI integration.
OpenBMC-test-automation: A tool based on robot framework for testing some
portion of the OpenBMC Redfish use cases.
Status: Passing for some machines with CI integration.
-
-slowloris: A tool to verify timeouts and DOS attack mitigation is implemented properly.
-https://github.com/gkbrk/slowloris
+slowloris: A tool to verify timeouts and DOS attack mitigation is implemented
+properly. https://github.com/gkbrk/slowloris
Status: Passing, no automated enforcement.
-
testssl.sh: A tool for verifying the corectness of the bmcweb cipher suites
against current recommended security standards
https://github.com/drwetter/testssl.sh
Status: Unknown
-
## Clients
fwupd: Is a client implementation that allows updating firmware components in a
@@ -54,29 +49,22 @@ git@github.com:fwupd/fwupd.git
Status: Unknown
-
python-redfish-library: A python library used by a number of tools.
git@github.com:DMTF/python-redfish-library.git
Status: Compatible
-
Redfish-Event-Listener: An example client for testing and implementing
-EventService handlers.
-https://github.com/DMTF/Redfish-Event-Listener
-
-Status: Compatible. No CI integration.
+EventService handlers. https://github.com/DMTF/Redfish-Event-Listener
+Status: Compatible. No CI integration.
Redfish-Tacklebox: A collection of common utilities for managing redfish servers
git@github.com:DMTF/Redfish-Tacklebox.git
Status: Unknown.
-
redfishtool: A generic command line tool for reading and writing operations to
-the Redfish server.
-https://github.com/DMTF/Redfishtool
-
-Status: Compatible. No automated testing.
+the Redfish server. https://github.com/DMTF/Redfishtool
+Status: Compatible. No automated testing.