nicolas
/
gaspype
mirror of https://github.com/DLR-Institute-of-Future-Fuels/gaspype.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

example unit test updated to test all examples from example directory

This commit is contained in:
Nicolas Kruse 2025-06-06 09:05:40 +02:00
parent 793b2a0ab4
commit 6c3437f509
2 changed files with 27 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
tests/md_to_code.py
View File

@ -1,10 +1,9 @@
import re import re
from typing import Generator, Iterable, Literal from typing import Generator, Iterable
from dataclasses import dataclass from dataclasses import dataclass
import sys import sys
@dataclass @dataclass
class markdown_segment: class markdown_segment:
code_block: bool code_block: bool
@ -24,7 +23,7 @@ def convert_to(target_format: str, md_filename: str, out_filename: str, language
f_out.write('\n'.join(segments_to_striped_markdown(segments, language))) f_out.write('\n'.join(segments_to_striped_markdown(segments, language)))
else: else:
raise ValueError('Unknown target format') raise ValueError('Unknown target format')
def segment_markdown(markdown_file: Iterable[str]) -> Generator[markdown_segment, None, None]: def segment_markdown(markdown_file: Iterable[str]) -> Generator[markdown_segment, None, None]:
regex = re.compile(r"(?:^```\s*(?P<language>(?:\w|-)*)$)", re.MULTILINE) regex = re.compile(r"(?:^```\s*(?P<language>(?:\w|-)*)$)", re.MULTILINE)
@ -95,7 +94,7 @@ def segments_to_test(segments: Iterable[markdown_segment], script_language: str
if segment.language == script_language: if segment.language == script_language:
lines = [line for line in segment.text.splitlines() if line.strip()] lines = [line for line in segment.text.splitlines() if line.strip()]
ret_block_flag = lines[-1] if not re.match(r'^[^(]*=', lines[-1]) and not lines[-1].startswith('import ') else None ret_block_flag = lines[-1] if not re.match(r'^[^(]*=', lines[-1]) and not lines[-1].startswith('import ') else None
print('Last line: ', ret_block_flag, '-----------', lines[-1]) # print('Last line: ', ret_block_flag, '-----------', lines[-1])
yield '' yield ''
yield ' print("---------------------------------------------------------")' yield ' print("---------------------------------------------------------")'
@ -119,7 +118,8 @@ def segments_to_test(segments: Iterable[markdown_segment], script_language: str
yield '\nif __name__ == "__main__":' yield '\nif __name__ == "__main__":'
yield ' run_test()' yield ' run_test()'
if __name__ == "__main__": if __name__ == "__main__":
format = sys.argv[1] format = sys.argv[1]
assert format in ['test', 'script'] assert format in ['test', 'script']
convert_to(sys.argv[1], sys.argv[2], sys.argv[3]) convert_to(sys.argv[1], sys.argv[2], sys.argv[3])

25
tests/test_doc_examples.py
View File

@ -1,11 +1,28 @@
import md_to_code import md_to_code
from glob import glob
import importlib
import os
def test_readme(): def test_readme():
md_to_code.convert_to('test', 'README.md', 'tests/autogenerated_readme.py') md_to_code.convert_to('test', 'README.md', 'tests/autogenerated_readme.py')
import autogenerated_readme import autogenerated_readme
autogenerated_readme.run_test() autogenerated_readme.run_test()
def test_soec_example():
md_to_code.convert_to('test', 'docs/source/examples/soec_methane.md', 'tests/autogenerated_soec_example.py') def test_example_code():
import autogenerated_soec_example filter = 'docs/source/examples/*.md'
autogenerated_soec_example.run_test()
files = glob(filter)
for path in files:
file_name = '.'.join(os.path.basename(path).split('.')[:-1])
if not file_name.lower() == 'readme':
print(f"> Test Example {file_name} ...")
md_to_code.convert_to('test', path, f'tests/autogenerated_{file_name}.py')
mod = importlib.import_module(file_name)
mod.run_test()
if __name__ == "__main__":
test_readme()
test_example_code()