cmCTestTestHandler.h 4.72 KB
Newer Older
Ken Martin's avatar
Ken Martin committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
/*=========================================================================

  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.

     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.

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

#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();
Ken Martin's avatar
Ken Martin committed
40
  
41
  /**
42
43
44
45
46
47
   * 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.
   */
  void SetUseUnion(bool val) { m_UseUnion = val; }

48
49
50
  /**
   * This method is called when reading CTest custom file
   */
51
52
  void PopulateCustomVectors(cmMakefile *mf);
  
Ken Martin's avatar
Ken Martin committed
53
54
55
56
57
58
59
60
61
62
63
  ///! 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 *);
  

  ///! 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);

Ken Martin's avatar
Ken Martin committed
76
77
78
79
80
81
82
83
84
85
86
87
88
89
  struct cmCTestTestResult
  {
    std::string m_Name;
    std::string m_Path;
    std::string m_FullCommandLine;
    double      m_ExecutionTime;
    int         m_ReturnValue;
    int         m_Status;
    std::string m_CompletionStatus;
    std::string m_Output;
    std::string m_RegressionImages;
    int         m_TestCount;
  };

90
91
  void Initialize();

Andy Cedilnik's avatar
Andy Cedilnik committed
92
93
94
95
96
protected:
  struct cmCTestTestProperties
  {
    cmStdString m_Name;
    cmStdString m_Directory;
97
    std::vector<std::string> m_Args;
98
99
    std::vector<cmsys::RegularExpression> m_ErrorRegularExpressions;
    std::vector<cmsys::RegularExpression> m_RequiredRegularExpressions;
Andy Cedilnik's avatar
Andy Cedilnik committed
100
    bool m_IsInBasedOnREOptions;
101
    bool m_WillFail;
Andy Cedilnik's avatar
Andy Cedilnik committed
102
103
104
  };


105
106
107
108
109
110
111
  virtual int PreProcessHandler();
  virtual int PostProcessHandler();
  virtual void GenerateTestCommand(std::vector<const char*>& args);
  int ExecuteCommands(std::vector<cmStdString>& vec);

  double                  m_ElapsedTestingTime;

Ken Martin's avatar
Ken Martin committed
112
113
114
  typedef std::vector<cmCTestTestResult> tm_TestResultsVector;
  tm_TestResultsVector    m_TestResults;

115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
  std::vector<cmStdString> m_CustomTestsIgnore;
  std::string             m_StartTest;
  std::string             m_EndTest;
  bool m_MemCheck;

private:
  enum { // Program statuses
    NOT_RUN = 0,
    TIMEOUT,
    SEGFAULT,
    ILLEGAL,
    INTERRUPT,
    NUMERICAL,
    OTHER_FAULT,
    FAILED,
    BAD_COMMAND,
    COMPLETED
  };
Ken Martin's avatar
Ken Martin committed
133
134
135
136
137


  /**
   * Generate the Dart compatible output
   */
138
  virtual void GenerateDartOutput(std::ostream& os);
Ken Martin's avatar
Ken Martin committed
139
140
141
142
143

  /**
   * Run the test for a directory and any subdirectories
   */
  void ProcessDirectory(std::vector<cmStdString> &passed, 
144
                        std::vector<cmStdString> &failed);
145
  
Ken Martin's avatar
Ken Martin committed
146
147
148
149
150

  typedef std::vector<cmCTestTestProperties> tm_ListOfTests;
  /**
   * Get the list of tests in directory and subdirectories.
   */
151
  void GetListOfTests();
Ken Martin's avatar
Ken Martin committed
152
153
154
155
156
157
158
159
160
161
162
163

  /**
   * Find the executable for a test
   */
  std::string FindTheExecutable(const char *exe);

  const char* GetTestStatus(int status);
  void ExpandTestsToRunInformation(int numPossibleTests);

  std::vector<cmStdString> m_CustomPreTest;
  std::vector<cmStdString> m_CustomPostTest;

164
165
166
  int m_CustomMaximumPassedTestOutputSize;
  int m_CustomMaximumFailedTestOutputSize;

Ken Martin's avatar
Ken Martin committed
167
168
169
170
171
172
173
  std::vector<int>        m_TestsToRun;

  bool m_UseIncludeRegExp;
  bool m_UseExcludeRegExp;
  bool m_UseExcludeRegExpFirst;
  std::string m_IncludeRegExp;
  std::string m_ExcludeRegExp;
174
175
  cmsys::RegularExpression m_IncludeTestsRegularExpression;
  cmsys::RegularExpression m_ExcludeTestsRegularExpression;
Ken Martin's avatar
Ken Martin committed
176
177
178

  std::string GenerateRegressionImages(const std::string& xml);

179
180
181
  //! Clean test output to specified length
  bool CleanTestOutput(std::string& output, size_t length);

Ken Martin's avatar
Ken Martin committed
182
  std::string TestsToRunString;
183
  bool m_UseUnion;
184
  tm_ListOfTests m_TestList;
185
  cmsys::RegularExpression m_DartStuff;
Andy Cedilnik's avatar
Andy Cedilnik committed
186

Andy Cedilnik's avatar
Andy Cedilnik committed
187
  std::ostream* m_LogFile;
Ken Martin's avatar
Ken Martin committed
188
189
190
};

#endif