OpenOLT agent unit test framework is based on the following frameworks
The goal of the unit tests for OpenOLT agent is to test the OpenOLT application by stubbing and mocking the external interfaces, especially the BAL API and GRPC.
All the pre-requisite software for running the openolt agent unit tests are packaged, versioned and released as a docker container. See https://github.com/opencord/openolt-test for more details.
Follow the below steps to build and run unit test
cd <openolt agent root directory> make test
The openolt agent source code will be mounted to docker container, compiled and unit tests will be run. Note that you will need access to internet to download the voltha/openolt-test docker container for the first time.
If you choose not to use docker container packaged with pre-requisite software for building and running unit tests, you may install the pre-requisite software directly on the host system using procedure below. However this procedure is NOT RECOMMENDED as software being installed via this procedure may conflict or overwrite the software that may already exist on the host system.
$ cd agent/test # Run Autoconfig to generate the appropriate makefile scaffolding for the desired target ./configure # This will build pre-requisite software to build openolt. Needed once only. $ make prereq # This will install gtest and c-mock libraries. Needed once only $ make prereq-mock-lib # This will build and run the unit test cases $ make test
Once you have successfully built and run the unit-test, the test report will be available in test_openolt_report_xunit.xml file in agent/test. To clean all build artifacts and test reports, do make clean from openolt agent root directory.
Before you add new test cases please read GOOGLE TEST COOKBOOK and USING CMOCK to get acquainted with frameworks used for the unit-test cases.
Refer agent/test/src/bal_mocker.cc and agent/test/src/bal_mocker.h to see how mock functions are created (if needed by your test case). In the aforementioned examples, mocks are created for certain BAL APIs.
Please refer example agent/test/src/test_enable_olt.cc.
Tests are grouped under Test Fixtures, i.e., TEST_F which takes argument of Test Fixture Name and the Test Case. There will typically be many test cases under a test fixture. Also it is preferable to create a new file for different test fixtures.
If your test case needs mocking, you will need to instantiate the appropriate mocker class you have created and use the ON_CALL, EXPECT_CALL or other utilities from the gtest suite to produce the required behavior.
Use the ASSERT_XXX utility from the gtest suite to verify the required result. Please refer the GOOGLE TEST COOKBOOK for detailed documentation.