Requirements and Specification
System Requirements
lobster/tools/core/online_report/requirements.trlc
TRLC System_requirement core_online_report_req.Valid_Git_Repository
IF the provided repository root directory contains a ".git" directory, THEN the tool shall write the output in the LOBSTER interchange format to the file given in the "out" parameter AND exit with a zero return code.
Build Reference: 4cd44f9f406e0d4089a907ad6a3fc93caf9a08ab | Timestamp: 2025-06-06 08:48:06+00:00
TRLC System_requirement_aspect core_online_report_req.Invalid_Git_Repository
OTHERWISE the tool shall exit with a non-zero return code and display an error message indicating that the repository is not a valid Git repository.
Build Reference: 4cd44f9f406e0d4089a907ad6a3fc93caf9a08ab | Timestamp: 2025-06-06 08:48:06+00:00
Software Requirements
TRLC Software_requirement core_online_report_req.Dummy_Requirement
This is not really a requirement. It will be used only to generate a minimal tracing report for each tool. It can be deleted as soon as all the tools get their real requirements.
Issues:
missing reference to Software Test
Build Reference: 4cd44f9f406e0d4089a907ad6a3fc93caf9a08ab | Timestamp: 2025-06-06 08:48:06+00:00
TRLC Software_requirement core_online_report_req.Dummy_Requirement_Unit_Test
This is not really a requirement. It will be used only to generate a minimal tracing report for each tool. It can be deleted as soon as all the tools get their real requirements.
Issues:
missing reference to Code
missing reference to Software Test
Build Reference: 4cd44f9f406e0d4089a907ad6a3fc93caf9a08ab | Timestamp: 2025-06-06 08:48:06+00:00
Implementation
Code
lobster/tools/core/online_report/online_report.py
Python Function online_report.is_git_main_module
Build Reference: 4cd44f9f406e0d4089a907ad6a3fc93caf9a08ab | Timestamp: 2025-06-06 08:48:06+00:00
Python Function online_report.is_dir_in_git_submodule
Build Reference: 4cd44f9f406e0d4089a907ad6a3fc93caf9a08ab | Timestamp: 2025-06-06 08:48:06+00:00
Python Function online_report.is_dir_in_git_main_module
Build Reference: 4cd44f9f406e0d4089a907ad6a3fc93caf9a08ab | Timestamp: 2025-06-06 08:48:06+00:00
Python Function online_report.find_repo_main_root
Build Reference: 4cd44f9f406e0d4089a907ad6a3fc93caf9a08ab | Timestamp: 2025-06-06 08:48:06+00:00
Python Function online_report.path_starts_with_subpath
Build Reference: 4cd44f9f406e0d4089a907ad6a3fc93caf9a08ab | Timestamp: 2025-06-06 08:48:06+00:00
Python Function online_report.parse_git_root
Build Reference: 4cd44f9f406e0d4089a907ad6a3fc93caf9a08ab | Timestamp: 2025-06-06 08:48:06+00:00
Python Function online_report.add_github_reference_to_items
Build Reference: 4cd44f9f406e0d4089a907ad6a3fc93caf9a08ab | Timestamp: 2025-06-06 08:48:06+00:00
Python Function online_report.get_git_commit_hash_repo_and_path
Build Reference: 4cd44f9f406e0d4089a907ad6a3fc93caf9a08ab | Timestamp: 2025-06-06 08:48:06+00:00
Python Function online_report.get_hash_for_git_commit
Build Reference: 4cd44f9f406e0d4089a907ad6a3fc93caf9a08ab | Timestamp: 2025-06-06 08:48:06+00:00
Python Function online_report.get_summary
Build Reference: 4cd44f9f406e0d4089a907ad6a3fc93caf9a08ab | Timestamp: 2025-06-06 08:48:06+00:00
Python Function online_report.main
Build Reference: 4cd44f9f406e0d4089a907ad6a3fc93caf9a08ab | Timestamp: 2025-06-06 08:48:06+00:00
Verification and Validation
System Test
tests-system/lobster-online-report/test_git_repo_different_location.py
PyUnit Test test_git_repo_different_location.NonGitRepositoryTest.test_non_git_repository_with_repo_root:25
Build Reference: 4cd44f9f406e0d4089a907ad6a3fc93caf9a08ab | Timestamp: 2025-06-06 08:48:06+00:00
PyUnit Test test_git_repo_different_location.NonGitRepositoryTest.test_non_git_repository_without_repo_root:40
Build Reference: 4cd44f9f406e0d4089a907ad6a3fc93caf9a08ab | Timestamp: 2025-06-06 08:48:06+00:00
tests-system/lobster-online-report/test_git_repository.py
PyUnit Test test_git_repository.GitRepositoryTest.test_invalid_git_repository:15
Build Reference: 4cd44f9f406e0d4089a907ad6a3fc93caf9a08ab | Timestamp: 2025-06-06 08:48:06+00:00
PyUnit Test test_git_repository.GitRepositoryTest.test_valid_git_repository:30
Build Reference: 4cd44f9f406e0d4089a907ad6a3fc93caf9a08ab | Timestamp: 2025-06-06 08:48:06+00:00
Software Test
tests-unit/lobster-online-report/test_online_report.py
PyUnit Test test_online_report.LobsterOnlineReportTests.test_valid_inputs:19
Build Reference: 4cd44f9f406e0d4089a907ad6a3fc93caf9a08ab | Timestamp: 2025-06-06 08:48:06+00:00
PyUnit Test test_online_report.LobsterOnlineReportTests.test_print_summary_same_values:39
Build Reference: 4cd44f9f406e0d4089a907ad6a3fc93caf9a08ab | Timestamp: 2025-06-06 08:48:06+00:00
PyUnit Test test_online_report.LobsterOnlineReportTests.test_print_summary_different_values:44
Build Reference: 4cd44f9f406e0d4089a907ad6a3fc93caf9a08ab | Timestamp: 2025-06-06 08:48:06+00:00
PyUnit Test test_online_report.LobsterOnlineReportTests.test_commit_hash_for_main_repo:50
Build Reference: 4cd44f9f406e0d4089a907ad6a3fc93caf9a08ab | Timestamp: 2025-06-06 08:48:06+00:00