CMakeLua/Source/CTest/cmCTestScriptHandler.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmCTestScriptHandler.h,v $
   5   Language:  C++
   6 <<<<<<< cmCTestScriptHandler.h
   7   Date:      $Date: 2007/06/08 20:06:33 $
   8   Version:   $Revision: 1.19 $
   9 =======
  10   Date:      $Date: 2009-01-09 17:05:23 $
  11   Version:   $Revision: 1.20 $
  12 >>>>>>> 1.20
  13
  14   Copyright (c) 2002 Kitware, Inc. All rights reserved.
  15   See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
  16
  17      This software is distributed WITHOUT ANY WARRANTY; without even
  18      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  19      PURPOSE.  See the above copyright notices for more information.
  20
  21 =========================================================================*/
  22
  23 #ifndef cmCTestScriptHandler_h
  24 #define cmCTestScriptHandler_h
  25
  26
  27 #include "cmCTestGenericHandler.h"
  28 #include "cmListFileCache.h"
  29
  30 class cmMakefile;
  31 class cmLocalGenerator;
  32 class cmGlobalGenerator;
  33 class cmake;
  34 class cmCTestCommand;
  35
  36 /** \class cmCTestScriptHandler
  37  * \brief A class that handles ctest -S invocations
  38  *
  39  * CTest script is controlled using several variables that script has to
  40  * specify and some optional ones. Required ones are:
  41  *   CTEST_SOURCE_DIRECTORY - Source directory of the project
  42  *   CTEST_BINARY_DIRECTORY - Binary directory of the project
  43  *   CTEST_COMMAND          - Testing commands
  44  *
  45  * Optional variables are:
  46  *   CTEST_BACKUP_AND_RESTORE
  47  *   CTEST_CMAKE_COMMAND
  48  *   CTEST_CMAKE_OUTPUT_FILE_NAME
  49  *   CTEST_CONTINUOUS_DURATION
  50  *   CTEST_CONTINUOUS_MINIMUM_INTERVAL
  51  *   CTEST_CVS_CHECKOUT
  52  *   CTEST_CVS_COMMAND
  53  *   CTEST_UPDATE_COMMAND
  54  *   CTEST_DASHBOARD_ROOT
  55  *   CTEST_ENVIRONMENT
  56  *   CTEST_INITIAL_CACHE
  57  *   CTEST_START_WITH_EMPTY_BINARY_DIRECTORY
  58  *   CTEST_START_WITH_EMPTY_BINARY_DIRECTORY_ONCE
  59  *
  60  * In addition the following variables can be used. The number can be 1-10.
  61  *   CTEST_EXTRA_UPDATES_1
  62  *   CTEST_EXTRA_UPDATES_2
  63  *   ...
  64  *   CTEST_EXTRA_UPDATES_10
  65  *
  66  * CTest script can use the following arguments CTest provides:
  67  *   CTEST_SCRIPT_ARG
  68  *   CTEST_SCRIPT_DIRECTORY
  69  *   CTEST_SCRIPT_NAME
  70  *
  71  */
  72 class cmCTestScriptHandler : public cmCTestGenericHandler
  73 {
  74 public:
  75   cmTypeMacro(cmCTestScriptHandler, cmCTestGenericHandler);
  76
  77   /**
  78    * Add a script to run, and if is should run in the current process
  79    */
  80   void AddConfigurationScript(const char *, bool pscope);
  81
  82   /**
  83    * Run a dashboard using a specified confiuration script
  84    */
  85   int ProcessHandler();
  86
  87   /*
  88    * Run a script
  89    */
  90   static bool RunScript(cmCTest* ctest, const char *script, bool InProcess);
  91   int RunCurrentScript();
  92
  93   /*
  94    * Empty Binary Directory
  95    */
  96   static bool EmptyBinaryDirectory(const char *dir);
  97
  98   /*
  99    * Some elapsed time handling functions
 100    */
 101   static void SleepInSeconds(unsigned int secondsToWait);
 102   void UpdateElapsedTime();
 103
 104   /**
 105    * Return the time remaianing that the script is allowed to run in
 106    * seconds if the user has set the variable CTEST_TIME_LIMIT. If that has
 107    * not been set it returns 1e7 seconds
 108    */
 109   double GetRemainingTimeAllowed();
 110
 111   cmCTestScriptHandler();
 112   ~cmCTestScriptHandler();
 113
 114   void Initialize();
 115
 116   void CreateCMake();
 117   void GetCommandDocumentation(std::vector<cmDocumentationEntry>& v) const;
 118   cmake* GetCMake() { return this->CMake;}
 119 private:
 120   // reads in a script
 121   int ReadInScript(const std::string& total_script_arg);
 122   int ExecuteScript(const std::string& total_script_arg);
 123
 124   // extract vars from the script to set ivars
 125   int ExtractVariables();
 126
 127   // perform a CVS checkout of the source dir
 128   int CheckOutSourceDir();
 129
 130   // perform any extra cvs updates that were requested
 131   int PerformExtraUpdates();
 132
 133   // backup and restore dirs
 134   int BackupDirectories();
 135   void RestoreBackupDirectories();
 136
 137   int RunConfigurationScript(const std::string& script, bool pscope);
 138   int RunConfigurationDashboard();
 139
 140   // Add ctest command
 141   void AddCTestCommand(cmCTestCommand* command);
 142
 143   std::vector<cmStdString> ConfigurationScripts;
 144   std::vector<bool> ScriptProcessScope;
 145
 146   bool Backup;
 147   bool EmptyBinDir;
 148   bool EmptyBinDirOnce;
 149
 150   cmStdString SourceDir;
 151   cmStdString BinaryDir;
 152   cmStdString BackupSourceDir;
 153   cmStdString BackupBinaryDir;
 154   cmStdString CTestRoot;
 155   cmStdString CVSCheckOut;
 156   cmStdString CTestCmd;
 157   cmStdString UpdateCmd;
 158   cmStdString CTestEnv;
 159   cmStdString InitCache;
 160   cmStdString CMakeCmd;
 161   cmStdString CMOutFile;
 162   std::vector<cmStdString> ExtraUpdates;
 163
 164   double MinimumInterval;
 165   double ContinuousDuration;
 166
 167   // what time in seconds did this script start running
 168   double ScriptStartTime;
 169
 170   cmMakefile *Makefile;
 171   cmLocalGenerator *LocalGenerator;
 172   cmGlobalGenerator *GlobalGenerator;
 173   cmake *CMake;
 174 };
 175
 176 #endif