yuzu-emu/mbedtls
1
0
Fork 0
mirror of https://github.com/yuzu-emu/mbedtls.git synced 2024-11-25 21:35:48 +01:00
Code Issues Packages Projects Releases Wiki Activity

Documentation improvements

Browse Source 
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
This commit is contained in:
Gilles Peskine 2020-07-03 00:30:12 +02:00
parent 3d863f2631
commit bbb3664957
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
tests/scripts/check_test_cases.py
View File

@ -1,6 +1,9 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
"""Sanity checks for test data. """Sanity checks for test data.
This program contains a class for traversing test cases that can be used
independently of the checks.
""" """
# Copyright (C) 2019, Arm Limited, All Rights Reserved # Copyright (C) 2019, Arm Limited, All Rights Reserved
@ -60,14 +63,15 @@ the process_test_case method, and call walk_all().
file_name, line_number, description): file_name, line_number, description):
"""Process a test case. """Process a test case.
per_file_state: a new object returned by per_file_state() for each file. per_file_state: an object created by new_per_file_state() at the beginning
of each file.
file_name: a relative path to the file containing the test case. file_name: a relative path to the file containing the test case.
line_number: the line number in the given file. line_number: the line number in the given file.
description: the test case description as a byte string. description: the test case description as a byte string.
""" """
raise NotImplementedError raise NotImplementedError
def per_file_state(self): def new_per_file_state(self):
"""Return a new per-file state object. """Return a new per-file state object.
The default per-file state object is None. Child classes that require per-file The default per-file state object is None. Child classes that require per-file
@ -79,7 +83,7 @@ state may override this method.
def walk_test_suite(self, data_file_name): def walk_test_suite(self, data_file_name):
"""Iterate over the test cases in the given unit test data file.""" """Iterate over the test cases in the given unit test data file."""
in_paragraph = False in_paragraph = False
descriptions = self.per_file_state() # pylint: disable=assignment-from-none descriptions = self.new_per_file_state() # pylint: disable=assignment-from-none
with open(data_file_name, 'rb') as data_file: with open(data_file_name, 'rb') as data_file:
for line_number, line in enumerate(data_file, 1): for line_number, line in enumerate(data_file, 1):
line = line.rstrip(b'\r\n') line = line.rstrip(b'\r\n')
@ -96,7 +100,7 @@ state may override this method.
def walk_ssl_opt_sh(self, file_name): def walk_ssl_opt_sh(self, file_name):
"""Iterate over the test cases in ssl-opt.sh or a file with a similar format.""" """Iterate over the test cases in ssl-opt.sh or a file with a similar format."""
descriptions = self.per_file_state() # pylint: disable=assignment-from-none descriptions = self.new_per_file_state() # pylint: disable=assignment-from-none
with open(file_name, 'rb') as file_contents: with open(file_name, 'rb') as file_contents:
for line_number, line in enumerate(file_contents, 1): for line_number, line in enumerate(file_contents, 1):
# Assume that all run_test calls have the same simple form # Assume that all run_test calls have the same simple form
@ -142,7 +146,7 @@ class DescriptionChecker(TestDescriptionExplorer):
def __init__(self, results): def __init__(self, results):
self.results = results self.results = results
def per_file_state(self): def new_per_file_state(self):
"""Dictionary mapping descriptions to their line number.""" """Dictionary mapping descriptions to their line number."""
return {} return {}