L.O.B.S.T.E.R.

Lightweight Open BMW Software Traceability Evidence Report
!

Overview

Coverage

Category Ratio Coverage OK Items Total Items
Use Cases 0.0% 0.00% 0 1
Potential Errors 100.0% 100.00% 4 4
Test Specifications 100.0% 100.00% 4 4
System Requirements 0.0% 0.00% 0 2
Software Requirements 0.0% 0.00% 0 0
Code 0.0% 0.00% 0 14
System Tests 100.0% 100.00% 5 5
Software Tests 0.0% 0.00% 0 2

Tracing policy

LOBSTER Tracing Policy n_1cf7e301510c711b73d2b182b9dcf084 Use Cases n_8a4b9a55ec70e0ca32d3abcc64ac6879 Potential Errors n_1cf7e301510c711b73d2b182b9dcf084->n_8a4b9a55ec70e0ca32d3abcc64ac6879 n_419cfc02b324dc7d8faefa90ed608fb0 System Requirements n_1cf7e301510c711b73d2b182b9dcf084->n_419cfc02b324dc7d8faefa90ed608fb0 n_eeb09e7009c699f439a0daadf03458e7 Test Specifications n_8a4b9a55ec70e0ca32d3abcc64ac6879->n_eeb09e7009c699f439a0daadf03458e7 n_3f7ae1d4bec7e6d318ef39c7a7dcaa65 System Tests n_eeb09e7009c699f439a0daadf03458e7->n_3f7ae1d4bec7e6d318ef39c7a7dcaa65 n_9d273bd32c1fceb91b7d6a4d40e98bdd Software Requirements n_419cfc02b324dc7d8faefa90ed608fb0->n_9d273bd32c1fceb91b7d6a4d40e98bdd n_419cfc02b324dc7d8faefa90ed608fb0->n_3f7ae1d4bec7e6d318ef39c7a7dcaa65 n_ca0dbad92a874b2f69b549293387925e Code n_9d273bd32c1fceb91b7d6a4d40e98bdd->n_ca0dbad92a874b2f69b549293387925e n_c4738e043501e27ee3ef08d6a4883d27 Software Tests n_9d273bd32c1fceb91b7d6a4d40e98bdd->n_c4738e043501e27ee3ef08d6a4883d27

Filtering

Item Filters

Show Issues

Filter

Issues

Detailed report

Requirements and Specification

Use Cases

lobster/use_cases.trlc
TRLC Usecase UseCases.Item_GitHub_Source
As a requirements manager
I want the traceability report
to mention the GitHub location of each item which comes from a file inside a git
repository (hosted on my company's GitHub Enterprise server),
so that I can
- map the traceability report to a commit SHA, and
- easily navigate to the corresponding location.

The location shall include:
- the full URL including the git commit SHA,
- and the line number (if applicable).

Note:
- The assumption is that, the repository will be checked out locally by the user
or CI system, and the URL to the remote repository will be given as input to
the LOBSTER tool suite. That is, the tool suite does not have to detect the
commit SHA on its own.
- The line number is optional, because otherwise it is impossible to represent
files as a whole by a LOBSTER item.
Issues:
  • missing reference to System Requirements
Build Reference: main | Timestamp: 2025-09-18 11:06:21+00:00 UTC

Potential Errors

lobster/tools/core/online_report/requirements/potential_errors.trlc
TRLC Potentialerror UseCases.Incorrect_GitHub_Reference_in_Output
The GitHub URL, commit SHA, or line number for an item in the output file is incorrect or missing.
Traces to:
Derived from:
Build Reference: main | Timestamp: 2025-09-18 11:06:21+00:00 UTC
TRLC Potentialerror UseCases.Online_Report_Extract_Wrong_Item_Data_in_Output
The data of the items in the output file is not equal to the data of the items in the input file.
Derived from:
Build Reference: main | Timestamp: 2025-09-18 11:06:21+00:00 UTC
TRLC Potentialerror UseCases.Output_Despite_Missing_Config_File_Online_Report
The user does not provide a valid path to a configuration file,
but the lobster-online_report tool generates valid output nevertheless, potentially based on
irrelevant report file.
For example, the lobster-online tool might consider the current working directory
as source of report file, and these do in fact contain links to real requirements,
such that lobster-online_report would compute a non-zero coverage value.
Traces to:
Derived from:
Build Reference: main | Timestamp: 2025-09-18 11:06:21+00:00 UTC
TRLC Potentialerror UseCases.Output_Despite_Config_File_Error_Online_Report
The user provides an invalid configuration file, but the lobster-online_report tool
generates valid output nevertheless, potentially based on
irrelevant report file.
This includes cases where the config file:
- contains invalid data,
- is missing required keys or attributes,
Traces to:
Derived from:
Build Reference: main | Timestamp: 2025-09-18 11:06:21+00:00 UTC

Test Specifications

lobster/tools/core/online_report/requirements/test_specifications.trlc
TRLC Testspecification UseCases.Incorrect_GitHub_Reference_in_Output_file
The test shall verify that the GitHub reference (URL, commit SHA, and line number if applicable) for each item in the output matches the expected values from the input and repository configuration.
Example: If an item is from a file tracked in git, the output must contain the correct GitHub URL, commit SHA, and line number.
Build Reference: main | Timestamp: 2025-09-18 11:06:21+00:00 UTC
TRLC Testspecification UseCases.Correct_Item_Data_in_Online_Report_Output_File
The test shall verify that the item data in the output file matches the item data in the input file.
Build Reference: main | Timestamp: 2025-09-18 11:06:21+00:00 UTC
TRLC Testspecification UseCases.Online_Report_Config_File_Missing
The test shall verify that the lobster-online_report tool exits with a non-zero return code when the config file does not exist.
Example: Verify that the lobster-online_report tool throws an error when a non-existent config file is provided.
Build Reference: main | Timestamp: 2025-09-18 11:06:21+00:00 UTC
TRLC Testspecification UseCases.Online_Report_Config_File_Key_Error
The test shall verify that lobster-online_report tool exits with a non-zero return code when the config file is missing required keys.
Build Reference: main | Timestamp: 2025-09-18 11:06:21+00:00 UTC

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.
Issues:
  • missing up reference
  • missing reference to Software Requirements
  • missing reference to System Tests
Build Reference: main | Timestamp: 2025-09-18 11:06:21+00:00 UTC
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.
Issues:
  • missing up reference
  • missing reference to Software Requirements
  • missing reference to System Tests
Build Reference: main | Timestamp: 2025-09-18 11:06:21+00:00 UTC

Software Requirements

No items recorded at this level.

Implementation

Code

lobster/tools/core/online_report/online_report.py
Python Function online_report.load_config
Issues:
  • missing up reference
Build Reference: main | Timestamp: 2025-09-18 11:06:21+00:00 UTC
Python Function online_report.parse_config_data
Issues:
  • missing up reference
Build Reference: main | Timestamp: 2025-09-18 11:06:21+00:00 UTC
Python Function online_report.add_github_reference_to_items
Issues:
  • missing up reference
Build Reference: main | Timestamp: 2025-09-18 11:06:21+00:00 UTC
Python Constructor online_report.OnlineReportTool.__init__
Issues:
  • missing up reference
Build Reference: main | Timestamp: 2025-09-18 11:06:21+00:00 UTC
Python Method online_report.OnlineReportTool._run_impl
Issues:
  • missing up reference
Build Reference: main | Timestamp: 2025-09-18 11:06:21+00:00 UTC
Python Method online_report.OnlineReportTool._print_error
Issues:
  • missing up reference
Build Reference: main | Timestamp: 2025-09-18 11:06:21+00:00 UTC
Python Method online_report.OnlineReportTool._execute
Issues:
  • missing up reference
Build Reference: main | Timestamp: 2025-09-18 11:06:21+00:00 UTC
Python Function online_report.lobster_online_report
Issues:
  • missing up reference
Build Reference: main | Timestamp: 2025-09-18 11:06:21+00:00 UTC
Python Function online_report.main
Issues:
  • missing up reference
Build Reference: main | Timestamp: 2025-09-18 11:06:21+00:00 UTC
lobster/tools/core/online_report/path_to_url_converter.py
Python Constructor path_to_url_converter.PathToUrlConverter.__init__
Issues:
  • missing up reference
Build Reference: main | Timestamp: 2025-09-18 11:06:21+00:00 UTC
Python Method path_to_url_converter.PathToUrlConverter._path_to_html_format
Issues:
  • missing up reference
Build Reference: main | Timestamp: 2025-09-18 11:06:21+00:00 UTC
Python Method path_to_url_converter.PathToUrlConverter._get_submodule_full_url
Issues:
  • missing up reference
Build Reference: main | Timestamp: 2025-09-18 11:06:21+00:00 UTC
Python Method path_to_url_converter.PathToUrlConverter.path_to_url
Issues:
  • missing up reference
Build Reference: main | Timestamp: 2025-09-18 11:06:21+00:00 UTC
Python Method path_to_url_converter.PathToUrlConverter._get_submodule_and_relative_path
Issues:
  • missing up reference
Build Reference: main | Timestamp: 2025-09-18 11:06:21+00:00 UTC

Verification and Validation

System Tests

tests_system/lobster_online_report/test_config_exceptions.py
PyUnit Test test_config_exceptions.ConfigParserExceptionsOnlineReport.test_missing_config_file:15
Derived from:
Build Reference: main | Timestamp: 2025-09-18 11:06:21+00:00 UTC
PyUnit Test test_config_exceptions.ConfigParserExceptionsOnlineReport.test_config_file_errors:31
Derived from:
Build Reference: main | Timestamp: 2025-09-18 11:06:21+00:00 UTC
tests_system/lobster_online_report/test_valid_cases.py
PyUnit Test test_valid_cases.ConfigParserExceptionsOnlineReport.test_main_repo:38
Build Reference: main | Timestamp: 2025-09-18 11:06:21+00:00 UTC
PyUnit Test test_valid_cases.ConfigParserExceptionsOnlineReport.test_submodules:63
Build Reference: main | Timestamp: 2025-09-18 11:06:21+00:00 UTC
PyUnit Test test_valid_cases.ConfigParserExceptionsOnlineReport.test_codebeamer_links:116
Derived from:
Build Reference: main | Timestamp: 2025-09-18 11:06:21+00:00 UTC

Software Tests

tests_unit/lobster_online_report/test_online_report.py
PyUnit Test test_online_report.LobsterOnlineReportTests.test_load_config:28
Issues:
  • missing up reference
Build Reference: main | Timestamp: 2025-09-18 11:06:21+00:00 UTC
PyUnit Test test_online_report.LobsterOnlineReportTests.test_add_github_reference_to_items:36
Issues:
  • missing up reference
Build Reference: main | Timestamp: 2025-09-18 11:06:21+00:00 UTC

LOBSTER Version: 1.0.2