Skip to content

Latest commit

 

History

History
116 lines (89 loc) · 3.41 KB

README.md

File metadata and controls

116 lines (89 loc) · 3.41 KB
Raw

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 JSON files. The tool expects a json file with a list of objects, for which you can specify members to extract by name. It is extremely simplistic but it may be good enough to support some use-cases.

If you have a more complex file format you will likely need to provide your own tool for your own files.

Tools

  • lobster-json: Extract activities from JSON files

Usage

Some projects store their test vectors in JSON files. This tool can be used to expose these to LOBSTER. Consider this example:

[
    {"name"        : "XOR Test 1",
     "values"      : [false, false],
     "expectation" : false,
     "tags"        : "example.req_xor"},

    {"name"        : "XOR Test 2",
     "values"      : [false, true],
     "expectation" : true,
     "tags"        : "example.req_xor"},

    {"name"          : "Potato Test 1",
     "values"        : [false, false],
     "expectation"   : true,
     "tags"          : null,
     "justification" : "Unlinked on purpose"}
]

Here we have a list of three tests. You can configure the lobster-json tool to extract the relevant information:

$ lobster-json --name-attribute "name" \
               --tag-attribute "tags" \
               --justification-attribute "justification" \
               FILENAME

The name attribute is optional. If your test files do not contain names for the tests then a name is synthesised using the filename and the index of the test (e.g. foo_1, foo_2, foo_3, etc.).

The justification attribute is also optional.

The tag attribute is not, and it needs to be present in each test object.

The specification of these attributes can be nested, for example if your test objects instead look like this:

[
    {"meta" : {"name" : "XOR Test 1",
               "asil" : "B",
               "req"  : "example.req_xor"},
     "test" : {"inputs" : [false, false],
               "expect" : false}
    },

    ...

Then you can get to the data like so:

$ lobster-json --name-attribute "meta.name" \
               --tag-attribute "meta.req" \
               --justification-attribute "meta.just" \
               FILENAME

Finally, if your list of tests is nested more deeply in an object, you can use the --test-list flag to identify where it is. For example:

{ "kind"    : "tests",
  "vectors" : [
    {"meta" : {"name" : "XOR Test 1",
               "asil" : "B",
               "req"  : "example.req_xor"},
     "test" : {"inputs" : [false, false],
               "expect" : false}
    },

    ...

Then you can use --test-list=vectors to identify the correct list.

Note: This tool is pretty limited. For the obvious cases it works pretty well, but if you have a more complex test definition in JSON then you will need to write your own adaptor using the documented schema.

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.