/PID_TestDrivenDevelopment

A github repository for Google Mock testing exercise

Primary LanguageCMakeMIT LicenseMIT

Google Mock Test Exercise

Build Status Coverage Status

Overview

Testing a project of a simple PID controller using GMock framework. The class ControlSystemHelper is mocked and the methods computeError and computeVelocity of the mocked class is used in the testing phase. The method computeControlSignalInfo in PIDController class uses the mocked method computeVelocity, whereas the method computeTrackingError in PIDController class uses the mocked method computeError. The returned value from PIDController class methods computeControlSignalInfo and computeTrackingError is checked to be consistent with the values reutrned by the mock class. All the written tests, using gtest and gmock framework, were succesfully passed by the implementation. No dependencies exist to execute the code on this repository. The different CMakeLists.txt have been modified appropriately to ensure GMock testing runs

Standard install via command-line

git clone --single-branch -b  GMock_Extra_Credit https://github.com/rohithjayarajan/PID_TestDrivenDevelopment.git
cd PID_TestDrivenDevelopment
mkdir build
cd build
cmake ..
make
Run program: ./app/shell-app
Run tests: ./test/cpp-test

Building for code coverage

sudo apt-get install lcov
cmake -D COVERAGE=ON -D CMAKE_BUILD_TYPE=Debug ../
make
make code_coverage

This generates a index.html page in the build/coverage sub-directory that can be viewed locally in a web browser.

Working with Eclipse IDE

Installation

In your Eclipse workspace directory (or create a new one), checkout the repo (and submodules)

mkdir -p ~/workspace
cd ~/workspace
git clone --recursive https://github.com/rohithjayarajan/PID_TestDrivenDevelopment.git

In your work directory, use cmake to create an Eclipse project for an [out-of-source build] of PID_TestDrivenDevelopment-eclipse

cd ~/workspace
mkdir -p PID_TestDrivenDevelopment-eclipse
cd PID_TestDrivenDevelopment-eclipse
cmake -G "Eclipse CDT4 - Unix Makefiles" -D CMAKE_BUILD_TYPE=Debug -D CMAKE_ECLIPSE_VERSION=4.7.0 -D CMAKE_CXX_COMPILER_ARG1=-std=c++14 ../PID_TestDrivenDevelopment

Import

Open Eclipse, go to File -> Import -> General -> Existing Projects into Workspace -> Select "PID_TestDrivenDevelopment-eclipse" directory created previously as root directory -> Finish

Edit

Source files may be edited under the "[Source Directory]" label in the Project Explorer.

Build

To build the project, in Eclipse, unfold PID_TestDrivenDevelopment-eclipse project in Project Explorer, unfold Build Targets, double click on "all" to build all projects.

Run

  1. In Eclipse, right click on the PID_TestDrivenDevelopment-eclipse in Project Explorer, select Run As -> Local C/C++ Application

  2. Choose the binaries to run (e.g. shell-app, cpp-test for unit testing)

Debug

  1. Set breakpoint in source file (i.e. double click in the left margin on the line you want the program to break).

  2. In Eclipse, right click on the PID_TestDrivenDevelopment-eclipse in Project Explorer, select Debug As -> Local C/C++ Application, choose the binaries to run (e.g. shell-app).

  3. If prompt to "Confirm Perspective Switch", select yes.

  4. Program will break at the breakpoint you set.

  5. Press Step Into (F5), Step Over (F6), Step Return (F7) to step/debug your program.

  6. Right click on the variable in editor to add watch expression to watch the variable in debugger window.

  7. Press Terminate icon to terminate debugging and press C/C++ icon to switch back to C/C++ perspetive view (or Windows->Perspective->Open Perspective->C/C++).

Plugins

  • CppChEclipse

    To install and run cppcheck in Eclipse

    1. In Eclipse, go to Window -> Preferences -> C/C++ -> cppcheclipse. Set cppcheck binary path to "/usr/bin/cppcheck".

    2. To run CPPCheck on a project, right click on the project name in the Project Explorer and choose cppcheck -> Run cppcheck.

  • Google C++ Sytle

    To include and use Google C++ Style formatter in Eclipse

    1. In Eclipse, go to Window -> Preferences -> C/C++ -> Code Style -> Formatter. Import eclipse-cpp-google-style and apply.

    2. To use Google C++ style formatter, right click on the source code or folder in Project Explorer and choose Source -> Format

  • Git

    It is possible to manage version control through Eclipse and the git plugin, but it typically requires creating another project. If you're interested in this, try it out yourself and contact me on Canvas.