Fix logging to be initialized in binary and not in lib (#64)

* add logger for integration tests
* change println! to log events
* remove env_logger init from ustreamer
* fix GitHub action runner to use ubuntu-22.04 for vsomeip workaround

Author: olitha

.github/workflows/unbundled-lint-and-test.yaml

@@ -39,7 +39,7 @@ concurrency:
 
 jobs:
   obtain_and_build_vsomeip:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     outputs:
       cache_key: ${{ steps.generate_cache_key.outputs.CACHE_KEY }}
     steps:
@@ -120,7 +120,7 @@ jobs:
   lint:
     name: Lint
     needs: obtain_and_build_vsomeip
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     env:
       CACHE_KEY: ${{ needs.obtain_and_build_vsomeip.outputs.cache_key }}
 
@@ -179,7 +179,7 @@ jobs:
   test:
     name: Test
     needs: obtain_and_build_vsomeip
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     env:
       CACHE_KEY: ${{ needs.obtain_and_build_vsomeip.outputs.cache_key }}
 
@@ -258,7 +258,7 @@ jobs:
   build-docs:
     name: Build documentation
     needs: obtain_and_build_vsomeip
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     env:
       CACHE_KEY: ${{ needs.obtain_and_build_vsomeip.outputs.cache_key }}
 

Cargo.lock

@@ -11,6 +11,7 @@
  * SPDX-License-Identifier: Apache-2.0
  ********************************************************************************/
 
+use log::warn;
 use std::collections::{HashMap, HashSet};
 use std::hash::{Hash, Hasher};
 use std::sync::Mutex;
@@ -98,19 +99,19 @@ impl SubscriptionCache {
             let status = if let Some(status) = subscription.status.into_option() {
                 status
             } else {
-                println!("Unable to parse status from subscription, setting as default");
+                warn!("Unable to parse status from subscription, setting as default");
                 SubscriptionStatus::default()
             };
             let attributes = if let Some(attributes) = subscription.attributes.into_option() {
                 attributes
             } else {
-                println!("Unable to parse attributes from subscription, setting as default");
+                warn!("Unable to parse attributes from subscription, setting as default");
                 SubscribeAttributes::default()
             };
             let config = if let Some(config) = subscription.config.into_option() {
                 config
             } else {
-                println!("Unable to parse config from subscription, setting as default");
+                warn!("Unable to parse config from subscription, setting as default");
                 EventDeliveryConfig::default()
             };
             // Create new hashset if the key does not exist and insert the subscription

subscription-cache/src/lib.rs

@@ -575,11 +575,6 @@ impl UStreamer {
         usubscription: Arc<dyn USubscription>,
     ) -> Result<Self, UStatus> {
         let name = format!("{USTREAMER_TAG}:{name}:");
-        // Try to initiate logging.
-        // Required in case of dynamic lib, otherwise no logs.
-        // But cannot be done twice in case of static link.
-        std::env::set_var("RUST_LOG", "debug");
-        let _ = env_logger::try_init();
         debug!(
             "{}:{}:{} UStreamer created",
             &name, USTREAMER_TAG, USTREAMER_FN_NEW_TAG

up-streamer/src/ustreamer.rs

@@ -38,6 +38,8 @@ const SENT_MESSAGE_VEC_CAPACITY: usize = 10_000;
 
 #[tokio::test(flavor = "multi_thread")]
 async fn single_local_single_remote() {
+    integration_test_utils::init_logging();
+
     // using async_broadcast to simulate communication protocol
     let (tx_1, rx_1) = broadcast(10000);
     let (tx_2, rx_2) = broadcast(10000);

up-streamer/tests/single_local_single_remote.rs

@@ -39,6 +39,8 @@ const SENT_MESSAGE_VEC_CAPACITY: usize = 20_000;
 
 #[tokio::test(flavor = "multi_thread")]
 async fn single_local_two_remote_add_remove_rules() {
+    integration_test_utils::init_logging();
+
     // using async_broadcast to simulate communication protocol
     let (tx_1, rx_1) = broadcast(20000);
     let (tx_2, rx_2) = broadcast(20000);

up-streamer/tests/single_local_two_remote_add_remove_rules.rs

@@ -39,6 +39,7 @@ const SENT_MESSAGE_VEC_CAPACITY: usize = 10_000;
 
 #[tokio::test(flavor = "multi_thread")]
 async fn single_local_two_remote_authorities_different_remote_transport() {
+    integration_test_utils::init_logging();
     // using async_broadcast to simulate communication protocol
     let (tx_1, rx_1) = broadcast(20000);
     let (tx_2, rx_2) = broadcast(20000);

up-streamer/tests/single_local_two_remote_authorities_different_remote_transport.rs

@@ -39,6 +39,8 @@ const SENT_MESSAGE_VEC_CAPACITY: usize = 10_000;
 
 #[tokio::test(flavor = "multi_thread")]
 async fn single_local_two_remote_authorities_same_remote_transport() {
+    integration_test_utils::init_logging();
+
     // using async_broadcast to simulate communication protocol
     let (tx_1, rx_1) = broadcast(20000);
     let (tx_2, rx_2) = broadcast(20000);

up-streamer/tests/single_local_two_remote_authorities_same_remote_transport.rs

@@ -19,6 +19,8 @@ use usubscription_static_file::USubscriptionStaticFile;
 
 #[tokio::test(flavor = "multi_thread")]
 async fn usubscription_bad_data() {
+    integration_test_utils::init_logging();
+
     let utransport_foo: Arc<dyn UTransport> =
         Arc::new(UPClientFailingRegister::new("upclient_foo").await);
     let utransport_bar: Arc<dyn UTransport> =

up-streamer/tests/usubscription.rs

@@ -39,3 +39,16 @@ pub use integration_test_messages::{
     request_from_remote_client_for_local_client, response_from_local_client_for_remote_client,
     response_from_remote_client_for_local_client,
 };
+
+/// Helper method for integration tests to initialise
+/// [env_logger].
+///
+/// `RUST_LOG` env is read. Defaults to `DEBUG`
+pub fn init_logging() {
+    let log_filter = std::env::var("RUST_LOG").unwrap_or_else(|_| "debug".to_string());
+    env_logger::builder()
+        .parse_filters(&log_filter)
+        .format_timestamp(None)
+        .is_test(true)
+        .init();
+}