Validation

Unit Tests

Unit tests in rules_score components are written with GoogleTest and built with cc_test. Each test case that covers a component requirement must carry a lobster-tracing annotation so that the build can link the test back to the requirement.

Annotating Tests

Call RecordProperty inside the test body next to the respective code blocks:

TEST(Foo, GetNumber) {
    ::testing::Test::RecordProperty("lobster-tracing",
                                    "SampleComponent.REQ_COMP_001");

    ::testing::Test::RecordProperty("given",
                                    "a default-constructed Foo instance");
    unit_1::Foo unit{};

    ::testing::Test::RecordProperty("when", "GetNumber is called");
    ::testing::Test::RecordProperty("then", "it returns 42");
    EXPECT_EQ(unit.GetNumber(), 42u);
}

Property	Required	Description
lobster-tracing	yes	Comma-separated requirement IDs; links the test to one or more CompReq records
given	no	Initial state / precondition
when	no	Action or event under test
then	no	Expected outcome

A dependable_element report renders every annotated test on its Unit Test page at <dependable-element>_index/traceability_report/unit_test.html. The entry shows its Given/When/Then text, links to the traced requirements, and links back to the test source.

A test without lobster-tracing has no traceability and is not included in coverage tracking.

Stating Coverage for test cases

Coverage is declared through a committed test_case_coverage.lock.yaml file that lists, per requirement, every test case (uid + given/when/then) that covers it. Committing the file is stating the coverage claim.

In Bazel the yaml file can be linked to the component macro via the test_case_coverage_lock attribute:

component(
    name = "my_component",
    requirements = [":my_component_requirements"],
    components  = [":unit_a", ":unit_b"],
    test_case_coverage_lock = "test_case_coverage.lock.yaml",
)

Two complementary workflows keep the lock file in sync:

• ``bazel run …update`` — reads the current test results and rewrites test_case_coverage.lock.yaml in the source tree.

• ``bazel test //…`` — the build action recomputes coverage from the same test results and compares it against the committed lock. Any drift (new test, removed test, changed GWT text, version bump) fails the build until the lock is refreshed and re-committed.

When a dependable_element report is built, this claim is rendered on its Test Case Coverage page at <dependable-element>_index/traceability_report/test_case_coverage.html. Each requirement entry shows its coverage status and GWT text, with links to the individual traced test cases.

For example, the SEooC example’s lock records two tests covering one component requirement:

schema_version: 3
requirements:
  - id: SampleComponent.REQ_COMP_001
    version: '1'
    description: The numeric value management interface shall provide a read operation that returns a uint8_t value
    test_cases:
      - uid: //Foo:GetNumber
        given: a default-constructed Foo instance
        when: GetNumber is called
        then: it returns 42
      - uid: //Foo:GetNumberViaConstInstance
        given: a const default-constructed Foo instance
        when: GetNumber is called through a const reference
        then: it still returns 42

For the full tool description — lock file format, update workflow, design decisions — see Test Case Coverage (test_case_coverage).