Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/components/mw_log/detailed_design/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,16 @@ The backend composition and recorder relationships are shown below:
datarouter_backend/index


Unit Test
---------

The unit test documentation for the ``mw::log`` backend can be found here:

.. toctree::

unit_test


Inspection Checklist
--------------------

Expand Down
52 changes: 52 additions & 0 deletions docs/components/mw_log/detailed_design/unit_test.rst
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

Copy link
Copy Markdown
Contributor

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!

Copy link
Copy Markdown
Contributor Author

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

-----------------

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.
2 changes: 1 addition & 1 deletion docs/module/safety_mgt/module_safety_plan.rst
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ Component Logging Backend Work products List
* - :need:`wp__verification_sw_unit_test`
- :need:`gd_guidl__verification_guide`
- :ndf:`copy('status', need_id='gd_guidl__verification_guide')`
- <Link to WP>
- :need:`doc__mw_log_backend_unit_test`

* - :need:`wp__sw_implementation_inspection`
- :need:`gd_chklst__impl_inspection_checklist`
Expand Down
Loading