From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga12.intel.com (mga12.intel.com [192.55.52.136]) by gabe.freedesktop.org (Postfix) with ESMTPS id 8630910E976 for ; Fri, 10 Mar 2023 08:23:39 +0000 (UTC) From: =?UTF-8?q?Zbigniew=20Kempczy=C5=84ski?= To: igt-dev@lists.freedesktop.org Date: Fri, 10 Mar 2023 09:23:10 +0100 Message-Id: <20230310082326.12088-3-zbigniew.kempczynski@intel.com> In-Reply-To: <20230310082326.12088-1-zbigniew.kempczynski@intel.com> References: <20230310082326.12088-1-zbigniew.kempczynski@intel.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Subject: [igt-dev] [PATCH i-g-t 02/18] scripts/igt_doc.py: add JSON file output List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: igt-dev-bounces@lists.freedesktop.org Sender: "igt-dev" List-ID: From: Mauro Carvalho Chehab At least for debugging purposes, it is interesting to see how the script is parsing the input files and expanding wildcards on a more condensed way. So, add support to output the dictionary contents into a json file. Signed-off-by: Mauro Carvalho Chehab Reviewed-by: Zbigniew Kempczyński --- scripts/igt_doc.py | 51 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) diff --git a/scripts/igt_doc.py b/scripts/igt_doc.py index c8bd4054f6..d21f87dc71 100644 --- a/scripts/igt_doc.py +++ b/scripts/igt_doc.py @@ -11,6 +11,7 @@ """Maintain test plan and test implementation documentation on IGT.""" import argparse +import json import re import subprocess import sys @@ -231,6 +232,42 @@ class TestList: return subtest_array + def expand_dictionary(self): + + """ prepares a dictonary with subtest arguments expanded """ + + test_dict = {} + + for test in self.doc: # pylint: disable=C0206 + fname = self.doc[test]["File"] + + name = re.sub(r'.*tests/', '', fname) + name = re.sub(r'\.[ch]', '', name) + name = "igt@" + name + + test_dict[name] = {} + + for field in self.doc[test]: + if field == "subtest": + continue + if field == "arg": + continue + + test_dict[name][field] = self.doc[test][field] + + subtest_array = self.expand_subtest(fname, name, test) + for subtest in subtest_array: + summary = subtest["Summary"] + test_dict[name][summary] = {} + for field in sorted(subtest.keys()): + if field == 'Summary': + continue + if field == 'arg': + continue + test_dict[name][summary][field] = subtest[field] + + return test_dict + # # Output methods # @@ -280,6 +317,14 @@ class TestList: print() print() + def print_json(self, out_fname): + + """Adds the contents of test/subtest documentation form a file""" + test_dict = self.expand_dictionary() + + with open(out_fname, "w", encoding='utf8') as write_file: + json.dump(test_dict, write_file, indent=4) + # # Subtest list methods # @@ -541,6 +586,8 @@ parser = argparse.ArgumentParser(description = "Print formatted kernel documenta epilog = 'If no action specified, assume --rest.') parser.add_argument("--rest", action="store_true", help="Generate documentation from the source files, in ReST file format.") +parser.add_argument("--to-json", + help="Output test documentation in JSON format as TO_JSON file") parser.add_argument("--show-subtests", action="store_true", help="Shows the name of the documented subtests in alphabetical order.") parser.add_argument("--check-testlist", action="store_true", @@ -570,5 +617,9 @@ if parse_args.check_testlist: RUN = 1 tests.check_tests() +if parse_args.to_json: + RUN = 1 + tests.print_json(parse_args.to_json) + if not RUN or parse_args.rest: tests.print_test() -- 2.34.1