Task/thdubois/gh 45/update testlib

.dockerignore

@@ -0,0 +1,33 @@
+# .dockerignore
+Dockerfile
+docker-compose.yml
+
+# .gitignore
+# Temporary files
+*~
+tmp
+# All build folders
+/build*/
+# Visual Studio Code
+.vscode/settings.json
+.vscode/launch.json
+.vscode/*.log
+*.code-workspace
+# JetBrains IDE
+.idea/
+# Cmake Projects in root ###
+compile_commands.json
+# Clangd index
+.clangd/
+.cache/
+# BeyondCompare backup files
+*.orig
+# SonarScanner files
+.scannerwork/
+# Generated debconf files
+applications/*/debconf/config
+# Macos fs igores
+*.DS_Store
+# Other files
+*.swp
+*.gcov

.github/workflows/build-rootfs.yml

@@ -8,6 +8,8 @@ on:  # yamllint disable-line rule:truthy
       - '*'
 jobs:
   build:
+    permissions:
+      contents: read
     runs-on: ubuntu-24.04
     strategy:
       matrix:
@@ -16,9 +18,13 @@ jobs:
           - arm64
           # - armhf # TODO Enable when supported
     steps:
-      - uses: actions/checkout@v4.1.1
+      # yamllint disable-line rule:line-length
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
         with:
           fetch-depth: 0
+          # Relate-to: https://github.com/actions/checkout/pull/2081#2025
+          ref: ${{ github.ref }}
+
       - id: describe
         name: Describe HEAD
         run: >-
@@ -31,7 +37,8 @@ jobs:
           UNIFYSDK_GIT_TAG=${{ secrets.UNIFYSDK_GIT_TAG }}
           ./scripts/build-rootfs.sh
       - name: Upload artifacts
-        uses: actions/upload-artifact@v4
+        # yamllint disable-line rule:line-length
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02  # v4.6.2
         with:
           # yamllint disable-line rule:line-length
           name: ${{ github.event.repository.name }}-${{ steps.describe.outputs.describe }}-${{ matrix.arch }}
@@ -42,8 +49,12 @@ jobs:
           ./scripts/build-rootfs.sh docs/dist
       - name: Upload Release Asset
         id: upload-release-asset
-        uses: softprops/action-gh-release@v2
-        if: startsWith(github.ref, 'refs/tags/')
+        env:
+          token-defined: ${{ secrets.GH_UNIFY_ACCESS_TOKEN != '' }}
+        # yamllint disable-line rule:line-length
+        if: ${{ env.token-defined == true && startsWith(github.ref, 'refs/tags/') }}
+        # yamllint disable-line rule:line-length
+        uses: softprops/action-gh-release@da05d552573ad5aba039eaac05058a918a7bf631  # v2.2.2
         with:
           files: build/dist/*
           # yamllint disable-line rule:line-length
@@ -52,7 +63,8 @@ jobs:
       - name: Upload pages artifact
         id: deployment
         if: startsWith(github.ref, 'refs/tags/') && matrix.arch == 'amd64'
-        uses: actions/upload-pages-artifact@v3.0.1
+        # yamllint disable-line rule:line-length
+        uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa  # v3.0.1
         with:
           path: docs/
   deploy:
@@ -67,5 +79,6 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v4
+        # yamllint disable-line rule:line-length
+        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e  # v4.0.5
         if: startsWith(github.ref, 'refs/tags/')

.github/workflows/build.yml

@@ -1,18 +1,23 @@
 # YAML -*- mode: yaml; tab-width: 2; indent-tabs-mode: nil; coding: utf-8 -*-
+# SPDX-License-Identifier: Zlib
+# SPDX-FileCopyrightText: Silicon Laboratories Inc. https://www.silabs.com
 ---
 
-name: z-wave-protocol-controller Build in docker
+name: build
 
 on:  # yamllint disable-line rule:truthy
   push:
 
 jobs:
   build:
+    permissions:
+      contents: read
     env:
-      project-name: z-wave-protocol-controller  # This should be lowercase for docker (and aligned)
+      project-name: z-wave-protocol-controller  # Align to docker (lowercase)
     runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v4.1.1
+      # yamllint disable-line rule:line-length
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
         with:
           fetch-depth: 0
       - id: describe
@@ -22,18 +27,33 @@ jobs:
           | tee $GITHUB_OUTPUT
       - name: Build Docker image from sources
         run: >-
+          df -h
+          &&
           docker build
           --tag "${{ env.project-name }}:latest"
-          --build-arg UNIFYSDK_GIT_REPOSITORY=${{ secrets.UNIFYSDK_GIT_REPOSITORY }}
-          --build-arg UNIFYSDK_GIT_TAG=${{ secrets.UNIFYSDK_GIT_TAG }}
+          --build-arg
+          UNIFYSDK_GIT_REPOSITORY=${{ secrets.UNIFYSDK_GIT_REPOSITORY }}
+          --build-arg
+          UNIFYSDK_GIT_TAG=${{ secrets.UNIFYSDK_GIT_TAG }}
           .
+          &&
+          df -h
+
+      - name: Upload container image
+        # yamllint disable-line rule:line-length
+        uses: ishworkh/container-image-artifact-upload@5d71a2417f0576fa11fe770fb04ece58c4587714  # v2.0.0
+        with:
+          image: "${{ env.project-name }}:latest"
+          retention_days: 10
+
       - name: Extract artifacts
         run: >-
           container=$(docker create "${{ env.project-name }}:latest")
           && docker cp
-          ${container}:/usr/local/opt/${{ env.project-name }}/build/dist .
+          ${container}:/usr/local/opt/${{ env.project-name }}/dist .
       - name: Upload artifacts
-        uses: actions/upload-artifact@v4
+        # yamllint disable-line rule:line-length
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02  # v4.6.2
         with:
           # yamllint disable-line
           name: ${{ github.event.repository.name }}-${{ steps.describe.outputs.describe }}

.github/workflows/test.yml

@@ -0,0 +1,97 @@
+# YAML -*- mode: yaml; tab-width: 2; indent-tabs-mode: nil; coding: utf-8 -*-
+# SPDX-License-Identifier: Zlib
+# SPDX-FileCopyrightText: Silicon Laboratories Inc. https://www.silabs.com
+---
+
+name: test
+
+# yamllint disable-line rule:line-length
+run-name: "test: ${{ github.event.workflow_run.head_branch }}#${{ github.event.workflow_run.head_commit.id }}"
+
+on:  # yamllint disable-line rule:truthy
+  workflow_run:
+    workflows: ["build"]
+    types:
+      - completed
+
+jobs:
+  test:
+    permissions:
+      contents: read
+      statuses: write
+    env:
+      project-name: z-wave-protocol-controller  # Align to docker (lowercase)
+    runs-on: ubuntu-24.04
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    steps:
+      - name: Download image
+        # yamllint disable-line rule:line-length
+        uses: ishworkh/container-image-artifact-download@ccb3671db007622e886a2d7037eb62b119d5ffaf  # v2.0.0
+        with:
+          image: "${{ env.project-name }}:latest"
+          workflow: "build"
+          token: ${{ secrets.GH_SL_ACCESS_TOKEN }}
+          workflow_run_id: ${{ github.event.workflow_run.id }}
+
+      # yamllint disable-line rule:line-length
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
+        with:
+          fetch-depth: 0
+          ref: ${{ github.event.workflow_run.head_commit.id }}
+
+      - name: Download embedded applications package
+        # yamllint disable-line rule:line-length
+        uses: robinraju/release-downloader@daf26c55d821e836577a15f77d86ddc078948b05  # v1.12
+        with:
+          repository: 'Z-Wave-Alliance/z-wave-stack-binaries'
+          tag: 'v25.1.0-28-g7e0b50f'
+          fileName: 'z-wave-stack-binaries-*-Linux.tar.gz'
+          token: ${{ secrets.GH_ZWAVE_ACCESS_TOKEN }}
+          latest: true
+
+      - name: Setup
+        env:
+          debian_packages: time screen docker-compose mosquitto-clients jq wget
+        run: >-
+          set -x
+          && sudo apt update
+          && sudo apt install -y --no-install-recommends
+          ${{ env.debian_packages }}
+          && sudo apt-get clean -y
+          && echo "https://github.com/Z-Wave-Alliance/z-wave-stack/issues/733"
+          && mkdir -p z-wave-stack-binaries
+          && tar xfz z-wave-stack-binaries-*-Linux.tar.gz
+          -C z-wave-stack-binaries
+          && rm z-wave-stack-binaries-*-Linux.tar.gz
+          && date -u
+
+      - name: Run
+        id: run
+        run: |
+          set -x
+          export ZPC_RUN_MODE="docker"
+          export ZPC_COMMAND="docker run ${{ env.project-name }}"
+          $ZPC_COMMAND --version
+          docker-compose pull
+          export ZPC_COMMAND="docker-compose up --abort-on-container-exit"
+          cd z-wave-stack-binaries/bin && file -E *_x86_REALTIME.elf && cd -
+          export ZPC_ARGS="--log.level=d"
+          ./scripts/tests/z-wave-stack-binaries-test.sh
+        continue-on-error: true
+
+      - name: Propagate run status to commit status
+        # yamllint disable-line rule:line-length
+        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea  # v7.0.1
+        if: always()
+        env:
+          status: ${{ steps.run.outcome }}
+          sha: ${{ github.event.workflow_run.head_commit.id }}
+        with:
+          script: |
+            await github.rest.repos.createCommitStatus({
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            sha: process.env.sha,
+            state: process.env.status
+            })
+            process.exit(process.env.status == 'success' ? 0 : 1);

.gitignore

@@ -0,0 +1,29 @@
+# .gitignore
+# Temporary files
+*~
+tmp
+# All build folders
+/build*/
+# Visual Studio Code
+.vscode/settings.json
+.vscode/launch.json
+.vscode/*.log
+*.code-workspace
+# JetBrains IDE
+.idea/
+# Cmake Projects in root ###
+compile_commands.json
+# Clangd index
+.clangd/
+.cache/
+# BeyondCompare backup files
+*.orig
+# SonarScanner files
+.scannerwork/
+# Generated debconf files
+applications/*/debconf/config
+# Macos fs igores
+*.DS_Store
+# Other files
+*.swp
+*.gcov

CMakeLists.txt

@@ -14,12 +14,19 @@ if(NOT DEFINED COMMON_LOCATION)
 endif()
 
 if(BUILD_TESTING)
+  include(cmake/modules/FindCMock.cmake)
+  set(THS-CMOCK_LOCATION "${cmock_SOURCE_DIR}")
+  set(THS-UNITY_LOCATION  "${cmock_SOURCE_DIR}/vendor/unity")
   # https://gitlab.kitware.com/cmake/cmake/-/issues/22813#note_1620373
-  option(BUILD_TESTING_PROPERTY_DISABLED "WARNING: Bypass some tests" True)
+  option(BUILD_TESTING_PROPERTY_DISABLED "WARNING: Bypass some tests" false)
   if(BUILD_TESTING_PROPERTY_DISABLED)
     message(WARNING "TODO: Some tests are bypassed, please help fixing them")
   endif()
-  include(${CMAKE_SOURCE_DIR}/components/testframework/target_add_unittest.cmake)
+  # Testframework deduplicated, only one to be used
+  set(ZPC_TESTFRAMEWORK_PATH
+    ${unifysdk_SOURCE_DIR}/components/testframework
+  )
+  include(${ZPC_TESTFRAMEWORK_PATH}/target_add_unittest.cmake)
   include(cmake/include/unittest.cmake)
 endif()
 

Dockerfile

@@ -1,22 +1,11 @@
-FROM debian:bookworm
+# SPDX-License-Identifier: Zlib
+# SPDX-FileCopyrightText: Silicon Laboratories Inc. https://www.silabs.com
 
-ENV DEBIAN_FRONTEND noninteractive
-ENV LC_ALL en_US.UTF-8
-ENV LANG ${LC_ALL}
+FROM debian:bookworm as builder
 
 ARG UNIFYSDK_GIT_REPOSITORY https://github.com/SiliconLabs/UnifySDK
 ARG UNIFYSDK_GIT_TAG main
 
-RUN echo "# log: Configuring locales" \
-  && set -x  \
-  && apt-get update -y \
-  && apt-get install -y locales \
-  && echo "${LC_ALL} UTF-8" | tee /etc/locale.gen \
-  && locale-gen ${LC_ALL} \
-  && dpkg-reconfigure locales \
-  && TZ=Etc/UTC apt-get -y install tzdata \
-  && date -u
-
 ENV project z-wave-protocol-controller
 ENV workdir /usr/local/opt/${project}
 ADD . ${workdir}
@@ -25,14 +14,40 @@ WORKDIR ${workdir}
 
 RUN echo "# log: Setup system" \
   && set -x  \
-  && apt-get install -y make sudo \
+  && df -h \
+  && apt-get update \
+  && apt-get install -y --no-install-recommends -- make sudo \
   && ./helper.mk help setup \
   && date -u
 
 RUN echo "# log: Build" \
   && set -x  \
   && ./helper.mk \
+  && date -u \
+  && echo "# log: Clean to only keep packages to save space" \
+  && mkdir -p dist \
+  && cd dist \
+  && unzip ../build/dist/${project}*.zip \
+  && cd - \
+  && ./helper.mk distclean \
+  && date -u
+
+FROM debian:bookworm
+ENV project z-wave-protocol-controller
+ENV workdir /usr/local/opt/${project}
+COPY --from=builder ${workdir}/dist/ ${workdir}/dist/
+WORKDIR ${workdir}
+
+RUN echo "# log: Install to system" \
+  && set -x  \
+  && apt-get update \
+  && dpkg -i ./dist/${project}*/*.deb \
+  || apt install -f -y --no-install-recommends \
+  && echo "TODO: rm -rf dist # If artifacts are no more needed" \
+  && apt-get clean -y \
+  && rm -rf /var/lib/{apt,dpkg,cache,log}/ \
+  && df -h \
   && date -u
 
-ENTRYPOINT [ "/usr/local/opt/z-wave-protocol-controller/helper.mk" ]
-CMD [ "help" ]
+ENTRYPOINT [ "/usr/bin/zpc" ]
+CMD [ "--help" ]