Source/cmTest.cxx

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmTest.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2008-04-01 18:22:07 $
   7   Version:   $Revision: 1.10 $
   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 cmTest::cmTest()
  24 {
  25   this->Makefile = 0;
  26 }
  27
  28 cmTest::~cmTest()
  29 {
  30 }
  31
  32 void cmTest::SetName(const char* name)
  33 {
  34   if ( !name )
  35     {
  36     name = "";
  37     }
  38   this->Name = name;
  39 }
  40
  41 void cmTest::SetCommand(const char* command)
  42 {
  43   if ( !command )
  44     {
  45     command = "";
  46     }
  47   this->Command = command;
  48   cmSystemTools::ConvertToUnixSlashes(this->Command);
  49 }
  50
  51 void cmTest::SetArguments(const std::vector<cmStdString>& args)
  52 {
  53   this->Args = args;
  54 }
  55
  56 const char *cmTest::GetProperty(const char* prop) const
  57 {
  58   bool chain = false;
  59   const char *retVal =
  60     this->Properties.GetPropertyValue(prop, cmProperty::TEST, chain);
  61   if (chain)
  62     {
  63     return this->Makefile->GetProperty(prop,cmProperty::TEST);
  64     }
  65   return retVal;
  66 }
  67
  68 bool cmTest::GetPropertyAsBool(const char* prop) const
  69 {
  70   return cmSystemTools::IsOn(this->GetProperty(prop));
  71 }
  72
  73 void cmTest::SetProperty(const char* prop, const char* value)
  74 {
  75   if (!prop)
  76     {
  77     return;
  78     }
  79
  80   this->Properties.SetProperty(prop, value, cmProperty::TEST);
  81 }
  82
  83 //----------------------------------------------------------------------------
  84 void cmTest::AppendProperty(const char* prop, const char* value)
  85 {
  86   if (!prop)
  87     {
  88     return;
  89     }
  90   this->Properties.AppendProperty(prop, value, cmProperty::TEST);
  91 }
  92
  93 //----------------------------------------------------------------------------
  94 void cmTest::SetMakefile(cmMakefile* mf)
  95 {
  96   // Set our makefile.
  97   this->Makefile = mf;
  98   this->Properties.SetCMakeInstance(mf->GetCMakeInstance());
  99 }
 100
 101 // define properties
 102 void cmTest::DefineProperties(cmake *cm)
 103 {
 104   // define properties
 105   cm->DefineProperty
 106     ("FAIL_REGULAR_EXPRESSION", cmProperty::TEST,
 107      "If the output matches this regular expression the test will fail.",
 108      "If set, if the output matches one of "
 109      "specified regular expressions, the test will fail."
 110      "For example: PASS_REGULAR_EXPRESSION \"[^a-z]Error;ERROR;Failed\"");
 111
 112   cm->DefineProperty
 113     ("MEASUREMENT", cmProperty::TEST,
 114      "Specify a DART measurement and value to be reported for a test.",
 115      "If set to a name then that name will be reported to DART as a "
 116      "named measurement with a value of 1. You may also specify a value "
 117      "by setting MEASUREMENT to \"measurement=value\".");
 118
 119   cm->DefineProperty
 120     ("PASS_REGULAR_EXPRESSION", cmProperty::TEST,
 121      "The output must match this regular expression for the test to pass.",
 122      "If set, the test output will be checked "
 123      "against the specified regular expressions and at least one of the"
 124      " regular expressions has to match, otherwise the test will fail.");
 125
 126   cm->DefineProperty
 127     ("TIMEOUT", cmProperty::TEST,
 128      "How many seconds to allow for this test.",
 129      "This property if set will limit a test to not take more than "
 130      "the specified number of seconds to run. If it exceeds that the "
 131      "test process will be killed and ctest will move to the next test. "
 132      "This setting takes precedence over DART_TESTING_TIMEOUT and "
 133      "CTEST_TESTING_TIMEOUT.");
 134
 135   cm->DefineProperty
 136     ("WILL_FAIL", cmProperty::TEST,
 137      "If set to true, this will invert the pass/fail flag of the test.",
 138      "This property can be used for tests that are expected to fail and "
 139      "return a non zero return code.");
 140 }