devops-exercises/tests/syntax_lint.py

143 lines
3.5 KiB
Python
Raw Normal View History

2019-12-21 19:24:34 +01:00
"""
2019-12-21 21:22:32 +01:00
Testing suite for https://github.com/bregman-arie/devops-interview-questions
written by surister
2019-12-21 19:24:34 +01:00
2019-12-21 21:22:32 +01:00
Even though both check_details_tag and check_summary_tags are practically the
same, due to readability and functionality it was decided to be split like
that.
2019-12-21 19:24:34 +01:00
Usage:
2020-01-09 12:12:06 +01:00
$ python tests/syntax_lint.py
2019-12-21 19:24:34 +01:00
"""
import pathlib
p = pathlib.Path(__file__).parent.parent.joinpath('README.md')
with open(p, 'rb') as f:
file_list = [line.rstrip() for line in f.readlines()]
errors = []
def count_details(file_list):
"""
Counts the total amount of <details> and </details>
Used for debugging purpose, not meant to be used in actual tests
"""
details_final_count = 0
details_count = 0
for line_number, line in enumerate(file_list):
if b'<details>' in line:
details_count += 1
if b'</details>' in line:
details_final_count += 1
2019-12-24 19:34:31 +01:00
return details_count == details_final_count
2019-12-21 19:24:34 +01:00
2020-01-09 12:12:06 +01:00
def count_summary(file_list):
"""
Counts the total amount of <details> and </details>
Used for debugging purpose, not meant to be used in actual tests
"""
details_final_count = 0
details_count = 0
for line_number, line in enumerate(file_list):
if b'<summary>' in line:
details_count += 1
if b'</summary>' in line:
details_final_count += 1
return details_count == details_final_count
2019-12-21 19:24:34 +01:00
def check_details_tag(file_list):
"""
Check whether the structure:
<details>
...
</details>
Is correctly followed, if not generates an error.
"""
after_detail = False
error = False
err_message = ''
for line_number, line in enumerate(file_list):
if b'<details>' in line and b'</details>' in line:
pass
else:
if b'<details>' in line and after_detail:
2019-12-21 23:18:34 +01:00
err_message = f'Missing closing detail tag round line {line_number - 1}'
2019-12-21 19:24:34 +01:00
error = True
if b'</details>' in line and not after_detail:
2019-12-21 23:18:34 +01:00
err_message = f'Missing opening detail tag round line {line_number - 1}'
2019-12-21 19:24:34 +01:00
error = True
if b'<details>' in line:
after_detail = True
if b'</details>' in line and after_detail:
after_detail = False
if error:
errors.append(err_message)
error = False
2019-12-21 19:24:34 +01:00
def check_summary_tag(file_list):
"""
Check whether the structure:
<summary>
...
</summary>
Is correctly followed, if not generates an error.
"""
2019-12-21 23:18:34 +01:00
after_summary = False
2019-12-21 19:24:34 +01:00
error = False
err_message = ''
for line_number, line in enumerate(file_list):
if b'<summary>' in line and b'</summary>' in line:
pass
else:
2019-12-21 23:18:34 +01:00
if b'<summary>' in line and after_summary:
err_message = f'Missing closing summary tag around line {line_number}'
2019-12-21 19:24:34 +01:00
error = True
2019-12-21 23:18:34 +01:00
if b'</summary>' in line and not after_summary:
err_message = f'Missing opening summary tag around line {line_number}'
2019-12-21 19:24:34 +01:00
error = True
if b'<summary>' in line:
2019-12-21 23:18:34 +01:00
after_summary = True
2019-12-21 19:24:34 +01:00
2019-12-21 23:18:34 +01:00
if b'</summary>' in line and after_summary:
after_summary = False
2019-12-21 19:24:34 +01:00
if error:
errors.append(err_message)
error = False
2019-12-21 19:24:34 +01:00
if __name__ == '__main__':
check_details_tag(file_list)
check_summary_tag(file_list)
if errors:
for error in errors:
print(error)
exit(1)
print("Tests passed successfully.")