Build System CMake Guide Covers Workflow, Packaging & Testing

CMake CPack CTest and CDash

CMake - a cross-platform, open-source build
system

Andreas Schneider <anschneider@suse.de>
Daniel Gollub <dgollub@suse.de>

SUSE Linux Products GmbH

8th July 2008

Andreas Schneider <anschneider@suse.de> Daniel Gollub <dgollub@suse.de> SUSE Linux Products GmbH
CMake - a cross-platform, open-source build system


CMake

1 CMake
About CMake
Workﬂow
Details
External dependencies

2 CPack

3 CTest and CDash
CTest
CDash



About CMake


1 CMake
About CMake
Workﬂow
Details

2 CPack

3 CTest and CDash
CTest
CDash



About CMake

What is CMake?

CMake is
BSD licensed open-source package
written in C++
tools to build, test and package software



About CMake

More exactly

CMake is a meta-build system
doesn’t do the final build
it generates files for other build systems
Makefiles, KDevelop, Eclipse, XCode, MinGW, Cygwin and
Visual Studio
gives the developer the ability to use the tool they are most
productive with



About CMake

Who is using it

Projects using CMake are
KDE4
libzypp
Qutecom (formly known as WengoPhone)
csync, OpenSync



About CMake

Important features

CMake supports
complex custom commands (qt moc, yacc)
optional component support
shared libraries and DSOs with version support
automatic dependency generation (C, C++, Fortran)
out-of-source builds
cross-compiling support



Workﬂow


1 CMake
About CMake
Workﬂow
Details

2 CPack

3 CTest and CDash
CTest
CDash



Workﬂow

Simple example

Hello world!



Workflow

CMake configure process

Read the CMakeCache.txt if it is already there
Read the CMake input files (CMakeLists.txt, ..)
Write the cache back out
Generate the Makefiles



Workﬂow

CMake Cache

Faster compilation with the cache (KDE4 with cmake in 5
min)
Stores all kind of values you can change
Can be modiﬁed via commandline, ccmake, cmake-gui (qt4)



Details


1 CMake
About CMake
Workﬂow
Details

2 CPack

3 CTest and CDash
CTest
CDash



Details

Variables

You don’t have to declare them
simply set(VARNAME arg1 arg2 ...argN)
list() is sometimes better
Use SPERATE ARGUMENTS to split space sparated into
semi-colon spearated



Details

Build types

None (default)
Debug
Release
RelWithDebInfo
MinSizeRel
You can deﬁne your own



Details

Build parameters

add definition(-Wall)
CMAKE C FLAGS or CMAKE CXX FLAGS
or it could be CMAKE C FLAGS DEBUG for the Debug build type
For packagers:
CFLAGS="%{optflags} -g -DNDEBUG"
CXXFLAGS="%{optflags} -g -DNDEBUG"
cmake -DCMAKE BUILD TYPE=None /path/to/source



Details

Flow control

if (expression)
...
else (expression)
...
endif (expression)
foreach (loop list)
...
endforeach (loop list)
while (condition)
...
while (condition)



Details

Macros and functions

macro (NAME arg1 arg2 ...argN)
...
command1
command2
...
endmacro (NAME arg1 arg2 ...argN)
They perform text substituions like #define does in C
WARNING: variable name clashing is possible. Preﬁx your
variables!
Functions have been introduced with CMake 2.6





1 CMake
About CMake
Workﬂow
Details

2 CPack

3 CTest and CDash
CTest
CDash




Find packages

find package(Iniparser REQURIED)
CMake ships approx. 100 FindXXX.cmake modules
You can create your own FindXXX.cmake module
Put them in your source dir and set CMAKE MODULE PATH
Think of find package as an #include




Your own ﬁnd module

Script: https://dev.csync.org/browser/cmake/
Scripts/generate_findpackage_file
Creates simple FindXXX.cmake module




Important addresses

#cmake @ irc.freenode.net
http://www.cmake.org/
http://www.cmake.org/Wiki/CMake Useful Variables
http://www.cmake.org/Wiki/CMake FAQ
Examples: http://dev.csync.org/browser or
http://opensync.org/browser



CPack

Package Generator
Independent of CMake
Abstracts Packaging
Packaging of sources and builds/binaries



Available Package Generators
TGZ
STGZ
NSIS (Null Soft Installer)
ZIP
TBZ2
TZ
PackageMaker (MacOSX)
OSXX11
CygwinBinary
CygwinSource
DEB
RPM


CPack Example: Release Tarballs

include(CPack)
set(CPACK_SOURCE_GENERATOR "TGZ;TBZ2")
set(CPACK_SOURCE_PACKAGE_FILE_NAME "${NAME}-${VERSION}")



CPack

It’s like make dist-check, without -check :(
make package source



CTest


1 CMake
About CMake
Workﬂow
Details

2 CPack

3 CTest and CDash
CTest
CDash



CTest

CTest

Testing driver
Independent of CMake



CTest

Features

Updating from repositories (CVS, SVN ... no GIT support)
Conﬁguration of the project
Building
Running the tests
Performs memory checking
Performs code coverage analyse
Logging (stdout/stderr/time/...)



CTest

Example: CTest standalone

Create DartTestﬁle.txt and just run ctest:

add_test(TestcaseName1 "command1" "param1" "param2")
...



CTest

Example: CTest integrated in CMake

include(CTest)
enable_testing()

...

This will generate a make target called “test”.



CTest

Test-Model

Nightly
Experimental
Continous



CTest

Test-Mode

Start
Update
Conﬁgure
Build
Test
MemCheck
Coverage
Submit



CTest

Why CTest?

Test driven development!



CDash


1 CMake
About CMake
Workﬂow
Details

2 CPack

3 CTest and CDash
CTest
CDash



CDash

CDash

Cross-Platform Dashboard System
PHP & MySQL



CDash

CDash

Retrieves testing logﬁles
Summaries testing results
Build warnings/errors
Testcase PASS/FAIL results
Testcase timing results
Code Coverage
Valgrind/Memcheck results
Notiﬁes about regressions (build failures, failed tests, ...)
Supports multiple projects



CDash

CDash

Doesn’t build or test the projects!



CDash

CTest & CDash

”Make it work as one!”



CDash

CTest & CDash

Continous Buildhosts of diﬀerent platforms
Checking the SCM for updates
Build the projects from scratch
Run tests
Archive results
Report regressions



CDash

CTest & CDash - Beneﬁts

Detect immeditally build breaking commits
Testing on several platforms
Tracking performance regressions
Hopefully increases qualtiy of the project
No time-wasting manual testing
More time for development



CDash

Questions & Answers



CDash

Thanks for listenting


Build System CMake Guide Covers Workflow, Packaging & Testing

Recommended

Recommended

More Related Content

What's hot

What's hot (19)

Similar to Build System CMake Guide Covers Workflow, Packaging & Testing

Similar to Build System CMake Guide Covers Workflow, Packaging & Testing (20)

Build System CMake Guide Covers Workflow, Packaging & Testing