CONTRIBUTING.md

@@ -173,7 +173,7 @@ work-in-progress, feel free to propose changes.
     Example:
         Suite:  test_boot_progress_code.robot
 
-        Force Tags    Boot_Progress_Code
+        Test Tags    Boot_Progress_Code
     ```
 
   - Create a tag for every test case with a tag name that mirrors the test case

README.md

@@ -48,38 +48,23 @@
 If using Python 3.x, use the corresponding `pip3` to install packages. Note:
 Older Python 2.x is not actively supported.
 
-REST base packages:
-
-```
-    $ pip install -U requests
-    $ pip install -U robotframework-requests
-    $ pip install -U robotframework-httplibrary
-```
-
-Python redfish library packages: For more detailed intstructions see
-[python-redfish-library](https://github.com/DMTF/python-redfish-library)
-
-```
-    $ pip install redfish
-```
-
-SSH and SCP base packages: For more detailed installation instructions see
-[robotframework-sshlibrary](https://pypi.python.org/pypi/robotframework-sshlibrary)
+Installing requirement dependencies:
 
 ```
-    $ pip install robotframework-sshlibrary
-    $ pip install robotframework-scplibrary
+    $ pip install -r requirements.txt
 ```
 
-Installing requirement dependencies:
+Optional packages but required for `redfish/dmtf_tools/`
 
 ```
-    $ pip install -r requirements.txt
+    $ pip install -r requirements_optional.txt
 ```
 
 you'll find this file once your clone openbmc-test-automation repository.
 
-For Web UI ( GUI ) Testing setup instructions see
+For Web UI ( GUI ) Testing setup, please the follow instructions mentioned in
+the OpenBMC GUI Test Setup Guide. Note: GUI test cases under `gui/` will not
+work without the above setup completed in your environment.
 [OpenBMC GUI Test Setup Guide](https://github.com/openbmc/openbmc-test-automation/blob/master/docs/gui_setup_reference.md)
 
 Installing tox:
@@ -102,24 +87,32 @@ These documents contain details on developing OpenBMC test code and debugging.
 - [CONTRIBUTING.md](CONTRIBUTING.md): Coding guidelines.
 - [Code Check Tools](https://github.com/openbmc/openbmc-test-automation/blob/master/docs/code_standards_check.md):
   To check common code misspellings, syntax and standard checks.
+- [Redfish Coding Guidelines](https://github.com/openbmc/openbmc-test-automation/blob/master/docs/redfish_coding_guidelines.md):
+  Refer for Redfish coding guidelines.
 - [REST-cheatsheet.md](https://github.com/openbmc/docs/blob/master/REST-cheatsheet.md):
   Quick reference for some common curl commands required for legacy REST
   testing.
 - [REDFISH-cheatsheet.md](https://github.com/openbmc/docs/blob/master/REDFISH-cheatsheet.md):
   Quick reference for some common curl commands required for redfish testing.
 - [README.md](https://github.com/openbmc/webui-vue/blob/master/README.md): Web
   UI setup reference.
+- [Redfish Request Via mTLS](https://github.com/openbmc/openbmc-test-automation/blob/master/docs/redfish_request_via_mTLS.md):
+  Reference for Redfish Request Via mTLS .
 - [Corporate CLA and Individual CLA](https://github.com/openbmc/docs/blob/master/CONTRIBUTING.md#submitting-changes-via-gerrit-server):
   Submitting changes via Gerrit server
 
 ## OpenBMC Test Documentation
 
+- [OpenBMC Test Architecture](https://github.com/openbmc/openbmc-test-automation/blob/master/docs/openbmc_test_architecture.md):
+  Reference for OpenBMC Test Architecture.
 - [Tools](https://github.com/openbmc/openbmc-test-automation/blob/master/docs/openbmc_test_tools.md):
   Reference information for helper tools.
 - [Code Update](https://github.com/openbmc/openbmc-test-automation/blob/master/docs/code_update.md):
   Currently supported BMC and PNOR update.
 - [Certificate Generate](https://github.com/openbmc/openbmc-test-automation/blob/master/docs/certificate_generate.md):
   Steps to create and install CA signed certificate.
+- [Boot Test](https://github.com/openbmc/openbmc-test-automation/blob/master/docs/boot_test.md):
+  Boot test for OpenBMC.
 
 ## Supported Systems Architecture
 
@@ -153,6 +146,8 @@ There are several sub-directories within the openbmc-test-automation base which
 contain test suites, tools, templates, etc. These sub-directories are classified
 as follows:
 
+`docs/`: Contains the documentation related to OpenBMC.
+
 `redfish/`: Contains the general test cases for OpenBMC stack functional
 verification.
 
@@ -228,6 +223,8 @@ packages which will help to invoke tests through tox (Note that tox version
   $ export OPENBMC_USERNAME=<openbmc username>
   $ export OPENBMC_PASSWORD=<openbmc password>
   $ export IPMI_COMMAND=<Dbus/External>
+  $ export REST_USERNAME=<REST interface username>
+  $ export REST_PASSWORD=<REST interface password>
   ```
 
   or

bin/generate_testsuite_info.py

@@ -2,13 +2,13 @@
 
 r"""
 Use robot framework API to extract test data from test suites.
-Refer to https://robot-framework.readthedocs.io/en/3.0.1/autodoc/robot.parsing.html
+Refer to https://robot-framework.readthedocs.io/en/latest/autodoc/robot.running.html
 """
 
 import os
 import sys
 
-from robot.parsing.model import TestData
+from robot.api import SuiteVisitor, TestSuiteBuilder
 
 sys.path.append(os.path.join(os.path.dirname(__file__), "../lib"))
 
@@ -54,6 +54,27 @@
 stock_list = [("test_mode", 0), ("quiet", 0), ("debug", 0)]
 
 
+class TestPrint(SuiteVisitor):
+
+    def __init__(self, option):
+        self.option = option
+
+    def visit_test(self, test):
+        r"""
+        Print the test data from suite test object from option specified.
+        """
+        if self.option == "name":
+            print(test.name)
+        elif self.option == "tags":
+            print(test.tags)
+        elif self.option == "doc":
+            print(test.doc)
+        elif self.option == "all":
+            print(test.name)
+            print(test.tags)
+            print(test.doc)
+
+
 def exit_function(signal_number=0, frame=None):
     r"""
     Execute whenever the program ends normally or with the signals that we
@@ -119,7 +140,7 @@ def parse_test_suites(source_path, option):
         print(file_path)
         if "__init__.robot" in file_path:
             continue
-        test_suite_obj = TestData(parent=None, source=file_path)
+        test_suite_obj = TestSuiteBuilder().build(file_path)
         parse_test_file(test_suite_obj, option)
 
 
@@ -138,17 +159,7 @@ def parse_test_file(test_suite_obj, option):
                       "tags" or "doc".
     """
 
-    for testcase in test_suite_obj.testcase_table:
-        if option == "name":
-            print(testcase.name)
-        elif option == "tags":
-            print(testcase.tags)
-        elif option == "doc":
-            print(testcase.doc)
-        elif option == "all":
-            print(testcase.name)
-            print(testcase.tags)
-            print(testcase.doc)
+    test_suite_obj.visit(TestPrint(option))
 
 
 def main():

data/Romulus.py

@@ -961,5 +961,3 @@
     # 0x06 : { 'class' : 'PowerCap',
     #    'os_path' : '/sys/class/hwmon/hwmon3/user_powercap' },
 }
-
-# vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4

data/Witherspoon.py

@@ -598,5 +598,3 @@
     0xDA: {"class": "TurboAllowedSensor"},
     0xD8: {"class": "PowerSupplyDeratingSensor"},
 }
-
-# vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4