| commit | 134947d9572fa951114c40895ec923b6d1b5a7dd | [log] [tgz] |
|---|---|---|
| author | Shad Ansari <shad@opennetworking.org> | Thu Feb 14 23:45:03 2019 -0800 |
| committer | Shad Ansari <shad@opennetworking.org> | Wed Feb 20 21:14:57 2019 +0000 |
| tree | 1600874d686ff6f8ab018dd4df34f448af71f6cb | |
| parent | 82dd202d12c6176c9faca0855a2e38471b92f025 [diff] |
Introduce the openolt_data_model module. A voltha adapter maintains its data model in KV store. In most cases the interaction with the KV store's data model is not direct but via the adapter_agent. There is a fair amount of boiler-plate code in the adapter related to the interaction with adapter_agent. Most of this is going to change from voltha 1.x to 2.0. This, and subsequent related commits, aim to abstract out the adapter_agent interface in the openolt_data_model. The resulting de-cluttered logic of the adapter will be more amenable to re-use in the porting to 2.0. Change-Id: Ic0d7223db2a6713bae7a0c953d11b1977759fab6
Voltha aims to provide a layer of abstraction on top of legacy and next generation access network equipment for the purpose of control and management. Its initial focus is on PON (GPON, EPON, NG PON 2), but it aims to go beyond to eventually cover other access technologies (xDSL, Docsis, G.FAST, dedicated Ethernet, fixed wireless).
Key concepts of Voltha:
Control and management in the access network space is a mess. Each access technology brings its own bag of protocols, and on top of that vendors have their own interpretation/extension of the same standards. Compounding the problem is that these vendor- and technology specific differences ooze way up into the centralized OSS systems of the service provider, creating a lot of inefficiencies.
Ideally, all vendor equipment for the same access technology should provide an identical interface for control and management. Moreover, there shall be much higher synergies across technologies. While we wait for vendors to unite, Voltha provides an increment to that direction, by confining the differences to the locality of access and hiding them from the upper layers of the OSS stack.
While we are still at the early phase of development, you can check out the BUILD.md file to see how you can build it, run it, test it, etc.
Contributions, small and large, are welcome. Minor contributions and bug fixes are always welcome in form of pull requests. For larger work, the best is to check in with the existing developers to see where help is most needed and to make sure your solution is compatible with the general philosophy of Voltha.
To begin, make sure to have a development environement installed according to the OpenCord WIKI. Next, In a shell environment
source env.sh; # Source the environment Settings and create a virtual environment make utest-with-coverage; # Execute the Unit Test with coverage reporting
New unit tests for the core can be written in the nosetest framework and can be found under /tests/utest/
Each adapter's unit tests are discovered by the presence of a test.mk submake file underneath the adapter's directory. for example)
# voltha/adapters/my_new_adapter/test.mk .PHONY test test: @echo "Testing my amazing new adapter" @./my_test_harness
Voltha's test framework will execute the FIRST Target in the submake file as the unit test function. It may include as many dependencies as needed, such as using a different python framework for testing (pytest, unittest, tox) or even alternate languages (go, rust, php).
In order for you adapter's test-coverage to be reported, make sure that your test_harness creates a coverage report in a junit xml format. Most test harnesses can easily produce this report format. The Jenkins Job will pick up your coverage report file if named appropriately junit-report.xml according to the Jenkins configuration.