Skip to main content

LOBSTER Tool for TRLC

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 to interface with the proprietary requirements management tool Codebeamer.

Configuration

This tool is a bit more complex and you need to supply a config file, named (by default) lobster-trlc.conf. In it you can declare how you'd like tracing tags to be extracted.

For record types you can write:

package.typename {
   description = field_name
   tags = field_name
}

By default none of the objects are traced, but adding a declaration like this marks this type (and all its extensions) as things to trace.

The description marks which field carries the description text that can be optionally included in LOBSTER.

The tags field identifies the field carrying a tags field. In LOBSTER all tags are namespaced, and by default the namespace is "req" as that is generally what you want to do. But you can change this by including the namespace like so:

   tags "franka" = field_name

For tuple types like this one:

tuple Codebeamer_Id {
  item Integer
  separator @
  version optional Integer
}

You need to provide a series of text expansions so that the lobster-trlc tool can build lobster tags from it. You can do this like so:

example.Codebeamer_Id {
  to_string = "$(item)@$(version)"
  to_string = "$(item)"
}

These functions are applied in order, and we pick the first one that fully manages to apply. When a value is null, then and it'd be used (like in the first to_string function above) then the expansion does not apply and we move to the next, and so on. When none apply an error is created.

If you need to justify requirements not being linked or implemented, then you can also defined up to three extra fields (using just_up, just_down, and just_global) that should carry this information. For example:

type Requirement {
   text String
   unimplemented_justification optional String
}

With this config file:

example.Requirement {
   description = text
   just_down   = unimplemented_justification
}

The meaning of "up" is along the usual direction of tracing tags. For example putting this in a software requirement means it is not linked to a system requirement. The meaning of "down" is against the usual direction of tracing tags. For example putting this in a software requirement means it is either not implemented or not tested.

As you can see the down justification is much more imprecise than an up justification. You should only use them if there is no other way to attach this justification on the actual offending object.

Finally the "global" justification is a catch all: it just means no tracing policy will be validated at all when considering this object.

Tools

  • lobster-trlc: Extrat requirements from TRLC.

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

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

bmw_lobster_tool_trlc-0.9.19-py3-none-any.whl (7.6 kB view details)

Uploaded Python 3

File details

Details for the file bmw_lobster_tool_trlc-0.9.19-py3-none-any.whl.

File metadata

File hashes

Hashes for bmw_lobster_tool_trlc-0.9.19-py3-none-any.whl
Algorithm Hash digest
SHA256 be84b4605b73ae7b17374b9e20a22b85a9f0a5a94276a4f15546747b9043a5cf
MD5 f6c3a4d057edf559e3c6ef099f4770f3
BLAKE2b-256 031a9b26ab3e8eba549ae63295894d4c923bfffbe46ee34e74ef17ce3a9d7e21

See more details on using hashes here.

Provenance

The following attestation bundles were made for bmw_lobster_tool_trlc-0.9.19-py3-none-any.whl:

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

Attestations:

Supported by

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