Improving scripts

Author: hiltonlima

test_collections/matter/scripts/OTBR/otbr_srp_restart.sh

@@ -14,7 +14,16 @@
  # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  # See the License for the specific language governing permissions and
  # limitations under the License.
+ROOT_DIR=$(realpath $(dirname "$0")/../..)
+TH_SCRIPTS_DIR="$ROOT_DIR/scripts"
 
+source "$TH_SCRIPTS_DIR/utils.sh"
+
+print_start_of_script
+
+print_script_step "Restarting OTBR service"
 sudo docker exec -t otbr-chip ot-ctl srp server disable
 sleep 2
-sudo docker exec -t otbr-chip ot-ctl srp server enable
+sudo docker exec -t otbr-chip ot-ctl srp server enable
+
+print_end_of_script

test_collections/matter/scripts/OTBR/otbr_start.sh

@@ -15,6 +15,7 @@
  # See the License for the specific language governing permissions and
  # limitations under the License.
 ROOT_DIR=$(realpath $(dirname "$0")/../..)
+TH_SCRIPTS_DIR="$ROOT_DIR/scripts"
 
 DEFAULT_OTBR_INTERFACE="eth0"
 BR_INTERFACE=${1:-$DEAFULT_OTBR_INTERFACE}
@@ -24,21 +25,27 @@ BR_IMAGE_BASE="nrfconnect/otbr"
 BR_IMAGE_TAG="9185bda"
 BR_IMAGE=$BR_IMAGE_BASE":"$BR_IMAGE_TAG
 
+source "$TH_SCRIPTS_DIR/utils.sh"
+
+print_start_of_script
+
+print_script_step "Removing 'otbr-chip' container"
 docker rm otbr-chip > /dev/null 2>&1
 
 if docker images | grep $BR_IMAGE_BASE | grep $BR_IMAGE_TAG;
 then
 	echo "otbr image "$BR_IMAGE" already installed"
 else
-	echo "pulling otbr image "$BR_IMAGE
+	print_script_step "Pulling $BR_IMAGE image"
 	docker pull $BR_IMAGE || exit 1
 fi
+
+print_script_step "Starting 'otbr-chip' container"
 AVAHI_PATH=$ROOT_DIR/backend/app/otbr_manager/avahi
 sudo modprobe ip6table_filter || exit 1
 sudo docker run --privileged -d --network host --name otbr-chip -e NAT64=1 -e DNS64=0 -e WEB_GUI=0 -v $AVAHI_PATH:/etc/avahi -v /dev/ttyACM0:/dev/radio $BR_IMAGE --radio-url spinel+hdlc+uart:///dev/radio?uart-baudrate=115200 -B $BR_INTERFACE || exit 1
 
-echo "waiting 10 seconds to give the the docker container enough time to start up..."
-
+print_script_step "waiting 10 seconds to give the the docker container enough time to start up..."
 sleep 10
 
 BR_CHANNEL_HEX=$(printf '%02x' $BR_CHANNEL)
@@ -63,15 +70,17 @@ BR_PARAMS=(
 "dataset active -x"
 )
 
+print_script_step "Setting up Thread Network"
+
 for i in "${BR_PARAMS[@]}"
 do
-        echo "Param: '"$i"'"
+        printf "Param: '$i'"
         sudo docker exec -t otbr-chip ot-ctl $i || exit 1
 done
 
 BR_SIMPLE_DATASET="00030000"${BR_CHANNEL_HEX}"0208"${BR_EXTPANID}"0510"${BR_NETWORKKEY}"0102"${BR_PANID}
 sudo echo ${BR_SIMPLE_DATASET} > /tmp/otbr_simple_dataset.txt
-echo "Simple Dataset: " ${BR_SIMPLE_DATASET}
+printf "Simple Dataset: $BR_SIMPLE_DATASET"
 
-# Also make sure to restart the Raspi avahi to have it in a clean state
+print_script_step "Also make sure to restart the Raspi avahi to have it in a clean state"
 sudo service avahi-daemon restart

test_collections/matter/scripts/OTBR/otbr_stop.sh

@@ -14,7 +14,16 @@
  # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  # See the License for the specific language governing permissions and
  # limitations under the License.
+ROOT_DIR=$(realpath $(dirname "$0")/../..)
+TH_SCRIPTS_DIR="$ROOT_DIR/scripts"
 
+source "$TH_SCRIPTS_DIR/utils.sh"
+
+print_start_of_script
+
+print_script_step "Stoping OTBR service"
 sudo docker exec -t otbr-chip ot-ctl srp server disable
 sleep 2
-sudo docker kill otbr-chip
+sudo docker kill otbr-chip
+
+print_end_of_script

test_collections/matter/scripts/update-paa-certs.sh

@@ -28,13 +28,18 @@ set -e
 
 # Paths
 MATTER_PROGRAM_DIR=$(realpath $(dirname "$0")/..)
+TH_SCRIPTS_DIR="$MATTER_PROGRAM_DIR/../../../scripts"
 TMP_SDK_FOLDER="sdk-sparse"
 TMP_SDK_PATH="/tmp/$TMP_SDK_FOLDER"
 SDK_CERT_PATH="credentials/development/paa-root-certs"
 SDK_CERT_DEVELOPMENT_PATH="credentials/development"
 CERT_PATH="/var/paa-root-certs"
 DEVELOPMENT_PATH="/var/credentials/development"
 
+source "$TH_SCRIPTS_DIR/utils.sh"
+
+print_start_of_script
+
 # If SDK path is not present, then do local checkout
 if [ -z "$SDK_PATH" ]
 then
@@ -46,7 +51,7 @@ then
         SDK_SHA=$(cat $MATTER_PROGRAM_DIR/config.py | grep SDK_SHA | cut -d'"' -f 2 | cut -d"'" -f 2)
     fi
 
-    # Checkout SDK sparsely 
+    print_script_step "Checkout SDK sparsely"
     rm -rf $TMP_SDK_PATH
     cd /tmp
     git clone --filter=blob:none --no-checkout --depth 1 --sparse https://github.com/project-chip/connectedhomeip.git $TMP_SDK_FOLDER
@@ -60,17 +65,23 @@ fi
 # Create folder if missing (owned by user)
 if [ ! -d "$CERT_PATH" ]
 then
+    print_script_step "Creating certification folder $CERT_PATH"
     sudo mkdir -p $CERT_PATH
     sudo chown $USER:$USER $CERT_PATH
 fi
 
 # Create folder if missing (owned by user)
 if [ ! -d "$DEVELOPMENT_PATH" ]
 then
+    print_script_step "Creating developer certification folder $DEVELOPMENT_PATH"
     sudo mkdir -p $DEVELOPMENT_PATH
     sudo chown $USER:$USER $DEVELOPMENT_PATH
 fi
 
-# Copy certs from SDK
+print_script_step "Copying Certificates from SDK"
 cp "$SDK_PATH/$SDK_CERT_PATH/"* $CERT_PATH/
+
+print_script_step "Copying Developer Certificates from SDK"
 cp -R "$SDK_PATH/$SDK_CERT_DEVELOPMENT_PATH/"** $DEVELOPMENT_PATH/
+
+print_end_of_script

test_collections/matter/scripts/update-sample-apps.sh

@@ -15,12 +15,21 @@
  # See the License for the specific language governing permissions and
  # limitations under the License.
 MATTER_PROGRAM_DIR=$(realpath $(dirname "$0")/..)
+TH_SCRIPTS_DIR="$MATTER_PROGRAM_DIR/../../../scripts"
 
+source "$TH_SCRIPTS_DIR/utils.sh"
+
+print_start_of_script
+
+print_script_step "Pulling the SDK Docker image"
 # We are fetching SDK docker image and tag name from backend
 # This is done to minimize the places the SDK version is tracked.
 SDK_DOCKER_IMAGE=$(cat $MATTER_PROGRAM_DIR/config.py | grep SDK_DOCKER_IMAGE | cut -d'"' -f 2 | cut -d"'" -f 2)
 SDK_DOCKER_TAG=$(cat $MATTER_PROGRAM_DIR/config.py | grep SDK_DOCKER_TAG | cut -d'"' -f 2 | cut -d"'" -f 2)
 sudo docker pull $SDK_DOCKER_IMAGE:$SDK_DOCKER_TAG
 
+print_script_step "Updating Sample APPs"
 sudo docker run -t -v ~/apps:/apps $SDK_DOCKER_IMAGE:$SDK_DOCKER_TAG bash -c "rm -v /apps/*; cp -v * /apps/;"
 sudo chown -R `whoami` ~/apps
+
+print_end_of_script