ci: build-yocto: switch to kas-shell-helper (#934)

Add kas-shell-helper script and switch to it to execute the kas shell
scripts on build-yocto ci

Author: lumag

.github/workflows/build-yocto.yml

@@ -52,7 +52,7 @@ jobs:
 
       - name: Run yocto-check-layer
         run: |
-          ci/yocto-check-layer.sh
+          ci/kas-shell-helper.sh ci/yocto-check-layer.sh
 
   yocto-patchreview:
     needs: kas-setup
@@ -70,7 +70,7 @@ jobs:
 
       - name: Run Yocto patchreview
         run: |
-          ci/yocto-patchreview.sh
+          ci/kas-shell-helper.sh ci/yocto-patchreview.sh
 
   compile:
     needs: kas-setup
@@ -110,7 +110,8 @@ jobs:
           kas dump --resolve-env --resolve-local --resolve-refs \
               ci/mirror.yml:ci/${{ matrix.machine }}.yml > kas-build.yml
           kas build ci/mirror.yml:ci/${{ matrix.machine }}.yml
-          ci/yocto-pybootchartgui.sh && mv $KAS_WORK_DIR/build/buildchart.svg .
+          ci/kas-shell-helper.sh ci/yocto-pybootchartgui.sh
+          mv $KAS_WORK_DIR/build/buildchart.svg .
 
           if [ "${{ matrix.machine }}" = "qcom-armv8a" ]; then
             kas build ci/mirror.yml:ci/${{ matrix.machine }}.yml:ci/initramfs-test.yml

ci/kas-shell-helper.sh

@@ -0,0 +1,19 @@
+#!/bin/sh -e
+# Copyright (c) 2025 Qualcomm Innovation Center, Inc. All rights reserved.
+# SPDX-License-Identifier: MIT
+
+TOPDIR=$(realpath $(dirname $(readlink -f $0))/..)
+SCRIPT=$(realpath $1)
+
+if ! [ -f $SCRIPT ]; then
+    echo "The script path argument is missing, please run it with:"
+    echo " $0 /path/to/script"
+    exit 1
+fi
+
+# Ensure KAS workspace is outside of the checked out repo
+# Allows the caller to specify KAS_WORK_DIR, otherwise make temp one
+export KAS_WORK_DIR=$(realpath ${KAS_WORK_DIR:-$(mktemp -d)})
+
+echo "Running kas in $KAS_WORK_DIR"
+exec kas shell $TOPDIR/ci/base.yml --command "$SCRIPT $TOPDIR $KAS_WORK_DIR"

ci/yocto-check-layer.sh

@@ -2,24 +2,36 @@
 # Copyright (c) 2024 Qualcomm Innovation Center, Inc. All rights reserved.
 # SPDX-License-Identifier: MIT
 
-TOPDIR=$(realpath $(dirname $(readlink -f $0))/..)
+if [ -z $1 ] || [ -z $2 ] ; then
+    echo "The REPO_DIR or WORK_DIR is empty and it needs to point to the corresponding directories."
+    echo "Please run it with:"
+    echo " $0 REPO_DIR WORK_DIR"
+    exit 1
+fi
 
-# Ensure KAS workspace is outside of the checked out repo
-# Allows the caller to specify KAS_WORK_DIR, otherwise make temp one
-export KAS_WORK_DIR=$(realpath ${KAS_WORK_DIR:-$(mktemp -d)})
+REPO_DIR="$1"
+WORK_DIR="$2"
+
+_is_dir(){
+    test -d "$1" && return
+    echo "The '$1' is not a directory."
+    exit 1
+}
+
+_is_dir "$REPO_DIR"
+_is_dir "$WORK_DIR"
 
 # Yocto Project layer checking tool
 CMD="yocto-check-layer-wrapper"
 # Layer to check
-CMD="$CMD $TOPDIR"
+CMD="$CMD $REPO_DIR"
 # Disable auto layer discovery
 CMD="$CMD --no-auto"
 # Layers to process for dependencies
-CMD="$CMD --dependency $KAS_WORK_DIR/oe-core/meta"
+CMD="$CMD --dependency $WORK_DIR/oe-core/meta"
 # Disable automatic testing of dependencies
 CMD="$CMD --no-auto-dependency"
 # Set machines to all machines defined in this BSP layer
-CMD="$CMD --machines $(echo $(find $TOPDIR/conf/machine/ -maxdepth 1 -name *.conf -exec basename {} .conf \; ))"
+CMD="$CMD --machines $(echo $(find $REPO_DIR/conf/machine/ -maxdepth 1 -name *.conf -exec basename {} .conf \; ))"
 
-echo "Running kas in $KAS_WORK_DIR"
-exec kas shell $TOPDIR/ci/base.yml --command "$CMD"
+exec $CMD

ci/yocto-patchreview.sh

@@ -2,15 +2,28 @@
 # Copyright (c) 2024 Qualcomm Innovation Center, Inc. All rights reserved.
 # SPDX-License-Identifier: MIT
 
-TOPDIR=$(realpath $(dirname $(readlink -f $0))/..)
+if [ -z $1 ] || [ -z $2 ] ; then
+    echo "The REPO_DIR or WORK_DIR is empty and it needs to point to the corresponding directories."
+    echo "Please run it with:"
+    echo " $0 REPO_DIR WORK_DIR"
+    exit 1
+fi
 
-# Ensure KAS workspace is outside of the checked out repo
-# Allows the caller to specify KAS_WORK_DIR, otherwise make temp one
-export KAS_WORK_DIR=$(realpath ${KAS_WORK_DIR:-$(mktemp -d)})
+REPO_DIR="$1"
+WORK_DIR="$2"
 
-echo "Running kas in $KAS_WORK_DIR"
-kas shell $TOPDIR/ci/base.yml --command "$KAS_WORK_DIR/oe-core/scripts/contrib/patchreview.py -v -b -j status.json $TOPDIR"
+_is_dir(){
+    test -d "$1" && return
+    echo "The '$1' is not a directory."
+    exit 1
+}
+
+_is_dir "$REPO_DIR"
+_is_dir "$WORK_DIR"
+
+
+$WORK_DIR/oe-core/scripts/contrib/patchreview.py -v -b -j status.json $REPO_DIR
 
 # return an error if any malformed patch is found
-cat $KAS_WORK_DIR/build/status.json |
+cat $WORK_DIR/build/status.json |
     python -c "import json,sys;obj=json.load(sys.stdin); sys.exit(1) if 'malformed-sob' in obj[0] or 'malformed-upstream-status' in obj[0] else sys.exit(0)"

ci/yocto-pybootchartgui.sh

@@ -2,21 +2,34 @@
 # Copyright (c) 2024 Qualcomm Innovation Center, Inc. All rights reserved.
 # SPDX-License-Identifier: MIT
 
-TOPDIR=$(realpath $(dirname $(readlink -f $0))/..)
-
-if [ -z $KAS_WORK_DIR ]; then
-    echo "KAS_WORK_DIR is empty and it needs to point to populated work dir"
+if [ -z $1 ] || [ -z $2 ] ; then
+    echo "The REPO_DIR or WORK_DIR is empty and it needs to point to the corresponding directories."
+    echo "Please run it with:"
+    echo " $0 REPO_DIR WORK_DIR"
+    exit 1
 fi
 
+REPO_DIR="$1"
+WORK_DIR="$2"
+
+_is_dir(){
+    test -d "$1" && return
+    echo "The '$1' is not a directory."
+    exit 1
+}
+
+_is_dir "$REPO_DIR"
+_is_dir "$WORK_DIR"
+
 # pybootchartgui tool
-CMD="$CMD $KAS_WORK_DIR/oe-core/scripts/pybootchartgui/pybootchartgui.py"
+CMD="$CMD $WORK_DIR/oe-core/scripts/pybootchartgui/pybootchartgui.py"
 # display time in minutes instead of seconds
 CMD="$CMD --minutes"
 # image format (png, svg, pdf); default format png
 CMD="$CMD --format=svg"
 # output path (file or directory) where charts are stored
 CMD="$CMD --output=buildchart"
 # /path/to/tmp/buildstats/<recipe-machine>/<BUILDNAME>/
-CMD="$CMD $KAS_WORK_DIR/build/tmp/buildstats"
+CMD="$CMD $WORK_DIR/build/tmp/buildstats"
 
-exec kas shell $TOPDIR/ci/base.yml --command "$CMD"
+exec $CMD