-
-
Notifications
You must be signed in to change notification settings - Fork 19
/
test_report.py
375 lines (291 loc) · 11.9 KB
/
test_report.py
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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
import datetime
import os
import shutil
import tempfile
import pytest
from rich.color import Color
from buildtest.cli.build import BuildTest
from buildtest.cli.report import (
Report,
clear_report,
list_report,
report_cmd,
report_summary,
)
from buildtest.config import SiteConfiguration
from buildtest.defaults import BUILD_REPORT, BUILDTEST_REPORTS, BUILDTEST_ROOT
from buildtest.exceptions import BuildTestError
from buildtest.utils.file import is_file
configuration = SiteConfiguration()
configuration.detect_system()
configuration.validate()
@pytest.mark.cli
def test_report():
# assert os.path.exists(BUILD_REPORT)
result = Report(configuration)
print("Processing Report File:", result.reportfile())
result.print_report()
# buildtest report --count 0
result.print_report(count=-1)
# buildtest report --count 0 --terse
result.print_report(count=-1, terse=True)
# run 'buildtest --color <Color> report --format name,state,returncode,buildspec --terse'
result.print_report(terse=True, color=Color.default().name)
result.print_report(row_count=True)
# run 'buildtest report --format name,state,returncode,buildspec'
result = Report(
configuration=configuration, format="name,state,returncode,buildspec"
)
result.print_report()
result = Report(configuration, pager=True)
result.print_report()
result = Report(configuration, color="red")
result.print_report()
result = Report(configuration, color="red", pager=True)
result.print_report()
result = Report(configuration, color="BAD_COLOR")
result.print_report()
result = Report(configuration, color="BAD_COLOR", pager=True)
result.print_report()
def test_report_detailed():
# buildtest report --detailed
Report(configuration=configuration, detailed=True)
# buildtest report --detailed --format name
with pytest.raises(BuildTestError):
Report(configuration=configuration, detailed=True, format="name")
@pytest.mark.cli
def test_report_format():
# buildtest report --helpformat
report = Report(configuration)
report.print_format_fields()
# buildtest report --formatfields
report.print_raw_format_fields()
# buildtest report --format XYZ is invalid format field
with pytest.raises(BuildTestError):
Report(configuration, format="XYZ")
@pytest.mark.cli
def test_report_filter():
# run 'buildtest report --helpfilter'
report = Report(configuration)
report.print_filter_fields()
# run 'buildtest report --filterfields'
report.print_raw_filter_fields()
# run 'buildtest report --helpfilter'
report.print_format_fields()
report = Report(configuration, filter={"state": "PASS"})
report.print_report()
report = Report(configuration, filter={"state": "PASS"}, format="name,state")
report.print_report()
# run 'buildtest report --filter returncode=0,executor=generic.local.bash --format name,returncode,executor
report = Report(
configuration=configuration,
filter={"returncode": "0", "executor": "generic.local.bash"},
format="name,returncode,executor",
)
report.print_report()
# run 'buildtest report --filter buildspec=tutorials/pass_returncode.yml --format name,returncode,buildspec
Report(
configuration=configuration,
filter={
"buildspec": os.path.join(
BUILDTEST_ROOT, "tutorials", "test_status", "pass_returncode.yml"
)
},
format="name,returncode,buildspec",
)
# run 'buildtest report --filter name=exit1_pass --format name,returncode,state
Report(
configuration=configuration,
filter={"name": "exit1_pass"},
format="name,returncode,state",
)
# run 'buildtest report --filter returncode=-999 to ensure _filter_test_by_returncode returns True
Report(configuration=configuration, filter={"returncode": "-999"})
# Testing multiple filter fields. 'buildtest report --filter tags=tutorials,executor=generic.local.bash,state=PASS,returncode=0 --format name,returncode,state,executor,tags
Report(
configuration=configuration,
filter={
"tags": "tutorials",
"executor": "generic.local.bash",
"state": "PASS",
"returncode": 0,
},
format="name,returncode,state,executor,tags",
)
def test_report_with_metrics():
buildspecs = [
os.path.join(BUILDTEST_ROOT, "tutorials", "perf_checks", "assert_ge.yml")
]
build_cmd = BuildTest(configuration=configuration, buildspecs=buildspecs)
build_cmd.build()
# see if metrics are printed properly
cmd = Report(
configuration=configuration,
filter={"buildspec": buildspecs[0]},
format="name,metrics",
)
cmd.print_report()
@pytest.mark.cli
def test_report_oldest_and_latest():
# buildtest report --filter tags=tutorials --latest
Report(configuration=configuration, filter={"tags": "tutorials"}, latest=True)
# buildtest report --filter tags=tutorials --oldest
Report(configuration=configuration, filter={"tags": "tutorials"}, oldest=True)
# buildtest report --filter tags=tutorials --oldest --latest
Report(
configuration=configuration,
filter={"tags": "tutorials"},
oldest=True,
latest=True,
)
@pytest.mark.cli
def test_report_failure():
# buildtest report --filter tags=tutorials --fail
Report(configuration=configuration, filter={"tags": "tutorials"}, failure=True)
@pytest.mark.cli
def test_report_passed():
# buildtest report --filter tags=tutorials --pass
Report(configuration=configuration, filter={"tags": "tutorials"}, passed=True)
@pytest.mark.cli
def test_report_start_and_end():
start_date = datetime.datetime.strptime("2022-06-07 00:00:00", "%Y-%m-%d %X")
end_date = datetime.datetime.now()
# buildtest report --filter tags=tutorials --start
Report(configuration=configuration, filter={"tags": "tutorials"}, start=start_date)
# buildtest report --filter tags=tutorials --end
Report(configuration=configuration, filter={"tags": "tutorials"}, end=end_date)
# buildtest report --filter tags=tutorials --start --end
Report(
configuration=configuration,
filter={"tags": "tutorials"},
start=start_date,
end=end_date,
)
@pytest.mark.cli
def test_invalid_filters():
# run 'buildtest report --filter state=UNKNOWN --format name,state',
# this raises error because UNKNOWN is not valid value for state field
with pytest.raises(BuildTestError):
Report(
configuration=configuration,
filter={"state": "UNKNOWN"},
format="name,state",
)
tf = tempfile.NamedTemporaryFile(delete=True)
tf.close()
# test invalid buildspec file that doesn't exist in filesystem
with pytest.raises(BuildTestError):
Report(
configuration=configuration,
filter={"buildspec": tf.name},
format="name,returncode,state",
)
# run 'buildtest report --filter buildspec=$HOME/.bashrc --format name,returncode,state
# this will raise error even though file is valid it won't be found in cache
with pytest.raises(BuildTestError):
Report(
configuration=configuration,
filter={"buildspec": "$HOME/.bashrc"},
format="name,returncode,state",
)
# buildtest report --filter returncode=1.5 is invalid returncode (must be INT)
with pytest.raises(BuildTestError):
Report(configuration=configuration, filter={"returncode": "1.5"})
# buildtest report --filter XYZ=tutorials is invalid filter field
with pytest.raises(BuildTestError):
Report(configuration=configuration, filter={"XYZ": "tutorials"})
@pytest.mark.cli
def test_invalid_report_files():
tf = tempfile.NamedTemporaryFile(delete=True)
# reading a report file not in JSON format will result in exception BuildTestError
with pytest.raises(BuildTestError):
Report(configuration=configuration, report_file=tf.name)
# closing the file will delete the file from file-system
tf.close()
# An invalid path for report file will raise an exception
with pytest.raises(SystemExit):
Report(configuration=configuration, report_file=tf.name)
tempdir = tempfile.TemporaryDirectory()
with pytest.raises(SystemExit):
Report(configuration=configuration, report_file=tempdir.name)
@pytest.mark.cli
def test_report_summary():
report = Report(configuration=configuration)
report_summary(report, configuration=configuration)
# buildtest rt summary --pager
report = Report(configuration=configuration, pager=True)
report_summary(report, configuration=configuration)
# buildtest rt summary --detailed
report = Report(configuration=configuration)
report_summary(report, configuration=configuration, detailed=True)
# buildtest rt summary --detailed --pager
report = Report(configuration=configuration, pager=True)
report_summary(report, configuration=configuration, detailed=True)
report = Report(configuration=configuration, color="light_pink1")
report_summary(report, configuration=configuration)
report = Report(configuration=configuration, pager=True, color="light_pink1")
report_summary(report, configuration=configuration, detailed=True)
# buildtest --color light_pink1 rt sm --detailed
report = Report(configuration=configuration, color="light_pink1")
report_summary(report, configuration=configuration, detailed=True)
# buildtest rt sm --detailed --pager
report = Report(configuration=configuration, pager=True)
report_summary(report, configuration=configuration, detailed=True)
# buildtest --color BAD_COLOR rt sm --detailed
report = Report(configuration=configuration, color="BAD_COLOR")
report_summary(report, configuration=configuration, detailed=True)
@pytest.mark.cli
def test_report_list():
list_report()
backupfile = tempfile.NamedTemporaryFile()
shutil.copy2(BUILDTEST_REPORTS, backupfile.name)
# now removing report summary it should print a message
os.remove(BUILDTEST_REPORTS)
with pytest.raises(SystemExit):
list_report()
# move back the removed BUILDTEST_REPORTS file
shutil.move(backupfile.name, BUILDTEST_REPORTS)
assert is_file(BUILDTEST_REPORTS)
@pytest.mark.cli
def test_report_clear():
backupfile_report = tempfile.NamedTemporaryFile()
shutil.copy2(BUILD_REPORT, backupfile_report.name)
backupfile_list_report = tempfile.NamedTemporaryFile()
shutil.copy2(BUILDTEST_REPORTS, backupfile_list_report.name)
clear_report()
# buildtest report clear will raise an error since file doesn't exist
with pytest.raises(SystemExit):
clear_report()
assert not is_file(BUILD_REPORT)
# move back the backe-up files since report_cmd() function removes the files BUILD_REPORT and BUILDTEST_REPORTS
shutil.move(backupfile_report.name, BUILD_REPORT)
shutil.move(backupfile_list_report.name, BUILDTEST_REPORTS)
assert is_file(BUILD_REPORT)
assert is_file(BUILDTEST_REPORTS)
@pytest.mark.cli
def test_report_limited_rows():
report = Report(configuration=configuration)
report.print_report(count=5)
report.print_report(terse=True, count=5)
# test report query with 0 and negative number with and without terse mode
report.print_report(terse=False, count=0)
report.print_report(terse=False, count=-1)
report.print_report(terse=True, count=0)
report.print_report(terse=True, count=-1)
@pytest.mark.cli
def test_report_path():
class args:
filter = None
format = None
start = None
end = None
fail = None
passed = None
oldest = False
latest = False
report_subcommand = "path"
count = None
color = None
pager = None
detailed = None
report_cmd(args, configuration=configuration)