basistest.ctest File Reference

CTest script used to test BASIS projects. More...

Go to the source code of this file.

Functions
macro	append_option (in VAR, in ARGN)
function	print_contact (in ARGN)
	Print contact section of usage information and help screen. More...
function	print_help (in ARGN)
	Print help screen. More...
function	print_helpshort (in ARGN)
	Print usage information. More...
function	print_options (in ARGN)
	Print options section of usage information and help screen. More...
function	print_usage (in ARGN)
	Print usage section of usage information and help screen. More...
function	print_version (in ARGN)
	Print version information. More...
function	read_cmake_cache_value (inout VAR, in ARGN)
	Read value from CMake cache. More...
macro	set_option (in VAR, in ARGN)
function	update_metadata (in ARGN)
	Adjust information attached to test results using CMakeCache.txt. More...

Variables
cmake	BUILD_RESULT
cmake	CONFIGURE_RESULT
cmake	CTEST_BASE_DIRECTORY
cmake	CTEST_BINARY_DIRECTORY
cmake	CTEST_BUILD_NAME
cmake	CTEST_BUILD_SUBDIR
cmake	CTEST_BUILD_TYPE
cmake	CTEST_CHECKOUT_COMMAND
cmake	CTEST_CMAKE_GENERATOR
cmake	CTEST_CMAKE_OPTIONS
cmake	CTEST_COMPILER_FLAGS
cmake	CTEST_CONFIGURE_COMMAND
cmake	CTEST_DROP_LOCATION
cmake	CTEST_DROP_METHOD
cmake	CTEST_DROP_SITE
cmake	CTEST_DROP_SITE_CDASH
cmake	CTEST_LINKER_FLAGS
	CTEST_MEMORYCHECK_SUPPRESSIONS_FILE
cmake	CTEST_MODEL
cmake	CTEST_NIGHTLY_START_TIME
cmake	CTEST_PREFIX
	CTEST_PROJECT_NAME
cmake	CTEST_SITE
cmake	CTEST_SOURCE_DIRECTORY
cmake	CTEST_START_WITH_EMPTY_BINARY_DIRECTORY
cmake	CTEST_SVN_BRANCH
cmake	CTEST_UPDATE_COMMAND
cmake	CTEST_USE_LAUNCHERS
cmake	FAILURE
cmake	FORCE_BUILD
cmake	FORCE_TEST
cmake	MANUAL_MODE
cmake	OPTION
cmake	SHARED_BUILD
cmake	SHARED_SOURCE
cmake	SUBMIT_RESULTS
cmake	UNINSTALLER
cmake	UPDATED_FILES
cmake	VALUE
cmake	WITH_APIDOC
cmake	WITH_COVERAGE
cmake	WITH_INSTALL
cmake	WITH_MEMCHECK

Detailed Description

CTest script used to test BASIS projects.

To display the help of this CTest script, run:

ctest -S basistest.ctest,help

Definition in file basistest.ctest.

Function Documentation

append_option()

macro append_option	(	in	VAR,
		in	ARGN
	)

Returns

Nothing.

print_contact()

function print_contact

(

in

ARGN

)

Print contact section of usage information and help screen.

Parameters

[in]

ARGN

Not used.

Returns

Nothing.

print_help()

function print_help

(

in

ARGN

)

Print help screen.

Parameters

[in]

ARGN

Not used.

Returns

Nothing.

print_helpshort()

function print_helpshort

(

in

ARGN

)

Print usage information.

Parameters

[in]

ARGN

Not used.

Returns

Nothing.

print_options()

function print_options

(

in

ARGN

)

Print options section of usage information and help screen.

Parameters

[in]

ARGN

Not used.

Returns

Nothing.

print_usage()

function print_usage

(

in

ARGN

)

Print usage section of usage information and help screen.

Parameters

[in]

ARGN

Not used.

Returns

Nothing.

print_version()

function print_version

(

in

ARGN

)

Print version information.

Parameters

[in]

ARGN

Not used.

Returns

Nothing.

read_cmake_cache_value()

function read_cmake_cache_value	(	inout	VAR,
		in	ARGN
	)

Read value from CMake cache.

Parameters

[in,out]	VAR	Name of CMake variable.
[in]	ARGN	Not used.

Returns

Sets VAR to the value of the cached variable VAR.

set_option()

macro set_option	(	in	VAR,
		in	ARGN
	)

Returns

Nothing.

update_metadata()

function update_metadata

(

in

ARGN

)

Adjust information attached to test results using CMakeCache.txt.

Parameters

[in]

ARGN

List of XML test report files without directory path. If omitted, this function globs for all XML files in the Testing/<tag>/ directory.

Returns

Nothing.

Variable Documentation

BUILD_RESULT

cmake BUILD_RESULT

Definition at line 808 of file basistest.ctest.

CONFIGURE_RESULT

cmake CONFIGURE_RESULT

Definition at line 807 of file basistest.ctest.

CTEST_BASE_DIRECTORY

cmake CTEST_BASE_DIRECTORY

Definition at line 377 of file basistest.ctest.

CTEST_BINARY_DIRECTORY

cmake CTEST_BINARY_DIRECTORY

Definition at line 379 of file basistest.ctest.

CTEST_BUILD_NAME

cmake CTEST_BUILD_NAME

Definition at line 659 of file basistest.ctest.

CTEST_BUILD_SUBDIR

cmake CTEST_BUILD_SUBDIR

Definition at line 681 of file basistest.ctest.

CTEST_BUILD_TYPE

cmake CTEST_BUILD_TYPE

Definition at line 397 of file basistest.ctest.

CTEST_CHECKOUT_COMMAND

cmake CTEST_CHECKOUT_COMMAND

Definition at line 729 of file basistest.ctest.

CTEST_CMAKE_GENERATOR

cmake CTEST_CMAKE_GENERATOR

Definition at line 396 of file basistest.ctest.

CTEST_CMAKE_OPTIONS

cmake CTEST_CMAKE_OPTIONS

Definition at line 534 of file basistest.ctest.

CTEST_COMPILER_FLAGS

cmake CTEST_COMPILER_FLAGS

Definition at line 398 of file basistest.ctest.

CTEST_CONFIGURE_COMMAND

cmake CTEST_CONFIGURE_COMMAND

Definition at line 775 of file basistest.ctest.

CTEST_DROP_LOCATION

cmake CTEST_DROP_LOCATION

Definition at line 616 of file basistest.ctest.

CTEST_DROP_METHOD

cmake CTEST_DROP_METHOD

Definition at line 614 of file basistest.ctest.

CTEST_DROP_SITE

cmake CTEST_DROP_SITE

Definition at line 615 of file basistest.ctest.

CTEST_DROP_SITE_CDASH

cmake CTEST_DROP_SITE_CDASH

Definition at line 617 of file basistest.ctest.

CTEST_LINKER_FLAGS

cmake CTEST_LINKER_FLAGS

Definition at line 399 of file basistest.ctest.

CTEST_MEMORYCHECK_SUPPRESSIONS_FILE

CTEST_MEMORYCHECK_SUPPRESSIONS_FILE

Initial value:

= "${CTEST_SOURCE_DIRECTORY}/${CTEST_MEMORYCHECK_SUPPRESSIONS_FILE}"









cmake CTEST_CONFIGURE_COMMAND

Definition at line 763 of file basistest.ctest.

CTEST_MODEL

cmake CTEST_MODEL

Definition at line 380 of file basistest.ctest.

CTEST_NIGHTLY_START_TIME

cmake CTEST_NIGHTLY_START_TIME

Definition at line 57 of file basistest.ctest.

CTEST_PREFIX

cmake CTEST_PREFIX

Definition at line 673 of file basistest.ctest.

CTEST_PROJECT_NAME

cmake CTEST_PROJECT_NAME

Initial value:

= ""
cmake CTEST_SVN_URL

Definition at line 390 of file basistest.ctest.

CTEST_SITE

cmake CTEST_SITE

Definition at line 646 of file basistest.ctest.

CTEST_SOURCE_DIRECTORY

cmake CTEST_SOURCE_DIRECTORY

Definition at line 378 of file basistest.ctest.

CTEST_START_WITH_EMPTY_BINARY_DIRECTORY

cmake CTEST_START_WITH_EMPTY_BINARY_DIRECTORY

Definition at line 707 of file basistest.ctest.

CTEST_SVN_BRANCH

cmake CTEST_SVN_BRANCH

Definition at line 392 of file basistest.ctest.

CTEST_UPDATE_COMMAND

cmake CTEST_UPDATE_COMMAND

Definition at line 731 of file basistest.ctest.

CTEST_USE_LAUNCHERS

cmake CTEST_USE_LAUNCHERS

Definition at line 622 of file basistest.ctest.

FAILURE

cmake FAILURE

Definition at line 451 of file basistest.ctest.

FORCE_BUILD

cmake FORCE_BUILD

Definition at line 410 of file basistest.ctest.

FORCE_TEST

cmake FORCE_TEST

Definition at line 411 of file basistest.ctest.

MANUAL_MODE

cmake MANUAL_MODE

Definition at line 371 of file basistest.ctest.

OPTION

cmake OPTION

Definition at line 452 of file basistest.ctest.

SHARED_BUILD

cmake SHARED_BUILD

Definition at line 382 of file basistest.ctest.

SHARED_SOURCE

cmake SHARED_SOURCE

Definition at line 381 of file basistest.ctest.

SUBMIT_RESULTS

cmake SUBMIT_RESULTS

Definition at line 383 of file basistest.ctest.

UNINSTALLER

cmake UNINSTALLER

Definition at line 886 of file basistest.ctest.

UPDATED_FILES

cmake UPDATED_FILES

Definition at line 832 of file basistest.ctest.

VALUE

cmake VALUE

Definition at line 453 of file basistest.ctest.

WITH_APIDOC

cmake WITH_APIDOC

Definition at line 401 of file basistest.ctest.

WITH_COVERAGE

cmake WITH_COVERAGE

Definition at line 403 of file basistest.ctest.

WITH_INSTALL

cmake WITH_INSTALL

Definition at line 417 of file basistest.ctest.

WITH_MEMCHECK

cmake WITH_MEMCHECK

Definition at line 402 of file basistest.ctest.