CMake Talk 2008

CMake CPack CTest and CDash

CMake - a cross-platform, open-source buildsystem

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

1 CMakeAbout CMakeWorkflowDetailsExternal dependencies

2 CPack

3 CTest and CDashCTestCDash

About CMake

2 CPack

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 andVisual Studio

gives the developer the ability to use the tool they are mostproductive with

About CMake

Who is using it

Projects using CMake are

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

Workflow

2 CPack

Workflow

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

Workflow

CMake Cache

Faster compilation with the cache (KDE4 with cmake in 5min)

Stores all kind of values you can change

Can be modified via commandline, ccmake, cmake-gui (qt4)

Details

2 CPack

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 intosemi-colon spearated

Details

Build types

None (default)

Release

RelWithDebInfo

MinSizeRel

You can define 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)...command1command2...endmacro (NAME arg1 arg2 ...argN)

They perform text substituions like #define does in C

WARNING: variable name clashing is possible. Prefix yourvariables!

Functions have been introduced with CMake 2.6

External dependencies

2 CPack

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 find 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 orhttp://opensync.org/browser

Package Generator

Independent of CMake

Abstracts Packaging

Packaging of sources and builds/binaries

Available Package Generators

NSIS (Null Soft Installer)

PackageMaker (MacOSX)

OSXX11

CygwinBinary

CygwinSource

CPack Example: Release Tarballs

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

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

2 CPack

Testing driver

Independent of CMake

Features

Updating from repositories (CVS, SVN ... no GIT support)

Configuration of the project

Building

Running the tests

Performs memory checking

Performs code coverage analyse

Logging (stdout/stderr/time/...)

Example: CTest standalone

Create DartTestfile.txt and just run ctest:

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

Example: CTest integrated in CMake

include(CTest)enable_testing()

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

This will generate a make target called “test”.

Test-Model

Nightly

Experimental

Continous

Test-Mode

Update

Configure

MemCheck

Coverage

Submit

Why CTest?

Test driven development!

2 CPack

Cross-Platform Dashboard System

PHP & MySQL

Retrieves testing logfiles

Summaries testing results

Build warnings/errorsTestcase PASS/FAIL resultsTestcase timing resultsCode CoverageValgrind/Memcheck results

Notifies about regressions (build failures, failed tests, ...)

Supports multiple projects

Doesn’t build or test the projects!

CTest & CDash

”Make it work as one!”

CTest & CDash

Continous Buildhosts of different platforms

Checking the SCM for updates

Build the projects from scratch

Run tests

Archive results

Report regressions

CTest & CDash - Benefits

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

Questions & Answers

Thanks for listenting

CMake Talk 2008

Documents

Introduction to CMakeread.pudn.com/downloads403/ebook/1720931/cmake-overview.pdf · 2011-03-14 · cmake: source/binary tree(1) Source tree – CMake輸入檔(CMakeLists.txt) –

ATS CMake Documentation - Read the Docs · ATS CMake Documentation, Release latest This is a project aiming at developing a build tool for ATS. It is based on CMake. Currently, it

CMAKE - Plone siterenzo/doc/cmake/cmake-an-introduction.pdfQt by Nokia‘s build system • Scons Python-based build system • cmake cross-plattform make system Donnerstag, 12. Juli

Using Modern CMake with Qt - KDAB...9 May 13th 2020 Using Modern CMake with Qt / Kevin Funk (KDAB) Getting Started with CMake (1)CMake magic that enables Qt-specific behavior for .moc/.qrc/.ui

Seminar talk, 2008

CMake / CTest / CPack - FOSDEM€¦ · Testing with CMake, CTest and CDash • Testing command in CMake – add_test ( testname exename arg1 arg2 arg3 …) – Executable is expected

CMake Tutorial

CMAKE - uni-freiburg.dejakobro/files/cmake-an-introduction.pdf · • cmake cross-plattform make system Donnerstag, 12. Juli 12. WHAT IS IT? CMake is a build-process management tool

CMake Tutorial - ilcsoft.desy.de · Jan Engels - Introduction to CMake 5 CMake Basic Concepts CmakeLists.txt – Input text files that contain the project parameters and describe

Learning Cmake - elpauer

cmake error log

CMake Intro

CMake Tutorial - JohnLamp.net · In addition to setting up a build CMake can also create an install target that will install the outputs of your project in ... CMake Tutorial. cmake

Intro, CMake. CUDA execution configuration

Rodlima Cmake Presentation

NFAIS 2008 Talk

CMAKE Tutos · Jean-Charles Lambert CMAKE Simple example mkdir build cd build cmake .. make We create build directory to Isolate compilations files from sources files cmake ..-- The

Intro to CMake CTest CDash

Cmake kitware

CMake with Qt - Qt Developer Days