Requirements and Specification
System Requirements
lobster/tools/core/html_report/html_report_content.trlc
TRLC System_requirement html_req.Meta_Tag_In_Html_Report
IF a HTML report is generated, THEN the file should contain meta tag, HAVING attributes "http-equiv" and "content".
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
lobster/tools/core/html_report/input_file.trlc
TRLC System_requirement html_req.Missing_Lobster_File
IF the input .lobster file does not exist or is missing, THEN the tool shall exit with a non-zero return code (2) AND shall print an error message to STDERR indicating that the specified file is not a valid file.
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
TRLC System_requirement html_req.Valid_Lobster_File
IF a valid .lobster file is provided as input, THEN the tool shall execute successfully with a zero return code (0) AND shall write a valid HTML report to the specified output file.
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
TRLC System_requirement html_req.Valid_Lobster_File_With_Md_Content
IF a valid .lobster file with MD content is provided as input, THEN the tool shall execute successfully with a zero return code (0) AND shall write a valid HTML report to the specified output file with the rendered MD content.
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
TRLC System_requirement html_req.HTML_Report_with_20k_records
IF a valid .lobster file containing approximate 20 thousand items is provided as input, THEN the tool shall execute successfully with a zero return code (0) AND shall write a valid HTML report to the specified output file.
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
TRLC System_requirement html_req.HTML_Report_Displays_Custom_data
IF a valid .lobster file containing a "custom_data" field with keys such as "component", "branch", and "ci_run" is provided as input, THEN the tool shall extract these values from the file AND shall render them in the top-right corner of the generated HTML report AND shall exit successfully with a zero return code (0).
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
lobster/tools/core/html_report/requirements.trlc
TRLC System_requirement core_html_report_req.Clickable_Codebeamer_Item
If the input LOBSTER report file contains codebeamer items THEN the generated HTML report SHALL represent these as hyperlinks to the item on the codebeamer server, where the codebeamer server URL is taken from the repo_root configuration parameter.
Issues:
missing reference to System Test
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
TRLC System_requirement core_html_report_req.Codebeamer_Item_Name
If the input LOBSTER report file contains codebeamer items THEN the generated HTML report SHALL represent these by their codebeamer item name, if it is given.
Issues:
missing reference to System Test
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Software Requirements
TRLC Software_requirement core_html_report_req.Codebeamer_URL
The "to_html" method of the Codebeamer_Reference class SHALL return a string representation of an HTML anchor element to the codebeamer item by constructing the URL as follows: "<repo_roo>/issue/<item_id><version_addon>" where <repo_root> is taken from the configuration file, and <item_id> is the codebeamer item ID taken from the LOBSTER input file, and <version_addon> is "?version=<version>" IF the version number of the codebeamer item is given, OTHERWISE <version_addon> is an empty string.
Issues:
missing reference to Code
missing reference to Software Test
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
TRLC Software_requirement core_html_report_req.Codebeamer_Item_as_String
The "to_string" method of the Codebeamer_Reference class SHALL return the following string: "cb item <ITEM_ID> '<NAME>'" where <ITEM_ID> is the codebeamer item ID and <NAME> the codebeamer item name given to the class constructor.
Issues:
missing reference to Code
missing reference to Software Test
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Implementation
Code
lobster/tools/core/html_report/html_report.py
Python Function html_report.is_dot_available
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Python Function html_report.name_hash
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Python Function html_report.xref_item
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Python Function html_report.create_policy_diagram
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Python Function html_report.create_item_coverage
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Python Function html_report.run_git_show
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Python Function html_report.get_commit_timestamp_utc
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Python Function html_report.write_item_box_begin
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Python Function html_report.write_item_tracing
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Python Function html_report.write_item_box_end
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Python Function html_report.generate_custom_data
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Python Function html_report.write_html
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Python Function html_report.main
Issues:
unknown tracing target req core_html_report_req.Dummy_Requirement
missing up reference
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Verification and Validation
System Test
tests-system/lobster-html-report/test_html_report.py
PyUnit Test test_html_report.LobsterUIReportTests.test_show_issue_button:31
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
PyUnit Test test_html_report.LobsterUIReportTests.test_status_buttons:71
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
PyUnit Test test_html_report.LobsterUIReportTests.test_git_hash_timestamp:112
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
PyUnit Test test_html_report.LobsterUIReportTests.test_meta_tag:142
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
tests-system/lobster-html-report/test_input_file.py
PyUnit Test test_input_file.LobsterHtmlReportInputFileTest.test_lobster_file_is_missing:14
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
PyUnit Test test_input_file.LobsterHtmlReportInputFileTest.test_valid_lobster_file_succeeds:33
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
PyUnit Test test_input_file.LobsterHtmlReportInputFileTest.test_lobster_file_with_20k_records:61
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
PyUnit Test test_input_file.LobsterHtmlReportInputFileTest.test_custom_data_displayed_in_report:93
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
PyUnit Test test_input_file.LobsterHtmlReportInputFileTest.test_valid_md_lobster_file_succeeds:124
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Software Test
tests-unit/lobster-html-report/test_html_report.py
PyUnit Test test_html_report.LobsterHtmlReportTests.test_timestamp_found_in_main_repo:8
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
PyUnit Test test_html_report.LobsterHtmlReportTests.test_timestamp_unknown_commit:22
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00