Add logging showcase

bazel_common/score_modules_target_sw.MODULE.bazel

@@ -72,7 +72,12 @@ git_override(
 bazel_dep(name = "score_logging")
 git_override(
     module_name = "score_logging",
-    commit = "0e9187f79a9935ca192779234b82f9d00dc4e335",
+    commit = "3da15793ed76bc8b97cffe379345f3c3d61c17cd",
+    patch_strip = 1,
+    patches = [
+        "//patches/logging:001-logging-example-visibility.patch",
+        "//patches/logging:002-deps-visibility.patch",
+    ],
     remote = "https://github.com/eclipse-score/logging.git",
 )
 

feature_integration_tests/itf/test_remote_logging.py

@@ -27,8 +27,9 @@
 CAPTURE_DURATION_SECONDS = 10
 
 # DLT message identifiers for datarouter statistics
-APP_ID = "DR"
-CTX_ID = "STAT"
+
+APP_ID = "EXA"
+CTX_ID = "DFLT"
 
 _QNX_DATAROUTER_CHECK_CMD = "/proc/boot/pidin | /proc/boot/grep datarouter"
 _LINUX_DATAROUTER_CHECK_CMD = "ps -ef | grep datarouter | grep -v grep"
@@ -40,6 +41,9 @@
     "./datarouter --no_adaptive_runtime > /dev/null 2>&1 &"
 )
 _LINUX_DATAROUTER_START_CMD = "cd /usr/bin/datarouter && nohup ./datarouter --no_adaptive_runtime > /dev/null 2>&1 &"
+
+
+_LOGGINGAPP_START_CMD = "cd /showcases/data/logging/logging_app/etc && nohup /showcases/bin/logging_app &"
 # Multicast route directs all multicast traffic (224.0.0.0/4) out of the containers
 # network interface required for DLT messages to reach the host via the Docker bridge.
 _LINUX_CHECK_MULTICAST_ROUTE_CMD = "ip route add 224.0.0.0/4 dev eth0 2>/dev/null || true"
@@ -85,7 +89,7 @@ def datarouter_running(target):
     yield
 
 
-def test_remote_logging(datarouter_running, dlt_config):
+def test_remote_logging(datarouter_running, target, dlt_config):
     """Verifies remote logging of Dataraouter
 
     Starts Datarouter on the target if not already running, then
@@ -100,6 +104,10 @@ def test_remote_logging(datarouter_running, dlt_config):
         print_to_stdout=True,
         binary_path=dlt_config.dlt_receive_path,
     ) as window:
+        logger.info("Starting logging app to generate DLT messages..")
+        exit_code, out = target.execute(_LOGGINGAPP_START_CMD)
+        logger.debug("Logging app start command exit_code=%s", exit_code)
+
         time.sleep(CAPTURE_DURATION_SECONDS)
 
     record = window.record(filters=[(APP_ID, CTX_ID)])

known_good.json

@@ -97,8 +97,12 @@
             },
             "score_logging": {
                 "repo": "https://github.com/eclipse-score/logging.git",
-                "hash": "0e9187f79a9935ca192779234b82f9d00dc4e335",
+                "hash": "3da15793ed76bc8b97cffe379345f3c3d61c17cd",
+                "bazel_patches": [
+                    "//patches/logging:001-logging-example-visibility.patch",
+                    "//patches/logging:002-deps-visibility.patch"],
                 "metadata": {
+                    "code_root_path": "//score/mw/...",
                     "extra_test_config": [
                         "@score_logging//score/datarouter/build_configuration_flags:persistent_logging=False",
                         "@score_logging//score/datarouter/build_configuration_flags:persistent_config_feature_enabled=False",

patches/logging/001-logging-example-visibility.patch

@@ -0,0 +1,38 @@
+diff --git a/score/test/component/dlt_generator_app/BUILD b/score/test/component/dlt_generator_app/BUILD
+index 9736cac..a60ebd6 100644
+--- a/score/test/component/dlt_generator_app/BUILD
++++ b/score/test/component/dlt_generator_app/BUILD
+@@ -29,9 +29,14 @@ load("@rules_pkg//pkg:tar.bzl", "pkg_tar")
+ cc_binary(
+     name = "dlt_generator",
+     srcs = ["dlt_generator.cpp"],
++    visibility = ["//visibility:public"],
+     deps = ["//score/mw/log"],
+ )
+
++exports_files([
++    "etc/logging.json",
++])
++
+ pkg_tar(
+     name = "dlt_generator_bin_pkg",
+     srcs = [":dlt_generator"],
+diff --git a/score/test/component/logging_app/BUILD b/score/test/component/logging_app/BUILD
+index de63c65..f9f3346 100644
+--- a/score/test/component/logging_app/BUILD
++++ b/score/test/component/logging_app/BUILD
+@@ -29,9 +29,14 @@ load("@rules_pkg//pkg:tar.bzl", "pkg_tar")
+ cc_binary(
+     name = "logging_app",
+     srcs = ["logging_app.cpp"],
++    visibility = ["//visibility:public"],
+     deps = ["//score/mw/log"],
+ )
+
++exports_files([
++    "etc/logging.json",
++])
++
+ pkg_tar(
+     name = "logging_app_bin_pkg",
+     srcs = [":logging_app"],

patches/logging/002-deps-visibility.patch

@@ -0,0 +1,13 @@
+diff --git a/MODULE.bazel b/MODULE.bazel
+index 5eed2f9..06fb222 100644
+--- a/MODULE.bazel
++++ b/MODULE.bazel
+@@ -47,7 +47,7 @@ bazel_dep(name = "score_itf", version = "0.4.0", dev_dependency = True)
+
+ # OCI / Docker image rules for integration tests
+ bazel_dep(name = "rules_oci", version = "2.2.7", dev_dependency = True)
+-bazel_dep(name = "rules_pkg", version = "1.2.0", dev_dependency = True)
++bazel_dep(name = "rules_pkg", version = "1.2.0")
+
+ # QNX image filesystem rules for QNX integration tests
+ bazel_dep(name = "score_rules_imagefs", version = "0.0.1", dev_dependency = True)

rust_coverage/BUILD

@@ -82,6 +82,6 @@ rust_coverage_report(
         "linux-x86_64",
         "ferrocene-coverage",
     ],
-    query = 'kind("rust_test", @score_logging//score/...) -@score_logging//score/datarouter/test/ut/ut_logging:dltprotocolUT -@score_logging//score/datarouter/test/ut/ut_logging:persistentLogConfigUT -@score_logging//score/datarouter/test/ut/ut_logging:socketserverConfigUT -@score_logging//score/datarouter/test/ut/ut_logging:socketserverUT -@score_logging//score/mw/log/legacy_non_verbose_api:unit_test',
+    query = 'kind("rust_test", @score_logging//score/mw/...) -@score_logging//score/datarouter/test/ut/ut_logging:dltprotocolUT -@score_logging//score/datarouter/test/ut/ut_logging:persistentLogConfigUT -@score_logging//score/datarouter/test/ut/ut_logging:socketserverConfigUT -@score_logging//score/datarouter/test/ut/ut_logging:socketserverUT -@score_logging//score/mw/log/legacy_non_verbose_api:unit_test',
     visibility = ["//visibility:public"],
 )

showcases/BUILD

@@ -18,6 +18,7 @@ score_pkg_bundle(
     other_package_files = [
         "//showcases/standalone:comm_pkg_files",
         "//showcases/standalone:kyron_pkg_files",
+        "//showcases/standalone:logging_pkg_files",
         "//showcases/standalone:time_pkg_files",
         "//showcases/orchestration_persistency:orch_per_pkg_files",
         "//showcases/simple_lifecycle:simple_lifecycle_pkg_files",

showcases/README.md

@@ -0,0 +1,7 @@
+# Logging Example
+
+This example demonstrates logging with all log levels via Console Logging and Remote Logging.
+
+For remote logging details, refer to the following documentation:
+
+[Remote logging](https://github.com/eclipse-score/logging/blob/main/score/datarouter/doc/guideline/dlt_capture_demo.md)

showcases/standalone/BUILD

@@ -50,3 +50,19 @@ score_pkg_bundle(
     ],
     package_dir = "standalone",
 )
+
+score_pkg_bundle(
+    name = "logging",
+    bins = [
+        "@score_logging//score/test/component/logging_app:logging_app",
+        "@score_logging//score/test/component/dlt_generator_app:dlt_generator",
+    ],
+    config_data = [
+        "//showcases/standalone:logging.score.json",
+    ],
+    custom_layout = {
+        "@score_logging//score/test/component/logging_app:etc/logging.json": "logging_app/etc/logging.json",
+        "@score_logging//score/test/component/dlt_generator_app:etc/logging.json": "dlt_generator/etc/logging.json",
+    },
+    package_dir = "standalone",
+)

showcases/standalone/logging.score.json

@@ -0,0 +1,27 @@
+{
+    "name": "Logging example",
+    "description": "Example for running logging with all log levels via remote and console",
+    "apps": [
+      {
+        "path": "/bin/sh",
+        "args": [
+          "-c",
+          "cd /usr/bin/datarouter && ./datarouter --no_adaptive_runtime >/dev/null 2>&1 &"
+        ],
+        "env": {}
+      },
+      {
+        "path": "/showcases/bin/logging_app",
+        "args": [],
+        "env": {},
+        "dir": "/showcases/data/logging/logging_app/etc"
+      },
+
+      {
+        "path": "/showcases/bin/dlt_generator",
+        "args": [],
+        "env": {},
+        "dir": "/showcases/data/logging/dlt_generator/etc"
+      }
+    ]
+  }