How to create a Yocto recipe for cmake with separate -dev package of header files? - cmake

I am trying to write a Yocto recipe for an in-house library that uses cmake to build and install itself. Running make install from the command line, the library installs the following files (headers are somewhat abridged):
-- Installing: /prefix/lib/libreflection.so
-- Installing: /prefix/lib/libreflection.a
-- Installing: /prefix/include/reflect
-- Installing: /prefix/include/reflect/type.h
-- Installing: /prefix/include/reflect/detail
-- Installing: /prefix/include/reflect/detail/type.h
-- Installing: /prefix/include/reflect/detail/property.h
-- Installing: /prefix/include/reflect/detail/iterator
-- Installing: /prefix/include/reflect/detail/iterator/range.h
-- Installing: /prefix/include/reflect/detail/accessor.h
-- Installing: /prefix/include/reflect/property.h
-- Installing: /prefix/include/reflect/register.h
-- Installing: /prefix/include/reflect/object.h
-- Installing: /prefix/lib/cmake/libreflection/libreflection-config.cmake
-- Installing: /prefix/lib/cmake/libreflection/libreflection-config-noconfig.cmake
I would like to differentiate between a binary ".so only" Yocto package (libreflection) and a development version that additionally includes the static library, header and cmake package files (libreflection-dev).
My initial recipe is as follows, but with it both libreflection and libreflection-dev package all files:
DESCRIPTION = "C++ reflection library"
SECTION = "libs"
LICENSE = "CLOSED"
SRCREV = "${AUTOREV}"
SRCBRANCH = "master"
SRC_URI = "git://gitlab.company.com/group/${PN}.git;branch=${SRCBRANCH};protocol=ssh"
inherit cmake
S = "${WORKDIR}/git"
FILES_${PN}-dev += "${libdir}/cmake"
# The following are needed because the library is unversioned.
# See https://wiki.yoctoproject.org/wiki/TipsAndTricks/Packaging_Prebuilt_Libraries#Non-versioned_Libraries
SOLIBS = ".so"
FILES_SOLIBSDEV = ""
I have tried various changes to the FILES_${PN}* variables, but none have achieved the desired effect. Generally I either end up with packaging errors, or both libreflection and libreflection-dev include all files.
How can I adjust the recipe such that libreflection includes only the .so, and libreflection-dev includes all the files?

Related

Failed to process package 'rosconsole':

I have installed ROS noetic on raspian buster but it get gives error when this command is implemented as per the procedure mentioned in
http://wiki.ros.org/noetic/Installation/Source
./src/catkin/bin/catkin_make_isolated --install -DCMAKE_BUILD_TYPE=Release
It succesfully goes till 61 ros packages and gives a cmake error at 'rosconsole'
The error goes like this
==> Processing catkin package: 'rosconsole'
==> Building with env: '/home/pi/ros_catkin_ws/install_isolated/env.sh'
==> cmake /home/pi/ros_catkin_ws/src/rosconsole -DCATKIN_DEVEL_PREFIX=/home/pi/ros_catkin_ws/devel_isolated/rosconsole -DCMAKE_INSTALL_PREFIX=/home/pi/ros_catkin_ws/install_isolated -DCMAKE_BUILD_TYPE=Release-DPYTHON_EXECUTABLE=/usr/bin/python3 -G Unix Makefiles in '/home/pi/ros_catkin_ws/build_isolated/rosconsole'
-- Using CATKIN_DEVEL_PREFIX: /home/pi/ros_catkin_ws/devel_isolated/rosconsole
-- Using CMAKE_PREFIX_PATH: /home/pi/ros_catkin_ws/install_isolated
-- This workspace overlays: /home/pi/ros_catkin_ws/install_isolated
-- Found PythonInterp: /usr/bin/python3 (found suitable version "3.7.3", minimum required is "3")
-- Using PYTHON_EXECUTABLE: /usr/bin/python3
-- Using Debian Python package layout
-- Using empy: /usr/lib/python3/dist-packages/em.py
-- Using CATKIN_ENABLE_TESTING: ON
-- Call enable_testing()
-- Using CATKIN_TEST_RESULTS_DIR: /home/pi/ros_catkin_ws/build_isolated/rosconsole/test_results
-- Forcing gtest/gmock from source, though one was otherwise available.
-- Found gtest sources under '/usr/src/googletest': gtests will be built
-- Found gmock sources under '/usr/src/googletest': gmock will be built
-- Found PythonInterp: /usr/bin/python3 (found version "3.7.3")
-- Using Python nosetests: /usr/bin/nosetests3
-- catkin 0.8.10
-- BUILD_SHARED_LIBS is on
-- rosconsole backend: print
CMake Error: The following variables are used in this project, but they are set to NOTFOUND.
Please set them or make sure they are set and tested correctly in the CMake files:
LOG4CXX_LIBRARIES
linked by target "rosconsole-thread_test" in directory /home/pi/ros_catkin_ws/src/rosconsole
linked by target "rosconsole-utest" in directory /home/pi/ros_catkin_ws/src/rosconsole
-- Configuring incomplete, errors occurred!
See also "/home/pi/ros_catkin_ws/build_isolated/rosconsole/CMakeFiles/CMakeOutput.log".
See also "/home/pi/ros_catkin_ws/build_isolated/rosconsole/CMakeFiles/CMakeError.log".
<== Failed to process package 'rosconsole':
Command '['/home/pi/ros_catkin_ws/install_isolated/env.sh', 'cmake', '/home/pi/ros_catkin_ws/src/rosconsole', '-DCATKIN_DEVEL_PREFIX=/home/pi/ros_catkin_ws/devel_isolated/rosconsole', '-DCMAKE_INSTALL_PREFIX=/home/pi/ros_catkin_ws/install_isolated', '-DCMAKE_BUILD_TYPE=Release-DPYTHON_EXECUTABLE=/usr/bin/python3', '-G', 'Unix Makefiles']' returned non-zero exit status 1.
Reproduce this error by running:
==> cd /home/pi/ros_catkin_ws/build_isolated/rosconsole && /home/pi/ros_catkin_ws/install_isolated/env.sh cmake /home/pi/ros_catkin_ws/src/rosconsole -DCATKIN_DEVEL_PREFIX=/home/pi/ros_catkin_ws/devel_isolated/rosconsole -DCMAKE_INSTALL_PREFIX=/home/pi/ros_catkin_ws/install_isolated -DCMAKE_BUILD_TYPE=Release-DPYTHON_EXECUTABLE=/usr/bin/python3 -G 'Unix Makefiles'
Command failed, exiting.
Tried every possible thing, cant resolve the issue.
In addition to this, rospy package is successfully installed and sourced but cant be imported. Is there any way i can import rospy, I am a total beginner. any help is appreciated. Rospy succussed installation log is as follows
==> Processing catkin package: 'rospy'
==> Building with env: '/home/pi/ros_catkin_ws/install_isolated/env.sh'
Makefile exists, skipping explicit cmake invocation...
==> make cmake_check_build_system in '/home/pi/ros_catkin_ws/build_isolated/rospy'
==> make -j4 -l4 in '/home/pi/ros_catkin_ws/build_isolated/rospy'
==> make install in '/home/pi/ros_catkin_ws/build_isolated/rospy'
Install the project...
-- Install configuration: "Release-DPYTHON_EXECUTABLE=/usr/bin/python3"
-- Installing: /home/pi/ros_catkin_ws/install_isolated/_setup_util.py
-- Installing: /home/pi/ros_catkin_ws/install_isolated/env.sh
-- Installing: /home/pi/ros_catkin_ws/install_isolated/setup.bash
-- Installing: /home/pi/ros_catkin_ws/install_isolated/local_setup.bash
-- Installing: /home/pi/ros_catkin_ws/install_isolated/setup.sh
-- Installing: /home/pi/ros_catkin_ws/install_isolated/local_setup.sh
-- Installing: /home/pi/ros_catkin_ws/install_isolated/setup.zsh
-- Installing: /home/pi/ros_catkin_ws/install_isolated/local_setup.zsh
-- Installing: /home/pi/ros_catkin_ws/install_isolated/.rosinstall
-- Up-to-date: /home/pi/ros_catkin_ws/install_isolated/lib/pkgconfig/rospy.pc
-- Up-to-date: /home/pi/ros_catkin_ws/install_isolated/share/rospy/cmake/rospyConfig.cmake
-- Up-to-date: /home/pi/ros_catkin_ws/install_isolated/share/rospy/cmake/rospyConfig-version.cmake
-- Up-to-date: /home/pi/ros_catkin_ws/install_isolated/share/rospy/package.xml
+ cd /home/pi/ros_catkin_ws/src/ros_comm/rospy
+ mkdir -p /home/pi/ros_catkin_ws/install_isolated/lib/python3/dist-packages
+ /usr/bin/env PYTHONPATH=/home/pi/ros_catkin_ws/install_isolated/lib/python3/dist-packages:/home/pi/ros_catkin_ws/build_isolated/rospy/lib/python3/dist-packages:/home/pi/ros_catkin_ws/install_isolated/lib/python3/dist-packages CATKIN_BINARY_DIR=/home/pi/ros_catkin_ws/build_isolated/rospy /usr/bin/python3 /home/pi/ros_catkin_ws/src/ros_comm/rospy/setup.py egg_info --egg-base /home/pi/ros_catkin_ws/build_isolated/rospy build --build-base /home/pi/ros_catkin_ws/build_isolated/rospy install --root=/ --install-layout=deb --prefix=/home/pi/ros_catkin_ws/install_isolated --install-scripts=/home/pi/ros_catkin_ws/install_isolated/bin
running egg_info
writing /home/pi/ros_catkin_ws/build_isolated/rospy/rospy.egg-info/PKG-INFO
writing dependency_links to /home/pi/ros_catkin_ws/build_isolated/rospy/rospy.egg-info/dependency_links.txt
writing top-level names to /home/pi/ros_catkin_ws/build_isolated/rospy/rospy.egg-info/top_level.txt
reading manifest file '/home/pi/ros_catkin_ws/build_isolated/rospy/rospy.egg-info/SOURCES.txt'
writing manifest file '/home/pi/ros_catkin_ws/build_isolated/rospy/rospy.egg-info/SOURCES.txt'
running build
running build_py
running build_scripts
running install
running install_lib
running install_egg_info
removing '/home/pi/ros_catkin_ws/install_isolated/lib/python3/dist-packages/rospy-1.15.15.egg-info' (and everything under it)
Copying /home/pi/ros_catkin_ws/build_isolated/rospy/rospy.egg-info to /home/pi/ros_catkin_ws/install_isolated/lib/python3/dist-packages/rospy-1.15.15.egg-info
Skipping SOURCES.txt
running install_scripts
changing mode of /home/pi/ros_catkin_ws/install_isolated/bin/rosconsole to 755
-- Up-to-date: /home/pi/ros_catkin_ws/install_isolated/share/rospy/rosbuild/rospy.cmake
-- Up-to-date: /home/pi/ros_catkin_ws/install_isolated/share/rospy/rosbuild/scripts/genmsg_py.py
-- Up-to-date: /home/pi/ros_catkin_ws/install_isolated/share/rospy/rosbuild/scripts/gensrv_py.py
-- Up-to-date: /home/pi/ros_catkin_ws/install_isolated/share/rospy/rosbuild/scripts/genutil.py
<== Finished processing package [54 of 184]: 'rospy'
I did
sudo apt update
sudo apt upgrade
tried the procedure from scratch twice from
Everytime it get stuck on this rosconsole package. All i want is to import rospy in script as i am modifying a script which uses rospy.

IMPORTED_LOCATION not set for imported target

I'm getting the following error in cmake
[cmake] CMake Error in CMakeLists.txt:
[cmake] IMPORTED_LOCATION not set for imported target "fmt::fmt" configuration
[cmake] "Debug".
I've installed fmtlib
$ sudo cmake --install . --config Debug
-- Installing: /usr/local/lib/libfmt.so.9.1.1
-- Installing: /usr/local/lib/libfmt.so.9
-- Installing: /usr/local/lib/libfmt.so
-- Installing: /usr/local/include/fmt/args.h
-- Installing: /usr/local/include/fmt/chrono.h
-- Installing: /usr/local/include/fmt/color.h
-- Installing: /usr/local/include/fmt/compile.h
-- Installing: /usr/local/include/fmt/core.h
-- Installing: /usr/local/include/fmt/format.h
-- Installing: /usr/local/include/fmt/format-inl.h
-- Installing: /usr/local/include/fmt/os.h
-- Installing: /usr/local/include/fmt/ostream.h
-- Installing: /usr/local/include/fmt/printf.h
-- Installing: /usr/local/include/fmt/ranges.h
-- Installing: /usr/local/include/fmt/std.h
-- Installing: /usr/local/include/fmt/xchar.h
-- Installing: /usr/local/lib/cmake/fmt/fmt-config.cmake
-- Installing: /usr/local/lib/cmake/fmt/fmt-config-version.cmake
-- Installing: /usr/local/lib/cmake/fmt/fmt-targets.cmake
-- Installing: /usr/local/lib/pkgconfig/fmt.pc
Here's my CMakeLists.txt:
cmake_minimum_required (VERSION 3.20)
project (Test)
set(CMAKE_CXX_STANDARD 23)
add_executable(main main.cpp)
find_package(fmt)
target_link_libraries(main fmt::fmt)
Reinstalling without the debug config got it working:
$ sudo cmake --install .

Using CMake to compile Assimp on Windows 10

I am attempting to use assimp for model importing in openGL. However, when building assimp 4.1.0, I get this:
15>-- Install configuration: "Debug"
15>CMake Error at cmake_install.cmake:36 (file):
15> file cannot create directory: C:/Program Files
15> (x86)/Assimp/lib/cmake/assimp-4.1. Maybe need administrative privileges.
I should have administrative privileges, but I am not entirely sure. If not, how would I update this. If this is not the case, what would another course of action be? My project and assimp both are under Debug as well as Win32 (this gave a prior error, so I changed that).
Thank you.
I'm trying another way which #Daniel Schepler said, install other places and then set the PATH to the prefix path in environment:
Example on my cmake and build and install: [in Window10]
# cmake
cmake -DCMAKE_INSTALL_PREFIX=D:\Users\installpkg\bin -S . -B build -G "MinGW Makefiles"
# build and install
cmake --build build --target install
Explain a little bit:
-DCMAKE_INSTALL_PREFIX=D:\Users\installpkg\bin This flag is set the install path to = path
-G "MinGW Makefiles" is for MinGW to make.
Then you will see the result [Like I'm installing the glog now]:
PS D:\Users\installpkg\glog> cmake --build build --target install
Consolidate compiler generated dependencies of target glogbase
[ 30%] Built target glogbase
[ 34%] Built target glog
[ 38%] Built target glogtest
Consolidate compiler generated dependencies of target logging_unittest
[ 46%] Built target logging_unittest
Consolidate compiler generated dependencies of target logging_custom_prefix_unittest
[ 53%] Built target logging_custom_prefix_unittest
Consolidate compiler generated dependencies of target stl_logging_unittest
[ 61%] Built target stl_logging_unittest
Consolidate compiler generated dependencies of target demangle_unittest
[ 69%] Built target demangle_unittest
Consolidate compiler generated dependencies of target utilities_unittest
[ 76%] Built target utilities_unittest
Consolidate compiler generated dependencies of target cleanup_immediately_unittest
[ 84%] Built target cleanup_immediately_unittest
Consolidate compiler generated dependencies of target cleanup_with_absolute_prefix_unittest
[ 92%] Built target cleanup_with_absolute_prefix_unittest
Consolidate compiler generated dependencies of target cleanup_with_relative_prefix_unittest
[100%] Built target cleanup_with_relative_prefix_unittest
Install the project...
-- Install configuration: ""
-- Installing: D:/Users/installpkg/bin/lib/libglog.dll.a
-- Installing: D:/Users/installpkg/bin/bin/libglog.dll
-- Installing: D:/Users/installpkg/bin/include/glog/export.h
-- Installing: D:/Users/installpkg/bin/include/glog/logging.h
-- Installing: D:/Users/installpkg/bin/include/glog/raw_logging.h
-- Installing: D:/Users/installpkg/bin/include/glog/stl_logging.h
-- Installing: D:/Users/installpkg/bin/include/glog/vlog_is_on.h
-- Installing: D:/Users/installpkg/bin/include/glog/log_severity.h
-- Installing: D:/Users/installpkg/bin/include/glog/platform.h
-- Installing: D:/Users/installpkg/bin/lib/pkgconfig/libglog.pc
-- Installing: D:/Users/installpkg/bin/lib/cmake/glog/glog-modules.cmake
-- Installing: D:/Users/installpkg/bin/lib/cmake/glog/glog-config.cmake
-- Installing: D:/Users/installpkg/bin/lib/cmake/glog/glog-config-version.cmake
-- Installing: D:/Users/installpkg/bin/lib/cmake/glog/glog-targets.cmake
-- Installing: D:/Users/installpkg/bin/lib/cmake/glog/glog-targets-noconfig.cmake

Cmake is unable to find packages of Gmock

I am new to Cmake and Gtest. I have a problem with in CMake
find_package(GMock REQUIRED)
and
target_link_libraries(runtest ${GMOCK_BOTH_LIBRARIES} pthread).
When I build the project, CMake is unable find the GMock packages.
But when I mentioned the absolute paths of library, it is working fine.
For example:
set(GMOCK_INCLUDE_DIRS /usr/local/include/gmock)
set(GMOCK_BOTH_LIBRARIES /usr/local/lib/libgmock.a /usr/local/lib/libgmock_main.a /usr/local/lib/libgtest.a /usr/local/lib/libgtest_main.a)
Now the problem is my Supervisor recommended me to find the solution to run the code using find packages only. After doing some research, I came to know that FindGMock.cmake file is missing from the Cmake modules. I added it and run code again with find_package(), but still it is not working.
Errors are undefined references to functionalities of Gmock and Gtest.
For instance :
undefined reference to `testing::Message::Message()'.
undefined reference to testing::internal::GetBoolAssertionFailureMessage.
undefined reference totesting::internal::AssertHelper::~AssertHelper()'
Like this there too many errors.
Could anyone please explain me, how to make CMake to find the GMock packages automatically?
Here's a step-by-step example of building and linking to GMock from a CMake project on Linux from scratch. Steps 0-4 cover building and installing GMock while steps 5 and beyond address the question.
These steps are fairly generic and will work with little modification for any project that provides its own CMake package.
Step 0: Create a working directory
From my home folder, I created a blank directory called test:
alex:~$ mkdir test
alex:~$ cd test
alex:~/test$ ls
Step 1: Download GMock
GMock is included in the Google Test repository, so we clone that repository.
alex:~/test$ git clone https://github.com/google/googletest
Cloning into 'googletest'...
remote: Enumerating objects: 24427, done.
remote: Counting objects: 100% (92/92), done.
remote: Compressing objects: 100% (45/45), done.
remote: Total 24427 (delta 44), reused 72 (delta 38), pack-reused 24335
Receiving objects: 100% (24427/24427), 10.32 MiB | 2.68 MiB/s, done.
Resolving deltas: 100% (18062/18062), done.
Step 2: Configure GMock
We'll use the following command to build the googletest repository; GMock is included by default.
$ cmake -S googletest/ -B _build/googletest -DCMAKE_BUILD_TYPE=RelWithDebInfo
The -S flag sets the source directory to the root of the Google Test repository we just cloned. This tells CMake which project it's building. The -B flag sets the binary directory to ~/test/_build/googletest, which is where CMake will store intermediate build outputs before they are installed. This should always be distinct from the source directory. Finally, since we are using a single-configuration generator (Make is the default on Linux), we must specify the build type at this time. I have chosen RelWithDebInfo to keep debugging easy, but also to enable optimizations.
In general, you should always build your project with in the same configuration as its dependencies, so we'll use RelWithDebInfo again later.
For more detail on how to configure generic CMake projects, I'll refer you to this question/answer: How do I build a CMake project?
Finally, here's the output of running the command:
alex:~/test$ cmake -S googletest/ -B _build/googletest -DCMAKE_BUILD_TYPE=RelWithDebInfo
-- The C compiler identification is GNU 9.4.0
-- The CXX compiler identification is GNU 9.4.0
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Check for working C compiler: /usr/bin/cc - skipped
-- Detecting C compile features
-- Detecting C compile features - done
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Check for working CXX compiler: /usr/bin/c++ - skipped
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- Found Python: /usr/bin/python3.10 (found version "3.10.4") found components: Interpreter
-- Looking for pthread.h
-- Looking for pthread.h - found
-- Performing Test CMAKE_HAVE_LIBC_PTHREAD
-- Performing Test CMAKE_HAVE_LIBC_PTHREAD - Failed
-- Looking for pthread_create in pthreads
-- Looking for pthread_create in pthreads - not found
-- Looking for pthread_create in pthread
-- Looking for pthread_create in pthread - found
-- Found Threads: TRUE
-- Configuring done
-- Generating done
-- Build files have been written to: /home/alex/test/_build/googletest
Step 3: Build GMock
Now we'll go ahead and run the build. The following command will work with any single-config generator:
alex:~/test$ cmake --build _build/googletest/
[ 12%] Building CXX object googletest/CMakeFiles/gtest.dir/src/gtest-all.cc.o
[ 25%] Linking CXX static library ../lib/libgtest.a
[ 25%] Built target gtest
[ 37%] Building CXX object googlemock/CMakeFiles/gmock.dir/src/gmock-all.cc.o
[ 50%] Linking CXX static library ../lib/libgmock.a
[ 50%] Built target gmock
[ 62%] Building CXX object googlemock/CMakeFiles/gmock_main.dir/src/gmock_main.cc.o
[ 75%] Linking CXX static library ../lib/libgmock_main.a
[ 75%] Built target gmock_main
[ 87%] Building CXX object googletest/CMakeFiles/gtest_main.dir/src/gtest_main.cc.o
[100%] Linking CXX static library ../lib/libgtest_main.a
[100%] Built target gtest_main
The build should complete relatively quickly.
Step 4: Installing GMock
At this point, you could run sudo cmake --install _build/googletest/ to install it globally to /usr/local, but I wouldn't recommend this. It's much better to keep a frequently updated dependency like Google Test/GMock tied to the project that's using it.
Instead, we will install it to a project-local prefix, like so:
alex:~/test$ cmake --install _build/googletest/ --prefix _local
-- Install configuration: "RelWithDebInfo"
-- Installing: /home/alex/test/_local/include
-- Installing: /home/alex/test/_local/include/gmock
-- Installing: /home/alex/test/_local/include/gmock/gmock-matchers.h
-- Installing: /home/alex/test/_local/include/gmock/gmock-function-mocker.h
-- Installing: /home/alex/test/_local/include/gmock/internal
-- Installing: /home/alex/test/_local/include/gmock/internal/gmock-pp.h
-- Installing: /home/alex/test/_local/include/gmock/internal/gmock-internal-utils.h
-- Installing: /home/alex/test/_local/include/gmock/internal/gmock-port.h
-- Installing: /home/alex/test/_local/include/gmock/internal/custom
-- Installing: /home/alex/test/_local/include/gmock/internal/custom/gmock-port.h
-- Installing: /home/alex/test/_local/include/gmock/internal/custom/gmock-matchers.h
-- Installing: /home/alex/test/_local/include/gmock/internal/custom/gmock-generated-actions.h
-- Installing: /home/alex/test/_local/include/gmock/internal/custom/README.md
-- Installing: /home/alex/test/_local/include/gmock/gmock-more-actions.h
-- Installing: /home/alex/test/_local/include/gmock/gmock-more-matchers.h
-- Installing: /home/alex/test/_local/include/gmock/gmock-nice-strict.h
-- Installing: /home/alex/test/_local/include/gmock/gmock.h
-- Installing: /home/alex/test/_local/include/gmock/gmock-cardinalities.h
-- Installing: /home/alex/test/_local/include/gmock/gmock-spec-builders.h
-- Installing: /home/alex/test/_local/include/gmock/gmock-actions.h
-- Installing: /home/alex/test/_local/lib/libgmock.a
-- Installing: /home/alex/test/_local/lib/libgmock_main.a
-- Installing: /home/alex/test/_local/lib/pkgconfig/gmock.pc
-- Installing: /home/alex/test/_local/lib/pkgconfig/gmock_main.pc
-- Installing: /home/alex/test/_local/lib/cmake/GTest/GTestTargets.cmake
-- Installing: /home/alex/test/_local/lib/cmake/GTest/GTestTargets-relwithdebinfo.cmake
-- Installing: /home/alex/test/_local/lib/cmake/GTest/GTestConfigVersion.cmake
-- Installing: /home/alex/test/_local/lib/cmake/GTest/GTestConfig.cmake
-- Up-to-date: /home/alex/test/_local/include
-- Installing: /home/alex/test/_local/include/gtest
-- Installing: /home/alex/test/_local/include/gtest/gtest-param-test.h
-- Installing: /home/alex/test/_local/include/gtest/internal
-- Installing: /home/alex/test/_local/include/gtest/internal/gtest-port-arch.h
-- Installing: /home/alex/test/_local/include/gtest/internal/gtest-string.h
-- Installing: /home/alex/test/_local/include/gtest/internal/gtest-death-test-internal.h
-- Installing: /home/alex/test/_local/include/gtest/internal/gtest-type-util.h
-- Installing: /home/alex/test/_local/include/gtest/internal/gtest-port.h
-- Installing: /home/alex/test/_local/include/gtest/internal/gtest-internal.h
-- Installing: /home/alex/test/_local/include/gtest/internal/gtest-param-util.h
-- Installing: /home/alex/test/_local/include/gtest/internal/gtest-filepath.h
-- Installing: /home/alex/test/_local/include/gtest/internal/custom
-- Installing: /home/alex/test/_local/include/gtest/internal/custom/README.md
-- Installing: /home/alex/test/_local/include/gtest/internal/custom/gtest.h
-- Installing: /home/alex/test/_local/include/gtest/internal/custom/gtest-port.h
-- Installing: /home/alex/test/_local/include/gtest/internal/custom/gtest-printers.h
-- Installing: /home/alex/test/_local/include/gtest/gtest-matchers.h
-- Installing: /home/alex/test/_local/include/gtest/gtest-death-test.h
-- Installing: /home/alex/test/_local/include/gtest/gtest-spi.h
-- Installing: /home/alex/test/_local/include/gtest/gtest.h
-- Installing: /home/alex/test/_local/include/gtest/gtest-test-part.h
-- Installing: /home/alex/test/_local/include/gtest/gtest-typed-test.h
-- Installing: /home/alex/test/_local/include/gtest/gtest_prod.h
-- Installing: /home/alex/test/_local/include/gtest/gtest-assertion-result.h
-- Installing: /home/alex/test/_local/include/gtest/gtest_pred_impl.h
-- Installing: /home/alex/test/_local/include/gtest/gtest-message.h
-- Installing: /home/alex/test/_local/include/gtest/gtest-printers.h
-- Installing: /home/alex/test/_local/lib/libgtest.a
-- Installing: /home/alex/test/_local/lib/libgtest_main.a
-- Installing: /home/alex/test/_local/lib/pkgconfig/gtest.pc
-- Installing: /home/alex/test/_local/lib/pkgconfig/gtest_main.pc
The --prefix flag tells cmake --install into which directory to install the project. Here, we've chosen a directory named _local in our working directory. The name of this folder is arbitrary. I've chosen this name to mirror the /usr/local prefix naming and to play nicely with a common .gitignore strategy of ignoring top-level directories prefixed with and underscore.
Notice in the command output what's getting installed. Headers, the GTest and GMock static libraries, yes, but also pkg-config files and, most importantly, the CMake package files:
-- Installing: /home/alex/test/_local/lib/cmake/GTest/GTestTargets.cmake
-- Installing: /home/alex/test/_local/lib/cmake/GTest/GTestTargets-relwithdebinfo.cmake
-- Installing: /home/alex/test/_local/lib/cmake/GTest/GTestConfigVersion.cmake
-- Installing: /home/alex/test/_local/lib/cmake/GTest/GTestConfig.cmake
These are the files that find_package will use (soon) to load GTest into a dependent project. The two standard files are GTestConfig.cmake and GTestConfigVersion.cmake. The first one is the most important, and it's responsible for actually implementing the CMake package. It will ultimately load GTestTargets.cmake and GTestTargets-relwithdebinfo.cmake, which are specific to GTest. Notice also how RelWithDebInfo appears again in the generated file name; that's because config-specific information is stored there. If you want to support multiple configs, you'll need to redo steps 2-4 with a new CMAKE_BUILD_TYPE (e.g. Debug, Release, MinSizeRel)
Step 5: Creating an example project
Let's create a simple example project now that uses GMock. First, we'll create a directory for it:
alex:~/test$ mkdir example
and now we'll go in and create some files:
alex:~/test$ cd example/
alex:~/test/example$ touch CMakeLists.txt main.cpp
Using your favorite text editor, add the following contents to main.cpp:
#include <gmock/gmock.h>
using namespace testing;
struct Example : public Test {};
TEST_F(Example, AlwaysPass) { ASSERT_THAT(0, Eq(0)); }
TEST_F(Example, AlwaysFail) { ASSERT_THAT(0, Eq(1)); }
This is as basic of a "hello world" for GMock as I could come up with. It has one test that always passes and another that always fails (just so we can see the various outputs).
Now we'll write the build script in CMakeLists.txt:
cmake_minimum_required(VERSION 3.23)
project(example)
find_package(GTest REQUIRED)
add_executable(example main.cpp)
target_link_libraries(example PRIVATE GTest::gmock_main)
Once again, this is as simple as can be.
The first two lines are required boilerplate. They must always1 appear as the first two lines of your project, in that order, with nothing before or in between.
The first command, cmake_minimum_required, tells CMake which set of backwards-compatibility policies to enable. It does not put CMake into an emulation mode or anything like that. You must test your build with the version written there because CMake will not stop you from using features that are too new for the declared minimum version.
The second command, project, names your project and kicks off CMake's compiler detection routines.
Next, we tell CMake that this project depends on the GTest package by issuing find_package(GTest REQUIRED). The REQUIRED argument kills the configure step if the package cannot be found. The name GTest is derived from the GTestConfig.cmake file. For any CMake project XYZ, its main package file must be named either XYZConfig.cmake or XYZ-config.cmake.
Finally, we add our test executable example and link it to the target GTest::gmock_main. This target provides a main function in addition to the GMock standard library. If you want to write your own main, then link to GTest::gmock instead.
1. with very few exceptions that are hardly worth mentioning
Step 6: Building and running the example
Now we're finally ready to build and run the example. Let's go back up to our working directory:
alex:~/test/example$ cd ..
alex:~/test$
And now we'll go ahead and configure the build:
alex:~/test$ cmake -S example -B _build/example -DCMAKE_BUILD_TYPE=RelWithDebInfo -DCMAKE_PREFIX_PATH=$PWD/_local
-- The C compiler identification is GNU 9.4.0
-- The CXX compiler identification is GNU 9.4.0
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Check for working C compiler: /usr/bin/cc - skipped
-- Detecting C compile features
-- Detecting C compile features - done
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Check for working CXX compiler: /usr/bin/c++ - skipped
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- Found GTest: /home/alex/test/_local/lib/cmake/GTest/GTestConfig.cmake (found version "1.11.0")
-- Configuring done
-- Generating done
-- Build files have been written to: /home/alex/test/_build/example
Note the -DCMAKE_PREFIX_PATH=$PWD/_local flag. That's telling CMake that there are additional libraries and CMake packages in $PWD/_local and so find_package and the other find_* commands should look there. If you didn't pass this flag, you might see an error like this:
CMake Error at /usr/share/cmake-3.23/Modules/FindPackageHandleStandardArgs.cmake:230 (message):
Could NOT find GTest (missing: GTEST_LIBRARY GTEST_INCLUDE_DIR
GTEST_MAIN_LIBRARY)
Call Stack (most recent call first):
/usr/share/cmake-3.23/Modules/FindPackageHandleStandardArgs.cmake:594 (_FPHSA_FAILURE_MESSAGE)
/usr/share/cmake-3.23/Modules/FindGTest.cmake:270 (FIND_PACKAGE_HANDLE_STANDARD_ARGS)
CMakeLists.txt:4 (find_package)
-- Configuring incomplete, errors occurred!
See also "/home/alex/test/_build/example/CMakeFiles/CMakeOutput.log".
Now that we're configured, we can build the example:
alex:~/test$ cmake --build _build/example/
[ 50%] Building CXX object CMakeFiles/example.dir/main.cpp.o
[100%] Linking CXX executable example
[100%] Built target example
and then run it:
alex:~/test$ _build/example/example
Running main() from gmock_main.cc
[==========] Running 2 tests from 1 test suite.
[----------] Global test environment set-up.
[----------] 2 tests from Example
[ RUN ] Example.AlwaysPass
[ OK ] Example.AlwaysPass (0 ms)
[ RUN ] Example.AlwaysFail
/home/alex/test/example/main.cpp:8: Failure
Value of: 0
Expected: is equal to 1
Actual: 0 (of type int)
[ FAILED ] Example.AlwaysFail (0 ms)
[----------] 2 tests from Example (0 ms total)
[----------] Global test environment tear-down
[==========] 2 tests from 1 test suite ran. (0 ms total)
[ PASSED ] 1 test.
[ FAILED ] 1 test, listed below:
[ FAILED ] Example.AlwaysFail
1 FAILED TEST
As you can see, our passing test passed, and our failing test failed, as expected!
Step 6: CTest integration (optional)
If we want, we can integrate this with CTest for easier running of multiple GMock binaries down the line. Here's the new CMakeLists.txt
cmake_minimum_required(VERSION 3.23)
project(example)
enable_testing() # ------------------------ ADDED 1
find_package(GTest REQUIRED)
include(GoogleTest) # ------------------------ ADDED 2
add_executable(example main.cpp)
target_link_libraries(example PRIVATE GTest::gmock_main)
gtest_discover_tests(example) # ------------------------ ADDED 3
Aside from the three lines marked ADDED, nothing has changed. The first added line simply enables CTest support. The second added line imports CMake's native support for Google Test. Finally, the third line tells CTest that the example executable contains GTest tests.
After making these edits, an incremental build will automatically re-run CMake.
alex:~/test$ cmake --build _build/example/
-- Configuring done
-- Generating done
-- Build files have been written to: /home/alex/test/_build/example
Consolidate compiler generated dependencies of target example
[ 50%] Linking CXX executable example
[100%] Built target example
And now we can use the CTest runner on our build directory:
alex:~/test$ ctest --test-dir _build/example/
Internal ctest changing into directory: /home/alex/test/_build/example
Test project /home/alex/test/_build/example
Start 1: Example.AlwaysPass
1/2 Test #1: Example.AlwaysPass ............... Passed 0.00 sec
Start 2: Example.AlwaysFail
2/2 Test #2: Example.AlwaysFail ...............***Failed 0.00 sec
50% tests passed, 1 tests failed out of 2
Total Test time (real) = 0.00 sec
The following tests FAILED:
2 - Example.AlwaysFail (Failed)
Errors while running CTest
Output from these tests are in: /home/alex/test/_build/example/Testing/Temporary/LastTest.log
Use "--rerun-failed --output-on-failure" to re-run the failed cases verbosely.
And once again, we can see that our passing test passed and our failing test failed. Hooray!

CMake: find Armadillo library installed in a custom location

No root access on cluster, install Armadillo with
make install DEST_DIR=/home/my_id/include
and now I have no idea how to do find_package(ARMADILLO REQUIRED) to set ${ARMADILLO_INCLUDE_DIRS} and${ARMADILLO_LIBRARIES}.
use CMAKE_LIBRARY_PATH and/or CMAKE_PREFIX_PATH environment variables to specify additional paths where to look for libraries and headers.
Also see cmake - find_library - custom library location but all the answers there suggest to edit CMakeLists.txt that could be slightly inconvenient sometimes.
Edit: Here's the complete working example:
alex#rhyme /var/tmp $ tar zxf armadillo-6.500.4.tar.gz
alex#rhyme /var/tmp $ cd armadillo-6.500.4
alex#rhyme /var/tmp/armadillo-6.500.4 $ mkdir build
alex#rhyme /var/tmp/armadillo-6.500.4 $ cd build
alex#rhyme tmp/armadillo-6.500.4/build $ cmake ..
-- Configuring Armadillo 6.500.4
...
-- CMAKE_INSTALL_PREFIX = /usr
-- INSTALL_LIB_DIR = /usr/lib64
-- INSTALL_INCLUDE_DIR = /usr/include
-- INSTALL_DATA_DIR = /usr/share
-- INSTALL_BIN_DIR = /usr/bin
-- Generating '/var/tmp/armadillo-6.500.4/build/ArmadilloConfig.cmake'
-- Generating '/var/tmp/armadillo-6.500.4/build/ArmadilloConfigVersion.cmake'
-- Generating '/var/tmp/armadillo-6.500.4/build/InstallFiles/ArmadilloConfig.cmake'
-- Generating '/var/tmp/armadillo-6.500.4/build/InstallFiles/ArmadilloConfigVersion.cmake'
-- Configuring done
-- Generating done
-- Build files have been written to: /var/tmp/armadillo-6.500.4/build
alex#rhyme tmp/armadillo-6.500.4/build $ make -j4
Scanning dependencies of target armadillo
[100%] Building CXX object CMakeFiles/armadillo.dir/src/wrapper.cpp.o
Linking CXX shared library libarmadillo.so
[100%] Built target armadillo
alex#rhyme tmp/armadillo-6.500.4/build $ make install DESTDIR=/var/tmp/armadillo
[100%] Built target armadillo
Install the project...
-- Install configuration: ""
-- Installing: /var/tmp/armadillo/usr/include
-- Installing: /var/tmp/armadillo/usr/include/armadillo_bits
-- Installing: /var/tmp/armadillo/usr/include/armadillo_bits/spop_htrans_bones.hpp
...
-- Installing: /var/tmp/armadillo/usr/include/armadillo_bits/subview_elem2_bones.hpp
-- Installing: /var/tmp/armadillo/usr/include/armadillo
-- Installing: /var/tmp/armadillo/usr/lib64/libarmadillo.so.6.500.4
-- Installing: /var/tmp/armadillo/usr/lib64/libarmadillo.so.6
-- Installing: /var/tmp/armadillo/usr/lib64/libarmadillo.so
-- Installing: /var/tmp/armadillo/usr/share/Armadillo/CMake/ArmadilloLibraryDepends.cmake
-- Installing: /var/tmp/armadillo/usr/share/Armadillo/CMake/ArmadilloLibraryDepends-noconfig.cmake
-- Installing: /var/tmp/armadillo/usr/share/Armadillo/CMake/ArmadilloConfig.cmake
-- Installing: /var/tmp/armadillo/usr/share/Armadillo/CMake/ArmadilloConfigVersion.cmake
alex#rhyme tmp/armadillo-6.500.4/build $ cd ../../
alex#rhyme /var/tmp $ mkdir test_armadillo_project
alex#rhyme /var/tmp $ cd test_armadillo_project
alex#rhyme /var/tmp/test_armadillo_project $ cat >CMakeLists.txt <<EOF
CMAKE_MINIMUM_REQUIRED(VERSION 2.8)
FIND_PACKAGE(Armadillo REQUIRED)
EOF
Now we're trying to build the package w/o specifying its location. CMake expectedly fails:
alex#rhyme /var/tmp/test_armadillo_project $ cmake .
-- The C compiler identification is GNU 5.3.1
-- The CXX compiler identification is GNU 5.3.1
-- Check for working C compiler: /usr/bin/cc
-- Check for working C compiler: /usr/bin/cc -- works
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Detecting C compile features
-- Detecting C compile features - done
-- Check for working CXX compiler: /usr/bin/c++
-- Check for working CXX compiler: /usr/bin/c++ -- works
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Detecting CXX compile features
-- Detecting CXX compile features - done
CMake Error at /usr/share/CMake/Modules/FindPackageHandleStandardArgs.cmake:138 (message):
Could NOT find Armadillo (missing: ARMADILLO_LIBRARY ARMADILLO_INCLUDE_DIR)
Call Stack (most recent call first):
/usr/share/CMake/Modules/FindPackageHandleStandardArgs.cmake:374 (_FPHSA_FAILURE_MESSAGE)
/usr/share/CMake/Modules/FindArmadillo.cmake:92 (find_package_handle_standard_args)
CMakeLists.txt:3 (FIND_PACKAGE)
-- Configuring incomplete, errors occurred!
See also "/var/tmp/test_armadillo_project/CMakeFiles/CMakeOutput.log".
Now we're specifying the custom path via environment variable:
alex#rhyme /var/tmp/test_armadillo_project $ CMAKE_PREFIX_PATH=/var/tmp/armadillo/usr cmake .
-- Found Armadillo: /var/tmp/armadillo/usr/lib64/libarmadillo.so (found version "6.500.4")
-- Configuring done
-- Generating done
-- Build files have been written to: /var/tmp/test_armadillo_project
I'm pretty sure I could set CMAKE_PREFIX_PATH right in CMakeLists.txt and it would work just as with environment variable above.