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
|
#!/usr/bin/env python3
# pylint: disable=C0103, C0200
# SPDX-License-Identifier: (GPL-2.0 OR MIT)
## Copyright (C) 2023 Intel Corporation ##
## Author: Mauro Carvalho Chehab <mchehab@kernel.org> ##
## ##
## Allow keeping inlined test documentation and validate ##
## if the documentation is kept updated. ##
"""Write the contents of the testplan documentation to a XLS file."""
import argparse
from openpyxl.styles import Font
from openpyxl.utils import get_column_letter
from openpyxl import Workbook
from sys import stderr
from test_list import TestList
EPILOG = """
Examples:
1. Create a XLS file with a single worksheet with Xe driver documentation:
scripts/doc_to_xls.py --config tests/kms_*json tests/*/*.json --xls igt_test_documentation.xls
2. Create a XLS file with one sheet per driver, for all drivers with testplan config files and KMS:
scripts/doc_to_xls.py --config tests/kms_*json tests/*/*.json --xls igt_test_documentation.xls
"""
def tests_to_xls(tests, fname):
"""
Convert an array of IGT documentation tests into a XLS file
"""
wb = Workbook()
ws = None
expand_fields = {
"GPU excluded platform": "blocklist "
}
for row in range(len(tests)):
test = tests[row]
sheet_name = test.title
sheet = test.get_spreadsheet(expand_fields)
# Ignore empty sheets
if not len(sheet):
print(f"Warning: sheet '{test.title}' is empty!", file=stderr)
continue
if not ws:
ws = wb.active
ws.title = sheet_name
else:
ws = wb.create_sheet(sheet_name)
max_length = []
for col in range(len(sheet[0])):
max_length.append(0)
for row in range(len(sheet)):
for col in range(len(sheet[row])):
c = ws.cell(row=row + 1, column=col + 1, value=sheet[row][col])
if row == 0:
c.font = Font(bold=True)
if len(sheet[row][col]) > max_length[col]:
max_length[col] = len(sheet[row][col])
# Estimate column length
for col in range(len(sheet[0])):
column = get_column_letter(col + 1)
adjusted_width = (max_length[col] + 2) * 1.2
ws.column_dimensions[column].width = adjusted_width
# Turn on auto-filter
ws.auto_filter.ref = ws.dimensions
wb.save(fname)
######
# Main
######
def main():
"""Main program"""
parser = argparse.ArgumentParser(description=__doc__,
formatter_class=argparse.RawDescriptionHelpFormatter,
epilog=EPILOG)
parser.add_argument("--config", required=True, nargs='+',
help="JSON file describing the test plan template")
parser.add_argument("--include-plan", action="store_true",
help="Include test plans, if any.")
parser.add_argument("--xls", required=True,
help="Output XLS file.")
parse_args = parser.parse_args()
tests = []
for config_file in parse_args.config:
# Implemented tests
tests.append(TestList(config_file, parse_args.include_plan))
tests_to_xls(tests, fname=parse_args.xls)
if __name__ == '__main__':
main()
|
