AZB #101279 Quality pack targets - #150
Conversation
License Check Results🚀 The license check job ran with the Bazel command: bazel run //:license-checkStatus: Click to expand output |
|
The created documentation from the pull request is available at: docu-html |
There was a problem hiding this comment.
This doesn't match up with the score process module_template.
I've started the component requirements work for the other components following the guidelines, see #151 and #149. I think we should have this structure across all the components. The actual build of the docs themselves won't work until the update to docs-as-code 6.0 is merged in #148 (updating to use docs_bundles so that we can have docs alongside source).
Please update to match the template.
There was a problem hiding this comment.
I pushed the commit Update to match module_template , to match the template. However, like you said, until docs-as-code 6.0 isn't merged this will not work as we get:
"broken_references": [
{
"testcase": "testcase__SystemClockTest__NowReturnsTimepointSuitableForDurationArithmetic_nckqh",
"missing_need": "comp_req__system_time__snapshot"
},
{
"testcase": "testcase__SteadyClockTest__NowReturnsTimepointSuitableForDurationArithmetic_dhwjw",
"missing_need": "comp_req__steady_time__snapshot"
},
{
"testcase": "testcase__HighResSteadyClockTest__NowReturnsTimepointSuitableForDurationArithmetic_ogazc",
"missing_need": "comp_req__high_res_steady_time__snapshot"
},
{
"testcase": "testcase__VehicleClockTest__NowReturnsSynchronizedStatusAndTimepoint_xggob",
"missing_need": "comp_req__vehicle_time__snapshot"
},
{
"testcase": "testcase__VehicleClockTest__InitForwardsToBackend_vsaqs",
"missing_need": "comp_req__vehicle_time__lifecycle"
}
]
160bc42 to
7444a7c
Compare
…ality-pack-targets
…ality-pack-targets
…ality-pack-targets
Remove feature requirements as they belong to eclipse-score/score repo
…ality-pack-targets
| :satisfied_by: comp__time | ||
| .. comp_req:: Unified clock facade across time domains | ||
| :id: comp_req__time__unified_clock_facade | ||
| :reqtype: Interface |
There was a problem hiding this comment.
Think this should be functional since it describes type safety enforcement (functional behaviour)
| .. comp_req:: Immutable snapshot with quality metadata | ||
| :id: comp_req__time__snapshot_with_status | ||
| :reqtype: Functional | ||
| :security: NO | ||
| :safety: QM | ||
| :derived_from: feat_req__time__vehicle_time_time_api | ||
| :status: valid | ||
| :version: 1 | ||
| :satisfied_by: comp__time | ||
|
|
||
| The Component shall do xyz to another component to bring it to this condition at this time | ||
| Every ``Clock<Tag>::Now`` call shall return a single immutable | ||
| ``ClockSnapshot`` value that bundles the timepoint with the domain's | ||
| status metadata, so callers can inspect synchronization quality | ||
| without a separate status call. |
There was a problem hiding this comment.
Per checklist REQ_02_03 requirements should be atomic. The immutable aspect of ClockSnapshot feels like it should be pulled out to its own req.
| .. comp_req:: Immutable snapshot with quality metadata | |
| :id: comp_req__time__snapshot_with_status | |
| :reqtype: Functional | |
| :security: NO | |
| :safety: QM | |
| :derived_from: feat_req__time__vehicle_time_time_api | |
| :status: valid | |
| :version: 1 | |
| :satisfied_by: comp__time | |
| The Component shall do xyz to another component to bring it to this condition at this time | |
| Every ``Clock<Tag>::Now`` call shall return a single immutable | |
| ``ClockSnapshot`` value that bundles the timepoint with the domain's | |
| status metadata, so callers can inspect synchronization quality | |
| without a separate status call. | |
| .. comp_req:: Immutable snapshot with quality metadata | |
| :id: comp_req__time__snapshot_with_status | |
| :reqtype: Functional | |
| :security: NO | |
| :safety: QM | |
| :derived_from: feat_req__time__vehicle_time_time_api | |
| :status: valid | |
| :version: 1 | |
| :satisfied_by: comp__time | |
| The Component shall include synchronization metadata with each | |
| time snapshot for clock domains that provide status information, so | |
| callers can determine time validity without a separate status query. | |
| .. comp_req:: Immutable snapshot with quality metadata | |
| :id: comp_req__time__snapshot_with_status | |
| :reqtype: Functional | |
| :security: NO | |
| :safety: QM | |
| :derived_from: feat_req__time__vehicle_time_time_api | |
| :status: valid | |
| :version: 1 | |
| :satisfied_by: comp__time | |
| The Component shall return time snapshots as immutable values that | |
| cannot be modified after creation, so callers observe consistent | |
| snapshot data throughout its lifetime. |
There was a problem hiding this comment.
These are a good start, but I think we could probably do with some more at this level.
- thread safety for getInstance singleton access
- thread safety for reading time snapshots
- linux and qnx platform support
- error handling (that we log on errors)
- that we return empty snapshot when backend not initialized
- AoU that user will initialize backend where necessary
Co-authored-by: Ryan Steel <str1yok@bosch.com> Signed-off-by: Gabriel Pinheiro <gabriel.pinheiro@etas.com>
Provide Bazel targets: unit tests, component tests, code coverage.
Added documentation