-
Notifications
You must be signed in to change notification settings - Fork 16
/
test_main.py
1299 lines (1092 loc) · 37.9 KB
/
test_main.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
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
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""
Module to provide tests related to the basic parts of the scanner.
"""
import logging
import os
import runpy
import tempfile
from test.markdown_scanner import MarkdownScanner
from pymarkdown.container_block_processor import ContainerIndices
from pymarkdown.parser_logger import ParserLogger
from pymarkdown.stack_token import StackToken
from .utils import write_temporary_configuration
POGGER = ParserLogger(logging.getLogger(__name__))
# pylint: disable=too-many-lines
def test_markdown_with_no_parameters():
"""
Test to make sure we get the simple information if no parameters are supplied.
"""
# Arrange
scanner = MarkdownScanner()
supplied_arguments = []
expected_return_code = 2
expected_output = """usage: main.py [-h] [-e ENABLE_RULES] [-d DISABLE_RULES]
[--add-plugin ADD_PLUGIN] [--config CONFIGURATION_FILE]
[--set SET_CONFIGURATION] [--strict-config] [--stack-trace]
[--log-level {CRITICAL,ERROR,WARNING,INFO,DEBUG}]
[--log-file LOG_FILE]
{plugins,scan,version} ...
Lint any found Markdown files.
positional arguments:
{plugins,scan,version}
plugins plugin commands
scan scan the Markdown files in the specified paths
version version of the application
optional arguments:
-h, --help show this help message and exit
-e ENABLE_RULES, --enable-rules ENABLE_RULES
comma separated list of rules to enable
-d DISABLE_RULES, --disable-rules DISABLE_RULES
comma separated list of rules to disable
--add-plugin ADD_PLUGIN
path to a plugin containing a new rule to apply
--config CONFIGURATION_FILE, -c CONFIGURATION_FILE
path to the configuration file to use
--set SET_CONFIGURATION, -s SET_CONFIGURATION
manualy set properties
--strict-config throw an error if configuration is bad, instead of
assuming default
--stack-trace if an error occurs, print out the stack trace for
debug purposes
--log-level {CRITICAL,ERROR,WARNING,INFO,DEBUG}
minimum level required to log messages
--log-file LOG_FILE destination file for log messages
"""
expected_error = ""
# Act
execute_results = scanner.invoke_main(arguments=supplied_arguments)
# Assert
execute_results.assert_results(
expected_output, expected_error, expected_return_code
)
def test_markdown_with_dash_h():
"""
Test to make sure we get help if '-h' is supplied.
"""
# Arrange
scanner = MarkdownScanner()
supplied_arguments = ["-h"]
expected_return_code = 0
expected_output = """usage: main.py [-h] [-e ENABLE_RULES] [-d DISABLE_RULES]
[--add-plugin ADD_PLUGIN] [--config CONFIGURATION_FILE]
[--set SET_CONFIGURATION] [--strict-config] [--stack-trace]
[--log-level {CRITICAL,ERROR,WARNING,INFO,DEBUG}]
[--log-file LOG_FILE]
{plugins,scan,version} ...
Lint any found Markdown files.
positional arguments:
{plugins,scan,version}
plugins plugin commands
scan scan the Markdown files in the specified paths
version version of the application
optional arguments:
-h, --help show this help message and exit
-e ENABLE_RULES, --enable-rules ENABLE_RULES
comma separated list of rules to enable
-d DISABLE_RULES, --disable-rules DISABLE_RULES
comma separated list of rules to disable
--add-plugin ADD_PLUGIN
path to a plugin containing a new rule to apply
--config CONFIGURATION_FILE, -c CONFIGURATION_FILE
path to the configuration file to use
--set SET_CONFIGURATION, -s SET_CONFIGURATION
manualy set properties
--strict-config throw an error if configuration is bad, instead of
assuming default
--stack-trace if an error occurs, print out the stack trace for
debug purposes
--log-level {CRITICAL,ERROR,WARNING,INFO,DEBUG}
minimum level required to log messages
--log-file LOG_FILE destination file for log messages
"""
expected_error = ""
# Act
execute_results = scanner.invoke_main(arguments=supplied_arguments)
# Assert
execute_results.assert_results(
expected_output, expected_error, expected_return_code
)
def test_markdown_with_dash_dash_version():
"""
Test to make sure we get help if 'version' is supplied.
"""
# Arrange
scanner = MarkdownScanner()
supplied_arguments = ["version"]
version_meta = runpy.run_path("./pymarkdown/version.py")
semantic_version = version_meta["__version__"]
expected_return_code = 0
expected_output = """{version}
""".replace(
"{version}", semantic_version
)
expected_error = ""
# Act
execute_results = scanner.invoke_main(arguments=supplied_arguments)
# Assert
execute_results.assert_results(
expected_output, expected_error, expected_return_code
)
def test_markdown_with_dash_e_single_by_name():
"""
Test to make sure we get enable a rule if '-e' is supplied and the name of the
rule is provided. The test data for MD047 is used as it is a simple file that
passes normally, it is used as a comparison.
"""
# Arrange
scanner = MarkdownScanner()
supplied_arguments = [
"-e",
"debug-only",
"scan",
"test/resources/rules/md047/end_with_blank_line.md",
]
expected_return_code = 0
expected_output = """MD999>>init_from_config
MD999>>test_value>>1
MD999>>other_test_value>>1
MD999>>starting_new_file>>
MD999>>token:[atx(1,1):1:0:]
MD999>>token:[text(1,3):This is a test: ]
MD999>>token:[end-atx::]
MD999>>token:[BLANK(2,1):]
MD999>>token:[para(3,1):]
MD999>>token:[text(3,1):The line after this line should be blank.:]
MD999>>token:[end-para:::True]
MD999>>token:[BLANK(4,1):]
MD999>>next_line:# This is a test
MD999>>next_line:
MD999>>next_line:The line after this line should be blank.
MD999>>next_line:
MD999>>completed_file
"""
expected_error = ""
# Act
execute_results = scanner.invoke_main(arguments=supplied_arguments)
# Assert
execute_results.assert_results(
expected_output, expected_error, expected_return_code
)
def test_markdown_with_dash_e_single_by_id():
"""
Test to make sure we get enable a rule if '-e' is supplied and the id of the
rule is provided. The test data for MD047 is used as it is a simple file that
passes normally, it is used as a comparison.
"""
# Arrange
scanner = MarkdownScanner()
supplied_arguments = [
"-e",
"MD999",
"scan",
"test/resources/rules/md047/end_with_blank_line.md",
]
expected_return_code = 0
expected_output = """MD999>>init_from_config
MD999>>test_value>>1
MD999>>other_test_value>>1
MD999>>starting_new_file>>
MD999>>token:[atx(1,1):1:0:]
MD999>>token:[text(1,3):This is a test: ]
MD999>>token:[end-atx::]
MD999>>token:[BLANK(2,1):]
MD999>>token:[para(3,1):]
MD999>>token:[text(3,1):The line after this line should be blank.:]
MD999>>token:[end-para:::True]
MD999>>token:[BLANK(4,1):]
MD999>>next_line:# This is a test
MD999>>next_line:
MD999>>next_line:The line after this line should be blank.
MD999>>next_line:
MD999>>completed_file
"""
expected_error = ""
# Act
execute_results = scanner.invoke_main(arguments=supplied_arguments)
# Assert
execute_results.assert_results(
expected_output, expected_error, expected_return_code
)
def test_markdown_with_enabled_by_configuration_id():
"""
Test to make sure we enable a rule by using the rule's id in the
configuration, with no help from the command line.
The test data for MD047 is used as it is a simple file that
passes normally, it is used as a comparison.
"""
# Arrange
scanner = MarkdownScanner()
supplied_configuration = {"plugins": {"md999": {"enabled": True}}}
configuration_file = None
try:
configuration_file = write_temporary_configuration(supplied_configuration)
supplied_arguments = [
"-c",
configuration_file,
"scan",
"test/resources/rules/md047/end_with_blank_line.md",
]
expected_return_code = 0
expected_output = """MD999>>init_from_config
MD999>>test_value>>1
MD999>>other_test_value>>1
MD999>>starting_new_file>>
MD999>>token:[atx(1,1):1:0:]
MD999>>token:[text(1,3):This is a test: ]
MD999>>token:[end-atx::]
MD999>>token:[BLANK(2,1):]
MD999>>token:[para(3,1):]
MD999>>token:[text(3,1):The line after this line should be blank.:]
MD999>>token:[end-para:::True]
MD999>>token:[BLANK(4,1):]
MD999>>next_line:# This is a test
MD999>>next_line:
MD999>>next_line:The line after this line should be blank.
MD999>>next_line:
MD999>>completed_file
"""
expected_error = ""
# Act
execute_results = scanner.invoke_main(arguments=supplied_arguments)
# Assert
execute_results.assert_results(
expected_output, expected_error, expected_return_code
)
finally:
if configuration_file and os.path.exists(configuration_file):
os.remove(configuration_file)
def test_markdown_with_enabled_by_configuration_name():
"""
Test to make sure we enable a rule by using the rule's name in the
configuration, with no help from the command line.
The test data for MD047 is used as it is a simple file that
passes normally, it is used as a comparison.
"""
# Arrange
scanner = MarkdownScanner()
supplied_configuration = {"plugins": {"debug-only": {"enabled": True}}}
configuration_file = None
try:
configuration_file = write_temporary_configuration(supplied_configuration)
supplied_arguments = [
"-c",
configuration_file,
"--stack-trace",
"--log-level",
"DEBUG",
"scan",
"test/resources/rules/md047/end_with_blank_line.md",
]
expected_return_code = 0
expected_output = """MD999>>init_from_config
MD999>>test_value>>1
MD999>>other_test_value>>1
MD999>>starting_new_file>>
MD999>>token:[atx(1,1):1:0:]
MD999>>token:[text(1,3):This is a test: ]
MD999>>token:[end-atx::]
MD999>>token:[BLANK(2,1):]
MD999>>token:[para(3,1):]
MD999>>token:[text(3,1):The line after this line should be blank.:]
MD999>>token:[end-para:::True]
MD999>>token:[BLANK(4,1):]
MD999>>next_line:# This is a test
MD999>>next_line:
MD999>>next_line:The line after this line should be blank.
MD999>>next_line:
MD999>>completed_file
"""
expected_error = ""
# Act
execute_results = scanner.invoke_main(arguments=supplied_arguments)
# Assert
execute_results.assert_results(
expected_output, expected_error, expected_return_code
)
finally:
if configuration_file and os.path.exists(configuration_file):
os.remove(configuration_file)
def test_markdown_with_dash_d_single_by_name():
"""
Test to make sure we get enable a rule if '-d' is supplied and the name of the
rule is provided. The test data for MD047 is used as it is a simple file that
fails normally, it is used as a comparison.
"""
# Arrange
scanner = MarkdownScanner()
supplied_arguments = [
"-d",
"single-trailing-newline",
"scan",
"test/resources/rules/md047/end_with_blank_line.md",
]
expected_return_code = 0
expected_output = ""
expected_error = ""
# Act
execute_results = scanner.invoke_main(arguments=supplied_arguments)
# Assert
execute_results.assert_results(
expected_output, expected_error, expected_return_code
)
def test_markdown_with_dash_d_single_by_id():
"""
Test to make sure we get enable a rule if '-d' is supplied and the id of the
rule is provided. The test data for MD047 is used as it is a simple file that
fails normally, it is used as a comparison.
"""
# Arrange
scanner = MarkdownScanner()
supplied_arguments = [
"-d",
"MD047",
"scan",
"test/resources/rules/md047/end_with_no_blank_line.md",
]
expected_return_code = 0
expected_output = ""
expected_error = ""
# Act
execute_results = scanner.invoke_main(arguments=supplied_arguments)
# Assert
execute_results.assert_results(
expected_output, expected_error, expected_return_code
)
def test_markdown_with_dash_d_and_dash_e_single_by_name():
"""
Test to make sure we get disabled if a rule if '-d' is supplied
and if 'e' is supplied, both with the name of the rule.
The test data for MD047 is used as it is a simple file that
fails normally, it is used as a comparison.
"""
# Arrange
scanner = MarkdownScanner()
supplied_arguments = [
"-d",
"single-trailing-newline",
"-e",
"single-trailing-newline",
"scan",
"test/resources/rules/md047/end_with_blank_line.md",
]
expected_return_code = 0
expected_output = ""
expected_error = ""
# Act
execute_results = scanner.invoke_main(arguments=supplied_arguments)
# Assert
execute_results.assert_results(
expected_output, expected_error, expected_return_code
)
def test_markdown_with_dash_x_scan():
"""
Test to make sure we get simulate a test scan exception if the `-x-scan` flag
is set.
"""
# Arrange
scanner = MarkdownScanner()
supplied_arguments = [
"-x-scan",
"scan",
"test/resources/rules/md047/end_with_no_blank_line.md",
]
expected_return_code = 1
expected_output = ""
expected_error = """BadTokenizationError encountered while scanning 'test/resources/rules/md047/end_with_no_blank_line.md':
An unhandled error occurred processing the document.
"""
# Act
execute_results = scanner.invoke_main(arguments=supplied_arguments)
# Assert
execute_results.assert_results(
expected_output, expected_error, expected_return_code
)
def test_markdown_with_dash_dash_log_level_debug(caplog):
"""
Test to make sure we get the right effect if the `--log-level` flag
is set for debug.
"""
# Arrange
scanner = MarkdownScanner()
supplied_arguments = [
"--log-level",
"DEBUG",
"scan",
"test/resources/rules/md047/end_with_blank_line.md",
]
expected_return_code = 0
expected_output = ""
expected_error = """"""
# Act
ParserLogger.sync_on_next_call()
execute_results = scanner.invoke_main(arguments=supplied_arguments)
# Assert
execute_results.assert_results(
expected_output, expected_error, expected_return_code
)
# Info messages
assert "Number of files found: " in caplog.text
assert (
"Determining files to scan for path "
+ "'test/resources/rules/md047/end_with_blank_line.md'."
in caplog.text
)
# Debug messages
assert (
"Provided path 'test/resources/rules/md047/end_with_blank_line.md' "
+ "is a valid file. Adding."
in caplog.text
)
def test_markdown_with_dash_dash_log_level_info(caplog):
"""
Test to make sure we get the right effect if the `--log-level` flag
is set for info.
"""
# Arrange
scanner = MarkdownScanner()
supplied_arguments = [
"--log-level",
"INFO",
"scan",
"test/resources/rules/md047/end_with_blank_line.md",
]
expected_return_code = 0
expected_output = ""
expected_error = ""
# Act
ParserLogger.sync_on_next_call()
execute_results = scanner.invoke_main(arguments=supplied_arguments)
# Assert
execute_results.assert_results(
expected_output, expected_error, expected_return_code
)
# Info messages
assert "Number of files found: " in caplog.text
assert (
"Determining files to scan for path "
+ "'test/resources/rules/md047/end_with_blank_line.md'."
in caplog.text
)
# Debug messages
assert (
"Provided path 'test/resources/rules/md047/end_with_blank_line.md' "
+ "is a valid file. Adding."
not in caplog.text
)
def test_markdown_with_dash_dash_log_level_invalid(caplog):
"""
Test to make sure we get the right effect if the `--log-level` flag
is set for an invalid log level.
"""
# Arrange
scanner = MarkdownScanner()
supplied_arguments = [
"--log-level",
"invalid",
"scan",
"test/resources/rules/md047/end_with_blank_line.md",
]
expected_return_code = 2
expected_output = ""
expected_error = """usage: main.py [-h] [-e ENABLE_RULES] [-d DISABLE_RULES]
[--add-plugin ADD_PLUGIN] [--config CONFIGURATION_FILE]
[--set SET_CONFIGURATION] [--strict-config] [--stack-trace]
[--log-level {CRITICAL,ERROR,WARNING,INFO,DEBUG}]
[--log-file LOG_FILE]
{plugins,scan,version} ...
main.py: error: argument --log-level: invalid log_level_type value: 'invalid'
"""
# Act
ParserLogger.sync_on_next_call()
execute_results = scanner.invoke_main(arguments=supplied_arguments)
# Assert
execute_results.assert_results(
expected_output, expected_error, expected_return_code
)
# Info messages
assert "Number of scanned files found: " not in caplog.text
assert (
"Determining files to scan for path "
+ "'test/resources/rules/md047/end_with_blank_line.md'."
not in caplog.text
)
# Debug messages
assert (
"Provided path 'test/resources/rules/md047/end_with_blank_line.md' "
+ "is a valid Markdown file. Adding."
not in caplog.text
)
def test_markdown_with_dash_dash_log_level_info_with_file():
"""
Test to make sure we get the right effect if the `--log-level` flag
is set for info with the results going to a file.
"""
# Arrange
temp_file = None
try:
temp_file = tempfile.NamedTemporaryFile()
log_file_name = temp_file.name
finally:
if temp_file:
temp_file.close()
try:
scanner = MarkdownScanner()
supplied_arguments = [
"--log-level",
"INFO",
"--log-file",
log_file_name,
"scan",
"test/resources/rules/md047/end_with_blank_line.md",
]
expected_return_code = 0
expected_output = ""
expected_error = ""
# Act
ParserLogger.sync_on_next_call()
execute_results = scanner.invoke_main(arguments=supplied_arguments)
# Assert
execute_results.assert_results(
expected_output, expected_error, expected_return_code
)
with open(log_file_name) as file:
file_data = file.read().replace("\n", "")
# Info messages
assert "Number of files found: " in file_data, ">" + str(file_data) + "<"
assert (
"Determining files to scan for path "
+ "'test/resources/rules/md047/end_with_blank_line.md'."
in file_data
)
# Debug messages
assert (
"Provided path 'test/resources/rules/md047/end_with_blank_line.md' "
+ "is a valid file. Adding."
not in file_data
)
finally:
if os.path.exists(log_file_name):
os.remove(log_file_name)
def test_markdown_with_dash_x_init():
"""
Test to make sure we get simulate a test initialization exception if the
`-x-init` flag is set.
"""
# Arrange
scanner = MarkdownScanner()
supplied_arguments = [
"-x-init",
"scan",
"test/resources/rules/md047/end_with_no_blank_line.md",
]
fake_directory = "fredo"
abs_fake_directory = os.path.abspath(fake_directory).replace("\\", "\\\\")
expected_return_code = 1
expected_output = ""
expected_error = (
"BadTokenizationError encountered while initializing tokenizer:\n"
+ "Named character entity map file '"
+ fake_directory
+ "\\entities.json' was not loaded "
+ "([Errno 2] No such file or directory: '"
+ abs_fake_directory
+ "\\\\entities.json').\n"
)
# Act
execute_results = scanner.invoke_main(arguments=supplied_arguments)
# Assert
execute_results.assert_results(
expected_output, expected_error, expected_return_code
)
def test_markdown_with_dash_e_single_by_id_and_good_config():
"""
Test to make sure we get enable a rule if '-e' is supplied and the id of the
rule is provided. The test data for MD047 is used as it is a simple file that
passes normally, it is used as a comparison.
"""
# Arrange
scanner = MarkdownScanner()
supplied_configuration = {"plugins": {"md999": {"test_value": 2}}}
configuration_file = None
try:
configuration_file = write_temporary_configuration(supplied_configuration)
supplied_arguments = [
"-e",
"MD999",
"-c",
configuration_file,
"scan",
"test/resources/rules/md047/end_with_blank_line.md",
]
expected_return_code = 0
expected_output = """MD999>>init_from_config
MD999>>test_value>>2
MD999>>other_test_value>>1
MD999>>starting_new_file>>
MD999>>token:[atx(1,1):1:0:]
MD999>>token:[text(1,3):This is a test: ]
MD999>>token:[end-atx::]
MD999>>token:[BLANK(2,1):]
MD999>>token:[para(3,1):]
MD999>>token:[text(3,1):The line after this line should be blank.:]
MD999>>token:[end-para:::True]
MD999>>token:[BLANK(4,1):]
MD999>>next_line:# This is a test
MD999>>next_line:
MD999>>next_line:The line after this line should be blank.
MD999>>next_line:
MD999>>completed_file
"""
expected_error = ""
# Act
execute_results = scanner.invoke_main(arguments=supplied_arguments)
# Assert
execute_results.assert_results(
expected_output, expected_error, expected_return_code
)
finally:
if configuration_file and os.path.exists(configuration_file):
os.remove(configuration_file)
def test_markdown_with_dash_e_single_by_id_and_bad_config():
"""
Test to make sure we get enable a rule if '-e' is supplied and the id of the
rule is provided. The test data for MD047 is used as it is a simple file that
passes normally, it is used as a comparison.
"""
# Arrange
scanner = MarkdownScanner()
supplied_configuration = {"plugins": {"md999": {"test_value": "fred"}}}
configuration_file = None
try:
configuration_file = write_temporary_configuration(supplied_configuration)
supplied_arguments = [
"-e",
"MD999",
"-c",
configuration_file,
"scan",
"test/resources/rules/md047/end_with_blank_line.md",
]
expected_return_code = 0
expected_output = """MD999>>init_from_config
MD999>>test_value>>1
MD999>>other_test_value>>1
MD999>>starting_new_file>>
MD999>>token:[atx(1,1):1:0:]
MD999>>token:[text(1,3):This is a test: ]
MD999>>token:[end-atx::]
MD999>>token:[BLANK(2,1):]
MD999>>token:[para(3,1):]
MD999>>token:[text(3,1):The line after this line should be blank.:]
MD999>>token:[end-para:::True]
MD999>>token:[BLANK(4,1):]
MD999>>next_line:# This is a test
MD999>>next_line:
MD999>>next_line:The line after this line should be blank.
MD999>>next_line:
MD999>>completed_file
"""
expected_error = ""
# Act
execute_results = scanner.invoke_main(arguments=supplied_arguments)
# Assert
execute_results.assert_results(
expected_output, expected_error, expected_return_code
)
finally:
if configuration_file and os.path.exists(configuration_file):
os.remove(configuration_file)
def test_markdown_with_dash_e_single_by_id_and_bad_config_file():
"""
Test to make sure we get an error if we provide a configuration file that is
in a json format, but not valid.
"""
# Arrange
scanner = MarkdownScanner()
supplied_configuration = {"plugins": {"myrule.md999": {"test_value": "fred"}}}
configuration_file = None
try:
configuration_file = write_temporary_configuration(supplied_configuration)
supplied_arguments = [
"-e",
"MD999",
"-c",
configuration_file,
"scan",
"test/resources/rules/md047/end_with_blank_line.md",
]
expected_return_code = 1
expected_output = ""
expected_error = (
"Specified configuration file '"
+ configuration_file
+ "' is not valid (Keys strings cannot contain the separator character '.'.).\n"
)
# Act
execute_results = scanner.invoke_main(arguments=supplied_arguments)
# Assert
execute_results.assert_results(
expected_output, expected_error, expected_return_code
)
finally:
if configuration_file and os.path.exists(configuration_file):
os.remove(configuration_file)
def test_markdown_with_dash_e_single_by_id_and_non_json_config_file():
"""
Test to make sure we get an error if we provide a configuration file that is
not in a json format.
"""
# Arrange
scanner = MarkdownScanner()
supplied_configuration = "not a json file"
configuration_file = None
try:
configuration_file = write_temporary_configuration(supplied_configuration)
supplied_arguments = [
"-e",
"MD999",
"-c",
configuration_file,
"scan",
"test/resources/rules/md047/end_with_blank_line.md",
]
expected_return_code = 1
expected_output = ""
expected_error = (
"Specified configuration file '"
+ configuration_file
+ "' is not a valid JSON file (Expecting value: line 1 column 1 (char 0)).\n"
)
# Act
execute_results = scanner.invoke_main(arguments=supplied_arguments)
# Assert
execute_results.assert_results(
expected_output, expected_error, expected_return_code
)
finally:
if configuration_file and os.path.exists(configuration_file):
os.remove(configuration_file)
def test_markdown_with_dash_e_single_by_id_and_non_present_config_file():
"""
Test to make sure we get an error if we provide a configuration file that is
not in a json format.
"""
# Arrange
scanner = MarkdownScanner()
configuration_file = "not-exists"
assert not os.path.exists(configuration_file)
supplied_arguments = [
"-e",
"MD999",
"-c",
configuration_file,
"scan",
"test/resources/rules/md047/end_with_blank_line.md",
]
expected_return_code = 1
expected_output = ""
expected_error = (
"Specified configuration file 'not-exists' was not loaded "
+ "([Errno 2] No such file or directory: 'not-exists').\n"
)
# Act
execute_results = scanner.invoke_main(arguments=supplied_arguments)
# Assert
execute_results.assert_results(
expected_output, expected_error, expected_return_code
)
def test_markdown_with_dash_e_single_by_id_and_good_select_config():
"""
Test to make sure we get enable a rule if '-e' is supplied and the id of the
rule is provided. The test data for MD047 is used as it is a simple file that
passes normally, it is used as a comparison.
"""
# Arrange
scanner = MarkdownScanner()
supplied_configuration = {"plugins": {"md999": {"other_test_value": 2}}}
configuration_file = None
try:
configuration_file = write_temporary_configuration(supplied_configuration)
supplied_arguments = [
"-e",
"MD999",
"-c",
configuration_file,
"scan",
"test/resources/rules/md047/end_with_blank_line.md",
]
expected_return_code = 0
expected_output = """MD999>>init_from_config
MD999>>test_value>>1
MD999>>other_test_value>>2
MD999>>starting_new_file>>
MD999>>token:[atx(1,1):1:0:]
MD999>>token:[text(1,3):This is a test: ]
MD999>>token:[end-atx::]
MD999>>token:[BLANK(2,1):]
MD999>>token:[para(3,1):]
MD999>>token:[text(3,1):The line after this line should be blank.:]
MD999>>token:[end-para:::True]
MD999>>token:[BLANK(4,1):]
MD999>>next_line:# This is a test
MD999>>next_line:
MD999>>next_line:The line after this line should be blank.
MD999>>next_line:
MD999>>completed_file
"""
expected_error = ""
# Act
execute_results = scanner.invoke_main(arguments=supplied_arguments)
# Assert
execute_results.assert_results(
expected_output, expected_error, expected_return_code
)
finally:
if configuration_file and os.path.exists(configuration_file):
os.remove(configuration_file)