Repository navigation
docs: add Unit Test work product for mw::log backend #376
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Y-Vaishnavi
wants to merge
1
commit into
eclipse-score:main
Choose a base branch
from
Y-Vaishnavi:vy/log-backend-unit-test-traceability
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| .. | ||
| # ******************************************************************************* | ||
| # Copyright (c) 2026 Contributors to the Eclipse Foundation | ||
| # | ||
| # See the NOTICE file(s) distributed with this work for additional | ||
| # information regarding copyright ownership. | ||
| # | ||
| # This program and the accompanying materials are made available under the | ||
| # terms of the Apache License Version 2.0 which is available at | ||
| # https://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
|
|
||
| Unit Test | ||
| ######### | ||
|
|
||
| .. document:: mw::log Backend Unit Test | ||
| :id: doc__mw_log_backend_unit_test | ||
| :status: draft | ||
| :version: 1 | ||
| :safety: ASIL_B | ||
| :security: YES | ||
| :realizes: wp__verification_sw_unit_test | ||
|
|
||
| The unit tests for the ``mw::log`` backend verify the detailed design and | ||
| implementation (:need:`doc__mw_log_backend_detailed_design`) at unit level. They | ||
| are written with gTest, following the template described in | ||
| :need:`gd_guidl__verification_guide`, and are integrated into the CI build so | ||
| that they run on every change. | ||
|
|
||
| Unit Test Suites | ||
| ----------------- | ||
|
|
||
| Each internal unit (common utilities, file/syslog/slog/datarouter recorders, | ||
| the wait-free producer queue, signal handling, backend registrants, and the | ||
| legacy non-verbose API) has its own ``cc_test`` target colocated with the code | ||
| it verifies. Rather than duplicating that list here, the single entry point | ||
| below links to the component's source tree, which can be browsed to reach | ||
| every unit and its corresponding test: | ||
|
|
||
| `score/mw/log <https://github.com/eclipse-score/logging/tree/main/score/mw/log>`_ | ||
|
|
||
| Execution | ||
| --------- | ||
|
|
||
| Most of the above areas provide a Bazel ``unit_tests`` test suite target | ||
| (``cc_unit_test_suites_for_host_and_qnx``) that is run on the Linux host and, | ||
| where applicable, on QNX; the ``syslog`` and ``slog`` backends run their | ||
| ``cc_test`` targets directly. The aggregated ``unit_tests`` target for the | ||
| full ``mw::log`` backend is built and executed as part of CI on every pull | ||
| request. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is not ideal to list every test target here again. I would suggest to provide a landing page that navigates to all in one link. Otherwise its a maintenance effort!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
updated: removed the per-suite table and replaced it with a single link to the [log] source tree