gtest - Google Test and Google Mock for EPICS

This module adds the Google Test and Google Mock frameworks to EPICS, fully supported and integrated with the EPICS build system.

Features

• Google Test and Google Mock 1.10.0, built with the EPICS build system, thus using your specific configuration of EPICS Base, compilers, host platforms etc.

• TAP listener to create test reports in the TAP standard that EPICS uses.

• Additional rules for the EPICS build system that build and run Google Test executables as part of the regular make runtests and make test-results targets.

• Easy configuration in any EPICS Makefile; EPICS unit tests and Google Tests can live in the same directory.

• Compatibility RULES file that allows using this module with older releases of EPICS Base. (Tested for 3.14.12.8 and above.)

Prerequisites

• Recent versions of the EPICS 3.15 or EPICS 7 release series are supported out-of-the-box. Using the provided compatibility rules file, full functionality is available with older releases (3.14.12.8 and above).

• Googletest 1.10.x requires a compiler that implements the C++11 standard.
  Microsoft Visual C++ needs to be from Visual Studio 2015 or newer. g++ needs to be 4.6 or above.

Usage

1. Configure the compiler on Linux to use the C++11 standard by adding

   USR_CXXFLAGS_Linux += -std=c++11

   to the CONFIG_SITE file (or one of the host/target specific site configuration files).
   Under specific circumstances, it is not possible to link objects together that have been compiled using different C++ standard settings (see this StackOverflow thread). In those cases, setting this option globally in EPICS Base is preferable.

2. Build the gtest module using the standard techniques (e.g., configure the EPICS Base location through the RELEASE.local mechanism).

3. Set GTEST=/path/to/gtest/module in your module's dependency configuration (e.g., RELEASE.local).

4. Write test code in e.g. myTest.cpp (multiple test suites per source file are supported) and add the test to the Makefile:

GTESTPROD_HOST += myTest
myTest_SRCS += myTest.cpp
GTESTS += myTest

5. If you are using an older release of EPICS Base, include the compatibility rules file at the end of your Makefile:

-include $(GTEST)/cfg/compat.RULES_BUILD

6. Run make test-results.

When using the compatibility rules, you will see some warnings about make rules for test related targets being overwritten and/or ignored. This is expected, as it is the way the compatibility rules work: they overwrite some of the test rules from EPICS Base to work with Google Test. This is done only for the make run in the directories where you include that compatibility rules file; your Base installation (and all other/remaining builds) are left untouched.

Embed gtest into an EPICS 7 Installation

Building gtest as an embedded module inside an EPICS 7 installation is supported.

1. Put the gtest module into a subdirectory of <EPICS7>/modules, add that subdirectory to <EPICS7>/modules/Makefile.local, switch the compiler on Linux to the C++11 standard (see above) and recompile Base.

2. Set GTEST=$(EPICS_BASE) in your module's dependency configuration (e.g., RELEASE.local).

The remaining steps are the same as above.

License

The Google Test / Google Mock framework is distributed under the 3-Clause BSD License.
The TAP listener is distributed under the MIT License.
EPICS is distributed under the EPICS Open License.