testing.rst 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. CMake Testing Process
  2. *********************
  3. The following documents the process for running integration testing builds.
  4. See documentation on `CMake Development`_ for more information.
  5. .. _`CMake Development`: README.rst
  6. CMake Dashboard Scripts
  7. =======================
  8. The *integration testing* step of the `CMake Review Process`_ uses a set of
  9. testing machines that follow an integration branch on their own schedule to
  10. drive testing and submit results to the `CMake CDash Page`_. Anyone is
  11. welcome to provide testing machines in order to help keep support for their
  12. platforms working.
  13. The `CMake Dashboard Scripts Repository`_ provides CTest scripts to drive
  14. nightly, continuous, and experimental testing of CMake. Use the following
  15. commands to set up a new integration testing client:
  16. .. code-block:: console
  17. $ mkdir -p ~/Dashboards
  18. $ cd ~/Dashboards
  19. $ git clone https://gitlab.kitware.com/cmake/dashboard-scripts.git CMakeScripts
  20. $ cd CMakeScripts
  21. The ``cmake_common.cmake`` script contains comments at the top with
  22. instructions to set up a testing client. As it instructs, create a
  23. CTest script with local settings and include ``cmake_common.cmake``.
  24. .. _`CMake Review Process`: review.rst
  25. .. _`CMake CDash Page`: https://open.cdash.org/index.php?project=CMake
  26. .. _`CMake Dashboard Scripts Repository`: https://gitlab.kitware.com/cmake/dashboard-scripts
  27. Nightly Start Time
  28. ------------------
  29. The ``cmake_common.cmake`` script expects its includer to be run from a
  30. nightly scheduled task (cron job). Schedule such tasks for sometime after
  31. ``1:00am UTC``, the time at which our nightly testing branches fast-forward.