Update with up-transport-vsomeip-rust build changes (#60)

* Add shell script to set environment variables, updated CI workflows to use it.
* Update up-transport-vsomeip-rust and up-streamer-rust to use up-rust 0.3.0
* Update up-transport-mqtt5 to 0.2.0
* Add necessary piping through of environment variables for paths to C++ stdlib
* Update to published up-transport-vsomeip 0.4.1
* Update README.md on how to build using either config.toml or envsetup.sh

Author: PLeVasseur

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

@@ -15,8 +15,6 @@ name: Lint and Test - Bundled
 
 env:
   VSOMEIP_INSTALL_PATH: vsomeip-install
-  GENERIC_CPP_STDLIB_PATH: /usr/include/c++/11
-  ARCH_SPECIFIC_CPP_STDLIB_PATH: /usr/include/x86_64-linux-gnu/c++/11
 
 on:
   push:
@@ -35,9 +33,35 @@ concurrency:
 
 jobs:
 
+  set-env:
+    name: Set environment variables
+    runs-on: ubuntu-22.04
+
+    outputs:
+      arch_specific_cpp_stdlib_path: ${{ steps.set_env.outputs.arch_specific_cpp_stdlib_path }}
+      generic_cpp_stdlib_path: ${{ steps.set_env.outputs.generic_cpp_stdlib_path }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Add execute permissions for envsetup
+        run: chmod +x build/envsetup.sh
+
+      - name: Set stdlib paths dynamically
+        id: set_env
+        run: |
+          source ./build/envsetup.sh highest
+          echo "arch_specific_cpp_stdlib_path=$ARCH_SPECIFIC_CPP_STDLIB_PATH" >> $GITHUB_OUTPUT
+          echo "generic_cpp_stdlib_path=$GENERIC_CPP_STDLIB_PATH" >> $GITHUB_OUTPUT
+
   lint:
     name: Lint
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
+    needs: set-env
+
+    env:
+       ARCH_SPECIFIC_CPP_STDLIB_PATH: ${{ needs.set-env.outputs.arch_specific_cpp_stdlib_path }}
+       GENERIC_CPP_STDLIB_PATH: ${{ needs.set-env.outputs.generic_cpp_stdlib_path }}
 
     steps:
       - uses: actions/checkout@v4
@@ -48,10 +72,14 @@ jobs:
       - name: Set environment variables
         run: |
           echo "VSOMEIP_INSTALL_PATH=${{ github.workspace }}/${{ env.VSOMEIP_INSTALL_PATH }}" >> $GITHUB_ENV
+          env
 
       - name: Print environment variables for debugging
         run: |
           echo "VSOMEIP_INSTALL_PATH: ${{ env.VSOMEIP_INSTALL_PATH }}"
+          echo "GENERIC_CPP_STDLIB_PATH: ${{ env.GENERIC_CPP_STDLIB_PATH }}"
+          echo "ARCH_SPECIFIC_CPP_STDLIB_PATH: ${{ env.ARCH_SPECIFIC_CPP_STDLIB_PATH }}"
+          env
 
       - name: Ensure vsomeip install path exists
         run: |
@@ -81,7 +109,12 @@ jobs:
 
   test:
     name: Test
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
+    needs: set-env
+
+    env:
+       ARCH_SPECIFIC_CPP_STDLIB_PATH: ${{ needs.set-env.outputs.arch_specific_cpp_stdlib_path }}
+       GENERIC_CPP_STDLIB_PATH: ${{ needs.set-env.outputs.generic_cpp_stdlib_path }}
 
     steps:
       - uses: actions/checkout@v4
@@ -146,7 +179,12 @@ jobs:
 
   build-docs:
     name: Build documentation
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
+    needs: set-env
+
+    env:
+       ARCH_SPECIFIC_CPP_STDLIB_PATH: ${{ needs.set-env.outputs.arch_specific_cpp_stdlib_path }}
+       GENERIC_CPP_STDLIB_PATH: ${{ needs.set-env.outputs.generic_cpp_stdlib_path }}
 
     steps:
       - uses: actions/checkout@v4

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

@@ -19,9 +19,6 @@ env:
   VSOMEIP_SOURCE_PATH: vsomeip-src
   VSOMEIP_INSTALL_PATH: vsomeip-install
 
-  GENERIC_CPP_STDLIB_PATH: /usr/include/c++/11
-  ARCH_SPECIFIC_CPP_STDLIB_PATH: /usr/include/x86_64-linux-gnu/c++/11
-
 on:
   push:
     branches: [ main ]
@@ -38,10 +35,38 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+
+  set-env:
+    name: Set environment variables
+    runs-on: ubuntu-22.04
+
+    outputs:
+      arch_specific_cpp_stdlib_path: ${{ steps.set_env.outputs.arch_specific_cpp_stdlib_path }}
+      generic_cpp_stdlib_path: ${{ steps.set_env.outputs.generic_cpp_stdlib_path }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Add execute permissions for envsetup
+        run: chmod +x build/envsetup.sh
+
+      - name: Set stdlib paths dynamically
+        id: set_env
+        run: |
+          source ./build/envsetup.sh highest
+          echo "arch_specific_cpp_stdlib_path=$ARCH_SPECIFIC_CPP_STDLIB_PATH" >> $GITHUB_OUTPUT
+          echo "generic_cpp_stdlib_path=$GENERIC_CPP_STDLIB_PATH" >> $GITHUB_OUTPUT
+
   obtain_and_build_vsomeip:
+    needs: set-env
     runs-on: ubuntu-22.04
     outputs:
       cache_key: ${{ steps.generate_cache_key.outputs.CACHE_KEY }}
+
+    env:
+       ARCH_SPECIFIC_CPP_STDLIB_PATH: ${{ needs.set-env.outputs.arch_specific_cpp_stdlib_path }}
+       GENERIC_CPP_STDLIB_PATH: ${{ needs.set-env.outputs.generic_cpp_stdlib_path }}
+
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -52,14 +77,18 @@ jobs:
           echo "VSOMEIP_SOURCE_PATH=${{ github.workspace }}/${{ env.VSOMEIP_SOURCE_PATH }}" >> $GITHUB_ENV
           echo "VSOMEIP_INSTALL_PATH=${{ github.workspace }}/${{ env.VSOMEIP_INSTALL_PATH }}" >> $GITHUB_ENV
           echo "VSOMEIP_SOURCE_PATH_WITH_WILDCARD=${{ github.workspace }}/${{ env.VSOMEIP_SOURCE_PATH }}/*" >> $GITHUB_ENV
+          env
 
       - name: Print environment variables for debugging
         run: |
           echo "VSOMEIP_SOURCE_TARBALL: ${{ env.VSOMEIP_SOURCE_TARBALL }}"
           echo "VSOMEIP_SOURCE_PATH: ${{ env.VSOMEIP_SOURCE_PATH }}"
           echo "VSOMEIP_INSTALL_PATH: ${{ env.VSOMEIP_INSTALL_PATH }}"
           echo "VSOMEIP_SOURCE_PATH_WITH_WILDCARD: ${{ env.VSOMEIP_SOURCE_PATH_WITH_WILDCARD }}"
-
+          echo "GENERIC_CPP_STDLIB_PATH: ${{ env.GENERIC_CPP_STDLIB_PATH }}"
+          echo "ARCH_SPECIFIC_CPP_STDLIB_PATH: ${{ env.ARCH_SPECIFIC_CPP_STDLIB_PATH }}"
+          env
+          
       - name: Download tarball
         run: |
           wget -O vsomeip-source.tar.gz $VSOMEIP_SOURCE_TARBALL
@@ -101,7 +130,7 @@ jobs:
 
       - name: Install dependencies
         if: steps.cache-vsomeip.outputs.cache-hit != 'true'
-        run: sudo apt-get install -y build-essential cmake libboost-all-dev
+        run: sudo apt-get install -y build-essential cmake libboost-all-dev doxygen asciidoc 
 
       - name: Build vsomeip
         if: steps.cache-vsomeip.outputs.cache-hit != 'true'
@@ -119,9 +148,13 @@ jobs:
 
   lint:
     name: Lint
-    needs: obtain_and_build_vsomeip
+    needs: 
+      - set-env
+      - obtain_and_build_vsomeip
     runs-on: ubuntu-22.04
     env:
+      ARCH_SPECIFIC_CPP_STDLIB_PATH: ${{ needs.set-env.outputs.arch_specific_cpp_stdlib_path }}
+      GENERIC_CPP_STDLIB_PATH: ${{ needs.set-env.outputs.generic_cpp_stdlib_path }}
       CACHE_KEY: ${{ needs.obtain_and_build_vsomeip.outputs.cache_key }}
 
     steps:
@@ -178,9 +211,14 @@ jobs:
 
   test:
     name: Test
-    needs: obtain_and_build_vsomeip
+    needs: 
+      - set-env
+      - obtain_and_build_vsomeip
     runs-on: ubuntu-22.04
+
     env:
+      ARCH_SPECIFIC_CPP_STDLIB_PATH: ${{ needs.set-env.outputs.arch_specific_cpp_stdlib_path }}
+      GENERIC_CPP_STDLIB_PATH: ${{ needs.set-env.outputs.generic_cpp_stdlib_path }}
       CACHE_KEY: ${{ needs.obtain_and_build_vsomeip.outputs.cache_key }}
 
     steps:
@@ -257,9 +295,13 @@ jobs:
 
   build-docs:
     name: Build documentation
-    needs: obtain_and_build_vsomeip
+    needs: 
+      - obtain_and_build_vsomeip
+      - set-env
     runs-on: ubuntu-22.04
     env:
+      ARCH_SPECIFIC_CPP_STDLIB_PATH: ${{ needs.set-env.outputs.arch_specific_cpp_stdlib_path }}
+      GENERIC_CPP_STDLIB_PATH: ${{ needs.set-env.outputs.generic_cpp_stdlib_path }}
       CACHE_KEY: ${{ needs.obtain_and_build_vsomeip.outputs.cache_key }}
 
     steps:

Cargo.lock

@@ -41,10 +41,10 @@ serde_json = { version = "1.0.94" }
 uuid = { version = "1.7.0" }
 tokio = { version = "1.35.1", default-features = false, features = ["rt", "rt-multi-thread", "sync", "time"] }
 protobuf = { version = "3.3", features = ["with-bytes"] }
-up-rust = { version = "0.2.0", default-features = false }
-up-transport-zenoh = { version = "0.3.0" }
-up-transport-vsomeip = { git = "https://github.com/eclipse-uprotocol/up-transport-vsomeip-rust.git", tag = "v0.3.0", default-features = false }
-up-transport-mqtt5 = { version = "0.1.0" }
+up-rust = { version = "0.3.0", default-features = false }
+up-transport-zenoh = { version = "0.4.0" }
+up-transport-vsomeip = { version = "0.4.1", default-features = false }
+up-transport-mqtt5 = { version = "0.2.0" }
 zenoh = { version = "1.0.0", features = ["default", "plugins"] }
 zenoh-core = { version = "1.0.0" }
 zenoh-plugin-trait = { version = "1.0.0" }

Cargo.toml

@@ -33,7 +33,11 @@ cargo build
 
 You'll need to use the feature flags `vsomeip-transport`, `zenoh-transport` or `mqtt-transport` depending on which implementation you want to build. You then also have the option of including your own vsomeip or using one bundled in `up-transport-vsomeip`.
 
-For the bundled option, set the following environment variables (for example in your .cargo/config.toml file):
+For the bundled option, you have two options to set environment variables needed.
+
+#### Using `config.toml`
+
+Set the following environment variables (for example in your .cargo/config.toml file):
 
 ```toml
 [env]
@@ -45,6 +49,16 @@ ARCH_SPECIFIC_CPP_STDLIB_PATH=<path to your c++ stdlib (for example /usr/include
 cargo build --features vsomeip-transport,bundled-vsomeip,zenoh-transport
 ```
 
+#### Using `build/envsetup.sh`
+
+Alternatively, you may run:
+
+```shell
+build/envsetup.sh
+```
+
+to set the environment variables.
+
 The environment variables are necessary because of a workaround done in `up-transport-vsomeip` due to not being able to figure out another way to compile vsomeip without them. (If you can figure out how to avoid this, I'm all ears!)
 
 Please reference the documentation for [vsomeip-sys](https://github.com/eclipse-uprotocol/up-transport-vsomeip-rust/tree/main/vsomeip-sys) for more details on: