diff options
Diffstat (limited to 'docs/development/index.rst')
| -rw-r--r-- | docs/development/index.rst | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/docs/development/index.rst b/docs/development/index.rst index 9aea6ec..7d7ece7 100644 --- a/docs/development/index.rst +++ b/docs/development/index.rst @@ -4,3 +4,63 @@ CIRV-HDV Developer Guide
========================
+
+
+Intended Audience
+^^^^^^^^^^^^^^^^^
+
+This document is intended to aid those who want to modify the hdv code Or
+to extend it to add new features.
+
+Requirements
+^^^^^^^^^^^^
+* Python3
+* pip
+* git
+
+Installation
+^^^^^^^^^^^^^
+
+Clone repo as follows:
+
+.. code-block:: bash
+
+ $ git clone "git clone "ssh://YourLFID@gerrit.opnfv.org:29418/cirv-hdv""
+
+
+then install required python packages:
+
+.. code-block:: bash
+
+ $ pip install -r cirv-hdv/requirements.txt
+
+
+Structure
+^^^^^^^^^
+
+.. code-block:: console
+
+ ./redfish
+ ├─conf # config directory
+ ├─logs # hdv.log would be generated here.
+
+
+.. code-block:: console
+
+ $ ls redfish/*.py
+ redfish/__init__.py
+ redfish/hdv_redfish.py #The main code implementation by parsing config.yaml and cases.yaml
+ redfish/conftest.py # File automitacally runs before hdv_redfish.py used to take input and add paramters to fixtures.
+ redfish/log_utils.py #log utils
+ redfish/errors.py #error code definition for the tool during parse.
+ redfish/http_handler.py #http_handler
+ redfish/yaml_utils.py #yaml utils for test.
+
+ $ ls redfish/conf
+ pdf2.0 # OPNFV Pod Descriptor File, Used by hdv for accessing servers
+ cases.yaml #test cases yaml file
+ report.yaml #final test report
+
+
+ $ ls redfish/logs
+ hdv.log # test log file
|