Skip to main content

LOBSTER Tool for ISO C/C++

Project description

LOBSTER

The Lightweight Open BMW Software Traceability Evidence Report allows you to demonstrate software traceability and requirements coverage, which is essential for meeting standards such as ISO 26262.

This package contains a tool extract tracing tags from ISO C or C++ source code. The tracing tags are identified by searching for configurable markers in the comments of the source code.

Tools

  • lobster-cpptest: Extract requirements with specific references from tests.

Usage

This tool supports C/C++ code.

For this you have to provide a C/C++ test documentation with markers:

Markers can be either @requirement, @requiredby or @defect.

/**
 * @requirement CB-#1111, CB-#2222,
 *              CB-#3333
 * @requirement CB-#4444 CB-#5555
 *              CB-#6666
 */
TEST(RequirementTagTest1, RequirementsAsMultipleComments) {}

You have to provide a config-file which determines which markers should be extracted in which output-files. The expected kind for each output-file should also be specified.

  • Note: If you want to extract the other tests with other markers, you can use an empty list as markers value. Be aware in this case the tests do not have any references.
{
    "markers": [],
    "kind": "req"
}

In addition, you have to provide the codebeamer-url:

Kind can be either req, imp or act.

{
	"output": {
		"unit_tests.lobster" : 
            {
                "markers": ["@requirement"],
                "kind": "req"
            },
        "components_tests.lobster" :
            {
                "markers": ["@requiredby", "@requirement"],
                "kind": "imp"
            }
	},
	"codebeamer_url": "https://codebeamer.example.com/test"
}

For more information about how to setup cpp and config files take a look at manual-lobster_cpptest

Copyright & License information

The copyright holder of LOBSTER is the Bayerische Motoren Werke Aktiengesellschaft (BMW AG), and LOBSTER is published under the GNU Affero General Public License, Version 3.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bmw_lobster_tool_cpptest-0.9.21-py3-none-any.whl (12.2 kB view details)

Uploaded Python 3

File details

Details for the file bmw_lobster_tool_cpptest-0.9.21-py3-none-any.whl.

File metadata

File hashes

Hashes for bmw_lobster_tool_cpptest-0.9.21-py3-none-any.whl
Algorithm Hash digest
SHA256 6a8c99c1cb954730411bf5446b2dd6ea1eace4a5ee8d8f4d81d18ac9b56c3c7e
MD5 01582665c14567b467f664354df02000
BLAKE2b-256 9b89409de97ed5bf5858429da3e7801f9b75e4b73077f2cc9b2b9c6720af94a7

See more details on using hashes here.

Provenance

The following attestation bundles were made for bmw_lobster_tool_cpptest-0.9.21-py3-none-any.whl:

Publisher: package.yml on bmw-software-engineering/lobster

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page