Source/cmTest.cxx

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmTest.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2009-08-11 13:07:28 $
   7   Version:   $Revision: 1.16 $
   8
   9   Copyright (c) 2002 Kitware, Inc., Insight Consortium.  All rights reserved.
  10   See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
  11
  12      This software is distributed WITHOUT ANY WARRANTY; without even
  13      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14      PURPOSE.  See the above copyright notices for more information.
  15
  16 =========================================================================*/
  17 #include "cmTest.h"
  18 #include "cmSystemTools.h"
  19
  20 #include "cmake.h"
  21 #include "cmMakefile.h"
  22
  23 //----------------------------------------------------------------------------
  24 cmTest::cmTest(cmMakefile* mf)
  25 {
  26   this->Makefile = mf;
  27   this->OldStyle = true;
  28   this->Properties.SetCMakeInstance(mf->GetCMakeInstance());
  29   this->Backtrace = new cmListFileBacktrace;
  30   this->Makefile->GetBacktrace(*this->Backtrace);
  31 }
  32
  33 //----------------------------------------------------------------------------
  34 cmTest::~cmTest()
  35 {
  36   delete this->Backtrace;
  37 }
  38
  39 //----------------------------------------------------------------------------
  40 cmListFileBacktrace const& cmTest::GetBacktrace() const
  41 {
  42   return *this->Backtrace;
  43 }
  44
  45 //----------------------------------------------------------------------------
  46 void cmTest::SetName(const char* name)
  47 {
  48   if ( !name )
  49     {
  50     name = "";
  51     }
  52   this->Name = name;
  53 }
  54
  55 //----------------------------------------------------------------------------
  56 void cmTest::SetCommand(std::vector<std::string> const& command)
  57 {
  58   this->Command = command;
  59 }
  60
  61 //----------------------------------------------------------------------------
  62 const char *cmTest::GetProperty(const char* prop) const
  63 {
  64   bool chain = false;
  65   const char *retVal =
  66     this->Properties.GetPropertyValue(prop, cmProperty::TEST, chain);
  67   if (chain)
  68     {
  69     return this->Makefile->GetProperty(prop,cmProperty::TEST);
  70     }
  71   return retVal;
  72 }
  73
  74 //----------------------------------------------------------------------------
  75 bool cmTest::GetPropertyAsBool(const char* prop) const
  76 {
  77   return cmSystemTools::IsOn(this->GetProperty(prop));
  78 }
  79
  80 //----------------------------------------------------------------------------
  81 void cmTest::SetProperty(const char* prop, const char* value)
  82 {
  83   if (!prop)
  84     {
  85     return;
  86     }
  87
  88   this->Properties.SetProperty(prop, value, cmProperty::TEST);
  89 }
  90
  91 //----------------------------------------------------------------------------
  92 void cmTest::AppendProperty(const char* prop, const char* value)
  93 {
  94   if (!prop)
  95     {
  96     return;
  97     }
  98   this->Properties.AppendProperty(prop, value, cmProperty::TEST);
  99 }
 100
 101 //----------------------------------------------------------------------------
 102 void cmTest::DefineProperties(cmake *cm)
 103 {
 104   cm->DefineProperty
 105     ("ENVIRONMENT", cmProperty::TEST,
 106      "Specify environment variables that should be defined for running "
 107      "a test.",
 108      "If set to a list of environment variables and values of the form "
 109      "MYVAR=value those environment variables will be defined while "
 110      "running the test. The environment is restored to its previous state "
 111      "after the test is done.");
 112
 113   cm->DefineProperty
 114     ("FAIL_REGULAR_EXPRESSION", cmProperty::TEST,
 115      "If the output matches this regular expression the test will fail.",
 116      "If set, if the output matches one of "
 117      "specified regular expressions, the test will fail."
 118      "For example: PASS_REGULAR_EXPRESSION \"[^a-z]Error;ERROR;Failed\"");
 119
 120   cm->DefineProperty
 121     ("LABELS", cmProperty::TEST,
 122      "Specify a list of text labels associated with a test.",
 123      "The list is reported in dashboard submissions.");
 124
 125   cm->DefineProperty
 126     ("MEASUREMENT", cmProperty::TEST,
 127      "Specify a CDASH measurement and value to be reported for a test.",
 128      "If set to a name then that name will be reported to CDASH as a "
 129      "named measurement with a value of 1. You may also specify a value "
 130      "by setting MEASUREMENT to \"measurement=value\".");
 131
 132   cm->DefineProperty
 133     ("PASS_REGULAR_EXPRESSION", cmProperty::TEST,
 134      "The output must match this regular expression for the test to pass.",
 135      "If set, the test output will be checked "
 136      "against the specified regular expressions and at least one of the"
 137      " regular expressions has to match, otherwise the test will fail.");
 138
 139   cm->DefineProperty
 140     ("TIMEOUT", cmProperty::TEST,
 141      "How many seconds to allow for this test.",
 142      "This property if set will limit a test to not take more than "
 143      "the specified number of seconds to run. If it exceeds that the "
 144      "test process will be killed and ctest will move to the next test. "
 145      "This setting takes precedence over "
 146      "CTEST_TESTING_TIMEOUT.");
 147
 148   cm->DefineProperty
 149     ("WILL_FAIL", cmProperty::TEST,
 150      "If set to true, this will invert the pass/fail flag of the test.",
 151      "This property can be used for tests that are expected to fail and "
 152      "return a non zero return code.");
 153 }