cmCTestTestHandler.h 7.84 KB
Newer Older
Ken Martin's avatar
Ken Martin committed
1
2
3
4
5
6
7
8
9
10
11
/*=========================================================================

  Program:   CMake - Cross-Platform Makefile Generator
  Module:    $RCSfile$
  Language:  C++
  Date:      $Date$
  Version:   $Revision$

  Copyright (c) 2002 Kitware, Inc. All rights reserved.
  See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.

Andy Cedilnik's avatar
Andy Cedilnik committed
12
13
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
Ken Martin's avatar
Ken Martin committed
14
15
16
17
18
19
20
21
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/

#ifndef cmCTestTestHandler_h
#define cmCTestTestHandler_h


22
#include "cmCTestGenericHandler.h"
23
#include <cmsys/RegularExpression.hxx>
Ken Martin's avatar
Ken Martin committed
24
25
26
27
28
29
30

class cmMakefile;

/** \class cmCTestTestHandler
 * \brief A class that handles ctest -S invocations
 *
 */
31
class cmCTestTestHandler : public cmCTestGenericHandler
Ken Martin's avatar
Ken Martin committed
32
33
{
public:
34
  cmTypeMacro(cmCTestTestHandler, cmCTestGenericHandler);
Ken Martin's avatar
Ken Martin committed
35

36
  /**
Ken Martin's avatar
Ken Martin committed
37
38
   * The main entry point for this class
   */
39
  int ProcessHandler();
Andy Cedilnik's avatar
Andy Cedilnik committed
40

41
  /**
42
43
44
45
   * When both -R and -I are used should te resulting test list be the
   * intersection or the union of the lists. By default it is the
   * intersection.
   */
Andy Cedilnik's avatar
Andy Cedilnik committed
46
  void SetUseUnion(bool val) { this->UseUnion = val; }
47

48
49
50
  /**
   * This method is called when reading CTest custom file
   */
51
  void PopulateCustomVectors(cmMakefile *mf);
Andy Cedilnik's avatar
Andy Cedilnik committed
52

Ken Martin's avatar
Ken Martin committed
53
54
55
56
57
58
  ///! Control the use of the regular expresisons, call these methods to turn
  ///them on
  void UseIncludeRegExp();
  void UseExcludeRegExp();
  void SetIncludeRegExp(const char *);
  void SetExcludeRegExp(const char *);
Andy Cedilnik's avatar
Andy Cedilnik committed
59

Ken Martin's avatar
Ken Martin committed
60
61
62
63

  ///! pass the -I argument down
  void SetTestsToRunInformation(const char*);

64
  cmCTestTestHandler();
Ken Martin's avatar
Ken Martin committed
65

66
67
68
69
70
  /*
   * Add the test to the list of tests to be executed
   */
  bool AddTest(const std::vector<std::string>& args);

71
72
73
74
75
  /*
   * Set tests properties
   */
  bool SetTestsProperties(const std::vector<std::string>& args);

76
77
  void Initialize();

Bill Hoffman's avatar
Bill Hoffman committed
78
79
80
81
  // NOTE: This struct is Saved/Restored
  // in cmCTestTestHandler, if you add to this class
  // then you must add the new members to that code or
  // ctest -j N will break for that feature
Andy Cedilnik's avatar
Andy Cedilnik committed
82
83
  struct cmCTestTestProperties
  {
Andy Cedilnik's avatar
Andy Cedilnik committed
84
85
86
    cmStdString Name;
    cmStdString Directory;
    std::vector<std::string> Args;
87
    std::vector<std::string> Depends;
Bill Hoffman's avatar
Bill Hoffman committed
88
89
90
91
    std::vector<std::pair<cmsys::RegularExpression,
                          std::string> > ErrorRegularExpressions;
    std::vector<std::pair<cmsys::RegularExpression,
                          std::string> > RequiredRegularExpressions;
92
    std::map<cmStdString, cmStdString> Measurements;
Andy Cedilnik's avatar
Andy Cedilnik committed
93
94
    bool IsInBasedOnREOptions;
    bool WillFail;
95
    double Timeout;
96
    int Index;
97
    std::vector<std::string> Environment;
98
    std::vector<std::string> Labels;
Andy Cedilnik's avatar
Andy Cedilnik committed
99
100
  };

101
102
103
104
  struct cmCTestTestResult
  {
    std::string Name;
    std::string Path;
105
    std::string Reason;
106
107
108
109
110
111
112
113
114
115
116
    std::string FullCommandLine;
    double      ExecutionTime;
    int         ReturnValue;
    int         Status;
    std::string CompletionStatus;
    std::string Output;
    std::string RegressionImages;
    int         TestCount;
    cmCTestTestProperties* Properties;
  };

117
118
119
120
121
122
123
124
125
126
127
128
129
130
  // add configuraitons to a search path for an executable
  static void AddConfigurations(cmCTest *ctest, 
                                std::vector<std::string> &attempted,
                                std::vector<std::string> &attemptedConfigs,
                                std::string filepath,
                                std::string &filename);

  // full signature static method to find an executable
  static std::string FindExecutable(cmCTest *ctest,
                                    const char *testCommand,
                                    std::string &resultingConfig,
                                    std::vector<std::string> &extraPaths,
                                    std::vector<std::string> &failed);

Andy Cedilnik's avatar
Andy Cedilnik committed
131
protected:
132
  // comput a final test list
133
134
135
136
137
  virtual int PreProcessHandler();
  virtual int PostProcessHandler();
  virtual void GenerateTestCommand(std::vector<const char*>& args);
  int ExecuteCommands(std::vector<cmStdString>& vec);

138
139
140
  void WriteTestResultHeader(std::ostream& os, cmCTestTestResult* result);
  void WriteTestResultFooter(std::ostream& os, cmCTestTestResult* result);

141
142
143
  //! Clean test output to specified length
  bool CleanTestOutput(std::string& output, size_t length);

Andy Cedilnik's avatar
Andy Cedilnik committed
144
  double                  ElapsedTestingTime;
145

Andy Cedilnik's avatar
Andy Cedilnik committed
146
147
  typedef std::vector<cmCTestTestResult> TestResultsVector;
  TestResultsVector    TestResults;
Ken Martin's avatar
Ken Martin committed
148

Andy Cedilnik's avatar
Andy Cedilnik committed
149
150
151
  std::vector<cmStdString> CustomTestsIgnore;
  std::string             StartTest;
  std::string             EndTest;
152
153
  unsigned int            StartTestTime;
  unsigned int            EndTestTime;
Andy Cedilnik's avatar
Andy Cedilnik committed
154
  bool MemCheck;
155
156
  int CustomMaximumPassedTestOutputSize;
  int CustomMaximumFailedTestOutputSize;
157
158
159
160
161
162
163
164
165
protected:
  /**
   *  Run one test
   */
  virtual void ProcessOneTest(cmCTestTestProperties *props,
                              std::vector<cmStdString> &passed,
                              std::vector<cmStdString> &failed,
                              int count, int tmsize);

166

167

168
public:
169
170
171
172
173
174
175
176
177
178
179
180
  enum { // Program statuses
    NOT_RUN = 0,
    TIMEOUT,
    SEGFAULT,
    ILLEGAL,
    INTERRUPT,
    NUMERICAL,
    OTHER_FAULT,
    FAILED,
    BAD_COMMAND,
    COMPLETED
  };
Ken Martin's avatar
Ken Martin committed
181

182
private:
Ken Martin's avatar
Ken Martin committed
183
184
185
  /**
   * Generate the Dart compatible output
   */
186
  virtual void GenerateDartOutput(std::ostream& os);
Ken Martin's avatar
Ken Martin committed
187

188
  void PrintLabelSummary();
Ken Martin's avatar
Ken Martin committed
189
  /**
190
   * Run the tests for a directory and any subdirectories
Ken Martin's avatar
Ken Martin committed
191
   */
Andy Cedilnik's avatar
Andy Cedilnik committed
192
  void ProcessDirectory(std::vector<cmStdString> &passed,
193
                        std::vector<cmStdString> &failed);
Andy Cedilnik's avatar
Andy Cedilnik committed
194

Andy Cedilnik's avatar
Andy Cedilnik committed
195
  typedef std::vector<cmCTestTestProperties> ListOfTests;
Ken Martin's avatar
Ken Martin committed
196
197
198
  /**
   * Get the list of tests in directory and subdirectories.
   */
199
  void GetListOfTests();
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
  // compute the lists of tests that will actually run
  // based on union regex and -I stuff
  void ComputeTestList();
  
  // Save the state of the test list and return the file
  // name it was saved to
  std::string SaveTestList();
  void LoadTestList();
  bool GetValue(const char* tag,
                std::string& value,
                std::ifstream& fin);
  bool GetValue(const char* tag,
                int& value,
                std::ifstream& fin);
  bool GetValue(const char* tag,
                size_t& value,
                std::ifstream& fin);
  bool GetValue(const char* tag,
                bool& value,
                std::ifstream& fin);
  bool GetValue(const char* tag,
                double& value,
                std::ifstream& fin);
  // run in -j N mode
  void ProcessParallel(std::vector<cmStdString> &passed,
                       std::vector<cmStdString> &failed);
Ken Martin's avatar
Ken Martin committed
226
227
228
229
230
231
  /**
   * Find the executable for a test
   */
  std::string FindTheExecutable(const char *exe);

  const char* GetTestStatus(int status);
Bill Hoffman's avatar
Bill Hoffman committed
232
  void ExpandTestsToRunInformation(size_t numPossibleTests);
Ken Martin's avatar
Ken Martin committed
233

Andy Cedilnik's avatar
Andy Cedilnik committed
234
235
  std::vector<cmStdString> CustomPreTest;
  std::vector<cmStdString> CustomPostTest;
Ken Martin's avatar
Ken Martin committed
236

Andy Cedilnik's avatar
Andy Cedilnik committed
237
  std::vector<int>        TestsToRun;
Ken Martin's avatar
Ken Martin committed
238

239
240
  bool UseIncludeLabelRegExpFlag;
  bool UseExcludeLabelRegExpFlag;
Andy Cedilnik's avatar
Andy Cedilnik committed
241
242
243
  bool UseIncludeRegExpFlag;
  bool UseExcludeRegExpFlag;
  bool UseExcludeRegExpFirst;
244
245
  std::string IncludeLabelRegExp;
  std::string ExcludeLabelRegExp;
Andy Cedilnik's avatar
Andy Cedilnik committed
246
247
  std::string IncludeRegExp;
  std::string ExcludeRegExp;
248
249
  cmsys::RegularExpression IncludeLabelRegularExpression;
  cmsys::RegularExpression ExcludeLabelRegularExpression;
Andy Cedilnik's avatar
Andy Cedilnik committed
250
251
  cmsys::RegularExpression IncludeTestsRegularExpression;
  cmsys::RegularExpression ExcludeTestsRegularExpression;
Ken Martin's avatar
Ken Martin committed
252
253

  std::string GenerateRegressionImages(const std::string& xml);
Bill Hoffman's avatar
Bill Hoffman committed
254
  cmsys::RegularExpression DartStuff1;
255
256
257
  void CheckLabelFilter(cmCTestTestProperties& it);
  void CheckLabelFilterExclude(cmCTestTestProperties& it);
  void CheckLabelFilterInclude(cmCTestTestProperties& it);
Ken Martin's avatar
Ken Martin committed
258
259

  std::string TestsToRunString;
Andy Cedilnik's avatar
Andy Cedilnik committed
260
261
  bool UseUnion;
  ListOfTests TestList;
262
  size_t TotalNumberOfTests;
Andy Cedilnik's avatar
Andy Cedilnik committed
263
  cmsys::RegularExpression DartStuff;
Andy Cedilnik's avatar
Andy Cedilnik committed
264

Andy Cedilnik's avatar
Andy Cedilnik committed
265
  std::ostream* LogFile;
Ken Martin's avatar
Ken Martin committed
266
267
268
};

#endif