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 to interface with the proprietary requirements management tool Codebeamer.
Tools
lobster-codebeamer: Extract requirements from codebeamer.
Configuration
The tool requires a YAML configuration file to define its settings. You must provide this file when running the tool to specify parameters to process.
It allows to configure the following features:
References
Codebeamer items can reference other items through
Reference Fields.
This piece of information can be extracted by the tool, and serialized into the
LOBSTER output file.
It only needs to know which fields to take into account.
Following the LOBSTER yaml schema, the item references will be added to the
refs property of the LOBSTER item.
Accordingly, the configuration parameter to specify the codebeamer field names
is called refs, too.
It can contain a single field name, or a list of field names.
Field IDs cannot be used, only the field names.
Examples:
refs : "cb-fieldname"
or
refs : ["cb-fieldname"]
or
refs : ["cb-fieldname1", "cb-fieldname2"]
Bearer Authentication Token
Define the Bearer authentication token in the configuration file as follows
token : "your-codebeamer-Bearer-token"
Note:
- If
--cb-useror--cb-passis given together with a Bearer token (through the configuration file), then the Bearer authentication method is used, and the username and/or password are ignored. - If neither a token nor a username or password are given, then the tool tries
to read the username and password from the
.netrcfile in the user's home directory. - If value of root in config file is
https://codebeamer.bmwgroup.net, then value of machine in .netrc will becodebeamer.bmwgroup.net.
.netrc Configuration for Codebeamer
machine your.codebeamer.url
login your_username
password your_password
Example Configuration
Here is an example of a configuration file:
refs : ["derived from", "satisfied by"]
token : "SomeTokenStringABC123"
Is it also possible to define the codebeamer token in this file:
refs : "cb-fieldname"
token : "your cb-token"
Schema
You can also specify the type of schema for the resulting output file. The supported values for the schema field are:
- Activity: Sets the schema to lobster-act-trace.
- Implementation: Sets the schema to lobster-imp-trace.
- Requirement: Sets the schema to lobster-req-trace.
If the schema is not specified, the tool will default to Requirement, and the schema lobster-req-trace will be used.
Here is an example of a configuration file:
schema: "Activity", // Specifies schema
refs : ["cb-fieldname1", "cb-fieldname2"] // Specifies references
If an invalid schema is provided, the tool will raise an exception. Supported schema values are Activity, Implementation, and Requirement.
Usage
There are two ways you can use this tool:
-
Download all requirements mentioned by another lobster trace (this way you do not get a completeness check) (using
--import-tagged) -
Download all requirements generated by a saved codebeamer query ID OR a codebeamer query string (cbQL query) (using
--import-query- accepts the query ID as well as query string)
-
Configure the 'refs' upstream reference (this parameter is optional)
-
Additionally, you can specify the schema and references:
-
Specify the schema of the trace to be generated (optional, defaults to "Requirement"). You can set it in the configuration file.
-
Configure the 'refs' upstream reference (optional).
-
For example:
python lobster_codebeamer.py --config codebeamer-config.yamlThis command will extract activity traces (lobster-act-trace) with specified references.
-
Limitations
The key limitation is item text, which is currently not imported. However, we do plan to also import item text eventually.
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.
This tool has no actual dependency on, or with, Codebeamer. It just talks the API as described here: https://codebeamer.com/cb/wiki/117612
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file bmw_lobster_tool_codebeamer-1.0.5-py3-none-any.whl.
File metadata
- Download URL: bmw_lobster_tool_codebeamer-1.0.5-py3-none-any.whl
- Upload date:
- Size: 12.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e0fa851ad258f79115053f3d5c950d51cee33a78bc8b6d99fe5ce54a9d92dd55
|
|
| MD5 |
2d6c8736ab512793ffab725566f14eb5
|
|
| BLAKE2b-256 |
719b9ab0fdfcdf04d562d9dcd3f05e7eee740f03071b0498daedb1c07f75a465
|
Provenance
The following attestation bundles were made for bmw_lobster_tool_codebeamer-1.0.5-py3-none-any.whl:
Publisher:
package.yml on bmw-software-engineering/lobster
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
bmw_lobster_tool_codebeamer-1.0.5-py3-none-any.whl -
Subject digest:
e0fa851ad258f79115053f3d5c950d51cee33a78bc8b6d99fe5ce54a9d92dd55 - Sigstore transparency entry: 2270438932
- Sigstore integration time:
-
Permalink:
bmw-software-engineering/lobster@a9f40832154b428699e0409eb49ff18259aa447f -
Branch / Tag:
refs/tags/lobster-1.0.5 - Owner: https://github.com/bmw-software-engineering
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
package.yml@a9f40832154b428699e0409eb49ff18259aa447f -
Trigger Event:
release
-
Statement type:
