1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
|
// NOLINTBEGIN(*)
#ifndef CompareTest_h
#define CompareTest_h
#include <iostream>
#include <fstream>
#include <sstream>
#include <stdexcept>
#include <map>
#include <vector>
namespace CmpTst
{
//=============================================================================
//
// The CompareTest class
//
// description : Class to run tests based on device output comparison. The
// device output is redirected to a file which is then compared with
// a reference output.
//
//=============================================================================
class CompareTest
{
public:
//+-------------------------------------------------------------------------
//
// method : make_filename_unique
//
// description : Returns a filename from `base` which is guaranteed to be
// unique among all the running copies of this program.
// argument : in : - base : basename for the file
static std::string make_filename_unique(std::string base);
//+-------------------------------------------------------------------------
//
// method : out_set_event_properties
//
// description : Scans the output file seeking log4j:event tags and replaces
// values of the indicated properties in the found tags. E.g.:
// Original log4j:event tag:
// <log4j:event logger="DSERVER" timestamp="10" level="DEBUG" thread="1">
// After out_set_event_properties("outfile", "thread", "20") call:
// <log4j:event logger="DSERVER" timestamp="10" level="DEBUG" thread="20">
// argument : in : - file : output file to be modified
// - prop : property to be changed the value of
// - value : new value
//
//--------------------------------------------------------------------------
static void out_set_event_properties(std::string file, std::string prop, std::string value);
//+-------------------------------------------------------------------------
//
// method : out_set_event_properties
//
// description : Scans the output file seeking log4j:event tags and replaces
// values of the properties indicated by pop_val_map in the tags found.
// E.g.:
// Original log4j:event tag:
// <log4j:event logger="DSERVER" timestamp="10" level="DEBUG" thread="1">
// Map declaration:
// map<std::string,std::string> pop_val_map;
// prop_val_map["timestamp"] = "5";
// prop_val_map["thread"] = "20";
// The tag after out_set_event_properties("outfile", pop_val_map) call:
// <log4j:event logger="DSERVER" timestamp="5" level="DEBUG" thread="20">
// argument : in : - file : output file to be modified
// - prop_val_map : keys - properties to be modified,
// values - new values of the properties
//
//--------------------------------------------------------------------------
static void out_set_event_properties(std::string file, std::map<std::string, std::string> prop_val_map);
//+-------------------------------------------------------------------------
//
// method : out_set_replace_numbers
//
// description : Scans the output file seeking the occurrences of the
// prefix and replaces the following number with the one declared.
// The prefix can be any string directly preceding the number
// to be replaced.
// E.g.:
// Original tag in the output file:
// <![CDATA[In rel_monitor() DSERVER, ctr = 123, thread = 2]]>
// The tag after out_set_replace_numbers("outfile", "ctr = ", "4") call:
// <![CDATA[In rel_monitor() DSERVER, ctr = 4, thread = 2]]>
// argument : in : - file : output file to be modified
// - prefix : string directly preceding the number
// to be replaced
// - num : new number
//
//--------------------------------------------------------------------------
static void out_set_replace_numbers(std::string file, std::string prefix, std::string num);
//+-------------------------------------------------------------------------
//
// method : out_set_replace_numbers
//
// description : Scans the output file seeking the occurrences of the
// prefixes indicated by the prefix_num_map and replaces the
// following numbers with the ones declared in the map.
// The prefix can be any string directly preceding the number
// to be replaced.
// E.g.:
// Original tag in the output file:
// <![CDATA[In rel_monitor() DSERVER, ctr = 123, thread = 2]]>
// Map declaration:
// map<std::string,std::string> prefix_num_map;
// prefix_num_map["ctr = "] = "4";
// prefix_num_map["thread = "] = "567";
// The tag after out_set_replace_numbers("outfile", prefix_num_map) call:
// <![CDATA[In rel_monitor() DSERVER, ctr = 4, thread = 567]]>
// argument : in : - file : output file to be modified
// - prefix_num_map : keys - strings preceding the numbers
// to be modified,
// values - new numbers
//
//--------------------------------------------------------------------------
static void out_set_replace_numbers(std::string file, std::map<std::string, std::string> prefix_num_map);
//+-------------------------------------------------------------------------
//
// method : ref_replace_keywords
//
// description : Scans the output file seeking the occurrences of the
// keyword and replaces them with the declared value.
// E.g.:
// Original tag in the output file:
// <log4j:event logger="DSERVER" timestamp="10" level="DEBUG" thread="1">
// The tag after ref_replace_keywords("outfile", "DSERVER", "dserver/devTest/test") call:
// <log4j:event logger="dserver/devTest/test" timestamp="10" level="DEBUG" thread="1">
// argument : in : - file : output file to be modified
// - key : keyword to be replaced
// - value : new string
//
//--------------------------------------------------------------------------
static void ref_replace_keywords(std::string file, std::string key, std::string value);
//+-------------------------------------------------------------------------
//
// method : ref_replace_keywords
//
// description : Scans the output file seeking the occurrences of the
// keywords indicated by the key_val_map and replaces them with
// the declared values.
// E.g.:
// Original tag in the output file:
// <log4j:event logger="DSERVER" timestamp="10" level="DEBUG" thread="1">
// Map declaration:
// map<std::string,std::string> key_val_map;
// key_val_map["DSERVER"] = "dserver/devTest/test";
// key_val_map["DEBUG"] = "INFO";
// The tag after ref_replace_keywords("outfile", key_val_map) call:
// <log4j:event logger="dserver/devTest/test" timestamp="10" level="INFO" thread="1">
// argument : in : - file : output file to be modified
// - key_val_map : keys - keywords to be replaced,
// values - new replacement strings
//
//--------------------------------------------------------------------------
static void ref_replace_keywords(std::string file, std::map<std::string, std::string> key_val_map);
//+-------------------------------------------------------------------------
//
// method : compare
//
// description : Compares the output file with the reference file line
// by line. Throws an exception at the first occurrence of any
// discrepancy. No exception thrown means the files are identical.
// The exception indicates the number of the inconsistent line and
// displays it as well as the corresponding line from the reference
// file.
// argument : in : - ref : reference file to be compared with
// - out : output file to be compared with the
// reference file
//
//--------------------------------------------------------------------------
static void compare(std::string ref, std::string out);
//+-------------------------------------------------------------------------
//
// method : clean_on_startup
//
// description : Removes the temporary files created while running
// the CompareTest which were left undeleted on sudden termination
// of a test suite.
// argument : in : - ref : reference file
// - out : output file
//
//--------------------------------------------------------------------------
static void clean_on_startup(std::string ref, std::string out);
//+-------------------------------------------------------------------------
//
// method : clean_up
//
// description : Removes the output file and all the temporary files
// created while running the CompareTest like ref_tmp, or out_tmp.
// argument : in : - ref : reference file
// - out : output file
//
//--------------------------------------------------------------------------
static void clean_up(std::string ref, std::string out);
//+-------------------------------------------------------------------------
//
// method : leave_output
//
// description : Removes the temporary files created while running
// the CompareTest (ref_tmp) and leaves the output file.
// argument : in : - ref : reference file
//
//--------------------------------------------------------------------------
static void leave_output(std::string ref);
//+-------------------------------------------------------------------------
//
// method : print_output
//
// description : Displays the output file.
// argument : in : - out : output file to be displayed
//
//--------------------------------------------------------------------------
static void print_output(std::string out);
//+-------------------------------------------------------------------------
//
// method : print_output
//
// description : Displays the output file and shows the line numbers.
// argument : in : - out : output file to be displayed
// - show_line_numbers : if true displays line numbers
//
//--------------------------------------------------------------------------
static void print_output(std::string out, bool show_line_numbers);
static void out_remove_entries(std::string file, std::vector<std::string> &);
};
//=============================================================================
//
// The CompareTestException exception
//
// description : Exception thrown when CompareTest cannot open requested
// files or when comparison proves discrepancy between files.
//
//=============================================================================
class CompareTestException : public std::runtime_error
{
public:
CompareTestException(std::string err_str) :
std::runtime_error(err_str)
{
}
// ~CompareTestException() throw() {}
};
} // namespace CmpTst
#endif // CompareTest_h
// NOLINTEND(*)
|
