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
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
|
import os
import io
import unittest.mock
from mcstasscript.helper.component_reader import ComponentReader
def setup_component_reader():
"""
Sets up a component_reader instance with dummy mcstas
installation located in the tests directory
"""
THIS_DIR = os.path.dirname(os.path.abspath(__file__))
dummy_path = os.path.join(THIS_DIR, "dummy_mcstas")
current_work_dir = os.getcwd()
os.chdir(THIS_DIR) # Set work directory to test folder
component_reader = ComponentReader(mcstas_path=dummy_path)
os.chdir(current_work_dir) # Reset work directory
return component_reader
def setup_component_reader_input_path():
"""
Sets up a component_reader instance with dummy mcstas
installation located in the tests directory, and specifies
a input_path which is also located in the test directory.
"""
THIS_DIR = os.path.dirname(os.path.abspath(__file__))
dummy_path = os.path.join(THIS_DIR, "dummy_mcstas")
input_path = os.path.join(THIS_DIR, "test_input_folder")
current_work_dir = os.getcwd()
os.chdir(THIS_DIR) # Set work directory to test folder
component_reader = ComponentReader(mcstas_path=dummy_path,
input_path=input_path)
os.chdir(current_work_dir) # Reset work directory
return component_reader
class TestComponentReader(unittest.TestCase):
"""
Testing the ComponenReader class. As this class reads information
from McStas, a dummy McStas install is made in the test folder to
avoid the test results changing with updates of McStas.
"""
@unittest.mock.patch("sys.stdout", new_callable=io.StringIO)
def test_ComponentReader_init_overwrite_message(self, mock_stdout):
"""
Test that ComponentReader reports overwritten components
Here using default input path, which is current folder
"""
setup_component_reader()
message = ("The following components are found in the work directory "
+ "/ input_path:\n test_for_reading.comp\n"
+ "These definitions will be used instead of the "
+ "installed versions.\n")
self.assertEqual(mock_stdout.getvalue(), message)
@unittest.mock.patch("sys.stdout", new_callable=io.StringIO)
def test_ComponentReader_init_overwrite_message_input(self, mock_stdout):
"""
Test that ComponentReader reports overwritten components
Here using user defined input path, a directory in tests
"""
setup_component_reader_input_path()
message = ("The following components are found in the work directory "
+ "/ input_path:\n test_for_structure.comp\n"
+ "These definitions will be used instead of the "
+ "installed versions.\n")
self.assertEqual(mock_stdout.getvalue(), message)
@unittest.mock.patch("sys.stdout", new_callable=io.StringIO)
def test_ComponentReader_init_filenames(self, mock_stdout):
"""
Test that ComponentReader initializes component names correctly
"""
component_reader = setup_component_reader()
n_components_found = len(component_reader.component_path)
self.assertEqual(n_components_found, 4)
self.assertIn("test_for_reading", component_reader.component_path)
self.assertIn("test_for_structure", component_reader.component_path)
self.assertIn("test_for_structure2", component_reader.component_path)
self.assertIn("test_for_skipped_sections", component_reader.component_path)
@unittest.mock.patch("sys.stdout", new_callable=io.StringIO)
def test_ComponentReader_init_component_paths(self, mock_stdout):
"""
Test that ComponentReader stores correct absolute paths to
the components found in the McStas installation
"""
THIS_DIR = os.path.dirname(os.path.abspath(__file__))
dummy_path = os.path.join(THIS_DIR, "dummy_mcstas")
component_reader = setup_component_reader()
n_components_found = len(component_reader.component_path)
self.assertEqual(n_components_found, 4)
expected_path = os.path.join(THIS_DIR, "test_for_reading.comp")
path = component_reader.component_path["test_for_reading"]
self.assertEqual(path, expected_path)
category = component_reader.component_category["test_for_reading"]
self.assertEqual(category, "work directory")
expected_path = os.path.join(dummy_path, "misc",
"test_for_structure.comp")
self.assertIn("test_for_structure", component_reader.component_path)
path = component_reader.component_path["test_for_structure"]
self.assertEqual(path, expected_path)
category = component_reader.component_category["test_for_structure"]
self.assertEqual(category, "misc")
self.assertIn("test_for_structure2", component_reader.component_path)
path = component_reader.component_path["test_for_structure2"]
expected_path = os.path.join(dummy_path, "sources",
"test_for_structure2.comp")
self.assertEqual(path, expected_path)
category = component_reader.component_category["test_for_structure2"]
self.assertEqual(category, "sources")
@unittest.mock.patch("sys.stdout", new_callable=io.StringIO)
def test_ComponentReader_init_component_paths_input(self, mock_stdout):
"""
Test that ComponentReader stores correct absolute paths to
the components found in the McStas installation.
This version uses custom input_path
"""
THIS_DIR = os.path.dirname(os.path.abspath(__file__))
dummy_path = os.path.join(THIS_DIR, "dummy_mcstas")
input_path = os.path.join(THIS_DIR, "test_input_folder")
component_reader = setup_component_reader_input_path()
n_components_found = len(component_reader.component_path)
self.assertEqual(n_components_found, 4)
self.assertIn("test_for_reading", component_reader.component_path)
expected_path = os.path.join(dummy_path, "misc",
"test_for_reading.comp")
path = component_reader.component_path["test_for_reading"]
self.assertEqual(path, expected_path)
category = component_reader.component_category["test_for_reading"]
self.assertEqual(category, "misc")
expected_path = os.path.join(input_path, "test_for_structure.comp")
self.assertIn("test_for_structure", component_reader.component_path)
path = component_reader.component_path["test_for_structure"]
self.assertEqual(path, expected_path)
category = component_reader.component_category["test_for_structure"]
self.assertEqual(category, "work directory")
self.assertIn("test_for_structure2", component_reader.component_path)
path = component_reader.component_path["test_for_structure2"]
expected_path = os.path.join(dummy_path, "sources",
"test_for_structure2.comp")
self.assertEqual(path, expected_path)
category = component_reader.component_category["test_for_structure2"]
self.assertEqual(category, "sources")
@unittest.mock.patch("sys.stdout", new_callable=io.StringIO)
def test_ComponentReader_init_categories(self, mock_stdout):
"""
Test that ComponentReader initializes categories correctly
"""
component_reader = setup_component_reader()
n_categories_found = len(set(component_reader.component_category.values()))
self.assertEqual(n_categories_found, 3)
"""
Categories are the values of the category dict, so n_categories
is the same as the set of the values.
"""
category = component_reader.component_category["test_for_reading"]
self.assertEqual(category, "work directory")
category = component_reader.component_category["test_for_structure"]
self.assertEqual(category, "misc")
category = component_reader.component_category["test_for_structure2"]
self.assertEqual(category, "sources")
@unittest.mock.patch("sys.stdout", new_callable=io.StringIO)
def test_ComponentReader_show_categories(self, mock_stdout):
"""
This method prints to console, check it prints the categories
in the dummy installation correctly.
"""
component_reader = setup_component_reader()
component_reader.show_categories()
output = mock_stdout.getvalue()
output = output.split("\n")
self.assertEqual(len(output), 7)
self.assertIn(" sources", output)
self.assertIn(" work directory", output)
self.assertIn(" misc", output)
@unittest.mock.patch("sys.stdout", new_callable=io.StringIO)
def test_ComponentReader_show_categories_ordered(self, mock_stdout):
"""
Check that the print to console is ordered as usual. This test
may be implementation dependent as python dictionaries are not
ordered.
"""
component_reader = setup_component_reader()
component_reader.show_categories()
output = mock_stdout.getvalue()
output = output.split("\n")
self.assertEqual(len(output), 7)
# Ignoring message about overwritten components, starting from 3
self.assertEqual(output[3], " misc")
self.assertEqual(output[4], " sources")
self.assertEqual(output[5], " work directory")
@unittest.mock.patch("sys.stdout", new_callable=io.StringIO)
def test_ComponentReader_show_components_short(self, mock_stdout):
"""
Here we attempt to show components in the misc category. In
the dummy install, there are two components in this folder, but
one of these is overwritten by the version in the current
work directory.
"""
component_reader = setup_component_reader()
component_reader.show_components_in_category("misc", line_length=100)
output = mock_stdout.getvalue()
output = output.split("\n")
self.assertEqual(len(output), 6)
self.assertIn(" test_for_structure", output)
# Check overwritten component is not in the output
self.assertNotIn(" test_for_reading", output)
"""
# This test not as important, but could be finished later
@unittest.mock.patch("sys.stdout", new_callable = io.StringIO)
def test_ComponentReader_show_components_long(self, mock_stdout):
component_reader = setup_component_reader()
# Add elements directly to component_readers library
# generate list
# add list
#component_reader.component_category[]
component_reader.show_components_in_category("misc", line_length=100)
output = mock_stdout.getvalue()
output = output.split("\n")
self.assertEqual(len(output), 3)
self.assertIn(" test_for_structure", output)
"""
# test load_all_components
@unittest.mock.patch("sys.stdout", new_callable=io.StringIO)
def test_ComponentReader_load_all_components(self, mock_stdout):
"""
Load all components in the dummy install, but only one has any
content. The method is currently not necessary, as components
are now loaded individually when needed.
"""
component_reader = setup_component_reader()
CompInfo_dict = component_reader.load_all_components()
comp_name = "test_for_reading"
name = CompInfo_dict[comp_name].name
self.assertEqual(name, comp_name)
parameter_names = CompInfo_dict[comp_name].parameter_names
self.assertIn("target_index", parameter_names)
parameter_types = CompInfo_dict[comp_name].parameter_types
self.assertIn("target_index", parameter_types)
parameter_defaults = CompInfo_dict[comp_name].parameter_defaults
self.assertIn("target_index", parameter_defaults)
type_str = CompInfo_dict[comp_name].parameter_types["target_index"]
self.assertEqual(type_str, "int")
comp_name = "test_for_structure"
name = CompInfo_dict[comp_name].name
self.assertEqual(name, comp_name)
# test_for_structure is an empty file, so no conentet to check
comp_name = "test_for_structure2"
name = CompInfo_dict[comp_name].name
self.assertEqual(name, comp_name)
# test_for_structure2 is an empty file, so no conentet to check
@unittest.mock.patch("sys.stdout", new_callable=io.StringIO)
def test_ComponentReader_read_name_error(self, mock_stdout):
"""
read_name should throw an error when searching for a component
that is not present in the installation.
"""
component_reader = setup_component_reader()
with self.assertRaises(NameError):
component_reader.read_name("no_such_comp")
@unittest.mock.patch("sys.stdout", new_callable=io.StringIO)
def test_ComponentReader_read_name_success(self, mock_stdout):
"""
Read component simply calls read_component_file, but here
the output is checked against what is in the dummy file.
"""
component_reader = setup_component_reader()
CompInfo = component_reader.read_name("test_for_reading")
self.assertEqual(CompInfo.name, "test_for_reading")
self.assertEqual(CompInfo.category, "work directory")
self.assertIn("dist", CompInfo.parameter_names)
self.assertIn("dist", CompInfo.parameter_defaults)
self.assertIn("dist", CompInfo.parameter_types)
self.assertEqual(CompInfo.parameter_types["dist"], "double")
self.assertIn("dist", CompInfo.parameter_comments)
self.assertIn("dist", CompInfo.parameter_units)
self.assertEqual(CompInfo.parameter_units["dist"], "m")
@unittest.mock.patch("sys.stdout", new_callable=io.StringIO)
def test_ComponentReader_find_components_names(self, mock_stdout):
"""
Test that ComponentReader initializes component names correctly
"""
component_reader = setup_component_reader()
component_reader.component_path = {}
component_reader.component_category = {}
THIS_DIR = os.path.dirname(os.path.abspath(__file__))
dummy_path = os.path.join(THIS_DIR, "dummy_mcstas", "misc")
current_work_dir = os.getcwd()
os.chdir(THIS_DIR) # Set work directory to test folder
component_reader._find_components(dummy_path)
os.chdir(current_work_dir) # Return to original work directory
n_components_found = len(component_reader.component_path)
self.assertEqual(n_components_found, 3)
self.assertIn("test_for_reading", component_reader.component_path)
self.assertIn("test_for_structure", component_reader.component_path)
self.assertIn("test_for_skipped_sections", component_reader.component_path)
@unittest.mock.patch("sys.stdout", new_callable=io.StringIO)
def test_ComponentReader_find_components_categories(self, mock_stdout):
"""
Test that ComponentReader initializes component categories correctly
"""
component_reader = setup_component_reader()
component_reader.component_path = {}
component_reader.component_category = {}
THIS_DIR = os.path.dirname(os.path.abspath(__file__))
dummy_path = os.path.join(THIS_DIR, "dummy_mcstas", "misc")
current_work_dir = os.getcwd()
os.chdir(THIS_DIR) # Set work directory to test folder
component_reader._find_components(dummy_path)
os.chdir(current_work_dir) # Return to original work directory
n_components_found = len(component_reader.component_category)
self.assertEqual(n_components_found, 3)
category = component_reader.component_category["test_for_reading"]
self.assertEqual(category, "misc")
category = component_reader.component_category["test_for_structure"]
self.assertEqual(category, "misc")
category = component_reader.component_category["test_for_skipped_sections"]
self.assertEqual(category, "misc")
@unittest.mock.patch("sys.stdout", new_callable=io.StringIO)
def test_ComponentReader_read_component_category(self, mock_stdout):
"""
Check that the correct category is returned.
Can't run this test with overwritten component test_for_reading.
read_component will report tests as category, but this is
overwritten by read_name in normal use.
"""
component_reader = setup_component_reader()
path_for_test = component_reader.component_path["test_for_structure"]
CompInfo = component_reader.read_component_file(path_for_test)
exp_cat = component_reader.component_category["test_for_structure"]
self.assertEqual(CompInfo.category, exp_cat)
@unittest.mock.patch("sys.stdout", new_callable=io.StringIO)
def test_ComponentReader_read_component_standard(self, mock_stdout):
"""
Test that a normal parameter is read correctly when reading a
component file.
Has default, is double type, has comment, has unit
"""
component_reader = setup_component_reader()
path_for_test = component_reader.component_path["test_for_reading"]
CompInfo = component_reader.read_component_file(path_for_test)
self.assertIn("xwidth", CompInfo.parameter_names)
self.assertIn("xwidth", CompInfo.parameter_defaults)
self.assertEqual(CompInfo.parameter_defaults["xwidth"], 0.0)
self.assertIn("xwidth", CompInfo.parameter_types)
self.assertEqual(CompInfo.parameter_types["xwidth"], "double")
self.assertIn("xwidth", CompInfo.parameter_comments)
comment = "Width of rectangle test comment"
self.assertEqual(CompInfo.parameter_comments["xwidth"], comment)
self.assertIn("xwidth", CompInfo.parameter_units)
self.assertEqual(CompInfo.parameter_units["xwidth"], "m")
@unittest.mock.patch("sys.stdout", new_callable=io.StringIO)
def test_ComponentReader_read_component_required(self, mock_stdout):
"""
Test that a required parameter is read correctly when reading a
component file.
Has no default, is double type, has no comment, has no unit
"""
component_reader = setup_component_reader()
path_for_test = component_reader.component_path["test_for_reading"]
CompInfo = component_reader.read_component_file(path_for_test)
self.assertIn("gauss", CompInfo.parameter_names)
self.assertIn("gauss", CompInfo.parameter_defaults)
self.assertIsNone(CompInfo.parameter_defaults["gauss"])
self.assertIn("gauss", CompInfo.parameter_types)
self.assertEqual(CompInfo.parameter_types["gauss"], "double")
self.assertNotIn("gauss", CompInfo.parameter_comments)
self.assertNotIn("gauss", CompInfo.parameter_units)
@unittest.mock.patch("sys.stdout", new_callable=io.StringIO)
def test_ComponentReader_read_component_int(self, mock_stdout):
"""
Test that an integer parameter is read correctly when reading a
component file.
Has default, is int type (comments and unit checked already)
"""
component_reader = setup_component_reader()
path_for_test = component_reader.component_path["test_for_reading"]
CompInfo = component_reader.read_component_file(path_for_test)
self.assertIn("flux", CompInfo.parameter_names)
self.assertIn("flux", CompInfo.parameter_defaults)
self.assertEqual(CompInfo.parameter_defaults["flux"], 1)
self.assertIn("flux", CompInfo.parameter_types)
self.assertEqual(CompInfo.parameter_types["flux"], "int")
self.assertIn("flux", CompInfo.parameter_comments)
# Have already tested comments are read
self.assertIn("flux", CompInfo.parameter_units)
# Have already tested units are read
@unittest.mock.patch("sys.stdout", new_callable=io.StringIO)
def test_ComponentReader_read_component_string(self, mock_stdout):
"""
Test that a string parameter is read correctly when reading a
component file.
Has no default, is string type (comments and unit checked already)
"""
component_reader = setup_component_reader()
path_for_test = component_reader.component_path["test_for_reading"]
CompInfo = component_reader.read_component_file(path_for_test)
self.assertIn("test_string", CompInfo.parameter_names)
self.assertIn("test_string", CompInfo.parameter_defaults)
self.assertIsNone(CompInfo.parameter_defaults["test_string"])
self.assertIn("test_string", CompInfo.parameter_types)
self.assertEqual(CompInfo.parameter_types["test_string"], "string")
self.assertNotIn("test_string", CompInfo.parameter_comments)
# Have already tested comments are read
self.assertNotIn("test_string", CompInfo.parameter_units)
# Have already tested units are read
@unittest.mock.patch("sys.stdout", new_callable=io.StringIO)
def test_ComponentReader_read_comp_with_skipped_sections(self, mock_stdout):
"""
Read component simply calls read_component_file, but here
the output is checked against what is in the dummy file.
"""
component_reader = setup_component_reader()
CompInfo = component_reader.read_name("test_for_skipped_sections")
self.assertEqual(CompInfo.name, "test_for_skipped_sections")
self.assertEqual(CompInfo.category, "misc")
self.assertEqual(len(CompInfo.parameter_names), 4)
self.assertIn("packing_factor", CompInfo.parameter_names)
self.assertIn("packing_factor", CompInfo.parameter_defaults)
self.assertIn("packing_factor", CompInfo.parameter_types)
self.assertEqual(CompInfo.parameter_types["packing_factor"], "double")
self.assertIn("packing_factor", CompInfo.parameter_comments)
self.assertIn("packing_factor", CompInfo.parameter_units)
self.assertEqual(CompInfo.parameter_units["packing_factor"], "1")
if __name__ == '__main__':
unittest.main()
|
