-
Notifications
You must be signed in to change notification settings - Fork 4
User Guide
- Right click on a project in the Project Explorer view
- Select Install Unit Tests from the Unit Tests menu
We install our framework into a unittests folder at the root of the project. All files belonging to this framework are underneath this folder.
- Right click on a project in the Project Explorer view
- Select Uninstall Unit Tests from the Unit Tests menu
- If you want to permanently delete the unittests folder select Yes, otherwise click No to leave the folder on the file system (but remove the Momentics link to our plugin) or Cancel to stop the uninstall.
To make life easier for the developer we have created a simple to use interface which allows the user to create, view, and edit tests quickly and easily.
Underneath a project with the Unit Test Framework installed there will be a new node called Unit Tests. There are 4 nodes below this:
- Tests
- Support Files
- Code Coverage
- Mocks
This node provides an easy way to view classes that exist in the project and any unknown test files that do not match up to any known class. Each node at this level contains a name and a number of tests written for it. There are two types of nodes at this level:
- Class Nodes
- Unknown Nodes
Right clicking on the Tests node allows the user to create new unknown test source files.
The project is constantly scanned to find all known classes. A class node is created for each. Associated to each node is a test file named test_<ClassName>.cpp inside the framework folder. Double clicking on this node opens this associated test file if it exists. If it does not exist the test file is created for you and pre-populates the file with:
- the gmock/gmock.h header include
- the inclusion for the header file defining this class
- a test fixture named <Class>Test
- an empty sample test to start with
Any source files inside the test framework folder that do not correspond to a known class in the project are listed as an unknown node. Double clicking on these nodes will open the unknown test file.
Any support header/source files in the test framework folder are listed here. By default there is one item which corresponds to a source file containing the main() entry point to set up the testing framework. The user can right click on this node to create a new header or source file to add their own helper class/methods to be re-used across test files.
This node is used to open the code coverage results of the last executed unit test run. Double clicking on it opens the gcov plugin to display the code coverage in a user-friendly manner. In this gcov view you can double click on any file listed to see a highlighted view of the file showing each line in the file that has been executed or not.
This node allows the user to right click on it to update to the latest BB10 Mocks. A notification arrow will appear when the plugin detects the mock files are out of date. Since these mocks are ever-evolving it may be prudent to update to the latest mocks when an issue is encountered -- it could be it has already been fixed!
The plugin attempts to configure itself by looking in certain default locations for the prerequisites. The user can open Window -> Preferences and navigate to Blackberry -> Unit Testing. On this preferences page the user is required to select the location of the CMake executable, qmake executable, and on Windows the MinGW installation folder and the MSYS installation folder.
The Unit Testing plugin can now install the pre-requisites for you with the click of a button. In Window -> Preferences -> Blackberry -> Unit Testing there is a button to install the pre-requisites for you. Note that this does not update your PATH variable with the MinGW/MSys bin folders which is a requirement for the build to succeed.
For this option to be available you must install the com.bb.extensions.plugin.unittests.dependencies plugin feature.
To build the unit tests the user must switch to the Unit Tests build configuration. The user can then build the project as per normal.
To run the unit tests there is a Run Configuration automatically configured for the user. This configuration is listed under the C/C++ Unit category as <Project Name> Unit Tests. Running this configuration will execute the tests and present the user with a graphical window from the CDT Tests Runner plugin showing the results of each test run.
After Launching the Tests a window appears showing a graphical representation of the tests. For each and every test that was run you can view the pass/fail status as well as the failure reason.
- We only look in two locations for classes to test: src and include (and all sub folders). If your project uses a different structure the plugin will not find your classes.