-
Notifications
You must be signed in to change notification settings - Fork 13
RDKEMW-22276: Coverity integration for networkmanager plugin #331
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
08064f6
Added cov_build.sh script
gururaajar 0e7b951
Added all the required files for coverity
gururaajar a338169
Addressed copilot reported issues
gururaajar b1f36d1
Addressed compilation issue
gururaajar 307b693
updated the comments
gururaajar 8e0eaf7
Changed the permission of workflow to read only
gururaajar File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| name: Build Component in Native Environment | ||
|
|
||
| on: | ||
| push: | ||
| branches: [ main, develop, 'support/**', 'hotfix/**', 'topic/**' ] | ||
| pull_request: | ||
| branches: [ main, develop, 'support/**', 'hotfix/**', 'topic/**' ] | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| build-networkmanager: | ||
| name: Build networkmanager component in github rdkcentral | ||
| # Ubuntu 24.04 provides libnm 1.46, closer to the version used in RDK(1.43.7). | ||
| runs-on: ubuntu-24.04 | ||
|
|
||
| steps: | ||
|
|
||
| - name: Checkout code | ||
| uses: actions/checkout@v3 | ||
|
|
||
| - name: native build | ||
| run: | | ||
| sh -x build_dependencies.sh | ||
| sh -x cov_build.sh | ||
|
github-advanced-security[bot] marked this conversation as resolved.
Fixed
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,193 @@ | ||
| #!/usr/bin/env bash | ||
| # | ||
| # build_dependencies.sh - Install system packages and build the Thunder | ||
| # ecosystem (ThunderTools, Thunder, ThunderInterfaces) plus the mock | ||
| # dependency files required to build networkmanager for Coverity. | ||
| # | ||
| # This is the first half of the old cov_build.sh: everything that prepares | ||
| # the environment. The component itself is built by cov_build.sh, which is | ||
| # run afterwards from the same workspace. | ||
| # | ||
| # Usage: | ||
| # ./build_dependencies.sh | ||
| # | ||
| # Override any of the environment variables below on the command line, e.g.: | ||
| # THUNDER_REF=R4.4.3 ./build_dependencies.sh | ||
| # | ||
|
|
||
| # Re-exec under bash if started with a non-bash shell (e.g. `sh build_dependencies.sh`, | ||
| # where sh is dash). This script relies on bash features such as `pipefail` | ||
| # and ${BASH_SOURCE[0]}, which dash does not support. | ||
| if [ -z "${BASH_VERSION:-}" ]; then | ||
| exec bash "$0" "$@" | ||
| fi | ||
|
|
||
| set -euo pipefail | ||
|
|
||
| # --------------------------------------------------------------------------- | ||
| # Configuration (mirrors the workflow `env:` block) | ||
| # --------------------------------------------------------------------------- | ||
| BUILD_TYPE="${BUILD_TYPE:-Debug}" | ||
| THUNDER_REF="${THUNDER_REF:-R4.4.3}" | ||
| THUNDERTOOLS_REF="${THUNDERTOOLS_REF:-${THUNDER_REF}}" | ||
| INTERFACES_REF="${INTERFACES_REF:-${THUNDER_REF}}" | ||
|
|
||
| # Root workspace directory. In CI this is ${{ github.workspace }}. | ||
| # The Thunder repositories and install tree live inside the networkmanager | ||
| # checkout so the layout is self-contained and shared with cov_build.sh. | ||
| SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" | ||
| WORKSPACE="${WORKSPACE:-${SCRIPT_DIR}}" | ||
| NETWORKMANAGER_DIR="${NETWORKMANAGER_DIR:-${SCRIPT_DIR}}" | ||
| INSTALL_DIR="${WORKSPACE}/install/usr" | ||
| MODULE_PATH="${WORKSPACE}/install/tools/cmake" | ||
|
|
||
| NPROC="$(getconf _NPROCESSORS_ONLN 2>/dev/null || echo 4)" | ||
|
|
||
| log() { printf '\n\033[1;34m==> %s\033[0m\n' "$*"; } | ||
|
|
||
| # Use sudo only when it exists (CI build containers usually run as root and | ||
| # do not ship sudo). Otherwise run the command directly. | ||
| if command -v sudo >/dev/null 2>&1; then | ||
| SUDO="sudo" | ||
| else | ||
| SUDO="" | ||
| fi | ||
|
|
||
| # --------------------------------------------------------------------------- | ||
| # Install system packages | ||
| # --------------------------------------------------------------------------- | ||
| log "Installing system packages" | ||
| ${SUDO} apt-get update | ||
| ${SUDO} apt-get install -y \ | ||
| build-essential \ | ||
| cmake \ | ||
| pkg-config \ | ||
| libglib2.0-dev \ | ||
| libnm-dev \ | ||
| libcurl4-openssl-dev \ | ||
| lcov \ | ||
| ninja-build | ||
|
|
||
| # --------------------------------------------------------------------------- | ||
| # Install Python dependencies | ||
| # --------------------------------------------------------------------------- | ||
| log "Installing Python dependencies" | ||
| if command -v pip >/dev/null 2>&1; then | ||
| pip install --break-system-packages jsonref || pip install jsonref || true | ||
| elif command -v pip3 >/dev/null 2>&1; then | ||
| pip3 install --break-system-packages jsonref || pip3 install jsonref || true | ||
| else | ||
| echo "pip not found; skipping jsonref install" | ||
| fi | ||
|
|
||
| # --------------------------------------------------------------------------- | ||
| # Clone Thunder repositories | ||
| # --------------------------------------------------------------------------- | ||
| clone_repo() { | ||
| # clone_repo <url> <path> <ref> | ||
| local url="$1" path="$2" ref="$3" | ||
| if [ ! -d "${path}/.git" ]; then | ||
| log "Cloning ${url} (${ref}) into ${path}" | ||
| git clone --branch "${ref}" "${url}" "${path}" | ||
| else | ||
| log "Repository ${path} already present; fetching ${ref}" | ||
| git -C "${path}" fetch origin "${ref}" | ||
| git -C "${path}" checkout "${ref}" | ||
| fi | ||
| } | ||
|
|
||
| clone_repo "https://github.com/rdkcentral/ThunderTools" \ | ||
| "${WORKSPACE}/ThunderTools" "${THUNDERTOOLS_REF}" | ||
| clone_repo "https://github.com/rdkcentral/Thunder" \ | ||
| "${WORKSPACE}/Thunder" "${THUNDER_REF}" | ||
| clone_repo "https://github.com/rdkcentral/ThunderInterfaces" \ | ||
| "${WORKSPACE}/ThunderInterfaces" "${INTERFACES_REF}" | ||
|
|
||
| # --------------------------------------------------------------------------- | ||
| # Apply Thunder SubscribeStub patch | ||
| # --------------------------------------------------------------------------- | ||
| log "Applying Thunder SubscribeStub patch" | ||
| ( | ||
| cd "${WORKSPACE}/Thunder" | ||
| git apply "${NETWORKMANAGER_DIR}/tests/patches/thunder/SubscribeStub.patch" 2>/dev/null \ | ||
| || echo "Patch already applied or not needed" | ||
| ) | ||
|
|
||
| # --------------------------------------------------------------------------- | ||
| # Build ThunderTools | ||
| # --------------------------------------------------------------------------- | ||
| log "Building ThunderTools" | ||
| cmake \ | ||
| -S "${WORKSPACE}/ThunderTools" \ | ||
| -B "${WORKSPACE}/build/ThunderTools" \ | ||
| -DCMAKE_INSTALL_PREFIX="${INSTALL_DIR}" \ | ||
| -DCMAKE_MODULE_PATH="${MODULE_PATH}" \ | ||
| -DGENERIC_CMAKE_MODULE_PATH="${MODULE_PATH}" | ||
| cmake --build "${WORKSPACE}/build/ThunderTools" --target install -j"${NPROC}" | ||
|
|
||
| # --------------------------------------------------------------------------- | ||
| # Build Thunder | ||
| # --------------------------------------------------------------------------- | ||
| log "Building Thunder" | ||
| cmake \ | ||
| -S "${WORKSPACE}/Thunder" \ | ||
| -B "${WORKSPACE}/build/Thunder" \ | ||
| -DCMAKE_INSTALL_PREFIX="${INSTALL_DIR}" \ | ||
| -DCMAKE_MODULE_PATH="${MODULE_PATH}" \ | ||
| -DBUILD_TYPE="${BUILD_TYPE}" \ | ||
| -DBINDING=127.0.0.1 \ | ||
| -DPORT=9998 | ||
| cmake --build "${WORKSPACE}/build/Thunder" --target install -j"${NPROC}" | ||
|
|
||
| # --------------------------------------------------------------------------- | ||
| # Build ThunderInterfaces | ||
| # --------------------------------------------------------------------------- | ||
| log "Building ThunderInterfaces" | ||
| cmake \ | ||
| -S "${WORKSPACE}/ThunderInterfaces" \ | ||
| -B "${WORKSPACE}/build/ThunderInterfaces" \ | ||
| -DCMAKE_INSTALL_PREFIX="${INSTALL_DIR}" \ | ||
| -DCMAKE_MODULE_PATH="${MODULE_PATH}" | ||
| cmake --build "${WORKSPACE}/build/ThunderInterfaces" --target install -j"${NPROC}" | ||
|
|
||
| # --------------------------------------------------------------------------- | ||
| # Install IPowerManager header into the Thunder interfaces include path | ||
| # --------------------------------------------------------------------------- | ||
| log "Installing IPowerManager header" | ||
| IFACE_DIR="$(find "${INSTALL_DIR}/include" -maxdepth 2 -name "interfaces" -type d | head -1)" | ||
| if [ -z "${IFACE_DIR}" ] || [ ! -d "${IFACE_DIR}" ]; then | ||
| echo "Error: Thunder interfaces include dir not found under ${INSTALL_DIR}/include" >&2 | ||
| exit 1 | ||
| fi | ||
| cp "${NETWORKMANAGER_DIR}/tests/mocks/thunder/IPowerManager.h" "${IFACE_DIR}/" | ||
|
|
||
| # --------------------------------------------------------------------------- | ||
| # Generate dependency files | ||
| # --------------------------------------------------------------------------- | ||
| log "Generating /etc/device.properties" | ||
| ${SUDO} tee /etc/device.properties >/dev/null <<'EOF' | ||
| ETHERNET_INTERFACE=eth0 | ||
| WIFI_INTERFACE=wlan0 | ||
| DEFAULT_HOSTNAME=rdk_test_device | ||
| EOF | ||
|
|
||
| # --------------------------------------------------------------------------- | ||
| # Generate IARM headers/stubs | ||
| # --------------------------------------------------------------------------- | ||
| log "Generating IARM headers" | ||
| mkdir -p "${INSTALL_DIR}/lib" | ||
| printf 'void __nm_cov_stub(void){}\n' | ${CC:-cc} -fPIC -shared -x c - -o "${INSTALL_DIR}/lib/libIARMBus.so" | ||
| printf 'void __nm_cov_stub(void){}\n' | ${CC:-cc} -fPIC -shared -x c - -o "${INSTALL_DIR}/lib/libmfrlib.so" | ||
| mkdir -p "${INSTALL_DIR}/include/rdk/iarmbus" | ||
| mkdir -p "${INSTALL_DIR}/include/rdk/iarmmgrs-hal" | ||
| touch "${INSTALL_DIR}/include/rdk/iarmbus/libIARM.h" | ||
| touch "${INSTALL_DIR}/include/rdk/iarmmgrs-hal/mfrMgr.h" | ||
| ( | ||
| cd "${NETWORKMANAGER_DIR}/tests" | ||
| mkdir -p headers/rdk/iarmbus | ||
| mkdir -p headers/rdk/iarmmgrs-hal | ||
| touch headers/rdk/iarmmgrs-hal/mfrMgr.h | ||
| touch headers/rdk/iarmbus/libIARM.h headers/rdk/iarmbus/libIBus.h | ||
| ) | ||
|
|
||
| log "Dependencies ready. Run cov_build.sh to build networkmanager." |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| #!/usr/bin/env bash | ||
| # | ||
| # cov_build.sh - Coverity-friendly build of networkmanager with the Gnome | ||
| # libnm proxy. | ||
| # | ||
| # This is the second half of the original cov_build.sh: it builds only the | ||
| # networkmanager component. The Thunder ecosystem and mock dependency files | ||
| # it relies on are produced by build_dependencies.sh, which must be run first | ||
| # from the same workspace. | ||
| # | ||
| # Usage: | ||
| # ./build_dependencies.sh | ||
| # ./cov_build.sh | ||
| # | ||
| # Override any of the environment variables below on the command line, e.g.: | ||
| # THUNDER_REF=R4.4.3 ./cov_build.sh | ||
| # | ||
|
|
||
| # Re-exec under bash if started with a non-bash shell (e.g. `sh cov_build.sh`, | ||
| # where sh is dash). This script relies on bash features such as `pipefail` | ||
| # and ${BASH_SOURCE[0]}, which dash does not support. | ||
| if [ -z "${BASH_VERSION:-}" ]; then | ||
| exec bash "$0" "$@" | ||
| fi | ||
|
|
||
| set -euo pipefail | ||
|
|
||
| # --------------------------------------------------------------------------- | ||
| # Configuration (must match build_dependencies.sh so the paths line up) | ||
| # --------------------------------------------------------------------------- | ||
| # Optional cross-compile toolchain file (empty for native builds). | ||
| TOOLCHAIN_FILE="${TOOLCHAIN_FILE:-}" | ||
|
|
||
| # Root workspace directory. In CI this is ${{ github.workspace }}. | ||
| SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" | ||
| WORKSPACE="${WORKSPACE:-${SCRIPT_DIR}}" | ||
| NETWORKMANAGER_DIR="${NETWORKMANAGER_DIR:-${SCRIPT_DIR}}" | ||
| INSTALL_DIR="${WORKSPACE}/install/usr" | ||
| MODULE_PATH="${WORKSPACE}/install/tools/cmake" | ||
|
|
||
| NPROC="$(getconf _NPROCESSORS_ONLN 2>/dev/null || echo 4)" | ||
|
|
||
| log() { printf '\n\033[1;34m==> %s\033[0m\n' "$*"; } | ||
|
|
||
| # --------------------------------------------------------------------------- | ||
| # Build networkmanager with Gnome libnm Proxy | ||
| # --------------------------------------------------------------------------- | ||
| log "Building networkmanager with Gnome libnm Proxy" | ||
| NM_CXX_FLAGS=" -fprofile-arcs -ftest-coverage \ | ||
| -I ${NETWORKMANAGER_DIR}/tests/headers \ | ||
| -I ${NETWORKMANAGER_DIR}/tests/headers/rdk/iarmbus \ | ||
| -I ${NETWORKMANAGER_DIR}/tests/headers/rdk/iarmmgrs-hal \ | ||
| --include ${NETWORKMANAGER_DIR}/tests/mocks/Iarm.h \ | ||
| --include ${NETWORKMANAGER_DIR}/tests/mocks/mfrMgr.h " | ||
|
|
||
| TOOLCHAIN_ARG=() | ||
| if [ -n "${TOOLCHAIN_FILE}" ]; then | ||
| TOOLCHAIN_ARG=(-DCMAKE_TOOLCHAIN_FILE="${TOOLCHAIN_FILE}") | ||
| fi | ||
|
|
||
| cmake \ | ||
| -S "${NETWORKMANAGER_DIR}" \ | ||
| -B "${WORKSPACE}/build/networkmanager_libnm" \ | ||
| "${TOOLCHAIN_ARG[@]}" \ | ||
| -DCMAKE_INSTALL_PREFIX="${INSTALL_DIR}" \ | ||
| -DCMAKE_PREFIX_PATH="${INSTALL_DIR}" \ | ||
| -DCMAKE_MODULE_PATH="${MODULE_PATH}" \ | ||
| -DCMAKE_CXX_FLAGS="${NM_CXX_FLAGS}" \ | ||
|
Copilot marked this conversation as resolved.
|
||
| -DENABLE_GNOME_NETWORKMANAGER=ON \ | ||
| -DENABLE_LEGACY_PLUGINS=OFF \ | ||
| -DENABLE_UNIT_TESTING=ON \ | ||
| -DENABLE_PLUGIN_CLI=OFF \ | ||
| -DENABLE_MIGRATION_MFRMGR_SUPPORT=ON | ||
| cmake --build "${WORKSPACE}/build/networkmanager_libnm" --target install -j"${NPROC}" | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.