From 4e752dee910d3901a438d97aedf49357a8cb5628 Mon Sep 17 00:00:00 2001 From: David Cole Date: Thu, 8 Nov 2007 10:38:26 -0500 Subject: [PATCH] ENH: Add new Tutorial steps. Diff between Step5 and Step6 shows how to add a cpack driven installer to your project. Diff between Step6 and Step7 shows how to add ctest dashboard scripting capability. --- Tests/CMakeLists.txt | 4 +- Tests/Tutorial/Step6/CMakeLists.txt | 76 ++++++++++++++++++ Tests/Tutorial/Step6/License.txt | 2 + .../Step6/MathFunctions/CMakeLists.txt | 26 ++++++ .../Step6/MathFunctions/MakeTable.cxx | 35 ++++++++ .../Step6/MathFunctions/MathFunctions.h | 1 + Tests/Tutorial/Step6/MathFunctions/mysqrt.cxx | 44 +++++++++++ Tests/Tutorial/Step6/TutorialConfig.h.in | 9 +++ Tests/Tutorial/Step6/tutorial.cxx | 34 ++++++++ Tests/Tutorial/Step7/CMakeLists.txt | 79 +++++++++++++++++++ Tests/Tutorial/Step7/CTestConfig.cmake | 1 + Tests/Tutorial/Step7/License.txt | 2 + .../Step7/MathFunctions/CMakeLists.txt | 26 ++++++ .../Step7/MathFunctions/MakeTable.cxx | 35 ++++++++ .../Step7/MathFunctions/MathFunctions.h | 1 + Tests/Tutorial/Step7/MathFunctions/mysqrt.cxx | 44 +++++++++++ Tests/Tutorial/Step7/TutorialConfig.h.in | 9 +++ Tests/Tutorial/Step7/build1.cmake | 5 ++ Tests/Tutorial/Step7/build2.cmake | 9 +++ Tests/Tutorial/Step7/tutorial.cxx | 34 ++++++++ 20 files changed, 474 insertions(+), 2 deletions(-) create mode 100644 Tests/Tutorial/Step6/CMakeLists.txt create mode 100644 Tests/Tutorial/Step6/License.txt create mode 100644 Tests/Tutorial/Step6/MathFunctions/CMakeLists.txt create mode 100644 Tests/Tutorial/Step6/MathFunctions/MakeTable.cxx create mode 100644 Tests/Tutorial/Step6/MathFunctions/MathFunctions.h create mode 100644 Tests/Tutorial/Step6/MathFunctions/mysqrt.cxx create mode 100644 Tests/Tutorial/Step6/TutorialConfig.h.in create mode 100644 Tests/Tutorial/Step6/tutorial.cxx create mode 100644 Tests/Tutorial/Step7/CMakeLists.txt create mode 100644 Tests/Tutorial/Step7/CTestConfig.cmake create mode 100644 Tests/Tutorial/Step7/License.txt create mode 100644 Tests/Tutorial/Step7/MathFunctions/CMakeLists.txt create mode 100644 Tests/Tutorial/Step7/MathFunctions/MakeTable.cxx create mode 100644 Tests/Tutorial/Step7/MathFunctions/MathFunctions.h create mode 100644 Tests/Tutorial/Step7/MathFunctions/mysqrt.cxx create mode 100644 Tests/Tutorial/Step7/TutorialConfig.h.in create mode 100644 Tests/Tutorial/Step7/build1.cmake create mode 100644 Tests/Tutorial/Step7/build2.cmake create mode 100644 Tests/Tutorial/Step7/tutorial.cxx diff --git a/Tests/CMakeLists.txt b/Tests/CMakeLists.txt index 0b897a54a..81713e698 100644 --- a/Tests/CMakeLists.txt +++ b/Tests/CMakeLists.txt @@ -303,8 +303,8 @@ ${CMake_BINARY_DIR}/bin/cmake -DVERSION=CVS -P ${CMake_SOURCE_DIR}/Utilities/Rel --test-command helloDemo ) - # do the five tutorial steps - FOREACH (STP RANGE 1 5) + # do each of the tutorial steps + FOREACH(STP RANGE 1 7) ADD_TEST(TutorialStep${STP} ${CMAKE_CTEST_COMMAND} --build-and-test "${CMake_SOURCE_DIR}/Tests/Tutorial/Step${STP}" diff --git a/Tests/Tutorial/Step6/CMakeLists.txt b/Tests/Tutorial/Step6/CMakeLists.txt new file mode 100644 index 000000000..c4e0a5eb5 --- /dev/null +++ b/Tests/Tutorial/Step6/CMakeLists.txt @@ -0,0 +1,76 @@ +project (Tutorial) + +# The version number. +set (Tutorial_VERSION_MAJOR 1) +set (Tutorial_VERSION_MINOR 0) + +# does this system provide the log and exp functions? +include (${CMAKE_ROOT}/Modules/CheckFunctionExists.cmake) +check_function_exists (log HAVE_LOG) +check_function_exists (exp HAVE_EXP) + +# should we use our own math functions +option(USE_MYMATH "Use tutorial provided math implementation" ON) + +# configure a header file to pass some of the CMake settings +# to the source code +configure_file ( + "${PROJECT_SOURCE_DIR}/TutorialConfig.h.in" + "${PROJECT_BINARY_DIR}/TutorialConfig.h" + ) + +# add the binary tree to the search path for include files +# so that we will find TutorialConfig.h +include_directories ("${PROJECT_BINARY_DIR}") + +# add the MathFunctions library? +if (USE_MYMATH) + include_directories ("${PROJECT_SOURCE_DIR}/MathFunctions") + add_subdirectory (MathFunctions) + set (EXTRA_LIBS ${EXTRA_LIBS} MathFunctions) +endif (USE_MYMATH) + +# add the executable +add_executable (Tutorial tutorial.cxx) +target_link_libraries (Tutorial ${EXTRA_LIBS}) + +# add the install targets +install_targets (/bin Tutorial) +install_files (/include FILES "${PROJECT_BINARY_DIR}/TutorialConfig.h") + +# enable testing +enable_testing () + +# does the application run +add_test (TutorialRuns Tutorial 25) + +# does the usage message work? +add_test (TutorialUsage Tutorial) +set_tests_properties (TutorialUsage + PROPERTIES + PASS_REGULAR_EXPRESSION "Usage:.*number" + ) + +#define a macro to simplify adding tests +macro (do_test arg result) + add_test (TutorialComp${arg} Tutorial ${arg}) + set_tests_properties (TutorialComp${arg} + PROPERTIES PASS_REGULAR_EXPRESSION ${result} + ) +endmacro (do_test) + +# do a bunch of result based tests +do_test (4 "4 is 2") +do_test (9 "9 is 3") +do_test (5 "5 is 2.236") +do_test (7 "7 is 2.645") +do_test (25 "25 is 5") +do_test (-25 "-25 is 0") +do_test (0.0001 "0.0001 is 0.01") + +# build a CPack driven installer package +include (InstallRequiredSystemLibraries) +SET(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/License.txt") +SET(CPACK_PACKAGE_VERSION_MAJOR "${Tutorial_VERSION_MAJOR}") +SET(CPACK_PACKAGE_VERSION_MINOR "${Tutorial_VERSION_MINOR}") +INCLUDE (CPack) diff --git a/Tests/Tutorial/Step6/License.txt b/Tests/Tutorial/Step6/License.txt new file mode 100644 index 000000000..673d72453 --- /dev/null +++ b/Tests/Tutorial/Step6/License.txt @@ -0,0 +1,2 @@ +This is the open source License.txt file introduced in +CMake/Tests/Tutorial/Step6... diff --git a/Tests/Tutorial/Step6/MathFunctions/CMakeLists.txt b/Tests/Tutorial/Step6/MathFunctions/CMakeLists.txt new file mode 100644 index 000000000..8ecddfafd --- /dev/null +++ b/Tests/Tutorial/Step6/MathFunctions/CMakeLists.txt @@ -0,0 +1,26 @@ +# first we add the executable that generates the table +add_executable(MakeTable MakeTable.cxx) + +get_target_property(MakeTableLocation MakeTable LOCATION) + +# add the command to generate the source code +add_custom_command ( + OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/Table.h + DEPENDS MakeTable + COMMAND ${MakeTableLocation} + ARGS ${CMAKE_CURRENT_BINARY_DIR}/Table.h + ) + +set_source_files_properties ( + mysqrt.cxx PROPERTIES + OBJECT_DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/Table.h + ) + +# add the binary tree directory to the search path for include files +include_directories( ${CMAKE_CURRENT_BINARY_DIR} ) + +# add the main library +add_library(MathFunctions mysqrt.cxx) + +install_targets (/bin MathFunctions) +install_files (/include FILES MathFunctions.h) diff --git a/Tests/Tutorial/Step6/MathFunctions/MakeTable.cxx b/Tests/Tutorial/Step6/MathFunctions/MakeTable.cxx new file mode 100644 index 000000000..6a2be3a14 --- /dev/null +++ b/Tests/Tutorial/Step6/MathFunctions/MakeTable.cxx @@ -0,0 +1,35 @@ +// A simple program that builds a sqrt table +#include +#include + +int main (int argc, char *argv[]) +{ + int i; + double result; + + // make sure we have enough arguments + if (argc < 2) + { + return 1; + } + + // open the output file + FILE *fout = fopen(argv[1],"w"); + if (!fout) + { + return 1; + } + + // crate a source file with a table of square roots + fprintf(fout,"double sqrtTable[] = {\n"); + for (i = 0; i < 10; ++i) + { + result = sqrt(static_cast(i)); + fprintf(fout,"%g,\n",result); + } + + // close the table with a zero + fprintf(fout,"0};\n"); + fclose(fout); + return 0; +} diff --git a/Tests/Tutorial/Step6/MathFunctions/MathFunctions.h b/Tests/Tutorial/Step6/MathFunctions/MathFunctions.h new file mode 100644 index 000000000..cd36bccff --- /dev/null +++ b/Tests/Tutorial/Step6/MathFunctions/MathFunctions.h @@ -0,0 +1 @@ +double mysqrt(double x); diff --git a/Tests/Tutorial/Step6/MathFunctions/mysqrt.cxx b/Tests/Tutorial/Step6/MathFunctions/mysqrt.cxx new file mode 100644 index 000000000..33659b740 --- /dev/null +++ b/Tests/Tutorial/Step6/MathFunctions/mysqrt.cxx @@ -0,0 +1,44 @@ +#include +#include "MathFunctions.h" +#include "TutorialConfig.h" + +// include the generated table +#include "Table.h" + +#include + +// a hack square root calculation using simple operations +double mysqrt(double x) +{ + if (x <= 0) + { + return 0; + } + + double result; + + // if we have both log and exp then use them + double delta; + + // use the table to help find an initial value + result = x; + if (x >= 1 && x < 10) + { + result = sqrtTable[static_cast(x)]; + } + + // do ten iterations + int i; + for (i = 0; i < 10; ++i) + { + if (result <= 0) + { + result = 0.1; + } + delta = x - (result*result); + result = result + 0.5*delta/result; + fprintf(stdout,"Computing sqrt of %g to be %g\n",x,result); + } + + return result; +} diff --git a/Tests/Tutorial/Step6/TutorialConfig.h.in b/Tests/Tutorial/Step6/TutorialConfig.h.in new file mode 100644 index 000000000..a0912656a --- /dev/null +++ b/Tests/Tutorial/Step6/TutorialConfig.h.in @@ -0,0 +1,9 @@ +// the configured options and settings for Tutorial +#define Tutorial_VERSION_MAJOR @Tutorial_VERSION_MAJOR@ +#define Tutorial_VERSION_MINOR @Tutorial_VERSION_MINOR@ +#cmakedefine USE_MYMATH + +// does the platform provide exp and log functions? +#cmakedefine HAVE_LOG +#cmakedefine HAVE_EXP + diff --git a/Tests/Tutorial/Step6/tutorial.cxx b/Tests/Tutorial/Step6/tutorial.cxx new file mode 100644 index 000000000..82b416f11 --- /dev/null +++ b/Tests/Tutorial/Step6/tutorial.cxx @@ -0,0 +1,34 @@ +// A simple program that computes the square root of a number +#include +#include +#include +#include "TutorialConfig.h" + +#ifdef USE_MYMATH +#include "MathFunctions.h" +#endif + +int main (int argc, char *argv[]) +{ + if (argc < 2) + { + fprintf(stdout,"%s Version %d.%d\n", + argv[0], + Tutorial_VERSION_MAJOR, + Tutorial_VERSION_MINOR); + fprintf(stdout,"Usage: %s number\n",argv[0]); + return 1; + } + + double inputValue = atof(argv[1]); + +#ifdef USE_MYMATH + double outputValue = mysqrt(inputValue); +#else + double outputValue = sqrt(inputValue); +#endif + + fprintf(stdout,"The square root of %g is %g\n", + inputValue, outputValue); + return 0; +} diff --git a/Tests/Tutorial/Step7/CMakeLists.txt b/Tests/Tutorial/Step7/CMakeLists.txt new file mode 100644 index 000000000..6b7472c4e --- /dev/null +++ b/Tests/Tutorial/Step7/CMakeLists.txt @@ -0,0 +1,79 @@ +project (Tutorial) + +# The version number. +set (Tutorial_VERSION_MAJOR 1) +set (Tutorial_VERSION_MINOR 0) + +# does this system provide the log and exp functions? +include (${CMAKE_ROOT}/Modules/CheckFunctionExists.cmake) +check_function_exists (log HAVE_LOG) +check_function_exists (exp HAVE_EXP) + +# should we use our own math functions +option(USE_MYMATH "Use tutorial provided math implementation" ON) + +# configure a header file to pass some of the CMake settings +# to the source code +configure_file ( + "${PROJECT_SOURCE_DIR}/TutorialConfig.h.in" + "${PROJECT_BINARY_DIR}/TutorialConfig.h" + ) + +# add the binary tree to the search path for include files +# so that we will find TutorialConfig.h +include_directories ("${PROJECT_BINARY_DIR}") + +# add the MathFunctions library? +if (USE_MYMATH) + include_directories ("${PROJECT_SOURCE_DIR}/MathFunctions") + add_subdirectory (MathFunctions) + set (EXTRA_LIBS ${EXTRA_LIBS} MathFunctions) +endif (USE_MYMATH) + +# add the executable +add_executable (Tutorial tutorial.cxx) +target_link_libraries (Tutorial ${EXTRA_LIBS}) + +# add the install targets +install_targets (/bin Tutorial) +install_files (/include FILES "${PROJECT_BINARY_DIR}/TutorialConfig.h") + +# enable testing +enable_testing () + +# does the application run +add_test (TutorialRuns Tutorial 25) + +# does the usage message work? +add_test (TutorialUsage Tutorial) +set_tests_properties (TutorialUsage + PROPERTIES + PASS_REGULAR_EXPRESSION "Usage:.*number" + ) + +#define a macro to simplify adding tests +macro (do_test arg result) + add_test (TutorialComp${arg} Tutorial ${arg}) + set_tests_properties (TutorialComp${arg} + PROPERTIES PASS_REGULAR_EXPRESSION ${result} + ) +endmacro (do_test) + +# do a bunch of result based tests +do_test (4 "4 is 2") +do_test (9 "9 is 3") +do_test (5 "5 is 2.236") +do_test (7 "7 is 2.645") +do_test (25 "25 is 5") +do_test (-25 "-25 is 0") +do_test (0.0001 "0.0001 is 0.01") + +# build a CPack driven installer package +include (InstallRequiredSystemLibraries) +SET(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/License.txt") +SET(CPACK_PACKAGE_VERSION_MAJOR "${Tutorial_VERSION_MAJOR}") +SET(CPACK_PACKAGE_VERSION_MINOR "${Tutorial_VERSION_MINOR}") +INCLUDE (CPack) + +# enable dashboard scripting +INCLUDE (CTest) diff --git a/Tests/Tutorial/Step7/CTestConfig.cmake b/Tests/Tutorial/Step7/CTestConfig.cmake new file mode 100644 index 000000000..99fa0560d --- /dev/null +++ b/Tests/Tutorial/Step7/CTestConfig.cmake @@ -0,0 +1 @@ +SET(CTEST_PROJECT_NAME "Tutorial") diff --git a/Tests/Tutorial/Step7/License.txt b/Tests/Tutorial/Step7/License.txt new file mode 100644 index 000000000..673d72453 --- /dev/null +++ b/Tests/Tutorial/Step7/License.txt @@ -0,0 +1,2 @@ +This is the open source License.txt file introduced in +CMake/Tests/Tutorial/Step6... diff --git a/Tests/Tutorial/Step7/MathFunctions/CMakeLists.txt b/Tests/Tutorial/Step7/MathFunctions/CMakeLists.txt new file mode 100644 index 000000000..8ecddfafd --- /dev/null +++ b/Tests/Tutorial/Step7/MathFunctions/CMakeLists.txt @@ -0,0 +1,26 @@ +# first we add the executable that generates the table +add_executable(MakeTable MakeTable.cxx) + +get_target_property(MakeTableLocation MakeTable LOCATION) + +# add the command to generate the source code +add_custom_command ( + OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/Table.h + DEPENDS MakeTable + COMMAND ${MakeTableLocation} + ARGS ${CMAKE_CURRENT_BINARY_DIR}/Table.h + ) + +set_source_files_properties ( + mysqrt.cxx PROPERTIES + OBJECT_DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/Table.h + ) + +# add the binary tree directory to the search path for include files +include_directories( ${CMAKE_CURRENT_BINARY_DIR} ) + +# add the main library +add_library(MathFunctions mysqrt.cxx) + +install_targets (/bin MathFunctions) +install_files (/include FILES MathFunctions.h) diff --git a/Tests/Tutorial/Step7/MathFunctions/MakeTable.cxx b/Tests/Tutorial/Step7/MathFunctions/MakeTable.cxx new file mode 100644 index 000000000..6a2be3a14 --- /dev/null +++ b/Tests/Tutorial/Step7/MathFunctions/MakeTable.cxx @@ -0,0 +1,35 @@ +// A simple program that builds a sqrt table +#include +#include + +int main (int argc, char *argv[]) +{ + int i; + double result; + + // make sure we have enough arguments + if (argc < 2) + { + return 1; + } + + // open the output file + FILE *fout = fopen(argv[1],"w"); + if (!fout) + { + return 1; + } + + // crate a source file with a table of square roots + fprintf(fout,"double sqrtTable[] = {\n"); + for (i = 0; i < 10; ++i) + { + result = sqrt(static_cast(i)); + fprintf(fout,"%g,\n",result); + } + + // close the table with a zero + fprintf(fout,"0};\n"); + fclose(fout); + return 0; +} diff --git a/Tests/Tutorial/Step7/MathFunctions/MathFunctions.h b/Tests/Tutorial/Step7/MathFunctions/MathFunctions.h new file mode 100644 index 000000000..cd36bccff --- /dev/null +++ b/Tests/Tutorial/Step7/MathFunctions/MathFunctions.h @@ -0,0 +1 @@ +double mysqrt(double x); diff --git a/Tests/Tutorial/Step7/MathFunctions/mysqrt.cxx b/Tests/Tutorial/Step7/MathFunctions/mysqrt.cxx new file mode 100644 index 000000000..33659b740 --- /dev/null +++ b/Tests/Tutorial/Step7/MathFunctions/mysqrt.cxx @@ -0,0 +1,44 @@ +#include +#include "MathFunctions.h" +#include "TutorialConfig.h" + +// include the generated table +#include "Table.h" + +#include + +// a hack square root calculation using simple operations +double mysqrt(double x) +{ + if (x <= 0) + { + return 0; + } + + double result; + + // if we have both log and exp then use them + double delta; + + // use the table to help find an initial value + result = x; + if (x >= 1 && x < 10) + { + result = sqrtTable[static_cast(x)]; + } + + // do ten iterations + int i; + for (i = 0; i < 10; ++i) + { + if (result <= 0) + { + result = 0.1; + } + delta = x - (result*result); + result = result + 0.5*delta/result; + fprintf(stdout,"Computing sqrt of %g to be %g\n",x,result); + } + + return result; +} diff --git a/Tests/Tutorial/Step7/TutorialConfig.h.in b/Tests/Tutorial/Step7/TutorialConfig.h.in new file mode 100644 index 000000000..a0912656a --- /dev/null +++ b/Tests/Tutorial/Step7/TutorialConfig.h.in @@ -0,0 +1,9 @@ +// the configured options and settings for Tutorial +#define Tutorial_VERSION_MAJOR @Tutorial_VERSION_MAJOR@ +#define Tutorial_VERSION_MINOR @Tutorial_VERSION_MINOR@ +#cmakedefine USE_MYMATH + +// does the platform provide exp and log functions? +#cmakedefine HAVE_LOG +#cmakedefine HAVE_EXP + diff --git a/Tests/Tutorial/Step7/build1.cmake b/Tests/Tutorial/Step7/build1.cmake new file mode 100644 index 000000000..039d5569b --- /dev/null +++ b/Tests/Tutorial/Step7/build1.cmake @@ -0,0 +1,5 @@ +SET(CTEST_SOURCE_DIRECTORY "$ENV{HOME}/Dashboards/My Tests/CMake/Tests/Tutorial/Step7") +SET(CTEST_BINARY_DIRECTORY "${CTEST_SOURCE_DIRECTORY}-build1") + +SET(CTEST_CMAKE_COMMAND "cmake") +SET(CTEST_COMMAND "ctest -D Experimental") diff --git a/Tests/Tutorial/Step7/build2.cmake b/Tests/Tutorial/Step7/build2.cmake new file mode 100644 index 000000000..5112355b2 --- /dev/null +++ b/Tests/Tutorial/Step7/build2.cmake @@ -0,0 +1,9 @@ +SET(CTEST_SOURCE_DIRECTORY "$ENV{HOME}/Dashboards/My Tests/CMake/Tests/Tutorial/Step7") +SET(CTEST_BINARY_DIRECTORY "${CTEST_SOURCE_DIRECTORY}-build2") +SET(CTEST_CMAKE_GENERATOR "Visual Studio 8 2005") + +CTEST_START("Experimental") +CTEST_CONFIGURE(BUILD "${CTEST_BINARY_DIRECTORY}") +CTEST_BUILD(BUILD "${CTEST_BINARY_DIRECTORY}") +CTEST_TEST(BUILD "${CTEST_BINARY_DIRECTORY}") +CTEST_SUBMIT() diff --git a/Tests/Tutorial/Step7/tutorial.cxx b/Tests/Tutorial/Step7/tutorial.cxx new file mode 100644 index 000000000..82b416f11 --- /dev/null +++ b/Tests/Tutorial/Step7/tutorial.cxx @@ -0,0 +1,34 @@ +// A simple program that computes the square root of a number +#include +#include +#include +#include "TutorialConfig.h" + +#ifdef USE_MYMATH +#include "MathFunctions.h" +#endif + +int main (int argc, char *argv[]) +{ + if (argc < 2) + { + fprintf(stdout,"%s Version %d.%d\n", + argv[0], + Tutorial_VERSION_MAJOR, + Tutorial_VERSION_MINOR); + fprintf(stdout,"Usage: %s number\n",argv[0]); + return 1; + } + + double inputValue = atof(argv[1]); + +#ifdef USE_MYMATH + double outputValue = mysqrt(inputValue); +#else + double outputValue = sqrt(inputValue); +#endif + + fprintf(stdout,"The square root of %g is %g\n", + inputValue, outputValue); + return 0; +}