blob: 21247219dc5ff8bb8f91077d2c185f70066cf039 [file] [log] [blame]
Zack Williams16042b62020-03-29 22:03:16 -07001VOLTHA Robot Test Libraries
2===========================
Andy Bavier5dee6ae2020-01-29 16:03:40 -07003
Zack Williams16042b62020-03-29 22:03:16 -07004Below are links to the documentation generated by ``robot.libdoc`` from the
Joey Armstrong1a9b7d12022-12-19 14:13:07 -05005Robot resources in the voltha-system-tests repository.
6
7| These files can also be generated locally by checking out the repo and running:
8
9- % **make gendocs**
10
11 - `voltha-system-tests (gerrit) <https://gerrit.opencord.org/plugins/gitiles/voltha-system-tests>`_
12 - `voltha-system-tests (github) <https://github.com/opencord/voltha-system-tests>`_
Andy Bavier5dee6ae2020-01-29 16:03:40 -070013
14Libraries
15---------
Hardik Windlass0851c4e2022-03-09 14:10:50 +000016- `libraries/bbsim.robot <../_static/voltha-system-tests/libraries/bbsim.html>`_
17- `libraries/dmi-basics.robot <../_static/voltha-system-tests/libraries/dmi-basics.html>`_
18- `libraries/flows.robot <../_static/voltha-system-tests/libraries/flows.html>`_
Andy Bavier5dee6ae2020-01-29 16:03:40 -070019- `libraries/k8s.robot <../_static/voltha-system-tests/libraries/k8s.html>`_
20- `libraries/onos.robot <../_static/voltha-system-tests/libraries/onos.html>`_
Hardik Windlass0851c4e2022-03-09 14:10:50 +000021- `libraries/onu_utilities.robot <../_static/voltha-system-tests/libraries/onu_utilities.html>`_
22- `libraries/pm_utilities.robot <../_static/voltha-system-tests/libraries/pm_utilities.html>`_
Andy Bavier5dee6ae2020-01-29 16:03:40 -070023- `libraries/power_switch.robot <../_static/voltha-system-tests/libraries/power_switch.html>`_
24- `libraries/utils.robot <../_static/voltha-system-tests/libraries/utils.html>`_
25- `libraries/voltctl.robot <../_static/voltha-system-tests/libraries/voltctl.html>`_
26- `libraries/voltha.robot <../_static/voltha-system-tests/libraries/voltha.html>`_
27
28
29Test Files
30----------
Hardik Windlass0851c4e2022-03-09 14:10:50 +000031- `tests/bbsim/Voltha_BBSimTests.robot <../_static/voltha-system-tests/tests/bbsim/Voltha_BBSimTests.html>`_
32- `tests/dmi-interface/dmi-hw-management.robot <../_static/voltha-system-tests/tests/dmi-interface/dmi-hw-management.html>`_
Hardik Windlass138d9fb2022-03-24 03:26:43 +000033- `tests/dt-workflow/Voltha_DT_FTTB_Tests.robot <../_static/voltha-system-tests/tests/dt-workflow/Voltha_DT_FTTB_Tests.html>`_
Hardik Windlass0851c4e2022-03-09 14:10:50 +000034- `tests/dt-workflow/Voltha_DT_FailureScenarios.robot <../_static/voltha-system-tests/tests/dt-workflow/Voltha_DT_FailureScenarios.html>`_
Hardik Windlass138d9fb2022-03-24 03:26:43 +000035- `tests/dt-workflow/Voltha_DT_MultiOLT_Tests.robot <../_static/voltha-system-tests/tests/dt-workflow/Voltha_DT_MultiOLT_Tests.html>`_
Hardik Windlass0851c4e2022-03-09 14:10:50 +000036- `tests/dt-workflow/Voltha_DT_PODTests.robot <../_static/voltha-system-tests/tests/dt-workflow/Voltha_DT_PODTests.html>`_
Andy Bavier5dee6ae2020-01-29 16:03:40 -070037- `tests/functional/K8S_SystemTest.robot <../_static/voltha-system-tests/tests/functional/K8S_SystemTest.html>`_
Hardik Windlass0851c4e2022-03-09 14:10:50 +000038- `tests/functional/Redfish_Importer.robot <../_static/voltha-system-tests/tests/functional/Redfish_Importer.html>`_
39- `tests/functional/Voltha_AlarmTests.robot <../_static/voltha-system-tests/tests/functional/Voltha_AlarmTests.html>`_
Andy Bavier5dee6ae2020-01-29 16:03:40 -070040- `tests/functional/Voltha_ErrorScenarios.robot <../_static/voltha-system-tests/tests/functional/Voltha_ErrorScenarios.html>`_
41- `tests/functional/Voltha_FailureScenarios.robot <../_static/voltha-system-tests/tests/functional/Voltha_FailureScenarios.html>`_
Hardik Windlass0851c4e2022-03-09 14:10:50 +000042- `tests/functional/Voltha_MultiOLT_Tests.robot <../_static/voltha-system-tests/tests/functional/Voltha_MultiOLT_Tests.html>`_
43- `tests/functional/Voltha_ONOSHATests.robot <../_static/voltha-system-tests/tests/functional/Voltha_ONOSHATests.html>`_
Andy Bavier5dee6ae2020-01-29 16:03:40 -070044- `tests/functional/Voltha_PODTests.robot <../_static/voltha-system-tests/tests/functional/Voltha_PODTests.html>`_
45- `tests/functional/Voltha_ScaleFunctionalTests.robot <../_static/voltha-system-tests/tests/functional/Voltha_ScaleFunctionalTests.html>`_
Hardik Windlass0851c4e2022-03-09 14:10:50 +000046- `tests/functional/Voltha_StartContainerPODTests.robot <../_static/voltha-system-tests/tests/functional/Voltha_StartContainerPODTests.html>`_
47- `tests/memory-leak/VOLTHA_Memory_Leak_Tests.robot <../_static/voltha-system-tests/tests/memory-leak/VOLTHA_Memory_Leak_Tests.html>`_
48- `tests/openonu-go-adapter/Voltha_ONUFlowChecks.robot <../_static/voltha-system-tests/tests/openonu-go-adapter/Voltha_ONUFlowChecks.html>`_
49- `tests/openonu-go-adapter/Voltha_ONUMibAudit.robot <../_static/voltha-system-tests/tests/openonu-go-adapter/Voltha_ONUMibAudit.html>`_
50- `tests/openonu-go-adapter/Voltha_ONUNegativeStateTests.robot <../_static/voltha-system-tests/tests/openonu-go-adapter/Voltha_ONUNegativeStateTests.html>`_
51- `tests/openonu-go-adapter/Voltha_ONUOmciGetTest.robot <../_static/voltha-system-tests/tests/openonu-go-adapter/Voltha_ONUOmciGetTest.html>`_
52- `tests/openonu-go-adapter/Voltha_ONUReconcileTests.robot <../_static/voltha-system-tests/tests/openonu-go-adapter/Voltha_ONUReconcileTests.html>`_
53- `tests/openonu-go-adapter/Voltha_ONUStateTests.robot <../_static/voltha-system-tests/tests/openonu-go-adapter/Voltha_ONUStateTests.html>`_
54- `tests/openonu-go-adapter/Voltha_ONUTemplateTests.robot <../_static/voltha-system-tests/tests/openonu-go-adapter/Voltha_ONUTemplateTests.html>`_
55- `tests/pm-data/Voltha_ONUPMTests.robot <../_static/voltha-system-tests/tests/pm-data/Voltha_ONUPMTests.html>`_
56- `tests/scale/Voltha_Scale_Tests.robot <../_static/voltha-system-tests/tests/scale/Voltha_Scale_Tests.html>`_
57- `tests/software-upgrades/ONOS_AppsUpgrade.robot <../_static/voltha-system-tests/tests/software-upgrades/ONOS_AppsUpgrade.html>`_
58- `tests/software-upgrades/ONU_Upgrade.robot <../_static/voltha-system-tests/tests/software-upgrades/ONU_Upgrade.html>`_
59- `tests/software-upgrades/Voltha_ComponentsUpgrade.robot <../_static/voltha-system-tests/tests/software-upgrades/Voltha_ComponentsUpgrade.html>`_
Hardik Windlass702b5fa2022-06-29 17:27:01 +053060- `tests/tim-workflow/Voltha_TIM_PODTests.robot <../_static/voltha-system-tests/tests/tim-workflow/Voltha_TIM_PODTests.html>`_
Hardik Windlass0851c4e2022-03-09 14:10:50 +000061- `tests/tt-workflow/Voltha_TT_FailureScenarios.robot <../_static/voltha-system-tests/tests/tt-workflow/Voltha_TT_FailureScenarios.html>`_
62- `tests/tt-workflow/Voltha_TT_MultiTcontTests.robot <../_static/voltha-system-tests/tests/tt-workflow/Voltha_TT_MultiTcontTests.html>`_
63- `tests/tt-workflow/Voltha_TT_MulticastTests.robot <../_static/voltha-system-tests/tests/tt-workflow/Voltha_TT_MulticastTests.html>`_
64- `tests/tt-workflow/Voltha_TT_PODTests.robot <../_static/voltha-system-tests/tests/tt-workflow/Voltha_TT_PODTests.html>`_
Andy Bavier39d67b12020-02-27 16:08:52 -070065
66
67Package "cord-robot" Documentation
Zack Williams16042b62020-03-29 22:03:16 -070068----------------------------------
Andy Bavier39d67b12020-02-27 16:08:52 -070069
Zack Williams16042b62020-03-29 22:03:16 -070070Below are links to the documentation generated by ``robot.libdoc`` for the
71Robot resources in the `cord-robot <https://pypi.org/project/cord-robot/>`_
Joey Armstrong1a9b7d12022-12-19 14:13:07 -050072Python package.
73
74| These files can also be generated locally by checking out the `cord-tester <https://github.com/opencord/cord-tester>`_ repo and running **make gendocs**.
Andy Bavier39d67b12020-02-27 16:08:52 -070075
76Libraries
77---------
78- `ATTWorkflowDriver.resource <../_static/cord-tester/cord-robot/CORDRobot/rf-resources/ATTWorkFlowDriver.html>`_
79- `DHCP.resource <../_static/cord-tester/cord-robot/CORDRobot/rf-resources/DHCP.html>`_
80- `Kubernetes.resource <../_static/cord-tester/cord-robot/CORDRobot/rf-resources/Kubernetes.html>`_
81- `Network.resource <../_static/cord-tester/cord-robot/CORDRobot/rf-resources/Network.html>`_
82- `OLT.resource <../_static/cord-tester/cord-robot/CORDRobot/rf-resources/OLT.html>`_
83- `ONOS.resource <../_static/cord-tester/cord-robot/CORDRobot/rf-resources/ONOS.html>`_
84- `ONU.resource <../_static/cord-tester/cord-robot/CORDRobot/rf-resources/ONU.html>`_
85- `Subscriber.resource <../_static/cord-tester/cord-robot/CORDRobot/rf-resources/Subscriber.html>`_
86- `utils.resource <../_static/cord-tester/cord-robot/CORDRobot/rf-resources/utils.html>`_
87- `CORDDictUtils.py <../_static/cord-tester/cord-robot/CORDRobot/CORDDictUtils.html>`_
88- `testCaseUtils.py <../_static/cord-tester/cord-robot/CORDRobot/testCaseUtils.html>`_
Joey Armstrong1a9b7d12022-12-19 14:13:07 -050089
90See Also
91--------
92
93- `cord-robot <https://pypi.org/project/cord-robot/>`_
94- `cord-tester <https://github.com/opencord/cord-tester>`_