ctest.cxx 8.89 KB
Newer Older
Will Schroeder's avatar
Will Schroeder committed
1
2
/*=========================================================================

3
  Program:   CMake - Cross-Platform Makefile Generator
Will Schroeder's avatar
Will Schroeder committed
4
5
6
7
8
  Module:    $RCSfile$
  Language:  C++
  Date:      $Date$
  Version:   $Revision$

9
10
  Copyright (c) 2002 Kitware, Inc., Insight Consortium.  All rights reserved.
  See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
Will Schroeder's avatar
Will Schroeder committed
11
12
13
14
15
16

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
17
#include "cmCTest.h"
Bill Hoffman's avatar
Bill Hoffman committed
18
#include "cmSystemTools.h"
19

20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
// Need these for documentation support.
#include "cmake.h"
#include "cmDocumentation.h"

//----------------------------------------------------------------------------
static const cmDocumentationEntry cmDocumentationName[] =
{
  {0,
   "  ctest - Testing driver provided by CMake.", 0},
  {0,0,0}
};

//----------------------------------------------------------------------------
static const cmDocumentationEntry cmDocumentationUsage[] =
{
  {0,
   "  ctest [options]", 0},
  {0,0,0}
};

//----------------------------------------------------------------------------
static const cmDocumentationEntry cmDocumentationDescription[] =
{
  {0,
   "The \"ctest\" executable is the CMake test driver program.  "
   "CMake-generated build trees created for projects that use "
   "the ENABLE_TESTING and ADD_TEST commands have testing support.  "
   "This program will run the tests and report results.", 0},
  CMAKE_STANDARD_INTRODUCTION,
  {0,0,0}
};

//----------------------------------------------------------------------------
static const cmDocumentationEntry cmDocumentationOptions[] =
{
  {"-C <config>", "Choose configuration to test.",
   "Some CMake-generated build trees can have multiple build configurations "
   "in the same tree.  This option can be used to specify which one should "
   "be tested.  Example configurations are \"Debug\" and \"Release\"."},
  {"-V,--verbose", "Enable verbose output from tests.",
   "Test output is normally suppressed and only summary information is "
   "displayed.  This option will show all test output."},
  {"-N,--show-only", "Disable actual execution of tests.",
   "This option tells ctest to list the tests that would be run but not "
   "actually run them.  Useful in conjunction with the -R and -E options."},
  {"-R <regex>", "Run tests matching regular expression.",
   "This option tells ctest to run only the tests whose names match the "
   "given regular expression."},
  {"-E <regex>", "Exclude tests matching regular expression.",
   "This option tells ctest to NOT run the tests whose names match the "
   "given regular expression."},
71
72
73
74
75
  {"-D <DashboardTest>", "Execute dashboard test",
   "This option tells ctest to perform act as a Dart client and perform "
   "a dashboard test. All tests are ModeTest, where Mode can be Experimental, "
   "Nightly, and Continuous, and Test can be Start, Update, Configure, "
   "Build, Test, Coverage, and Submit."},
Ken Martin's avatar
Ken Martin committed
76
77
78
79
80
81
82
83
  {"-M <TestModel>", "Sets the model for a dashboard",
   "This option tells ctest to act as a Dart client "
   "where the TestModel can be Experimental, "
   "Nightly, and Continuous. Combining -M and -T is similar to -D"},
  {"-T <action>", "Sets the dashboard action to perform",
   "This option tells ctest to act as a Dart client "
   "and perform some action such as start, build, test etc. "
   "Combining -M and -T is similar to -D"},
Ken Martin's avatar
Ken Martin committed
84
85
86
87
88
89
  {"-S <ConfigScript>", "Execute a dashboard for a configuration",
   "This option tells ctest to load in a configuration script which sets "
   "a number of parameters such as the binary and source directories. Then "
   "ctest will do what is required to create and run a dashboard. This "
   "option basically sets up a dashboard and then runs ctest -D with the "
   "appropriate options."},
90
91
  {"-A <Notes file>", "Add a notes file with submission",
   "This option tells ctest to include a notes file when submitting dashboard. "},
92
93
94
95
96
97
98
  {"-I [Start,End,Stride,test#,test#|Test file]", 
   "Run a specific number of tests by number.",
   "This option causes ctest to run tests starting at number Start, ending "
   "at number End, and incrementing by Stride. Any additional numbers after "
   "Stride are considered individual test numbers.  Start, End,or stride "
   "can be empty.  Optionally a file can be given that contains the same "
   "syntax as the command line."},
Ken Martin's avatar
Ken Martin committed
99
100
  {"-U", "Take the Union of -I and -R",
   "When both -R and -I are specified by default the intersection of "
101
   "tests are run. By specifying -U the union of tests is run instead."},
Bill Hoffman's avatar
Bill Hoffman committed
102
  {"--interactive-debug-mode [0|1]", "Set the interactive mode to 0 or 1.",
103
104
105
106
107
108
109

   "This option causes ctest to run tests in either an interactive mode or "
   "a non-interactive mode. On Windows this means that in non-interactive "
   "mode, all system debug pop up windows are blocked. In dashboard mode "
   "(Experimental, Nightly, Continuous), the default is non-interactive.  "
   "When just running tests not for a dashboard the default is to allow "
   "popups and interactive "
Bill Hoffman's avatar
Bill Hoffman committed
110
   "debugging."},
111
112
113
114
115
116
117
118
119
120
121
  {"--build-and-test", "Configure, build and run a test.",
   "This option tells ctest to configure (i.e. run cmake on), build, and or "
   "execute a test. The configure and test steps are optional. The arguments "
   "to this command line are the source and binary directories. By default "
   "this will run CMake on the Source/Bin directories specified unless "
   "--build-nocmake is specified. Both --build-makeprogram and "
   "--build-generator MUST be provided to use --built-and-test. If "
   "--test-command is specified then that will be run after the build is "
   "complete. Other options that affect this mode are --build-target "
   "--build-nocmake, --build-run-dir, "
   "--build-two-config, --build-exe-dir, --build-project," 
Bill Hoffman's avatar
Bill Hoffman committed
122
123
124
125
126
127
128
129
130
131
132
133
134
   "--build-noclean, --build-options"},
  {"--build-target", "Specify a specific target to build.", 
   "This option goes with the --build-and-test option, if left out the all target is built." },
  {"--build-nocmake", "Run the build without running cmake first.", 
   "Skip the cmake step." },
  {"--build-run-dir", "Specify directory to run programs from.", 
   "Directory where programs will be after it has been compiled." },
  {"--build-two-config", "Run CMake twice", "" },
  {"--build-exe-dir", "Specify the directory for the executable.", "" },
  {"--build-generator", "Specify the generator to use.", "" },
  {"--build-project", "Specify the name of the project to build.", "" },
  {"--build-makeprogram", "Specify the make program to use.", "" },
  {"--build-noclean", "Skip the make clean step.", "" },
Ken Martin's avatar
Ken Martin committed
135
136
137
  {"--build-options", "Add extra options to the build step.", 
   "This option must be the last option with the exception of --test-command" },

138
  {"--test-command", "The test to run with the --build-and-test option.", "" },
Bill Hoffman's avatar
Bill Hoffman committed
139
140
  {"--tomorrow-tag", "Nightly or experimental starts with next day tag.", 
   "This is useful if the build will not finish in one day." },
141
142
143
144
145
146
147
148
149
150
151
  {0,0,0}
};

//----------------------------------------------------------------------------
static const cmDocumentationEntry cmDocumentationSeeAlso[] =
{
  {0, "cmake", 0},
  {0, "ccmake", 0},
  {0, 0, 0}
};

152
// this is a test driver program for cmCTest.
153
154
int main (int argc, char *argv[])
{
155
  cmSystemTools::EnableMSVCDebugHook();
156
157
158
159
160
161
162
163
164
  int nocwd = 0;

  if ( cmSystemTools::GetCurrentWorkingDirectory().size() == 0 )
    {
    std::cerr << "Current working directory cannot be established." << std::endl;
    nocwd = 1;
    }


165
166
167
168
169
170
  
  // If there is a testing input file, check for documentation options
  // only if there are actually arguments.  We want running without
  // arguments to run tests.
  if(argc > 1 || !cmSystemTools::FileExists("DartTestfile.txt"))
    {
171
172
173
174
175
176
    if(argc == 1)
      {
      std::cout << "*********************************" << std::endl;
      std::cout << "No test configuration file found!" << std::endl;
      std::cout << "*********************************" << std::endl;
      }
177
    cmDocumentation doc;
178
    if(doc.CheckOptions(argc, argv) || nocwd)
179
180
181
182
183
184
185
186
187
188
189
190
      {
      // Construct and print requested documentation.
      doc.SetName("ctest");
      doc.SetNameSection(cmDocumentationName);
      doc.SetUsageSection(cmDocumentationUsage);
      doc.SetDescriptionSection(cmDocumentationDescription);
      doc.SetOptionsSection(cmDocumentationOptions);
      doc.SetSeeAlsoList(cmDocumentationSeeAlso);
      return doc.PrintRequestedDocumentation(std::cout)? 0:1;
      }
    }
  
191
  
Ken Martin's avatar
Ken Martin committed
192
193
194
195
#ifdef _WIN32
  std::string comspec = "cmw9xcom.exe";
  cmSystemTools::SetWindows9xComspecSubstitute(comspec.c_str());
#endif
196
197
198
199
  cmCTest inst;
  // copy the args to a vector
  std::vector<std::string> args;
  for(int i =0; i < argc; ++i)
Ken Martin's avatar
Ken Martin committed
200
    {
201
    args.push_back(argv[i]);
Ken Martin's avatar
Ken Martin committed
202
    }
203
  // run ctest
204
205
  std::string output;
  int res = inst.Run(args,&output);
206
  std::cout << output;
207
208
209
  cmListFileCache::ClearCache();

  return res;
210
}
211