bbi_load_and_verify.sh #2

# bbi_load_and_verify.lib
Version=3.5.4

#==============================================================================
# Copyright and license info is available in the LICENSE file included with
# the P4BBI tool, and also available online:
# https://swarm.workshop.perforce.com/projects/perforce-software-baseline-and-branch-import/view/main/LICENSE
#------------------------------------------------------------------------------

#==============================================================================
# BBI Library Functions.

#------------------------------------------------------------------------------
# Function: check_p4_env
#
# Input:
# Define (export) the P4CONFIG variable prior to calling this function.
#------------------------------------------------------------------------------
function check_p4_env {
   vvmsg "CALL: check_p4_env($*)"
   declare -a errors
   declare -i errorCount=0
   declare -i i=0

   export P4CONFIG=${P4CONFIG:-Undefined}

   if [[ $P4CONFIG == Undefined ]]; then
      errmsg "P4CONFIG is not defined."
      return 1
   fi

   runCmd "$P4BIN -s info -s" "Target Perforce Environment:" 0 || {
      errors[$errorCount]="The Perforce server is not responding."
      errorCount+=1
   }

   if [[ "$($P4BIN protects -m 2>/dev/null)" == super ]]; then
      msg "Perforce super user access verified."
   else
      errors[$errorCount]="Perforce super user access could not be verified."
      errorCount+=1
   fi

   if [[ $errorCount -eq 0 ]]; then
      msg "Verified:  The Perforce environment is ready to receive imports."
      return 0
   else
      msg "The following problems were identified:"
      i=0; while [[ $i -lt $errorCount ]]; do
         errmsg "${errors[$i]}"
         i+=1
      done
      return 1
   fi
}

#------------------------------------------------------------------------------
# Function: load_baselines
#
# Input:
# $1 - BBI config file path
#
# Globals Modifiedq
# * Baselines, associative array, indexed by baseline name, value is path.
#
# Return:
# 0 - Baselines verified OK.
# 1 - Errors detected.
#------------------------------------------------------------------------------
function load_baselines {
   vvmsg "CALL: load_baselines($*)"

   declare bbiCfgFile=$1
   declare reqVersion=$2
   declare cfgVersion=
   declare baselineStorage=
   declare name=
   declare path=
   declare baselineOptions=
   declare line=
   declare -a errors
   declare -i errorCount=0
   declare -i i=0

   msg "Loading baseline definitions from [$bbiCfgFile]."

   if [[ ! -r "$bbiCfgFile" ]]; then
      errmsg "Cannot read BBI Config File [$bbiCfgFile]."
      return 1
   fi

   while read line; do
      if [[ $line == VERSION=* ]]; then
         cfgVersion=$(echo $line | cut -d '=' -f 2)
         if [[ "$cfgVersion" > "$reqVersion" ]]; then
            msg "Verified:  BBI config file version [$cfgVersion] meets minimum requirement."
         else
            errors[$errorCount]="BBI config file version [$cfgVersion] is too old.  Must be at least ${reqVersion}.0."
            errorCount+=1
         fi
         continue
      fi

      if [[ $line == BASELINE_STORAGE=* ]]; then
         baselineStorage=$(echo $line|cut -d '=' -f 2)
         if [[ $baselineStorage == \$* ]]; then
            baselineStorage=$(eval echo $baselineStorage)
         fi
         continue
      fi

      if [[ $line == GLOBAL_UPDATE_OPTIONS=* ]]; then
         GlobalUpdateOptions=$(echo $line|cut -d '=' -f 2)
      fi

      [[ $line == BASELINE* ]] || continue
      name=$(echo $line | cut -d '|' -f 2)
      path=$(echo $line | cut -d '|' -f 3)
      baselineOptions=$(echo $line | cut -d '|' -f 4)

      # If path is not an absolute path and baselineStorage is defined, prepend.
      if [[ $path != /* && -n "$baselineStorage" ]]; then
         path="$baselineStorage/$path"
      fi

      vvmsg "Line=[$line] N=[$name] P=[$path] O=[$baselineOptions]"
      Baselines[$name]="$path"
      BaselineOptions[$name]="$baselineOptions"

      case $path in
         (CMD:*)
            cmd=${path#CMD:}
            cmdExe=${cmd%% *}
            cmdExePath=$(which $cmdExe 2>/dev/null ||:)
            if [[ -z "$cmdExePath" ]]; then
               errors[$errorCount]="Command executable [$cmdExe] for baseline [$name] not found or not executable."
               errorCount+=1
            fi
         ;;
         (*.tar.gz|*.tgz|*.tar|*.zip)
            if [[ ! -r "$path" ]]; then
               errors[$errorCount]="Baseline file [$path] does not exist."
               errorCount+=1
            fi
         ;;
         (*)
            if [[ ! -r "$path" || ! -d "$path" ]]; then
               errors[$errorCount]="Baseline dir [$path] does not exist or is not a directory."
               errorCount+=1
            fi
         ;;
      esac
   done < $bbiCfgFile

   if [[ -z "$cfgVersion" ]]; then
      errors[$errorCount]="BBI config file version is not defined with a 'VERSION=' tag."
      errorCount+=1
   fi

   msg "${H}\nLoaded ${#Baselines[*]} baseline definitions:\n"

   printf "%-32s  %-s\n" "Name" "Path"
   printf "%-32s  %-s\n" "--------------------------------" "------------------------------------------"
   for name in ${!Baselines[*]}; do
      printf "%-32s  %-s\n" "$name" "${Baselines[$name]}"
   done

   if [[ $errorCount -eq 0 ]]; then
      msg "\nVerified:  All defined baselines are accessible."
   else
      msg "\nThe following problems were identified:"
      i=0; while [[ $i -lt $errorCount ]]; do
         errmsg "${errors[$i]}"
         i+=1
      done
   fi

   if [[ $errorCount -eq 0 ]]; then
      return 0
   else
      return 1
   fi
}

#------------------------------------------------------------------------------
# Function: load_actions
#
# Input:
# $1 - BBI config file path
#
# Globals Modified:
# * ActionType array
#
# This is the main array of actions, the index of which applies to the other
# arrays below.  So if ActionType[3] is an Update, then the arrays for an UPDATE
# action with that index will be defined, i.e. ActionBaseline[3], ActionPath1[3],
# and ActionDesc[3], and optionally ActionUpdateOptions[3].  Different action types
# have different parameters.
#
# * ActionBaseline array
# * ActionDepotName array
# * ActionDepotType array
# * ActionPath1 array
# * ActionPath2 array
# * ActionDesc array
# * ActionBranchSpecFile array
# * ActionDepotSpecFile array
# * ActionStreamSpecFile array
# * ActionUpdateOptions array
# * ActionStreamPath array
# * ActionStreamType array
# * ActionStreamOwner array
# * ActionStreamDesc array
# * ActionStreamOptions array
# * ActionCount integer
#
# Action Types and their parameters:
# BRANCH_SPEC|BranchSpecFile
# CLIENT_SPEC|ClientSpecFile
# DEPOT|Name|Type[|Desc]
# DEPOT_SPEC|DepotSpecFile
# UPDATE|Baseline|Path1|Desc[|ActionUpdateOptions]
# POPULATE|Path1|Path2|Desc (or POPULATE|BRANCH_SPEC[-r]|BranchSpec|Desc)
# COPY|Path1|Path2|Desc (or COPY|BRANCH_SPEC[-r]|BranchSpec|Desc)
# MOVE|Path1|Path2|Desc
# RECORD_MERGE|Path1|Path2|Desc (or RECORD_MERGE|BRANCH_SPEC[-r]|BranchSpec|Desc)
# STREAM|StreamPath|StreamType|StreamParent|StreamDesc[|<StreamOptions>]
# STREAM_SPEC|StreamSpecFile
#
# Return:
# 0 - Actions loaded, syntax verified, refererenced baselines defined.
# 1 - Errors detected.
#------------------------------------------------------------------------------
function load_actions {
   vvmsg "CALL: load_actions($*)"

   declare bbiCfgFile=$1
   declare actionType=
   declare baseline=
   declare path1=
   declare path2=
   declare desc=
   declare updateOption=
   declare updateOptions=
   declare branchSpecFile=
   declare depotSpecFile=
   declare streamSpecFile=
   declare streamPath=
   declare streamType=
   declare streamParent=
   declare streamDesc=
   declare streamOwner=
   declare streamOptions=
   declare injectionScript=
   declare injectionIndicator=
   declare line=
   declare -a errors
   declare -i errorCount=0
   declare -i i=0
   declare -i lineCount=0

   msg "Loading action sequences from [$bbiCfgFile]."

   if [[ ! -r "$bbiCfgFile" ]]; then
      errmsg "Cannot read BBI Config File [$bbiCfgFile]."
      return 1
   fi

   # The first action is artifically hard-coded to START_IMPORT.
   ActionType[$ActionCount]=START_IMPORT
   ActionCount+=1

   while read line; do
      lineCount+=1
      case $line in
         (\#*|BASELINE*|GLOBAL_UPDATE_OPTIONS*|NAME*|VERSION*) continue;;
         (BRANCH_SPEC*)
            # BRANCH_SPEC|BranchSpecFile
            ActionType[$ActionCount]=BRANCH_SPEC
            branchSpecFile="$BBIConfigDir/specs/$(echo $line | cut -d '|' -f 2).branch.p4s"
            ActionBranchSpecFile[$ActionCount]=$branchSpecFile
            ActionCount+=1
         ;;
         (CLIENT_SPEC*)
            # CLIENT_SPEC|ClientSpecFile
            ActionType[$ActionCount]=CLIENT_SPEC
            clientSpecFile="$BBIConfigDir/specs/$(echo $line | cut -d '|' -f 2).client.p4s"
            ActionBranchSpecFile[$ActionCount]=$clientSpecFile
            ActionCount+=1
         ;;
         (DEPOT_SPEC*)
            # DEPOT_SPEC|DepotSpecFile
            ActionType[$ActionCount]=DEPOT_SPEC
            depotSpecFile="$BBIConfigDir/specs/$(echo $line | cut -d '|' -f 2).depot.p4s"
            ActionDepotSpecFile[$ActionCount]=$depotSpecFile
            ActionCount+=1
         ;;
         (STREAM_SPEC*)
            # STREAM_SPEC|StreamSpecFile
            ActionType[$ActionCount]=STREAM_SPEC
            streamSpecFile="$BBIConfigDir/specs/$(echo $line | cut -d '|' -f 2).stream.p4s"
            ActionStreamSpecFile[$ActionCount]=$streamSpecFile
            ActionCount+=1
         ;;
         (DEPOT*)
            # DEPOT|Name|Type[|Desc]
            ActionType[$ActionCount]=DEPOT
            depotName="$(echo $line | cut -d '|' -f 2)"
            depotType="$(echo $line | cut -d '|' -f 3)"
            desc="$(echo $line | cut -d '|' -f 4)"
            [[ -z "$desc" ]] && desc="Created by $ImportUser."

            ActionDepotName[$ActionCount]="$depotName"
            ActionDepotType[$ActionCount]="$depotType"
            ActionDesc[$ActionCount]="$desc"

            ActionCount+=1
         ;;
         (UPDATE*)
            # UPDATE|Baseline|Path1|Desc[|ActionUpdateOptions]
            ActionType[$ActionCount]=UPDATE
            baseline="$(echo $line | cut -d '|' -f 2)"
            path1="$(echo $line | cut -d '|' -f 3)"
            desc="$(echo $line | cut -d '|' -f 4)"
            updateOptions="$(echo $line | cut -d '|' -f 5) $GlobalUpdateOptions"
            updateOptions=$(echo $updateOptions)

            for updateOption in $updateOptions; do
               case $updateOption in
                  (ASTYLE) ;;
                  (DOS2UNIX) ;;
                  (LABEL:*)
                     label=$(echo ${updateOption##*LABEL:})
                     label=${label%% *}
                     if [[ -z "$label" ]]; then
                        errors[$errorCount]="LABEL option for UPDATE action on line $lineCount is malformed.  Format is LABEL:YourLabelName."
                        errorCount+=1
                     fi
                  ;;
                  (VERIFY) ;;
                  (*)
                     errors[$errorCount]="Invalid UPDATE option value ($updateOption) defined on line $lineCount.  Valid options are ASTYLE, DOS2UNIX, LABEL:MyLabelName, and VERIFY."
                     errorCount+=1
                  ;;
               esac
            done

            ActionBaseline[$ActionCount]="$baseline"
            ActionPath1[$ActionCount]="$path1"
            ActionDesc[$ActionCount]="$desc"
            ActionUpdateOptions[$ActionCount]="$updateOptions"

            set +u
            if [[ -z "${Baselines[$baseline]}" ]]; then
               errors[$errorCount]="Baseline [$baseline] referenced on line $lineCount is not defined."
               errorCount+=1
            fi
            set -u

            ActionCount+=1
         ;;
         # POPULATE and BRANCH are synonomous; POPULATE is the preferred term since this is now
         # implemented with the 'p4 populate' command.
         (POPULATE*|BRANCH*)
            # POPULATE|Path1|Path2|Desc
            # or:
            # POPULATE|BRANCH_SPEC[-r]|BranchSpec|Desc
            ActionType[$ActionCount]=POPULATE
            path1="$(echo $line | cut -d '|' -f 2)"
            path2="$(echo $line | cut -d '|' -f 3)"
            desc="$(echo $line | cut -d '|' -f 4)"

            ActionPath1[$ActionCount]="$path1"
            ActionPath2[$ActionCount]="$path2"
            ActionDesc[$ActionCount]="$desc"

            ActionCount+=1
         ;;
         # COPY_MERGE and short form COPY are synonomous.
         (COPY*)
            # COPY|Path1|Path2|Desc
            # or:
            # COPY|BRANCH_SPEC[-r]|BranchSpecName|Desc
            ActionType[$ActionCount]=COPY
            path1="$(echo $line | cut -d '|' -f 2)"
            path2="$(echo $line | cut -d '|' -f 3)"
            desc="$(echo $line | cut -d '|' -f 4)"

            ActionPath1[$ActionCount]="$path1"
            ActionPath2[$ActionCount]="$path2"
            ActionDesc[$ActionCount]="$desc"

            ActionCount+=1
         ;;
         # RENAME and short form MOVE are synonomous.
         (MOVE*|RENAME*)
            ActionType[$ActionCount]=MOVE
            path1="$(echo $line | cut -d '|' -f 2)"
            path2="$(echo $line | cut -d '|' -f 3)"
            desc="$(echo $line | cut -d '|' -f 4)"

            ActionPath1[$ActionCount]="$path1"
            ActionPath2[$ActionCount]="$path2"
            ActionDesc[$ActionCount]="$desc"

            ActionCount+=1
         ;;
         # RECORD_AS_MERGED and short form RECORD_MERGE are synonomous.
         (RECORD_AS_MERGED*|RECORD_MERGE*)
            # RECORD_MERGE|Path1|Path2|Desc
            ActionType[$ActionCount]=RECORD_MERGE
            path1="$(echo $line | cut -d '|' -f 2)"
            path2="$(echo $line | cut -d '|' -f 3)"
            desc="$(echo $line | cut -d '|' -f 4)"

            ActionPath1[$ActionCount]="$path1"
            ActionPath2[$ActionCount]="$path2"
            ActionDesc[$ActionCount]="$desc"

            ActionCount+=1
         ;;
         (STREAM*)
            # STREAM|StreamPath|StreamType|StreamParent[|StreamOwner[|StreamDesc[|<StreamOptions>]]]
            ActionType[$ActionCount]=STREAM
            streamPath="$(echo $line | cut -d '|' -f 2)"
            streamType="$(echo $line | cut -d '|' -f 3)"
            streamParent="$(echo $line | cut -d '|' -f 4)"
            streamOwner="$(echo $line | cut -d '|' -f 5)"
            [[ -z "$streamOwner" ]] && streamOwner="$ImportUser"
            streamDesc="$(echo $line | cut -d '|' -f 6)"
            [[ -z "$streamDesc" ]] && streamDesc="Created by $ImportUser."
            streamOptions="$(echo $line | cut -d '|' -f 7)"

            ActionStreamPath[$ActionCount]="$streamPath"
            ActionStreamType[$ActionCount]="$streamType"
            ActionStreamParent[$ActionCount]="$streamParent"
            ActionStreamOwner[$ActionCount]="$streamOwner"
            ActionStreamDesc[$ActionCount]="$streamDesc"
            ActionStreamOptions[$ActionCount]="$streamOptions"

            ActionCount+=1
         ;;
         (*)
            [[ -z "$(echo $line)" ]] && continue
            actionType=${line%%\|*}
            errors[$errorCount]="Unprocessed action type [$actionType] on line $lineCount:\n$line\n"
            errorCount+=1
         ;;
      esac
   done < $bbiCfgFile

   msg "${H}\nLoaded $((${#ActionType[*]}-1)) action sequences:\n"

   printf "%-3s %-17s %-s\n" "#" "Action" "Stuff"
   printf "%-3s %-17s %-s\n" "---" "----------------" "--------------------------------------------------------"
   i=1; while [[ $i -lt ${#ActionType[*]} ]]; do
      printf "%-3s %-16s  " "$i" "${ActionType[$i]}"
      case ${ActionType[$i]} in
         (BRANCH_SPEC)
            msg "F=[${ActionBranchSpecFile[$i]}]"
            if [[ ! -r "${ActionBranchSpecFile[$i]}" ]]; then
               errors[$errorCount]="Missing branch spec file [${ActionBranchSpecFile[$i]}]."
               errorCount+=1
            fi
         ;;
         (DEPOT_SPEC)
            msg "F=[${ActionDepotSpecFile[$i]}]"
            if [[ ! -r "${ActionDepotSpecFile[$i]}" ]]; then
               errors[$errorCount]="Missing depot spec file [${ActionDepotSpecFile[$i]}]."
               errorCount+=1
            fi
         ;;
         (STREAM_SPEC)
            msg "F=[${ActionStreamSpecFile[$i]}]"
            if [[ ! -r "${ActionStreamSpecFile[$i]}" ]]; then
               errors[$errorCount]="Missing stream spec file [${ActionStreamSpecFile[$i]}]."
               errorCount+=1
            fi
         ;;
         (DEPOT)
            msg "N=[${ActionDepotName[$i]}] T=[${ActionDepotType[$i]}] D=[${ActionDesc[$i]}]"
         ;;
         (UPDATE)
            injectionScript="$BBIConfigDir/injections/before_UPDATE_${ActionBaseline[$i]}.sh"

            if [[ -r "$injectionScript" ]]; then
               injectionIndicator="*INJ*"
            else
               injectionIndicator=""
            fi

            msg "B=[${ActionBaseline[$i]}]${injectionIndicator} P=[${ActionPath1[$i]}] D=[${ActionDesc[$i]}] A=[${ActionUpdateOptions[$i]}]"
         ;;
         (POPULATE)
            msg "P1=[${ActionPath1[$i]}] P2=[${ActionPath2[$i]}] D=[${ActionDesc[$i]}]"
         ;;
         (COPY)
            msg "P1=[${ActionPath1[$i]}] P2=[${ActionPath2[$i]}] D=[${ActionDesc[$i]}]"
         ;;
         (MOVE)
            msg "P1=[${ActionPath1[$i]}] P2=[${ActionPath2[$i]}] D=[${ActionDesc[$i]}]"
         ;;
         (RECORD_MERGE)
            msg "P1=[${ActionPath1[$i]}] P2=[${ActionPath2[$i]}] D=[${ActionDesc[$i]}]"
         ;;
         (STREAM)
            msg "P=[${ActionStreamPath[$i]}] T=[${ActionStreamType[$i]}] MOM=[${ActionStreamParent[$i]}] O=[${ActionStreamOwner[$i]}] D=[${ActionStreamDesc[$i]}] O=[${ActionStreamOptions[$i]}]"
         ;;
         (*)
            errors[$errorCount]="Invalid action type [${ActionType[$i]}]."
            errorCount+=1
         ;;
      esac
      i+=1
   done

   if [[ $errorCount -eq 0 ]]; then
      msg "\nVerified:  All action sequences passed sanity checks, reference valid baselines etc."
   else
      msg "\nThe following problems were identified:"
      i=0; while [[ $i -lt $errorCount ]]; do
         errmsg "${errors[$i]}"
         i+=1
      done
   fi

   if [[ $errorCount -eq 0 ]]; then
      return 0
   else
      return 1
   fi
}