# Redfish Protocol Validator
Copyright 2020-2022 DMTF. All rights reserved.
## About
The Redfish Protocol Validator tests the HTTP protocol behavior of a Redfish service to validate that it conforms to the Redfish Specification.
## Installation
From PyPI:
pip install redfish_protocol_validator
From GitHub:
git clone https://github.com/DMTF/Redfish-Protocol-Validator.git
cd Redfish-Protocol-Validator
python setup.py sdist
pip install dist/redfish_protocol_validator-x.x.x.tar.gz
## Requirements
The Redfish Protocol Validator requires Python3.
Required external packages:
```
aenum
colorama
pyasn1
pyasn1-modules
requests
sseclient-py
urllib3
```
If installing from GitHub, you may install the external packages by running:
pip install -r requirements.txt
## Usage
```
usage: rf_protocol_validator.py [-h] [--version] --user USER --password
PASSWORD --rhost RHOST [--log-level LOG_LEVEL]
[--report-dir REPORT_DIR]
[--report-type {html,tsv,both}]
[--avoid-http-redirect]
[--no-cert-check | --ca-bundle CA_BUNDLE]
Validate the protocol conformance of a Redfish service
required arguments:
--user USER, -u USER the username for authentication
--password PASSWORD, -p PASSWORD
the password for authentication
--rhost RHOST, -r RHOST
address of the Redfish service (with scheme)
optional arguments:
-h, --help show this help message and exit
--version show program's version number and exit
--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}
the logging level (default: WARNING)
--report-dir REPORT_DIR
the directory for generated report files (default:
"reports")
--report-type {html,tsv,both}
the type of report to generate: html, tsv, or both
(default: both)
--avoid-http-redirect
avoid attempts to generate HTTP redirects for services
that do not support HTTP
--no-cert-check disable verification of host SSL certificates
--ca-bundle CA_BUNDLE
the file or directory containing trusted CAs
```
Example:
rf_protocol_validator -r https://192.168.1.100 -u USERNAME -p PASSWORD
## Unit Tests
The Redfish Protocol Validator unit tests are executed using the `tox` package.
You may install `tox` by running:
pip install tox
Running the unit tests:
tox
## Release Process
1. Go to the "Actions" page
2. Select the "Release and Publish" workflow
3. Click "Run workflow"
4. Fill out the form
5. Click "Run workflow"
Raw data
{
"_id": null,
"home_page": "https://github.com/DMTF/Redfish-Protocol-Validator",
"name": "redfish-protocol-validator",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Redfish",
"author": "DMTF, https://www.dmtf.org/standards/feedback",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/34/4e/fe2cd1bff997b4bfdb410690edb470d0bd31a41b3865ef0904321b4cf57a/redfish_protocol_validator-1.2.6.tar.gz",
"platform": null,
"description": "# Redfish Protocol Validator\n\nCopyright 2020-2022 DMTF. All rights reserved.\n\n## About\n\nThe Redfish Protocol Validator tests the HTTP protocol behavior of a Redfish service to validate that it conforms to the Redfish Specification.\n\n## Installation\n\nFrom PyPI:\n\n pip install redfish_protocol_validator\n\nFrom GitHub:\n\n git clone https://github.com/DMTF/Redfish-Protocol-Validator.git\n cd Redfish-Protocol-Validator\n python setup.py sdist\n pip install dist/redfish_protocol_validator-x.x.x.tar.gz\n\n## Requirements\n\nThe Redfish Protocol Validator requires Python3.\n\nRequired external packages:\n\n```\naenum\ncolorama\npyasn1\npyasn1-modules\nrequests\nsseclient-py\nurllib3\n```\n\nIf installing from GitHub, you may install the external packages by running:\n\n pip install -r requirements.txt\n\n## Usage\n\n```\nusage: rf_protocol_validator.py [-h] [--version] --user USER --password\n PASSWORD --rhost RHOST [--log-level LOG_LEVEL]\n [--report-dir REPORT_DIR]\n [--report-type {html,tsv,both}]\n [--avoid-http-redirect]\n [--no-cert-check | --ca-bundle CA_BUNDLE]\n\nValidate the protocol conformance of a Redfish service\n\nrequired arguments:\n --user USER, -u USER the username for authentication\n --password PASSWORD, -p PASSWORD\n the password for authentication\n --rhost RHOST, -r RHOST\n address of the Redfish service (with scheme)\n\noptional arguments:\n -h, --help show this help message and exit\n --version show program's version number and exit\n --log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}\n the logging level (default: WARNING)\n --report-dir REPORT_DIR\n the directory for generated report files (default:\n \"reports\")\n --report-type {html,tsv,both}\n the type of report to generate: html, tsv, or both\n (default: both)\n --avoid-http-redirect\n avoid attempts to generate HTTP redirects for services\n that do not support HTTP\n --no-cert-check disable verification of host SSL certificates\n --ca-bundle CA_BUNDLE\n the file or directory containing trusted CAs\n```\n\nExample:\n\n rf_protocol_validator -r https://192.168.1.100 -u USERNAME -p PASSWORD\n\n## Unit Tests\n\nThe Redfish Protocol Validator unit tests are executed using the `tox` package.\n\nYou may install `tox` by running:\n\n pip install tox\n\nRunning the unit tests:\n\n tox\n\n## Release Process\n\n1. Go to the \"Actions\" page\n2. Select the \"Release and Publish\" workflow\n3. Click \"Run workflow\"\n4. Fill out the form\n5. Click \"Run workflow\"\n",
"bugtrack_url": null,
"license": "BSD 3-clause \"New\" or \"Revised License\"",
"summary": "Redfish Protocol Validator",
"version": "1.2.6",
"project_urls": {
"Homepage": "https://github.com/DMTF/Redfish-Protocol-Validator"
},
"split_keywords": [
"redfish"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ba4c31382cb46b64121f1eead5c941769cb2b25866173dd919b926620e230df0",
"md5": "0d58f5a7e999a5ca3489c74909934b81",
"sha256": "7a401fb6ec9acc45d7c84cb583ace59889b55922d9d7d49070e63b62bc266619"
},
"downloads": -1,
"filename": "redfish_protocol_validator-1.2.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0d58f5a7e999a5ca3489c74909934b81",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 84562,
"upload_time": "2024-07-19T19:11:17",
"upload_time_iso_8601": "2024-07-19T19:11:17.118112Z",
"url": "https://files.pythonhosted.org/packages/ba/4c/31382cb46b64121f1eead5c941769cb2b25866173dd919b926620e230df0/redfish_protocol_validator-1.2.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "344efe2cd1bff997b4bfdb410690edb470d0bd31a41b3865ef0904321b4cf57a",
"md5": "e7b648db50cf47afea92a990994cea6d",
"sha256": "f6ac8584ab100dca13a05e31001f949f7a7197e5542fb8311bf160754316d2b7"
},
"downloads": -1,
"filename": "redfish_protocol_validator-1.2.6.tar.gz",
"has_sig": false,
"md5_digest": "e7b648db50cf47afea92a990994cea6d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 77415,
"upload_time": "2024-07-19T19:11:18",
"upload_time_iso_8601": "2024-07-19T19:11:18.616679Z",
"url": "https://files.pythonhosted.org/packages/34/4e/fe2cd1bff997b4bfdb410690edb470d0bd31a41b3865ef0904321b4cf57a/redfish_protocol_validator-1.2.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-19 19:11:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DMTF",
"github_project": "Redfish-Protocol-Validator",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "aenum",
"specs": []
},
{
"name": "colorama",
"specs": []
},
{
"name": "pyasn1",
"specs": []
},
{
"name": "pyasn1-modules",
"specs": []
},
{
"name": "requests",
"specs": []
},
{
"name": "sseclient-py",
"specs": []
},
{
"name": "urllib3",
"specs": []
}
],
"tox": true,
"lcname": "redfish-protocol-validator"
}
JSON
