| Category | Ratio | Coverage | OK Items | Total Items |
| Use Cases | 0.0% | 0 | 11 | |
| Potential Errors | 100.0% | 9 | 9 | |
| Test Specifications | 100.0% | 9 | 9 | |
| System Requirements | 0.0% | 0 | 12 | |
| Software Requirements | 0.0% | 0 | 2 | |
| Code | 0.0% | 0 | 16 | |
| System Tests | 80.0% | 12 | 15 | |
| Software Tests | 0.0% | 0 | 2 |
As a requirements manager I want the traceability report to show the list of
requirements which are covered by tests.
As a requirements manager I want the traceability report to show the list of
requirements which are not covered by tests.
As a requirements manager I want the traceability report to show the list of
tests covering requirements.
As a requirements manager I want the traceability report to show the list of
tests which are not covering any requirement.
As a requirements manager I want the traceability report to show the fraction of
the number of items in one level (of the tracing policy)
which fulfill the tracing policy,
divided by the total number of items in that level (of the tracing policy).
The fraction shall be shown as percentage.
Example:
If the tracing policy is: Tests --(trace to)--> Requirements,
then the report shall show the fraction of requirements which are covered by at
least one test, divided by the total number of requirements.
As a requirements manager I want the traceability report to mention the
codebeamer link to each requirement in codebeamer.
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.
As a requirements manager I want the traceability report to be generated as html
file.
As a requirements manager I want the traceability report
to show a list with all findings
where the tracing policy is violated.
As a requirements manager I want the traceability report
to highlight the missing traces and detected traces in different color.
As a requirements manager I want the traceability report
to be generated in English language.
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.
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.
HTML report is not generated.
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.
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.)
All Tracing policy violations are not listed.
example, for software test the requirement reference is missing but tracing policy violation
is not detected.
Source location of the input source is incorrect in HTML report.
The tool writes a coverage value into the output file
that is not equal to the coverage value from the input file.
The tool writes wrong information of an item into the output file
that is not equal to the data from the input file.
The test shall verify that requirements covered by software tests are correctly listed in the HTML file.
The test shall verify that requirements not covered by software tests are correctly listed in the HTML file.
The test shall verify that software tests covering requirements are correctly listed in the HTML file.
The test shall verify that software tests not covering requirements are correctly listed in the HTML file.
The test shall verify that HTML report file is generated.
The test shall verify that correct source locations of the inputs (url) are mentioned in the HTML report.
example: Verify HTML file contains correct source location URL from which c++ test file is taken
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.
The test shall verify correct coverage value in the HTML report.
The test shall verify correct item data is displayed in the HTML report.
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.
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.
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.
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.
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).
IF a HTML report is generated,
THEN the file should contain meta tag,
HAVING attributes "http-equiv" and "content".
IF the HTML report tool processes multiple items with their respective data,
THEN the tool shall ensure that data is not mixed between items,
AND each item shall be processed correctly with its unique data.
IF the tool "dot" is available,
THEN the tool shall include a visualization of the tracing policy.
IF multiple files are present in the working directory and a specific input file is provided,
THEN the tool shall process only the provided input file,
AND shall ignore all other files in the working directory.
IF the input data contains items with justifications,
THEN the tool shall process the justifications correctly,
AND shall display the content according to the justifications in the HTML report.
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.
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.
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.
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.