Initial version of udmi tool wrapper

.github/workflows/testing.yml

@@ -24,7 +24,7 @@ jobs:
           python-version: '3.10'
       - name: Checkout source
         uses: actions/checkout@v2.3.4
-      - name: Install dependencies
+      - name: bin/run_tests install_dependencies
         run: bin/run_tests install_dependencies
       - name: code checks
         if: ${{ always() }}
@@ -130,8 +130,8 @@ jobs:
         if: "${{ env.GCP_TARGET_PROJECT != '' }}"
         run: |
           bin/test_itemized $GCP_TARGET_PROJECT
-          more /tmp/test_itemized.out
-          diff -u /tmp/test_itemized.out etc/test_itemized.out
+          more out/test_itemized.out
+          diff -u out/test_itemized.out etc/test_itemized.out
       - name: output logs
         if: ${{ always() }}
         run: |

bin/run_tests

@@ -20,12 +20,14 @@ case "$1" in
   install_dependencies)
     bin/setup_base
     bin/clone_model
+    sudo ln -fs $PWD/bin/udmi /usr/local/bin/
     ;;
   code_checks)
     bin/gencode check
     pubber/bin/build check
     validator/bin/build check
     bin/test_pylint
+    bin/test_locate
     ;;
   schema_conformance_tests)
     bin/test_schema -p

bin/test_itemized

@@ -10,16 +10,26 @@ fi
 PROJECT_ID=$1
 shift 1
 
+udmi_profile=out/pubber_profile.json
 SITE_PATH=sites/udmi_site_model
 DEVICE_ID=AHU-1
 
-PUBBER_OUT=pubber.out
-SEQUENCER_OUT=sequencer.out
-RESULTS_OUT=/tmp/test_itemized.out
+PUBBER_OUT=out/pubber.out
+SEQUENCER_OUT=out/sequencer.out
+RESULTS_OUT=out/test_itemized.out
 GOLDEN_FILE=etc/test_itemized.out
 
-rm -f $RESULTS_OUT $SEQUENCER_OUT $PUBBER_OUT 
-touch $RESULTS_OUT $SEQUENCER_OUT $PUBBER_OUT 
+rm -f $RESULTS_OUT $SEQUENCER_OUT $PUBBER_OUT
+touch $RESULTS_OUT $SEQUENCER_OUT $PUBBER_OUT
+mkdir -p out
+
+cat <<EOF > $udmi_profile
+{
+  "site_model": "$PWD/$SITE_PATH",
+  "device_id": "$DEVICE_ID",
+  "project_id": "$PROJECT_ID"
+}
+EOF
 
 while read -u 7 action test_name remainder; do
     if [[ $action != TEST ]]; then
@@ -29,10 +39,10 @@ while read -u 7 action test_name remainder; do
 
     echo -n "TEST $test_name $pubber_opts" >> $RESULTS_OUT
     echo "TEST $test_name $pubber_opts"
-    
+
     serial_no=sequencer-$RANDOM
-    bin/pubber $SITE_PATH $PROJECT_ID $DEVICE_ID $serial_no $pubber_opts > $PUBBER_OUT 2>&1 &
-    WAITING=60
+    udmi pubber $udmi_profile -x $serial_no $pubber_opts > $PUBBER_OUT 2>&1 &
+    WAITING=20
     for i in `seq 1 $WAITING`; do
         if [[ -n $(fgrep "Connection complete" $PUBBER_OUT) ]]; then
             break
@@ -46,8 +56,8 @@ while read -u 7 action test_name remainder; do
         false
     fi
 
-    bin/sequencer $SITE_PATH $PROJECT_ID $DEVICE_ID $serial_no $test_name 2>&1 | tee $SEQUENCER_OUT 
-    
+    bin/sequencer $SITE_PATH $PROJECT_ID $DEVICE_ID $serial_no $test_name 2>&1 | tee $SEQUENCER_OUT
+
     kill $(ps ax | fgrep pubber | fgrep java | awk '{print $1}')
 
     result=$(grep -E -m 1 "RESULT [a-z]+ $test_name " $SEQUENCER_OUT)

bin/test_locate

@@ -0,0 +1,94 @@
+#!/bin/bash -e
+
+ROOT=$(realpath $(dirname $0)/..)
+cd $ROOT
+
+failures=$(mktemp)
+working=$(mktemp)
+
+function test_locate {
+    udmi locate $2 > $working
+    profile=$(echo $(fgrep profile: $working | cut -d: -f2))
+    site_model=$(echo $(fgrep site_model: $working | cut -d: -f2))
+    if [[ -n $4 ]]; then
+        expected_site=$(realpath --relative-base $PWD $ROOT/$4)
+    else
+        expected_site=
+    fi
+    if [[ $profile == $3 && $site_model == $expected_site ]]; then
+        result=PASS
+    else
+        result=FAIL
+        config_files=$(cd $ROOT; find $HOME/.udmi $ROOT/sites/udmi_site_model/.udmi -name \*.json 2>/dev/null)
+        echo "$1: udmi locate $2" >> $failures
+        echo "  working directory: " $PWD >> $failures
+        echo "  config files:" $config_files >> $failures
+        echo "  profile expected:" $3 was $profile >> $failures
+        echo "  site_model expected:" $expected_site was $site_model >> $failures
+    fi
+    echo $result $1
+}
+
+# Make sure udmi is in the path.
+export PATH=$ROOT/bin:$PATH
+
+SITE_PATH=sites/udmi_site_model
+USER_DEFAULT=$HOME/.udmi/default_profile.json
+PROFILE_TEMPLATE=$ROOT/out/default_profile.json
+mkdir -p ${PROFILE_TEMPLATE%/*.json}
+cat <<EOF > $PROFILE_TEMPLATE
+{
+  "site_model": "$ROOT/$SITE_PATH"
+}
+EOF
+
+[[ ! -d $ROOT/$SITE_PATH ]] && (echo $ROOT/$SITE_PATH not found, check your setup. && false)
+[[ -d $HOME/.udmi ]] && (echo $HOME/.udmi exists, remove before testing && false)
+[[ -d $ROOT/$SITE_PATH/.udmi ]] && (echo $ROOT/$SITE_PATH/.udmi exists, remove before testing && false)
+
+rm -rf   $HOME/.udmi $ROOT/$SITE_PATH/.udmi
+mkdir -p $HOME/.udmi $ROOT/$SITE_PATH/.udmi
+
+cp $PROFILE_TEMPLATE $USER_DEFAULT
+cp $PROFILE_TEMPLATE $HOME/.udmi/profile_foo.json
+
+cd $HOME
+echo Testing from $PWD
+
+test_locate default_site "" .udmi/default_profile.json $SITE_PATH
+test_locate user_profile foo .udmi/profile_foo.json $SITE_PATH
+test_locate user_missing bar "" ""
+
+echo Remove user default profile...
+rm -f $HOME/.udmi/default_profile.json
+
+test_locate default_missing "" "" ""
+
+echo Create empty user default profile...
+echo {} > $HOME/.udmi/default_profile.json
+
+test_locate default_empty "" .udmi/default_profile.json ""
+
+cd $ROOT/$SITE_PATH
+echo Testing from $PWD
+
+echo Copying profiles to .udmi/
+cp $PROFILE_TEMPLATE .udmi/
+cp $PROFILE_TEMPLATE .udmi/profile_bar.json
+
+test_locate site_default "" .udmi/default_profile.json $SITE_PATH
+test_locate site_missing foo "" $SITE_PATH
+test_locate site_profile bar .udmi/profile_bar.json $SITE_PATH
+test_locate site_nothing baz "" $SITE_PATH
+
+echo Cleanup .udmi directories...
+rm -rf $HOME/.udmi $ROOT/$SITE_PATH/.udmi
+
+if [[ -n $(cat $failures) ]]; then
+    echo Test failures:
+    cat $failures
+    false
+fi
+
+echo Done with locate tests.
+rm -f $failures

bin/udmi

@@ -0,0 +1,25 @@
+#!/bin/bash -e
+
+UDMI_ROOT=$(realpath $(dirname $(readlink -f $0))/..)
+
+commands=$(cd $UDMI_ROOT/bin; ls udmi-*)
+commands=$(echo ${commands//udmi-/})
+
+function show_help {
+  echo udmi sub-command [options]
+  echo "  sub-command is (usually) something like: $commands"
+}
+if [[ -z $1 ]]; then
+  show_help
+  false
+fi
+
+subcmd=udmi-$1
+shift
+
+pathcmd=$(which $subcmd || true)
+if [[ -z $pathcmd ]]; then
+  pathcmd=$UDMI_ROOT/bin/$subcmd
+fi
+
+$pathcmd "$@"

bin/udmi-locate

@@ -0,0 +1,10 @@
+#!/bin/bash -e
+
+UDMI_ROOT=$(realpath $(dirname $(readlink -f $0))/..)
+
+source $UDMI_ROOT/etc/shell_common.sh
+
+source $UDMI_ROOT/etc/find_udmi_profile.sh
+
+echo profile: ${udmi_profile}
+echo site_model: ${site_model}

bin/udmi-pubber

@@ -0,0 +1,18 @@
+#!/bin/bash -e
+
+UDMI_ROOT=$(realpath $(dirname $(readlink -f $0))/..)
+
+cd $UDMI_ROOT
+
+source etc/shell_common.sh
+
+source etc/find_udmi_profile.sh
+
+source etc/extract_parameters.sh
+
+[[ $udmi_project != null ]] || (echo project_id not defined && false)
+[[ $udmi_device != null ]] || (echo device_id not defined && false)
+[[ $udmi_serial != null ]] || (echo serial_id not defined && false)
+
+echo $UDMI_ROOT/bin/pubber $site_model $udmi_project $udmi_device $udmi_serial $*
+$UDMI_ROOT/bin/pubber $site_model $udmi_project $udmi_device $udmi_serial $*

etc/extract_parameters.sh

@@ -0,0 +1,33 @@
+#
+# Assuming the profile has been previously extracted/defined, this script will parse out the common
+# profile parameters and process any common command-line arguments.
+#
+
+if [[ -z $udmi_profile ]]; then
+    echo udmi_profile not defined.
+    false
+fi
+
+udmi_device=$(jq -r .device_id $udmi_profile)
+udmi_project=$(jq -r .project_id $udmi_profile)
+udmi_serial=$(jq -r .serial_no $udmi_profile)
+
+while getopts "d:p:x:" opt; do
+    case $opt in
+        d)
+            udmi_device=${OPTARG}
+            ;;
+        p)
+            udmi_project=${OPTARG}
+            ;;
+        x)
+            udmi_serial=${OPTARG}
+            ;;
+        \?)
+            echo "Usage: [-d device] [-p project] [-x serial]"
+            false
+            ;;
+    esac
+done
+
+shift $((OPTIND-1))

etc/find_udmi_profile.sh

@@ -0,0 +1,84 @@
+#
+# Look through and find the site and profile to use for tools.
+# This is not a function somewhere because it needs to manipulate the argument stack.
+#
+# A few configuration cases are supported:
+#  1. No argument, or first argument starts with -
+#    a. Look for working site_model directory and use ${site_mode}/.udmi/defailt_profile.json
+#    b. Look in ~/.udmi/default_profile.json
+#  2. Specific profile specified as file wiht .json extension
+#    a. Site defined in profile
+#    a. Site derived from working path (parent with .udmi directory)
+#  3. Semantic profile specificed (no .json)
+#    a. Working site derived from current working directory, look in ${site_mode}/.udmi/profile_${profile}.json
+#    b. Look in ~/.udmi/profile_${profile}.json
+#
+
+function find_or_extract {
+    if [[ -f $1 ]]; then
+        site_model=$(jq -r .site_model < $1)
+        profile_dir=$(dirname $1)
+        if [[ -z ${site_model} ]]; then
+            site_model=$(cd ${profile_dir}; find_site_model_root)
+        elif [[ ${site_model} == "null" ]]; then
+            site_model=
+        elif [[ ${site_model} =~ ^/ ]]; then
+            true # model is absolue, so don't munge.
+        else
+            site_model=$(realpath --relative-base ${PWD} ${profile_dir}/${site_model})
+        fi
+        echo ${site_model}
+    fi
+}
+
+udmi_profile=
+if [[ -z $1 || $1 =~ ^- ]]; then
+    # No argument specified
+    site_model=$(find_site_model_root)
+    if [[ -d ${site_model}/.udmi ]]; then
+        echo Using working site model $site_model
+        udmi_profile=${site_model}/.udmi/default_profile.json
+        echo Using site model default udmi profile $udmi_profile
+    else
+        udmi_profile=~/.udmi/default_profile.json
+        echo Using user default udmi profile $udmi_profile
+        site_model=$(find_or_extract $udmi_profile)
+        echo Extracted site model $site_model
+    fi
+elif [[ $1 =~ .json$ ]]; then
+    # Explicit .json file
+    udmi_profile=$1
+    shift
+    site_model=$(find_or_extract $udmi_profile)
+else
+    # Semantic profile (no .json suffix)
+    profile_name=$1
+    shift
+    site_model=$(find_site_model_root)
+    if [[ ! -f ${site_model}/cloud_iot_config.json ]]; then
+        site_model=
+    fi
+    if [[ -n ${site_model} ]]; then
+        udmi_profile=${site_model}/.udmi/profile_${profile_name}.json
+    else
+        udmi_profile=~/.udmi/profile_${profile_name}.json
+        site_model=$(find_or_extract $udmi_profile)
+    fi
+    if [[ -z ${site_model} ]]; then
+        udmi_profile=
+    fi
+fi
+
+if [[ ! -f ${udmi_profile} ]]; then
+    echo Invalid/empty udmi_profile ${udmi_profile}
+    udmi_profile=
+else
+    udmi_profile=$(realpath --relative-base $PWD ${udmi_profile})
+fi
+
+if [[ ! -f ${site_model}/cloud_iot_config.json ]]; then
+    echo Invalid/empty site_model ${site_model}
+    site_model=
+else
+    site_model=$(realpath --relative-base $PWD ${site_model})
+fi

etc/shell_common.sh

@@ -0,0 +1,16 @@
+#
+# General utility functions for working with UDMI scripts. Will be source'd by
+# executing scripts.
+#
+
+
+#
+# Walk up the directory tree looking for the cloud_iot_config.json site model marker.
+# If not found, just return empty.
+#
+function find_site_model_root {
+    while [ $PWD != "/" ]; do
+        test -f cloud_iot_config.json && { pwd; break; }
+        cd ..
+    done
+}