- {self._generate_header()}
- {self._generate_risk_banner()}
- {self._generate_risk_questions()}
- {self._generate_footer()}
-
-
-
- '''
-
- def _generate_head(self):
-
- return f'''
-
-
- '''
-
- content += self._generate_header()
-
- content += self._generate_table_head()
-
- return content
-
- def _generate_footer(self):
- footer = f'''
-
- '''
- return footer
-
- def _generate_css(self):
- return '''
- /* Set some global variables */
- :root {
- --header-height: .75in;
- --header-width: 8.5in;
- --header-pos-x: 0in;
- --header-pos-y: 0in;
- --page-width: 8.5in;
- }
-
- @font-face {
- font-family: 'Google Sans';
- font-style: normal;
- src: url(https://fonts.gstatic.com/s/googlesans/v58/4Ua_rENHsxJlGDuGo1OIlJfC6l_24rlCK1Yo_Iqcsih3SAyH6cAwhX9RFD48TE63OOYKtrwEIJllpyk.woff2) format('woff2');
- unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
- }
-
- @font-face {
- font-family: 'Roboto Mono';
- font-style: normal;
- src: url(https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,100..700;1,100..700&display=swap) format('woff2');
- unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
- }
-
- /* Define some common body formatting*/
- body {
- font-family: 'Google Sans', sans-serif;
- margin: 0px;
- padding: 0px;
- }
-
- /* Sets proper page size during print to pdf for weasyprint */
- @page {
- size: Letter;
- width: 8.5in;
- height: 11in;
- }
-
- .page {
- position: relative;
- margin: 0 20px;
- width: 8.5in;
- height: 11in;
- }
-
- /* Define the header related css elements*/
- .header {
- position: relative;
- }
-
- h1 {
- margin: 0 0 8px 0;
- font-size: 20px;
- font-weight: 400;
- }
-
- h2 {
- margin: 0px;
- font-size: 48px;
- font-weight: 700;
- }
-
- h3 {
- font-size: 24px;
- margin-bottom: 10px;
- margin-top: 15px;
- }
-
- h4 {
- font-size: 12px;
- font-weight: 500;
- color: #5F6368;
- margin-bottom: 0;
- margin-top: 0;
- }
-
- /* CSS for the footer */
- .footer {
- position: absolute;
- height: 30px;
- width: 8.5in;
- bottom: 0in;
- border-top: 1px solid #D3D3D3;
- }
-
- .footer-label {
- color: #3C4043;
- position: absolute;
- top: 5px;
- font-size: 12px;
- }
-
- @media print {
- @page {
- size: Letter;
- width: 8.5in;
- height: 11in;
- }
- }
-
- .risk-banner {
- min-height: 120px;
- padding: 5px 40px 0 40px;
- margin-top: 30px;
- }
-
- .risk-banner-limited {
- background-color: #E4F7FB;
- color: #007B83;
- }
-
- .risk-banner-high {
- background-color: #FCE8E6;
- color: #C5221F;
- }
-
- .risk-banner-title {
- text-transform: uppercase;
- font-weight: bold;
- }
-
- .risk-table {
- width: 100%;
- margin-top: 40px;
- text-align: left;
- color: #3C4043;
- font-size: 14px;
- }
-
- .risk-table-head {
- margin-bottom: 15px;
- }
-
- .risk-table-head-question {
- display: inline-block;
- margin-left: 70px;
- font-weight: bold;
- }
-
- .risk-table-head-answer {
- display: inline-block;
- margin-left: 325px;
- font-weight: bold;
- }
-
- .risk-table-row {
- margin-bottom: 8px;
- background-color: #F8F9FA;
- display: flex;
- align-items: stretch;
- overflow: hidden;
- }
-
- .risk-question-no {
- padding: 15px 20px;
- width: 10px;
- display: inline-block;
- vertical-align: top;
- position: relative;
- }
-
- .risk-question {
- padding: 15px 20px;
- display: inline-block;
- width: 350px;
- vertical-align: top;
- position: relative;
- height: 100%;
- }
-
- .risk-answer {
- background-color: #E8F0FE;
- padding: 15px 20px;
- display: inline-block;
- width: 340px;
- position: relative;
- height: 100%;
- }
-
- ul {
- margin-top: 0;
- }
-
- .risk-label{
- position: absolute;
- top: 0px;
- right: 0px;
- width: 52px;
- height: 16px;
- font-family: 'Google Sans', sans-serif;
- font-size: 8px;
- font-weight: 500;
- line-height: 16px;
- letter-spacing: 0.64px;
- text-align: center;
- font-weight: bold;
- border-radius: 3px;
- }
-
- .risk-label-high{
- background-color: #FCE8E6;
- color: #C5221F;
- }
-
- .risk-label-limited{
- width: 65px;
- background-color:#E4F7FB;
- color: #007B83;
- }
- '''
+ return pages
def to_pdf(self, device):
+ """Returns the current risk profile in PDF format"""
# Resolve the data as html first
html = self.to_html(device)
@@ -681,3 +428,21 @@ def to_pdf(self, device):
pdf_bytes = BytesIO()
HTML(string=html).write_pdf(pdf_bytes)
return pdf_bytes
+
+ # Adding risks to device profile questions
+ def _format_device_profile(self, device):
+ device_copy = deepcopy(device)
+ risk_map = {
+ question['question']: {
+ option['text']: option.get('risk', None)
+ for option in question['options'] if 'risk' in option
+ }
+ for question in self._device_format
+ }
+ for question in device_copy.additional_info:
+ risk = risk_map.get(
+ question['question'], {}
+ ).get(question['answer'], None)
+ if risk:
+ question['risk'] = risk
+ return device_copy
diff --git a/framework/python/src/common/statuses.py b/framework/python/src/common/statuses.py
new file mode 100644
index 000000000..4817d7cf8
--- /dev/null
+++ b/framework/python/src/common/statuses.py
@@ -0,0 +1,36 @@
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""Enums for Testrun"""
+
+
+class TestrunStatus:
+ IDLE = "Idle"
+ WAITING_FOR_DEVICE = "Waiting for Device"
+ MONITORING = "Monitoring"
+ IN_PROGRESS = "In Progress"
+ CANCELLED = "Cancelled"
+ COMPLIANT = "Compliant"
+ NON_COMPLIANT = "Non-Compliant"
+ STOPPING = "Stopping"
+
+
+class TestResult:
+ IN_PROGRESS = "In Progress"
+ COMPLIANT = "Compliant"
+ NON_COMPLIANT = "Non-Compliant"
+ ERROR = "Error"
+ FEATURE_NOT_DETECTED = "Feature Not Detected"
+ INFORMATIONAL = "Informational"
+ NOT_STARTED = "Not Started"
+ DISABLED = "Disabled"
diff --git a/framework/python/src/common/testreport.py b/framework/python/src/common/testreport.py
index 88a25a2b1..f9401fe80 100644
--- a/framework/python/src/common/testreport.py
+++ b/framework/python/src/common/testreport.py
@@ -17,14 +17,19 @@
from weasyprint import HTML
from io import BytesIO
from common import util
+from common.statuses import TestrunStatus
import base64
import os
from test_orc.test_case import TestCase
+from jinja2 import Environment, FileSystemLoader
+from collections import OrderedDict
DATE_TIME_FORMAT = '%Y-%m-%d %H:%M:%S'
RESOURCES_DIR = 'resources/report'
TESTS_FIRST_PAGE = 11
TESTS_PER_PAGE = 20
+TEST_REPORT_STYLES = 'test_report_styles.css'
+TEST_REPORT_TEMPLATE = 'test_report_template.html'
# Locate parent directory
current_dir = os.path.dirname(os.path.realpath(__file__))
@@ -37,13 +42,15 @@
report_resource_dir = os.path.join(root_dir, RESOURCES_DIR)
test_run_img_file = os.path.join(report_resource_dir, 'testrun.png')
+qualification_icon = os.path.join(report_resource_dir, 'qualification-icon.png')
+pilot_icon = os.path.join(report_resource_dir, 'pilot-icon.png')
class TestReport():
"""Represents a previous Testrun report."""
def __init__(self,
- status='Non-Compliant',
+ status=TestrunStatus.NON_COMPLIANT,
started=None,
finished=None,
total_tests=0):
@@ -115,6 +122,10 @@ def to_json(self):
if test.recommendations is not None and len(test.recommendations) > 0:
test_dict['recommendations'] = test.recommendations
+ if (test.optional_recommendations is not None
+ and len(test.optional_recommendations) > 0):
+ test_dict['optional_recommendations'] = test.optional_recommendations
+
test_results.append(test_dict)
report_json['tests'] = {'total': self._total_tests,
@@ -141,6 +152,12 @@ def from_json(self, json_file):
if 'test_modules' in json_file['device']:
self._device['test_modules'] = json_file['device']['test_modules']
+ if 'test_pack' in json_file['device']:
+ self._device['test_pack'] = json_file['device']['test_pack']
+
+ if 'additional_info' in json_file['device']:
+ self._device['device_profile'] = json_file['device']['additional_info']
+
self._status = json_file['status']
self._started = datetime.strptime(json_file['started'], DATE_TIME_FORMAT)
self._finished = datetime.strptime(json_file['finished'], DATE_TIME_FORMAT)
@@ -157,8 +174,16 @@ def from_json(self, json_file):
expected_behavior=test_result['expected_behavior'],
required_result=test_result['required_result'],
result=test_result['result'])
+
+ # Add test recommendations
if 'recommendations' in test_result:
test_case.recommendations = test_result['recommendations']
+
+ # Add optional test recommendations
+ if 'optional_recommendations' in test_result:
+ test_case.optional_recommendations = test_result[
+ 'optional_recommendations']
+
self.add_test(test_case)
# Create a pdf file in memory and return the bytes
@@ -172,35 +197,81 @@ def to_pdf(self):
return pdf_bytes
def to_html(self):
- json_data = self.to_json()
- return f'''
-
-
- {self.generate_head()}
-
- {self.generate_body(json_data)}
-
-
- '''
-
- def generate_test_sections(self, json_data):
- results = json_data['tests']['results']
- sections = ''
- for result in results:
- sections += self.generate_test_section(result)
- return sections
-
- def generate_test_section(self, result):
- section_content = '
\n'
- for key, value in result.items():
- if value is not None: # Check if the value is not None
- # Replace underscores and capitalize
- formatted_key = key.replace('_', ' ').title()
- section_content += f'{formatted_key}: {value}
\n'
- section_content += '\n
\n'
- return section_content
-
- def generate_pages(self, json_data):
+
+ # Jinja template
+ template_env = Environment(loader=FileSystemLoader(report_resource_dir))
+ template = template_env.get_template(TEST_REPORT_TEMPLATE)
+ with open(os.path.join(report_resource_dir,
+ TEST_REPORT_STYLES),
+ 'r',
+ encoding='UTF-8'
+ ) as style_file:
+ styles = style_file.read()
+
+ # Load Testrun logo to base64
+ with open(test_run_img_file, 'rb') as f:
+ logo = base64.b64encode(f.read()).decode('utf-8')
+
+ json_data=self.to_json()
+
+ # Icons
+ with open(qualification_icon, 'rb') as f:
+ icon_qualification = base64.b64encode(f.read()).decode('utf-8')
+ with open(pilot_icon, 'rb') as f:
+ icon_pilot = base64.b64encode(f.read()).decode('utf-8')
+
+ # Convert the timestamp strings to datetime objects
+ start_time = datetime.strptime(json_data['started'], '%Y-%m-%d %H:%M:%S')
+ end_time = datetime.strptime(json_data['finished'], '%Y-%m-%d %H:%M:%S')
+
+ # Calculate the duration
+ duration = end_time - start_time
+
+ # Calculate number of successful tests
+ successful_tests = 0
+ for test in json_data['tests']['results']:
+ if test['result'] != 'Error':
+ successful_tests += 1
+
+ # Obtain the steps to resolve
+ steps_to_resolve = self._get_steps_to_resolve(json_data)
+
+ # Obtain optional recommendations
+ optional_steps_to_resolve = self._get_optional_steps_to_resolve(json_data)
+
+ module_reports = self._get_module_pages()
+ pages_num = self._pages_num(json_data)
+ total_pages = pages_num + len(module_reports) + 1
+ if len(steps_to_resolve) > 0:
+ total_pages += 1
+ if (len(optional_steps_to_resolve) > 0
+ and json_data['device']['test_pack'] == 'Pilot Assessment'
+ ):
+ total_pages += 1
+
+ return template.render(styles=styles,
+ logo=logo,
+ icon_qualification=icon_qualification,
+ icon_pilot=icon_pilot,
+ version=self._version,
+ json_data=json_data,
+ device=json_data['device'],
+ modules=self._device_modules(json_data['device']),
+ test_status=json_data['status'],
+ duration=duration,
+ successful_tests=successful_tests,
+ total_tests=self._total_tests,
+ test_results=json_data['tests']['results'],
+ steps_to_resolve=steps_to_resolve,
+ optional_steps_to_resolve=optional_steps_to_resolve,
+ module_reports=module_reports,
+ pages_num=pages_num,
+ total_pages=total_pages,
+ tests_first_page=TESTS_FIRST_PAGE,
+ tests_per_page=TESTS_PER_PAGE,
+ )
+
+ def _pages_num(self, json_data):
# Calculate pages
test_count = len(json_data['tests']['results'])
@@ -208,136 +279,62 @@ def generate_pages(self, json_data):
# Multiple pages required
if test_count > TESTS_FIRST_PAGE:
# First page
- full_page = 1
+ pages = 1
- # Remaining tests
+ # Remaining testsgenerate
test_count -= TESTS_FIRST_PAGE
- full_page += (int)(test_count / TESTS_PER_PAGE)
- partial_page = 1 if test_count % TESTS_PER_PAGE > 0 else 0
+ pages += (int)(test_count / TESTS_PER_PAGE)
+ pages = pages + 1 if test_count % TESTS_PER_PAGE > 0 else pages
# 1 page required
- elif test_count == TESTS_FIRST_PAGE:
- full_page = 1
- partial_page = 0
- # Less than 1 page required
else:
- full_page = 0
- partial_page = 1
+ pages = 1
- num_pages = full_page + partial_page
-
- pages = ''
- for _ in range(num_pages):
- self._cur_page += 1
- pages += self.generate_results_page(json_data=json_data,
- page_num=self._cur_page)
return pages
- def generate_results_page(self, json_data, page_num):
- page = '
'
- page += self.generate_header(json_data, (page_num == 1))
- if page_num == 1:
- page += self.generate_summary(json_data)
- page += self.generate_results(json_data, page_num)
- page += self.generate_footer(page_num)
- page += '
'
- page += '
'
- return page
-
- def generate_module_page(self, json_data, module_report):
- self._cur_page += 1
- page = '
'
- page += self.generate_header(json_data, False)
- page += f'''
-
- {module_report}
-
'''
- page += self.generate_footer(self._cur_page)
- page += '
' # Page end
- page += '
'
- return page
-
- def generate_steps_to_resolve(self, json_data):
-
- steps_so_far = 0
+ def _device_modules(self, device):
+ sorted_modules = {}
+
+ if 'test_modules' in device:
+
+ for test_module in device['test_modules']:
+ if 'enabled' in device['test_modules'][test_module]:
+ sorted_modules[
+ util.get_module_display_name(test_module)] = device['test_modules'][
+ test_module]['enabled']
+
+ # Sort the modules by enabled first
+ sorted_modules = OrderedDict(sorted(sorted_modules.items(),
+ key=lambda x:x[1],
+ reverse=True)
+ )
+ return sorted_modules
+
+ def _get_steps_to_resolve(self, json_data):
tests_with_recommendations = []
- index = 1
# Collect all tests with recommendations
for test in json_data['tests']['results']:
if 'recommendations' in test:
tests_with_recommendations.append(test)
- # Check if test has recommendations
- if len(tests_with_recommendations) == 0:
- return ''
-
- # Start new page
- self._cur_page += 1
- page = '
'
- page += self.generate_header(json_data, False)
-
- # Add title
- page += '
Steps to Resolve
'
-
- for test in tests_with_recommendations:
-
- # Generate new page
- if steps_so_far == 4 and (
- len(tests_with_recommendations) - (index-1) > 0):
-
- # Reset steps counter
- steps_so_far = 0
-
- # Render footer
- page += self.generate_footer(self._cur_page)
- page += '' # Page end
- page += '
'
-
- # Render new header
- self._cur_page += 1
- page += '
'
- page += self.generate_header(json_data, False)
-
- # Render test recommendations
- page += f'''
-
-
-
{index}.
-
- Name
{test["name"]}
-
-
- Description
{test["description"]}
-
-
-
- Steps to resolve
- '''
-
- step_number = 1
- for recommendation in test['recommendations']:
- page += f'''
-
{
- step_number}. {recommendation}'''
- step_number += 1
-
- page += '
'
-
- index += 1
- steps_so_far += 1
-
- # Render final footer
- page += self.generate_footer(self._cur_page)
- page += '
' # Page end
- page += '
'
-
- return page
-
- def generate_module_pages(self, json_data):
- pages = ''
+ return tests_with_recommendations
+
+ def _get_optional_steps_to_resolve(self, json_data):
+ tests_with_recommendations = []
+
+ # Collect all tests with recommendations
+ for test in json_data['tests']['results']:
+ if 'optional_recommendations' in test:
+ tests_with_recommendations.append(test)
+
+ return tests_with_recommendations
+
+ def _get_module_pages(self):
content_max_size = 913
+ reports = []
+
for module_reports in self._module_reports:
# ToDo: Figure out how to make this dynamic
# Padding values from CSS
@@ -391,8 +388,7 @@ def generate_module_pages(self, json_data):
# If in the middle of a table, close the table
if data_rows_active:
page_content += ''
- page = self.generate_module_page(json_data, page_content)
- pages += page + '\n'
+ reports.append(page_content)
content_size = 0
# If in the middle of a data table, restart
# it for the rest of the rows
@@ -400,727 +396,5 @@ def generate_module_pages(self, json_data):
if data_rows_active else '')
page_content += line + '\n'
if len(page_content) > 0:
- page = self.generate_module_page(json_data, page_content)
- pages += page + '\n'
- return pages
-
- def generate_body(self, json_data):
- self._num_pages = 0
- self._cur_page = 0
- body = f'''
-
- {self.generate_pages(json_data)}
- {self.generate_steps_to_resolve(json_data)}
- {self.generate_module_pages(json_data)}
-
- '''
- # Set the max pages after all pages have been generated
- return body.replace('MAX_PAGE', str(self._cur_page))
-
- def generate_footer(self, page_num):
- footer = f'''
-
- '''
- return footer
-
- def generate_results(self, json_data, page_num):
-
- successful_tests = 0
- for test in json_data['tests']['results']:
- if test['result'] != 'Error':
- successful_tests += 1
-
- result_list = f'''
-
-
Results List ({successful_tests}/{self._total_tests})
-
-
-
-
-
'''
- if page_num == 1:
- start = 0
- elif page_num == 2:
- start = TESTS_FIRST_PAGE
- else:
- start = (page_num - 2) * TESTS_PER_PAGE + TESTS_FIRST_PAGE
- results_on_page = TESTS_FIRST_PAGE if page_num == 1 else TESTS_PER_PAGE
- result_end = min(start + results_on_page,
- len(json_data['tests']['results']))
- for ix in range(result_end - start):
- result = json_data['tests']['results'][ix + start]
- result_list += self.generate_result(result)
- result_list += '
'
- return result_list
-
- def generate_result(self, result):
- if result['result'] == 'Non-Compliant':
- result_class = 'result-test-result-non-compliant'
- elif result['result'] == 'Compliant':
- result_class = 'result-test-result-compliant'
- elif result['result'] == 'Error':
- result_class = 'result-test-result-error'
- elif result['result'] == 'Feature Not Detected':
- result_class = 'result-test-result-feature-not-detected'
- elif result['result'] == 'Informational':
- result_class = 'result-test-result-informational'
- else:
- result_class = 'result-test-result-skipped'
-
- result_html = f'''
-
-
{result['name']}
-
{result['description']}
-
{result['result']}
-
- '''
- return result_html
-
- def generate_header(self, json_data, first_page):
- with open(test_run_img_file, 'rb') as f:
- tr_img_b64 = base64.b64encode(f.read()).decode('utf-8')
- header = ''
-
- if first_page:
- header += f'''
-
+# Contents
-## Contents
+- [Get started](/docs/get_started.md)
+ - [Run on a virtual machine](/docs/virtual_machine.md)
+- [Network](/docs/network/README.md)
+ - [Network addresses](/docs/network/addresses.md)
+ - [Add a new network service](/docs/network/add_new_service.md)
+- [Testing](/docs/test/README.md)
+ - [Test modules](/docs/test/modules.md)
+ - [Test results](/docs/test/statuses.md)
+- [Developer guidelines](/docs/dev/README.md)
+- [Accessibility](/docs/ui/accessibility.md)
+- [Roadmap](/docs/roadmap.pdf)
- - [Get Started](get_started.md)
- - [Network](network/README.md)
- - [Network Overview](network/README.md)
- - [How to identify network interfaces](network/identify_interfaces.md)
- - [Addresses](network/addresses.md)
- - [Add a new network service](network/add_new_service.md)
- - [Testing](test/README.md)
- - [Test modules](test/modules.md)
- - [Test statuses](test/statuses.md)
- - [Development](dev/README.md)
- - [Running on a virtual machine](virtual_machine.md)
- - [Accessibility](ui/accessibility.mp4)
- - [Roadmap](roadmap.pdf)
+# Something missing?
-## Something missing?
-If you feel there is some documentation that you would find useful, or have found an issue with existing documentation, please raise an issue on GitHub by navigating [here](https://github.com/google/testrun/issues/new/choose)
\ No newline at end of file
+To request additional documentation or report an issue with existing resources, visit [the Issues tab](https://github.com/google/testrun/issues/new/choose).
diff --git a/docs/configure_device.md b/docs/configure_device.md
deleted file mode 100644
index 1db7155be..000000000
--- a/docs/configure_device.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-