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 14
Potential Errors 100.0% 100.00% 9 9
Test Specifications 0.0% 0.00% 0 10
System Requirements 0.0% 0.00% 0 8
Software Requirements 0.0% 0.00% 0 2
Code 0.0% 0.00% 0 15
System Tests 62.5% 62.50% 5 8
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.Trace_Requirements_to_Tests
As a requirements manager I want to have a report of traceability between
requirements (in codebeamer or TRLC) and tests (in C++ or JSON).
Issues:
  • missing reference to System Requirements
TRLC Usecase UseCases.List_Requirements_to_Tests
As a requirements manager I want the traceability report to show the list of
requirements (from codebeamer or TRLC) which are covered by tests (in C++ or JSON).
Issues:
  • missing reference to System Requirements
TRLC Usecase UseCases.List_Requirements_without_Tests
As a requirements manager I want the traceability report to show the list of
requirements (from codebeamer or TRLC) which are not covered by tests (in C++ or JSON).
Issues:
  • missing reference to System Requirements
TRLC Usecase UseCases.List_Tests_to_Requirements
As a requirements manager I want the traceability report to show the list of
tests (in C++ or JSON) covering requirements in (in codebeamer or TRLC).
Issues:
  • missing reference to System Requirements
TRLC Usecase UseCases.List_Tests_without_Requirements
As a requirements manager I want the traceability report to show the list of
tests (in C++ or JSON) which are not covering any requirement in (in codebeamer or TRLC).
Issues:
  • missing reference to System Requirements
TRLC Usecase UseCases.Requirements_to_Test_Coverage
As a requirements manager I want the traceability report to show the fraction of
the number of requirements (in codebeamer or TRLC) which are covered by tests (in C++ or JSON)
divided by the total number of requirements.
The fraction shall be shown as percentage.
Issues:
  • missing reference to Potential Errors
  • missing reference to System Requirements
TRLC Usecase UseCases.Show_Tracing_Policy
As a requirements manager I want the traceability report to show the tracing policy used to generate the report.
Traces to:
Issues:
  • missing reference to System Requirements
TRLC Usecase UseCases.Show_codebeamer_links
As a requirements manager I want the traceability report to mention the codebeamer link to requirements in codebeamer.
Traces to:
Issues:
  • missing reference to System Requirements
TRLC Usecase UseCases.Item_Source
As a requirements manager
I want the traceability report
between requirements in codebeamer and C++ tests
to mention the source location of each item.
Traces to:
Issues:
  • missing reference to System Requirements
TRLC Usecase UseCases.HTML_Output
As a requirements manager I want the traceability report to be generated as html file.
Issues:
  • missing reference to System Requirements
TRLC Usecase UseCases.git_hash
As a requirements manager I want the traceability report
which includes sources from a local git clone
to show the git hashes of the git commit from which files were taken.
Issues:
  • missing reference to Potential Errors
  • missing reference to System Requirements
TRLC Usecase UseCases.List_Findings
As a requirements manager I want the traceability report
between requirements (in codebeamer or TRLC) and tests (in C++ or JSON)
to show a list with all findings
where the tracing policy is violated.
Traces to:
Issues:
  • missing reference to System Requirements
TRLC Usecase UseCases.Colored_Findings
As a requirements manager I want the traceability report
to highlight the missing traces and detected traces in different color.
Issues:
  • missing reference to Potential Errors
  • missing reference to System Requirements
TRLC Usecase UseCases.English_Language
As a requirements manager I want the traceability report
to be generated in English language.
Issues:
  • missing reference to Potential Errors
  • missing reference to System Requirements

Potential Errors

lobster/tools/core/html_report/requirements/potential_errors.trlc
TRLC Potentialerror UseCases.Requirements_not_listed_correctly
Some requirements are not listed correctly
example,
- Some requirements which are not covered are not listed in the HTML report.
- Some requirements which are covered are not listed in the HTML report.
TRLC Potentialerror UseCases.Software_tests_not_listed_correctly
Some software tests are not listed correctly.
example,
- Some software tests which are not covering any requirement are not listed in the HTML report.
- Some software tests which are covering the requirement are not listed in the HTML report.
TRLC Potentialerror UseCases.Incorrect_mapping_in_HTML_File
Mapping between requirements and software tests is not shown correctly HTML report
example, while generating html report rows are interchanged or
incomplete data is written in html file.
TRLC Potentialerror UseCases.HTML_report_not_Generated
HTML report is not generated.
Traces to:
Derived from:
TRLC Potentialerror UseCases.Input_file_location_missing
Source location of the input file is missing in HTML report.
example, URL for git repo of software test is not shown in HTML report.
Traces to:
Derived from:
TRLC Potentialerror UseCases.Incorrect_syntax_in_HTML_report
Syntax of the generated HTML report is not correct
example, some content of the report is not readable(e.g. Non readable charachters in lines like string of &,*,.. etc.)
Traces to:
Derived from:
TRLC Potentialerror UseCases.Too_few_findings_in_HTML_report
All Tracing policy violations are not listed.
example, for software test the requirement reference is missing but tracing policy violation
is not detected.
Traces to:
Derived from:
TRLC Potentialerror UseCases.Wrong_tracing_policy_in_HTML_report
Tracing policy not shown correctly in HTML report.
Traces to:
Derived from:
TRLC Potentialerror UseCases.Wrong_Input_file_location
Source location of the input file is incorrect in HTML report.
Traces to:
Derived from:

Test Specifications

lobster/tools/core/html_report/requirements/test_specifications.trlc
TRLC Testspecification UseCases.Covered_Requirement_list_in_HTML_file
The test shall verify that requirements covered by software tests are correctly listed in the HTML file.
Derived from:
Issues:
  • missing reference to System Tests
TRLC Testspecification UseCases.Not_covered_Requirement_list_in_Output
The test shall verify that requirements not covered by software tests are correctly listed in the HTML file.
Derived from:
Issues:
  • missing reference to System Tests
TRLC Testspecification UseCases.List_of_Software_tests_covering_requirements_in_HTML_file
The test shall verify that software tests covering requirement are correctly listed in the HTML file.
Derived from:
Issues:
  • missing reference to System Tests
TRLC Testspecification UseCases.List_of_Software_tests_Not_covering_requirements_in_HTML_file
The test shall verify that software tests not covering any requirement are correctly listed in the HTML file.
Derived from:
Issues:
  • missing reference to System Tests
TRLC Testspecification UseCases.Mapping_in_HTML_file
The test shall verify that mapping between requirements and software tests is correct in HTML file.
Derived from:
Issues:
  • missing reference to System Tests
TRLC Testspecification UseCases.HTML_file_generation
The test shall verify that HTML report file is generated.
Derived from:
Issues:
  • missing reference to System Tests
TRLC Testspecification UseCases.Source_location_in_output
The test shall verify that correct source locations of the input files are mentioned in the HTML report.

example: Verify HTML file contains correct source location URL from which c++ test file is taken
Derived from:
Issues:
  • missing reference to System Tests
TRLC Testspecification UseCases.readable_data_in_output
The test shall verify html report contains readable data.

example : Verify the context is in human readable format.
Derived from:
Issues:
  • missing reference to System Tests
TRLC Testspecification UseCases.Missing_tracing_policy_violation_in_output
The test shall verify items where tracing policy is violated are listed correctly.

example: Finding shall be listed under violation of tracing policy if requirement reference is
missing in software test.
Derived from:
Issues:
  • missing reference to System Tests
TRLC Testspecification UseCases.Tracing_policy_in_output
The test shall verify correct tracing policy is mentioned in the HTML report.

example: For requirements in CB and software tests in C++ files,
the test shall verify tracing policy between requirements and software tests is correctly shown in the HTML report.
Derived from:
Issues:
  • missing reference to System Tests

System Requirements

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.
Issues:
  • missing up reference
  • missing reference to Software Requirements
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.
Issues:
  • missing up reference
  • missing reference to Software Requirements
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.
Issues:
  • missing up reference
  • missing reference to Software Requirements
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.
Issues:
  • missing up reference
  • missing reference to Software Requirements
  • missing reference to System Tests
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).
Issues:
  • missing up reference
  • missing reference to Software Requirements
lobster/tools/core/html_report/requirements/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".
Issues:
  • missing up reference
  • missing reference to Software Requirements
lobster/tools/core/html_report/requirements/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.
Traces to:
Issues:
  • missing up reference
  • missing reference to System Tests
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 up reference
  • missing reference to Software Requirements
  • missing reference to System Tests

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.
Derived from:
Issues:
  • missing reference to Code
  • missing reference to Software Tests
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 up reference
  • missing reference to Code
  • missing reference to Software Tests

Implementation

Code

lobster/tools/core/html_report/html_report.py
Python Function html_report.is_dot_available
Issues:
  • missing up reference
Python Function html_report.name_hash
Issues:
  • missing up reference
Python Function html_report.xref_item
Issues:
  • missing up reference
Python Function html_report.create_policy_diagram
Issues:
  • missing up reference
Python Function html_report.create_item_coverage
Issues:
  • missing up reference
Python Function html_report.run_git_show
Issues:
  • missing up reference
Python Function html_report.get_commit_timestamp_utc
Issues:
  • missing up reference
Python Function html_report.write_item_box_begin
Issues:
  • missing up reference
Python Function html_report.write_item_tracing
Issues:
  • missing up reference
Python Function html_report.write_item_box_end
Issues:
  • missing up reference
Python Function html_report.generate_custom_data
Issues:
  • missing up reference
Python Function html_report.write_html
Issues:
  • missing up reference
Python Constructor html_report.HtmlReportTool.__init__
Issues:
  • missing up reference
Python Method html_report.HtmlReportTool._run_impl
Issues:
  • missing up reference
Python Function html_report.main
Issues:
  • missing up reference

Verification and Validation

System Tests

tests_system/lobster_html_report/test_html_report.py
PyUnit Test test_html_report.LobsterUIReportTests.test_show_issue_button:32
Issues:
  • missing up reference
PyUnit Test test_html_report.LobsterUIReportTests.test_status_buttons:72
Issues:
  • missing up reference
PyUnit Test test_html_report.LobsterUIReportTests.test_git_hash_timestamp:113
Issues:
  • missing up reference
PyUnit Test test_html_report.LobsterUIReportTests.test_meta_tag:143
Derived from:
tests_system/lobster_html_report/test_input_file.py
PyUnit Test test_input_file.LobsterHtmlReportInputFileTest.test_lobster_file_is_missing:18
Derived from:
PyUnit Test test_input_file.LobsterHtmlReportInputFileTest.test_valid_lobster_file_succeeds:38
Derived from:
PyUnit Test test_input_file.LobsterHtmlReportInputFileTest.test_custom_data_displayed_in_report:73
Derived from:
PyUnit Test test_input_file.LobsterHtmlReportInputFileTest.test_valid_md_lobster_file_succeeds:111
Derived from:

Software Tests

tests_unit/lobster_html_report/test_html_report.py
PyUnit Test test_html_report.LobsterHtmlReportTests.test_timestamp_found_in_main_repo:8
Issues:
  • missing up reference
PyUnit Test test_html_report.LobsterHtmlReportTests.test_timestamp_unknown_commit:22
Issues:
  • missing up reference

LOBSTER Version: 0.14.4-dev