CMake/Source/CTest/cmCTestScriptHandler.cxx

1137 lines
33 KiB
C++
Raw Normal View History

/*============================================================================
CMake - Cross Platform Makefile Generator
Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
This software is distributed WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the License for more information.
============================================================================*/
#include "cmCTestScriptHandler.h"
#include "cmCTest.h"
2005-01-27 18:11:04 +03:00
#include "cmFunctionBlocker.h"
#include "cmGeneratedFileStream.h"
#include "cmGlobalGenerator.h"
#include "cmMakefile.h"
#include "cmake.h"
//#include <cmsys/RegularExpression.hxx>
#include <cmsys/Directory.hxx>
#include <cmsys/Process.h>
// used for sleep
#ifdef _WIN32
#include "windows.h"
#endif
#include <float.h>
#include <math.h>
2006-03-09 19:17:10 +03:00
#include <stdlib.h>
#include <time.h>
// needed for sleep
#if !defined(_WIN32)
# include <unistd.h>
#endif
#include "cmCTestBuildCommand.h"
#include "cmCTestConfigureCommand.h"
#include "cmCTestCoverageCommand.h"
2005-01-27 18:11:04 +03:00
#include "cmCTestEmptyBinaryDirectoryCommand.h"
#include "cmCTestMemCheckCommand.h"
#include "cmCTestReadCustomFilesCommand.h"
2005-01-27 18:11:04 +03:00
#include "cmCTestRunScriptCommand.h"
#include "cmCTestSleepCommand.h"
#include "cmCTestStartCommand.h"
#include "cmCTestSubmitCommand.h"
#include "cmCTestTestCommand.h"
#include "cmCTestUpdateCommand.h"
2011-02-18 20:11:51 +03:00
#include "cmCTestUploadCommand.h"
2005-01-27 18:11:04 +03:00
2004-09-28 17:00:06 +04:00
#define CTEST_INITIAL_CMAKE_OUTPUT_FILE_NAME "CTestInitialCMakeOutput.log"
2005-01-27 18:11:04 +03:00
// used to keep elapsed time up to date
class cmCTestScriptFunctionBlocker : public cmFunctionBlocker
{
public:
cmCTestScriptFunctionBlocker() {}
virtual ~cmCTestScriptFunctionBlocker() {}
virtual bool IsFunctionBlocked(const cmListFileFunction& lff,
cmMakefile &mf,
cmExecutionStatus &);
2005-01-27 18:11:04 +03:00
//virtual bool ShouldRemove(const cmListFileFunction& lff, cmMakefile &mf);
//virtual void ScopeEnded(cmMakefile &mf);
2006-03-09 19:17:10 +03:00
2006-03-10 23:03:09 +03:00
cmCTestScriptHandler* CTestScriptHandler;
2005-01-27 18:11:04 +03:00
};
// simply update the time and don't block anything
bool cmCTestScriptFunctionBlocker::
IsFunctionBlocked(const cmListFileFunction& , cmMakefile &,
cmExecutionStatus &)
2005-01-27 18:11:04 +03:00
{
2006-03-10 23:03:09 +03:00
this->CTestScriptHandler->UpdateElapsedTime();
2005-01-27 18:11:04 +03:00
return false;
}
//----------------------------------------------------------------------
cmCTestScriptHandler::cmCTestScriptHandler()
{
2006-03-10 23:03:09 +03:00
this->Backup = false;
this->EmptyBinDir = false;
this->EmptyBinDirOnce = false;
this->Makefile = 0;
this->CMake = 0;
this->GlobalGenerator = 0;
2005-01-27 18:11:04 +03:00
2006-03-10 23:03:09 +03:00
this->ScriptStartTime = 0;
2006-03-09 19:17:10 +03:00
// the *60 is becuase the settings are in minutes but GetTime is seconds
2006-03-10 23:03:09 +03:00
this->MinimumInterval = 30*60;
this->ContinuousDuration = -1;
}
//----------------------------------------------------------------------
void cmCTestScriptHandler::Initialize()
{
this->Superclass::Initialize();
2006-03-10 23:03:09 +03:00
this->Backup = false;
this->EmptyBinDir = false;
this->EmptyBinDirOnce = false;
this->SourceDir = "";
this->BinaryDir = "";
this->BackupSourceDir = "";
this->BackupBinaryDir = "";
this->CTestRoot = "";
this->CVSCheckOut = "";
this->CTestCmd = "";
this->UpdateCmd = "";
2006-03-10 23:03:09 +03:00
this->CTestEnv = "";
this->InitialCache = "";
2006-03-10 23:03:09 +03:00
this->CMakeCmd = "";
this->CMOutFile = "";
this->ExtraUpdates.clear();
this->MinimumInterval = 20*60;
this->ContinuousDuration = -1;
// what time in seconds did this script start running
2006-03-10 23:03:09 +03:00
this->ScriptStartTime = 0;
2006-03-09 19:17:10 +03:00
delete this->Makefile;
2006-03-10 23:03:09 +03:00
this->Makefile = 0;
delete this->GlobalGenerator;
2006-03-10 23:03:09 +03:00
this->GlobalGenerator = 0;
delete this->CMake;
}
//----------------------------------------------------------------------
cmCTestScriptHandler::~cmCTestScriptHandler()
{
delete this->Makefile;
delete this->GlobalGenerator;
delete this->CMake;
}
//----------------------------------------------------------------------
// just adds an argument to the vector
2011-03-11 16:04:58 +03:00
void cmCTestScriptHandler::AddConfigurationScript(const char *script,
2006-05-10 21:50:44 +04:00
bool pscope)
{
2006-03-10 23:03:09 +03:00
this->ConfigurationScripts.push_back(script);
this->ScriptProcessScope.push_back(pscope);
}
//----------------------------------------------------------------------
// the generic entry point for handling scripts, this routine will run all
// the scripts provides a -S arguments
2005-01-27 23:54:47 +03:00
int cmCTestScriptHandler::ProcessHandler()
{
int res = 0;
for (size_t i=0; i < this->ConfigurationScripts.size(); ++i)
{
// for each script run it
res |= this->RunConfigurationScript
(cmSystemTools::CollapseFullPath(this->ConfigurationScripts[i]),
this->ScriptProcessScope[i]);
}
2005-01-27 23:54:47 +03:00
if ( res )
{
return -1;
}
return 0;
}
2005-01-27 18:11:04 +03:00
void cmCTestScriptHandler::UpdateElapsedTime()
{
if (this->Makefile)
2005-01-27 18:11:04 +03:00
{
// set the current elapsed time
char timeString[20];
int itime = static_cast<unsigned int>(cmSystemTools::GetTime()
2006-03-10 23:03:09 +03:00
- this->ScriptStartTime);
2005-01-27 18:11:04 +03:00
sprintf(timeString,"%i",itime);
this->Makefile->AddDefinition("CTEST_ELAPSED_TIME", timeString);
2005-01-27 18:11:04 +03:00
}
}
//----------------------------------------------------------------------
void cmCTestScriptHandler::AddCTestCommand(cmCTestCommand* command)
{
cmCTestCommand* newCom = command;
2006-03-10 23:03:09 +03:00
newCom->CTest = this->CTest;
newCom->CTestScriptHandler = this;
2015-04-11 13:52:14 +03:00
this->CMake->GetState()->AddCommand(newCom);
}
int cmCTestScriptHandler::ExecuteScript(const std::string& total_script_arg)
{
// execute the script passing in the arguments to the script as well as the
// arguments from this invocation of cmake
std::vector<const char*> argv;
argv.push_back(cmSystemTools::GetCTestCommand().c_str());
argv.push_back("-SR");
argv.push_back(total_script_arg.c_str());
2011-03-11 16:04:58 +03:00
cmCTestLog(this->CTest, HANDLER_VERBOSE_OUTPUT,
"Executable for CTest is: " <<
cmSystemTools::GetCTestCommand() << "\n");
// now pass through all the other arguments
std::vector<std::string> &initArgs =
this->CTest->GetInitialCommandLineArguments();
2009-06-26 00:39:10 +04:00
//*** need to make sure this does not have the current script ***
for(size_t i=1; i < initArgs.size(); ++i)
{
argv.push_back(initArgs[i].c_str());
}
argv.push_back(0);
// Now create process object
cmsysProcess* cp = cmsysProcess_New();
cmsysProcess_SetCommand(cp, &*argv.begin());
//cmsysProcess_SetWorkingDirectory(cp, dir);
cmsysProcess_SetOption(cp, cmsysProcess_Option_HideWindow, 1);
//cmsysProcess_SetTimeout(cp, timeout);
cmsysProcess_Execute(cp);
std::vector<char> out;
std::vector<char> err;
std::string line;
int pipe = cmSystemTools::WaitForLine(cp, line, 100.0, out, err);
while(pipe != cmsysProcess_Pipe_None)
{
2011-03-11 16:04:58 +03:00
cmCTestLog(this->CTest, HANDLER_VERBOSE_OUTPUT, "Output: "
2006-05-10 21:50:44 +04:00
<< line << "\n");
if(pipe == cmsysProcess_Pipe_STDERR)
{
cmCTestLog(this->CTest, ERROR_MESSAGE, line << "\n");
}
else if(pipe == cmsysProcess_Pipe_STDOUT)
{
cmCTestLog(this->CTest, HANDLER_VERBOSE_OUTPUT, line << "\n");
}
pipe = cmSystemTools::WaitForLine(cp, line, 100, out, err);
}
2011-03-11 16:04:58 +03:00
// Properly handle output of the build command
cmsysProcess_WaitForExit(cp, 0);
int result = cmsysProcess_GetState(cp);
int retVal = 0;
2008-12-19 05:57:42 +03:00
bool failed = false;
if(result == cmsysProcess_State_Exited)
{
retVal = cmsysProcess_GetExitValue(cp);
}
2008-12-19 05:57:42 +03:00
else if(result == cmsysProcess_State_Exception)
{
2008-12-19 05:57:42 +03:00
retVal = cmsysProcess_GetExitException(cp);
cmCTestLog(this->CTest, ERROR_MESSAGE, "\tThere was an exception: "
2011-03-11 16:04:58 +03:00
<< cmsysProcess_GetExceptionString(cp) << " " <<
2008-12-19 05:57:42 +03:00
retVal << std::endl);
failed = true;
}
else if(result == cmsysProcess_State_Expired)
{
cmCTestLog(this->CTest, ERROR_MESSAGE, "\tThere was a timeout"
<< std::endl);
failed = true;
}
else if(result == cmsysProcess_State_Error)
{
cmCTestLog(this->CTest, ERROR_MESSAGE, "\tError executing ctest: "
<< cmsysProcess_GetErrorString(cp) << std::endl);
failed = true;
}
cmsysProcess_Delete(cp);
2008-12-19 05:57:42 +03:00
if(failed)
{
std::ostringstream message;
2008-12-19 05:57:42 +03:00
message << "Error running command: [";
message << result << "] ";
for(std::vector<const char*>::iterator i = argv.begin();
i != argv.end(); ++i)
{
if(*i)
{
message << *i << " ";
}
}
cmCTestLog(this->CTest, ERROR_MESSAGE,
message.str() << argv[0] << std::endl);
return -1;
}
return retVal;
}
static void ctestScriptProgressCallback(const char *m, float, void* cd)
{
cmCTest* ctest = static_cast<cmCTest*>(cd);
if(m && *m)
{
cmCTestLog(ctest, HANDLER_OUTPUT, "-- " << m << std::endl);
}
}
void cmCTestScriptHandler::CreateCMake()
{
// create a cmake instance to read the configuration script
if (this->CMake)
{
delete this->CMake;
delete this->GlobalGenerator;
delete this->Makefile;
}
this->CMake = new cmake;
this->CMake->SetHomeDirectory("");
this->CMake->SetHomeOutputDirectory("");
this->CMake->GetCurrentSnapshot().SetDefaultDefinitions();
this->CMake->AddCMakePaths();
this->GlobalGenerator = new cmGlobalGenerator(this->CMake);
cmState::Snapshot snapshot = this->CMake->GetCurrentSnapshot();
std::string cwd = cmSystemTools::GetCurrentWorkingDirectory();
snapshot.GetDirectory().SetCurrentSource(cwd);
snapshot.GetDirectory().SetCurrentBinary(cwd);
this->Makefile = new cmMakefile(this->GlobalGenerator, snapshot);
this->CMake->SetProgressCallback(ctestScriptProgressCallback, this->CTest);
2011-03-11 16:04:58 +03:00
// remove all cmake commands which are not scriptable, since they can't be
// used in ctest scripts
2015-04-11 13:52:14 +03:00
this->CMake->GetState()->RemoveUnscriptableCommands();
// add any ctest specific commands, probably should have common superclass
// for ctest commands to clean this up. If a couple more commands are
// created with the same format lets do that - ken
this->AddCTestCommand(new cmCTestBuildCommand);
this->AddCTestCommand(new cmCTestConfigureCommand);
this->AddCTestCommand(new cmCTestCoverageCommand);
this->AddCTestCommand(new cmCTestEmptyBinaryDirectoryCommand);
this->AddCTestCommand(new cmCTestMemCheckCommand);
this->AddCTestCommand(new cmCTestReadCustomFilesCommand);
this->AddCTestCommand(new cmCTestRunScriptCommand);
this->AddCTestCommand(new cmCTestSleepCommand);
this->AddCTestCommand(new cmCTestStartCommand);
this->AddCTestCommand(new cmCTestSubmitCommand);
this->AddCTestCommand(new cmCTestTestCommand);
this->AddCTestCommand(new cmCTestUpdateCommand);
2011-02-18 20:11:51 +03:00
this->AddCTestCommand(new cmCTestUploadCommand);
}
//----------------------------------------------------------------------
// this sets up some variables for the script to use, creates the required
// cmake instance and generators, and then reads in the script
2005-01-27 19:43:22 +03:00
int cmCTestScriptHandler::ReadInScript(const std::string& total_script_arg)
{
// Reset the error flag so that the script is read in no matter what
cmSystemTools::ResetErrorOccuredFlag();
// if the argument has a , in it then it needs to be broken into the fist
// argument (which is the script) and the second argument which will be
// passed into the scripts as S_ARG
std::string script = total_script_arg;
std::string script_arg;
if (total_script_arg.find(",") != std::string::npos)
{
script = total_script_arg.substr(0,total_script_arg.find(","));
script_arg = total_script_arg.substr(total_script_arg.find(",")+1);
}
// make sure the file exists
if (!cmSystemTools::FileExists(script.c_str()))
{
2004-09-28 17:00:06 +04:00
cmSystemTools::Error("Cannot find file: ", script.c_str());
return 1;
}
// read in the list file to fill the cache
// create a cmake instance to read the configuration script
this->CreateCMake();
2006-03-09 19:17:10 +03:00
// set a variable with the path to the current script
2006-03-10 23:03:09 +03:00
this->Makefile->AddDefinition("CTEST_SCRIPT_DIRECTORY",
cmSystemTools::GetFilenamePath(script).c_str());
2006-03-10 23:03:09 +03:00
this->Makefile->AddDefinition("CTEST_SCRIPT_NAME",
cmSystemTools::GetFilenameName(script).c_str());
2006-03-10 23:03:09 +03:00
this->Makefile->AddDefinition("CTEST_EXECUTABLE_NAME",
cmSystemTools::GetCTestCommand().c_str());
2006-03-10 23:03:09 +03:00
this->Makefile->AddDefinition("CMAKE_EXECUTABLE_NAME",
cmSystemTools::GetCMakeCommand().c_str());
2006-03-10 23:03:09 +03:00
this->Makefile->AddDefinition("CTEST_RUN_CURRENT_SCRIPT", true);
2005-01-27 18:11:04 +03:00
this->UpdateElapsedTime();
2006-03-09 19:17:10 +03:00
// add the script arg if defined
if (!script_arg.empty())
{
2006-03-10 23:03:09 +03:00
this->Makefile->AddDefinition("CTEST_SCRIPT_ARG", script_arg.c_str());
}
2005-01-27 18:11:04 +03:00
#if defined(__CYGWIN__)
this->Makefile->AddDefinition("CMAKE_LEGACY_CYGWIN_WIN32", "0");
#endif
2005-01-27 18:11:04 +03:00
// always add a function blocker to update the elapsed time
cmCTestScriptFunctionBlocker *f = new cmCTestScriptFunctionBlocker();
2006-03-10 23:03:09 +03:00
f->CTestScriptHandler = this;
this->Makefile->AddFunctionBlocker(f);
2006-03-09 19:17:10 +03:00
2011-03-11 16:04:58 +03:00
/* Execute CTestScriptMode.cmake, which loads CMakeDetermineSystem and
CMakeSystemSpecificInformation, so
that variables like CMAKE_SYSTEM and also the search paths for libraries,
header and executables are set correctly and can be used. Makes new-style
ctest scripting easier. */
2011-03-11 16:04:58 +03:00
std::string systemFile =
this->Makefile->GetModulesFile("CTestScriptMode.cmake");
if (!this->Makefile->ReadListFile(systemFile.c_str()) ||
cmSystemTools::GetErrorOccuredFlag())
2011-03-11 16:04:58 +03:00
{
cmCTestLog(this->CTest, ERROR_MESSAGE, "Error in read:"
<< systemFile << "\n");
return 2;
}
// Add definitions of variables passed in on the command line:
const std::map<std::string, std::string> &defs =
this->CTest->GetDefinitions();
for (std::map<std::string, std::string>::const_iterator it = defs.begin();
it != defs.end(); ++it)
{
this->Makefile->AddDefinition(it->first, it->second.c_str());
}
// finally read in the script
if (!this->Makefile->ReadListFile(script.c_str()) ||
cmSystemTools::GetErrorOccuredFlag())
{
2011-03-11 16:04:58 +03:00
// Reset the error flag so that it can run more than
// one script with an error when you use ctest_run_script.
cmSystemTools::ResetErrorOccuredFlag();
return 2;
}
2006-03-09 19:17:10 +03:00
return 0;
}
//----------------------------------------------------------------------
// extract variabels from the script to set ivars
int cmCTestScriptHandler::ExtractVariables()
{
// Temporary variables
const char* minInterval;
const char* contDuration;
2006-03-10 23:03:09 +03:00
this->SourceDir
= this->Makefile->GetSafeDefinition("CTEST_SOURCE_DIRECTORY");
this->BinaryDir
= this->Makefile->GetSafeDefinition("CTEST_BINARY_DIRECTORY");
// add in translations for src and bin
cmSystemTools::AddKeepPath(this->SourceDir);
cmSystemTools::AddKeepPath(this->BinaryDir);
2006-03-10 23:03:09 +03:00
this->CTestCmd
= this->Makefile->GetSafeDefinition("CTEST_COMMAND");
this->CVSCheckOut
= this->Makefile->GetSafeDefinition("CTEST_CVS_CHECKOUT");
this->CTestRoot
= this->Makefile->GetSafeDefinition("CTEST_DASHBOARD_ROOT");
this->UpdateCmd
= this->Makefile->GetSafeDefinition("CTEST_UPDATE_COMMAND");
if ( this->UpdateCmd.empty() )
{
this->UpdateCmd
= this->Makefile->GetSafeDefinition("CTEST_CVS_COMMAND");
}
2006-03-10 23:03:09 +03:00
this->CTestEnv
= this->Makefile->GetSafeDefinition("CTEST_ENVIRONMENT");
this->InitialCache
2006-03-10 23:03:09 +03:00
= this->Makefile->GetSafeDefinition("CTEST_INITIAL_CACHE");
this->CMakeCmd
= this->Makefile->GetSafeDefinition("CTEST_CMAKE_COMMAND");
this->CMOutFile
= this->Makefile->GetSafeDefinition("CTEST_CMAKE_OUTPUT_FILE_NAME");
this->Backup
= this->Makefile->IsOn("CTEST_BACKUP_AND_RESTORE");
this->EmptyBinDir
= this->Makefile->IsOn("CTEST_START_WITH_EMPTY_BINARY_DIRECTORY");
this->EmptyBinDirOnce
= this->Makefile->IsOn("CTEST_START_WITH_EMPTY_BINARY_DIRECTORY_ONCE");
2006-03-09 19:17:10 +03:00
minInterval
2006-03-10 23:03:09 +03:00
= this->Makefile->GetDefinition("CTEST_CONTINUOUS_MINIMUM_INTERVAL");
contDuration
= this->Makefile->GetDefinition("CTEST_CONTINUOUS_DURATION");
char updateVar[40];
int i;
for (i = 1; i < 10; ++i)
{
sprintf(updateVar,"CTEST_EXTRA_UPDATES_%i",i);
2006-03-10 23:03:09 +03:00
const char *updateVal = this->Makefile->GetDefinition(updateVar);
if ( updateVal )
{
if ( this->UpdateCmd.empty() )
{
2006-03-09 19:17:10 +03:00
cmSystemTools::Error(updateVar,
" specified without specifying CTEST_CVS_COMMAND.");
return 12;
}
2006-03-10 23:03:09 +03:00
this->ExtraUpdates.push_back(updateVal);
}
}
// in order to backup and restore we also must have the cvs root
2006-03-10 23:03:09 +03:00
if (this->Backup && this->CVSCheckOut.empty())
{
cmSystemTools::Error(
2006-03-09 19:17:10 +03:00
"Backup was requested without specifying CTEST_CVS_CHECKOUT.");
return 3;
}
2006-03-09 19:17:10 +03:00
// make sure the required info is here
2006-03-10 23:03:09 +03:00
if (this->SourceDir.empty() ||
this->BinaryDir.empty() ||
this->CTestCmd.empty())
{
std::string msg = "CTEST_SOURCE_DIRECTORY = ";
msg += (!this->SourceDir.empty()) ? this->SourceDir.c_str() : "(Null)";
msg += "\nCTEST_BINARY_DIRECTORY = ";
msg += (!this->BinaryDir.empty()) ? this->BinaryDir.c_str() : "(Null)";
msg += "\nCTEST_COMMAND = ";
msg += (!this->CTestCmd.empty()) ? this->CTestCmd.c_str() : "(Null)";
cmSystemTools::Error(
"Some required settings in the configuration file were missing:\n",
2006-03-10 23:03:09 +03:00
msg.c_str());
return 4;
}
2006-03-09 19:17:10 +03:00
// if the dashboard root isn't specified then we can compute it from the
2006-03-10 23:03:09 +03:00
// this->SourceDir
if (this->CTestRoot.empty() )
{
2006-03-10 23:03:09 +03:00
this->CTestRoot = cmSystemTools::GetFilenamePath(this->SourceDir).c_str();
}
// the script may override the minimum continuous interval
if (minInterval)
{
2006-03-10 23:03:09 +03:00
this->MinimumInterval = 60 * atof(minInterval);
}
if (contDuration)
{
2006-03-10 23:03:09 +03:00
this->ContinuousDuration = 60.0 * atof(contDuration);
}
2006-03-09 19:17:10 +03:00
2005-01-27 18:11:04 +03:00
this->UpdateElapsedTime();
return 0;
}
//----------------------------------------------------------------------
2005-01-27 18:11:04 +03:00
void cmCTestScriptHandler::SleepInSeconds(unsigned int secondsToWait)
{
#if defined(_WIN32)
Sleep(1000*secondsToWait);
#else
sleep(secondsToWait);
#endif
}
//----------------------------------------------------------------------
// run a specific script
int cmCTestScriptHandler::RunConfigurationScript
(const std::string& total_script_arg, bool pscope)
{
#ifdef CMAKE_BUILD_WITH_CMAKE
cmSystemTools::SaveRestoreEnvironment sre;
#endif
int result;
2006-03-09 19:17:10 +03:00
2006-03-10 23:03:09 +03:00
this->ScriptStartTime =
2005-01-27 18:11:04 +03:00
cmSystemTools::GetTime();
2006-03-09 19:17:10 +03:00
// read in the script
if (pscope)
{
cmCTestLog(this->CTest, HANDLER_VERBOSE_OUTPUT,
"Reading Script: " << total_script_arg << std::endl);
result = this->ReadInScript(total_script_arg);
}
else
{
cmCTestLog(this->CTest, HANDLER_VERBOSE_OUTPUT,
"Executing Script: " << total_script_arg << std::endl);
result = this->ExecuteScript(total_script_arg);
}
if (result)
{
return result;
}
2006-03-09 19:17:10 +03:00
// only run the curent script if we should
2006-03-10 23:03:09 +03:00
if (this->Makefile && this->Makefile->IsOn("CTEST_RUN_CURRENT_SCRIPT"))
2005-01-27 18:11:04 +03:00
{
return this->RunCurrentScript();
2005-01-27 18:11:04 +03:00
}
return result;
}
//----------------------------------------------------------------------
int cmCTestScriptHandler::RunCurrentScript()
2005-01-27 18:11:04 +03:00
{
int result;
// do not run twice
2006-03-10 23:03:09 +03:00
this->Makefile->AddDefinition("CTEST_RUN_CURRENT_SCRIPT", false);
2005-01-27 18:11:04 +03:00
// no popup widows
cmSystemTools::SetRunCommandHideConsole(true);
2006-03-09 19:17:10 +03:00
// extract the vars from the cache and store in ivars
result = this->ExtractVariables();
if (result)
{
return result;
}
2006-03-09 19:17:10 +03:00
// set any environment variables
2006-03-10 23:03:09 +03:00
if (!this->CTestEnv.empty())
{
std::vector<std::string> envArgs;
cmSystemTools::ExpandListArgument(this->CTestEnv,envArgs);
cmSystemTools::AppendEnv(envArgs);
}
// now that we have done most of the error checking finally run the
// dashboard, we may be asked to repeatedly run this dashboard, such as
// for a continuous, do we ned to run it more than once?
2006-03-10 23:03:09 +03:00
if ( this->ContinuousDuration >= 0 )
{
2005-01-27 18:11:04 +03:00
this->UpdateElapsedTime();
2006-03-10 23:03:09 +03:00
double ending_time = cmSystemTools::GetTime() + this->ContinuousDuration;
if (this->EmptyBinDirOnce)
{
2006-03-10 23:03:09 +03:00
this->EmptyBinDir = true;
}
do
{
double interval = cmSystemTools::GetTime();
result = this->RunConfigurationDashboard();
interval = cmSystemTools::GetTime() - interval;
2006-03-10 23:03:09 +03:00
if (interval < this->MinimumInterval)
{
2005-01-27 18:11:04 +03:00
this->SleepInSeconds(
2006-03-10 23:03:09 +03:00
static_cast<unsigned int>(this->MinimumInterval - interval));
}
2006-03-10 23:03:09 +03:00
if (this->EmptyBinDirOnce)
{
2006-03-10 23:03:09 +03:00
this->EmptyBinDir = false;
}
}
while (cmSystemTools::GetTime() < ending_time);
}
// otherwise just run it once
else
{
result = this->RunConfigurationDashboard();
}
return result;
}
//----------------------------------------------------------------------
int cmCTestScriptHandler::CheckOutSourceDir()
{
std::string command;
std::string output;
int retVal;
2006-03-09 19:17:10 +03:00
bool res;
2006-03-10 23:03:09 +03:00
if (!cmSystemTools::FileExists(this->SourceDir.c_str()) &&
!this->CVSCheckOut.empty())
{
// we must now checkout the src dir
output = "";
2006-03-10 23:03:09 +03:00
cmCTestLog(this->CTest, HANDLER_VERBOSE_OUTPUT,
"Run cvs: " << this->CVSCheckOut << std::endl);
res = cmSystemTools::RunSingleCommand(
this->CVSCheckOut.c_str(), &output, &output,
2006-03-10 23:03:09 +03:00
&retVal, this->CTestRoot.c_str(), this->HandlerVerbose,
0 /*this->TimeOut*/);
if (!res || retVal != 0)
{
2006-03-09 19:17:10 +03:00
cmSystemTools::Error("Unable to perform cvs checkout:\n",
output.c_str());
return 6;
}
}
return 0;
}
//----------------------------------------------------------------------
int cmCTestScriptHandler::BackupDirectories()
{
int retVal;
// compute the backup names
2006-03-10 23:03:09 +03:00
this->BackupSourceDir = this->SourceDir;
this->BackupSourceDir += "_CMakeBackup";
this->BackupBinaryDir = this->BinaryDir;
this->BackupBinaryDir += "_CMakeBackup";
2006-03-09 19:17:10 +03:00
// backup the binary and src directories if requested
2006-03-10 23:03:09 +03:00
if (this->Backup)
{
// if for some reason those directories exist then first delete them
2006-03-10 23:03:09 +03:00
if (cmSystemTools::FileExists(this->BackupSourceDir.c_str()))
{
cmSystemTools::RemoveADirectory(this->BackupSourceDir);
}
2006-03-10 23:03:09 +03:00
if (cmSystemTools::FileExists(this->BackupBinaryDir.c_str()))
{
cmSystemTools::RemoveADirectory(this->BackupBinaryDir);
}
2006-03-09 19:17:10 +03:00
// first rename the src and binary directories
2006-03-10 23:03:09 +03:00
rename(this->SourceDir.c_str(), this->BackupSourceDir.c_str());
rename(this->BinaryDir.c_str(), this->BackupBinaryDir.c_str());
2006-03-09 19:17:10 +03:00
// we must now checkout the src dir
retVal = this->CheckOutSourceDir();
if (retVal)
{
this->RestoreBackupDirectories();
return retVal;
}
}
return 0;
}
//----------------------------------------------------------------------
int cmCTestScriptHandler::PerformExtraUpdates()
{
std::string command;
std::string output;
int retVal;
2006-03-09 19:17:10 +03:00
bool res;
// do an initial cvs update as required
command = this->UpdateCmd;
std::vector<std::string>::iterator it;
2006-03-10 23:03:09 +03:00
for (it = this->ExtraUpdates.begin();
it != this->ExtraUpdates.end();
++ it )
{
std::vector<std::string> cvsArgs;
cmSystemTools::ExpandListArgument(*it,cvsArgs);
if (cvsArgs.size() == 2)
{
std::string fullCommand = command;
fullCommand += " update ";
fullCommand += cvsArgs[1];
output = "";
retVal = 0;
cmCTestLog(this->CTest, HANDLER_VERBOSE_OUTPUT, "Run Update: "
<< fullCommand << std::endl);
res = cmSystemTools::RunSingleCommand(
fullCommand.c_str(), &output, &output,
&retVal, cvsArgs[0].c_str(),
2006-03-10 23:03:09 +03:00
this->HandlerVerbose, 0 /*this->TimeOut*/);
if (!res || retVal != 0)
{
cmSystemTools::Error("Unable to perform extra updates:\n",
2006-07-07 21:59:35 +04:00
it->c_str(), "\nWith output:\n",
output.c_str());
return 0;
}
}
}
return 0;
}
//----------------------------------------------------------------------
// run a single dashboard entry
int cmCTestScriptHandler::RunConfigurationDashboard()
{
// local variables
std::string command;
std::string output;
int retVal;
2006-03-09 19:17:10 +03:00
bool res;
// make sure the src directory is there, if it isn't then we might be able
// to check it out from cvs
retVal = this->CheckOutSourceDir();
if (retVal)
{
return retVal;
}
// backup the dirs if requested
retVal = this->BackupDirectories();
if (retVal)
{
return retVal;
}
2006-03-09 19:17:10 +03:00
// clear the binary directory?
2006-03-10 23:03:09 +03:00
if (this->EmptyBinDir)
{
2006-03-10 23:03:09 +03:00
if ( !cmCTestScriptHandler::EmptyBinaryDirectory(
this->BinaryDir.c_str()) )
2005-02-17 00:06:11 +03:00
{
2006-03-10 23:03:09 +03:00
cmCTestLog(this->CTest, ERROR_MESSAGE,
2006-03-09 19:17:10 +03:00
"Problem removing the binary directory" << std::endl);
2005-02-17 00:06:11 +03:00
}
}
2006-03-09 19:17:10 +03:00
// make sure the binary directory exists if it isn't the srcdir
2006-03-10 23:03:09 +03:00
if (!cmSystemTools::FileExists(this->BinaryDir.c_str()) &&
this->SourceDir != this->BinaryDir)
{
2006-03-10 23:03:09 +03:00
if (!cmSystemTools::MakeDirectory(this->BinaryDir.c_str()))
{
2006-03-09 19:17:10 +03:00
cmSystemTools::Error("Unable to create the binary directory:\n",
2006-03-10 23:03:09 +03:00
this->BinaryDir.c_str());
this->RestoreBackupDirectories();
return 7;
}
}
// if the binary directory and the source directory are the same,
// and we are starting with an empty binary directory, then that means
// we must check out the source tree
2006-03-10 23:03:09 +03:00
if (this->EmptyBinDir && this->SourceDir == this->BinaryDir)
{
// make sure we have the required info
2006-03-10 23:03:09 +03:00
if (this->CVSCheckOut.empty())
{
2006-03-09 19:17:10 +03:00
cmSystemTools::Error("You have specified the source and binary "
"directories to be the same (an in source build). You have also "
"specified that the binary directory is to be erased. This means "
"that the source will have to be checked out from CVS. But you have "
"not specified CTEST_CVS_CHECKOUT");
return 8;
}
2006-03-09 19:17:10 +03:00
// we must now checkout the src dir
retVal = this->CheckOutSourceDir();
if (retVal)
{
this->RestoreBackupDirectories();
return retVal;
}
}
2006-03-09 19:17:10 +03:00
// backup the dirs if requested
retVal = this->PerformExtraUpdates();
if (retVal)
{
return retVal;
}
// put the initial cache into the bin dir
if (!this->InitialCache.empty())
{
2011-03-11 16:04:58 +03:00
if (!this->WriteInitialCache(this->BinaryDir.c_str(),
this->InitialCache.c_str()))
{
this->RestoreBackupDirectories();
return 9;
}
}
// do an initial cmake to setup the DartConfig file
int cmakeFailed = 0;
std::string cmakeFailedOuput;
2006-03-10 23:03:09 +03:00
if (!this->CMakeCmd.empty())
{
2006-03-10 23:03:09 +03:00
command = this->CMakeCmd;
command += " \"";
2006-03-10 23:03:09 +03:00
command += this->SourceDir;
output = "";
command += "\"";
retVal = 0;
2006-03-10 23:03:09 +03:00
cmCTestLog(this->CTest, HANDLER_VERBOSE_OUTPUT, "Run cmake command: "
<< command << std::endl);
res = cmSystemTools::RunSingleCommand(
command.c_str(), &output, &output,
2006-03-10 23:03:09 +03:00
&retVal, this->BinaryDir.c_str(),
this->HandlerVerbose, 0 /*this->TimeOut*/);
2004-09-28 17:00:06 +04:00
2006-03-10 23:03:09 +03:00
if ( !this->CMOutFile.empty() )
2004-09-28 17:00:06 +04:00
{
2006-03-10 23:03:09 +03:00
std::string cmakeOutputFile = this->CMOutFile;
2004-09-28 17:00:06 +04:00
if ( !cmSystemTools::FileIsFullPath(cmakeOutputFile.c_str()) )
{
2006-03-10 23:03:09 +03:00
cmakeOutputFile = this->BinaryDir + "/" + cmakeOutputFile;
2004-09-28 17:00:06 +04:00
}
2006-03-10 23:03:09 +03:00
cmCTestLog(this->CTest, HANDLER_VERBOSE_OUTPUT,
"Write CMake output to file: " << cmakeOutputFile
<< std::endl);
cmGeneratedFileStream fout(cmakeOutputFile.c_str());
2004-09-28 17:00:06 +04:00
if ( fout )
{
fout << output.c_str();
}
else
{
2006-03-10 23:03:09 +03:00
cmCTestLog(this->CTest, ERROR_MESSAGE,
"Cannot open CMake output file: "
<< cmakeOutputFile << " for writing" << std::endl);
2004-09-28 17:00:06 +04:00
}
}
if (!res || retVal != 0)
{
// even if this fails continue to the next step
cmakeFailed = 1;
cmakeFailedOuput = output;
}
}
// run ctest, it may be more than one command in here
std::vector<std::string> ctestCommands;
2006-03-10 23:03:09 +03:00
cmSystemTools::ExpandListArgument(this->CTestCmd,ctestCommands);
// for each variable/argument do a putenv
for (unsigned i = 0; i < ctestCommands.size(); ++i)
{
command = ctestCommands[i];
output = "";
retVal = 0;
2006-03-10 23:03:09 +03:00
cmCTestLog(this->CTest, HANDLER_VERBOSE_OUTPUT, "Run ctest command: "
<< command << std::endl);
res = cmSystemTools::RunSingleCommand(
command.c_str(), &output, &output,
2006-03-10 23:03:09 +03:00
&retVal, this->BinaryDir.c_str(), this->HandlerVerbose,
0 /*this->TimeOut*/);
2006-03-09 19:17:10 +03:00
// did something critical fail in ctest
if (!res || cmakeFailed ||
retVal & cmCTest::BUILD_ERRORS)
{
this->RestoreBackupDirectories();
if (cmakeFailed)
{
2006-03-10 23:03:09 +03:00
cmCTestLog(this->CTest, ERROR_MESSAGE,
"Unable to run cmake:" << std::endl
<< cmakeFailedOuput << std::endl);
return 10;
}
2006-03-10 23:03:09 +03:00
cmCTestLog(this->CTest, ERROR_MESSAGE,
"Unable to run ctest:" << std::endl
<< "command: " << command << std::endl
<< "output: " << output << std::endl);
if (!res)
{
return 11;
}
return retVal * 100;
}
}
2006-03-09 19:17:10 +03:00
// if all was succesful, delete the backup dirs to free up disk space
2006-03-10 23:03:09 +03:00
if (this->Backup)
{
cmSystemTools::RemoveADirectory(this->BackupSourceDir);
cmSystemTools::RemoveADirectory(this->BackupBinaryDir);
}
2006-03-09 19:17:10 +03:00
return 0;
}
//-------------------------------------------------------------------------
2011-03-11 16:04:58 +03:00
bool cmCTestScriptHandler::WriteInitialCache(const char* directory,
const char* text)
{
std::string cacheFile = directory;
cacheFile += "/CMakeCache.txt";
cmGeneratedFileStream fout(cacheFile.c_str());
if(!fout)
{
return false;
}
if (text!=0)
{
fout.write(text, strlen(text));
}
// Make sure the operating system has finished writing the file
// before closing it. This will ensure the file is finished before
// the check below.
fout.flush();
fout.close();
return true;
}
//-------------------------------------------------------------------------
void cmCTestScriptHandler::RestoreBackupDirectories()
{
// if we backed up the dirs and the build failed, then restore
// the backed up dirs
2006-03-10 23:03:09 +03:00
if (this->Backup)
{
// if for some reason those directories exist then first delete them
2006-03-10 23:03:09 +03:00
if (cmSystemTools::FileExists(this->SourceDir.c_str()))
{
cmSystemTools::RemoveADirectory(this->SourceDir);
}
2006-03-10 23:03:09 +03:00
if (cmSystemTools::FileExists(this->BinaryDir.c_str()))
{
cmSystemTools::RemoveADirectory(this->BinaryDir);
}
2006-03-09 19:17:10 +03:00
// rename the src and binary directories
2006-03-10 23:03:09 +03:00
rename(this->BackupSourceDir.c_str(), this->SourceDir.c_str());
rename(this->BackupBinaryDir.c_str(), this->BinaryDir.c_str());
}
}
2011-03-11 16:04:58 +03:00
bool cmCTestScriptHandler::RunScript(cmCTest* ctest, const char *sname,
bool InProcess, int* returnValue)
2005-01-27 18:11:04 +03:00
{
cmCTestScriptHandler* sh = new cmCTestScriptHandler();
2005-01-27 19:43:22 +03:00
sh->SetCTestInstance(ctest);
sh->AddConfigurationScript(sname,InProcess);
int res = sh->ProcessHandler();
if(returnValue)
{
*returnValue = res;
}
2005-01-27 18:11:04 +03:00
delete sh;
return true;
}
2005-01-27 18:11:04 +03:00
bool cmCTestScriptHandler::EmptyBinaryDirectory(const char *sname)
{
// try to avoid deleting root
if (!sname || strlen(sname) < 2)
{
return false;
}
2006-03-09 19:17:10 +03:00
// consider non existing target directory a success
if(!cmSystemTools::FileExists(sname))
{
return true;
}
2005-01-27 18:11:04 +03:00
// try to avoid deleting directories that we shouldn't
std::string check = sname;
check += "/CMakeCache.txt";
if(!cmSystemTools::FileExists(check.c_str()))
2005-01-27 18:11:04 +03:00
{
return false;
2005-01-27 18:11:04 +03:00
}
for(int i = 0; i < 5; ++i)
{
if(TryToRemoveBinaryDirectoryOnce(sname))
{
return true;
}
cmSystemTools::Delay(100);
}
return false;
}
//-------------------------------------------------------------------------
bool cmCTestScriptHandler::TryToRemoveBinaryDirectoryOnce(
const std::string& directoryPath)
{
cmsys::Directory directory;
directory.Load(directoryPath);
for(unsigned long i = 0; i < directory.GetNumberOfFiles(); ++i)
{
std::string path = directory.GetFile(i);
if(path == "." || path == ".." || path == "CMakeCache.txt")
{
continue;
}
std::string fullPath = directoryPath + std::string("/") + path;
bool isDirectory = cmSystemTools::FileIsDirectory(fullPath) &&
!cmSystemTools::FileIsSymlink(fullPath);
if(isDirectory)
{
if(!cmSystemTools::RemoveADirectory(fullPath))
{
return false;
}
}
else
{
if(!cmSystemTools::RemoveFile(fullPath))
{
return false;
}
}
}
return cmSystemTools::RemoveADirectory(directoryPath);
2005-01-27 18:11:04 +03:00
}
//-------------------------------------------------------------------------
double cmCTestScriptHandler::GetRemainingTimeAllowed()
{
if (!this->Makefile)
{
return 1.0e7;
}
const char *timelimitS
= this->Makefile->GetDefinition("CTEST_TIME_LIMIT");
2011-03-11 16:04:58 +03:00
if (!timelimitS)
{
return 1.0e7;
}
double timelimit = atof(timelimitS);
2011-03-11 16:04:58 +03:00
return timelimit - cmSystemTools::GetTime() + this->ScriptStartTime;
}