example/diameter/launcher/resources/scripts/clone.sh

   1 #!/bin/bash
   2 #####################################################
   3 ####                                             ####
   4 ##                                                 ##
   5 # THIS SCRIPT IS NORMALLY INTENDED FOR INTERNAL USE #
   6 ##                                                 ##
   7 ####                                             ####
   8 #####################################################
   9
  10 #############
  11 # VARIABLES #
  12 #############
  13 CLONE_WKDIR=$(mktemp -d)
  14 #MAX_NUMBER_GROUPS=400
  15 MAX_NUMBER_GROUPS=200
  16 # (depends on the machine)
  17 CLONE_EXTRA_VARS_SCR_BN=clone-extra-vars.sh
  18
  19 #############
  20 # FUNCTIONS #
  21 #############
  22 _exit (){
  23   echo
  24   echo -e $1
  25   echo
  26
  27   # Background jobs:
  28   #remaining_jobs=$(jobs -p)
  29   (kill -9 $(jobs -p) 2>&1) >/dev/null
  30
  31   # Cleanup:
  32   rm -rf $CLONE_WKDIR
  33
  34   rc=1
  35   [ -n "$2" ] && rc=$2
  36   exit $rc
  37 }
  38
  39 sig_handler() {
  40   _exit "Script interrupted. Cleanup & exit ..."
  41 }
  42
  43 usage() {
  44   echo "Usage: $0 <ADML directory> <testcase variable file> <initial sequence> <final sequence> [number of groups] [population]"
  45   echo
  46   echo "          ADML directory:         path to the ADML directory where 'operation.sh' script is used to load the test cases."
  47   echo "          testcase variable file: path to the testcase file with parseable variables, for example '<directory>/testcase.txt.msk'."
  48   echo "                                  xml files within this test case, must exist with aditional .msk extension in the same directory."
  49   echo
  50   echo "                                  Currently, 4 variables are supported to be replaced:"
  51   echo
  52   echo "                                  * __TESTID__   : sequence number. For example if you provide 1 to 20 for this script, it will be 1 .. 20"
  53   echo "                                  * __SEQ8__     : 8-digit number corresponding to the sequence number (00000001 for 1, and so on)"
  54   echo "                                  * __IPV4HEX__  : hexadecimal IPv4 address, for example: 00000001"
  55   echo "                                  * __IPV4__     : IPv4 address, for example: 0.0.0.1"
  56   echo
  57   echo "                                  Optionally (when exists), a user defined file '$CLONE_EXTRA_VARS_SCR_BN' is sourced to extend the parseable"
  58   echo "                                  variables used within the test case stuff (this script must be placed on that directory). The script"
  59   echo "                                  will be called with the sequence number as argument during clone procedure, and shall define the needed"
  60   echo "                                  variable values referenced in the parsed files. The variables must be named as '__<name>__' which ensures"
  61   echo "                                  that main clone script environment is not contaminated."
  62   echo
  63   echo "          initial sequence:       initial sequence number to parse over variables."
  64   echo "          final sequence:         final sequence number to parse over variables."
  65   echo "          number of groups:       number of background group jobs to clone the provided sequence range."
  66   echo "                                  By default (or if you provide \"\"), it will be the number of items divided by 25, with a maximum"
  67   echo "                                  of $MAX_NUMBER_GROUPS."
  68   echo "          population:             Optionally, a population file (basename) can be provided. It must exist on the same directory"
  69   echo "                                  than other stuff (testcase, xml files). The behaviour will be the accumulation of every parsing"
  70   echo "                                  operation during clone procedure regarding the templated content of the population file. The"
  71   echo "                                  accumulated content will be dump over a new file created together with cloned <population> and"
  72   echo "                                  named with the extension '.all' (<population>.all). This population file could be useful to"
  73   echo "                                  specify database commands related to each sequence (each single testcase), in order to have"
  74   echo "                                  the whole population file. This won't include common database elements for the tested scenary,"
  75   echo "                                  which shall be provisioned in a separated procedure."
  76   echo
  77   _exit
  78 }
  79
  80 children () {
  81   bash_pid=$$
  82   children=`ps -eo ppid | grep -w $bash_pid`
  83   echo $children | wc -w
  84 }
  85
  86 # $1: sequence number; $2: file to parse(will be updated); $3: result file
  87 parse_file() {
  88   local vars=$(egrep -o '__((_*[A-Z]*[0-9]*)*)__' $2 | cut -d: -f2 | sort -u)
  89   local file=$2
  90   cp $2 $3
  91   file=$3
  92   for pvar in $vars
  93   do
  94     eval pvalue=\$$pvar
  95     sed -i 's/'$pvar'/'$pvalue'/g' $file
  96   done
  97 }
  98
  99 # $1: sequence number; $2: working directory
 100 clone() {
 101   local sequence=$1
 102   local wkdir=$2
 103   mkdir -p $wkdir
 104
 105   ############################################# VARIABLES SECTION #############################################
 106   testid=$sequence
 107   seq8=$(printf "%08d" $testid)
 108   ipv4hex=$seq8
 109   # Numbers beginning with "0" are treated as octal (i.e. base-8): we would have 'invalid octal number with 08 and 09'
 110   # Solution: convert to base-10 in this way: $((10#$i))
 111   ipv4=$(for i in $(echo $seq8 | sed 's/\(..\)/ \1 /g'); do printf "%d." $((10#$i)); done | sed 's/\.$/\n/')
 112
 113   __TESTID__=$testid
 114   __SEQ8__=$seq8
 115   __IPV4HEX__=$ipv4hex
 116   __IPV4__=$ipv4
 117   [ -n "$extra_vars" ] && source $CLONE_EXTRA_VARS_SCR_FILE $sequence
 118   ######################################### END VARIABLES SECTION #########################################
 119
 120   # Parse template files:
 121   parse_file $sequence $TESTCASE_TEMPLATE $wkdir/testcase.txt.$sequence
 122   for file in $(grep sendxml $TESTCASE_TEMPLATE | cut -d\| -f4 | sed 's/\.xml$/.xml.msk/')
 123   do
 124     xml=`basename $file .msk`
 125     parse_file $sequence $TESTCASE_TEMPLATE_DIR/$file $wkdir/${xml}.${sequence}
 126     new_file=`readlink -f $wkdir/${xml}.${sequence}`
 127     sed -i 's|'$xml'|'$new_file'|g' $wkdir/testcase.txt.$sequence
 128   done
 129   cat $wkdir/testcase.txt.$sequence >> $wkdir/testcase.txt
 130   rm $wkdir/testcase.txt.$sequence
 131
 132   # Population:
 133   if [ -n "$POPULATION" ]
 134   then
 135     parse_file $sequence $POPULATION_FILE $CLONE_WKDIR/${POPULATION}.$sequence
 136     cat $CLONE_WKDIR/${POPULATION}.$sequence >> $POPULATION_ALL
 137   fi
 138 }
 139
 140 # $1: group number; $2: initial subrange value; $3: final subrange value
 141 clone_group() {
 142   for i in `seq $2 $3`
 143   do
 144     clone $i $CLONE_WKDIR/$1
 145     sleep 0.01
 146   done
 147 }
 148
 149 #############
 150 # EXECUTION #
 151 #############
 152 trap sig_handler SIGINT
 153 trap sig_handler SIGTERM
 154
 155 ADML_DIR=$1
 156 TESTCASE_TEMPLATE=`readlink -f $2`
 157 TESTCASE_TEMPLATE_DIR=`dirname $TESTCASE_TEMPLATE`
 158 CLONE_SEQ_BEGIN=$3
 159 CLONE_SEQ_END=$4
 160 N_GROUPS=$5
 161 POPULATION=$6
 162 POPULATION_FILE=$TESTCASE_TEMPLATE_DIR/$POPULATION
 163 POPULATION_ALL=$TESTCASE_TEMPLATE_DIR/${POPULATION}.all
 164 CLONE_EXTRA_VARS_SCR_FILE=$TESTCASE_TEMPLATE_DIR/$CLONE_EXTRA_VARS_SCR_BN
 165 extra_vars=
 166 [ -f $CLONE_EXTRA_VARS_SCR_FILE ] && extra_vars=yes
 167
 168 [ "$4" = "" ] && usage
 169
 170 # Auxiliary:
 171 OPERATION=$ADML_DIR/operation.sh
 172 [ ! -f $OPERATION ] && _exit "Missing '$OPERATION' file !!"
 173 [ ! -f $TESTCASE_TEMPLATE ] && _exit "Missing '$TESTCASE_TEMPLATE' testcase template file !!"
 174
 175 if [ -n "$POPULATION" ]
 176 then
 177   bn_population=`basename $POPULATION`
 178   [ "$bn_population" != "$POPULATION" ] && _exit "Only basename is allowed for population provided !!"
 179   [ ! -f $POPULATION_FILE ] && _exit "Missing provided population file '$POPULATION_FILE' !!"
 180   0> $POPULATION_ALL
 181 fi
 182
 183 N_ITEMS=$((CLONE_SEQ_END - CLONE_SEQ_BEGIN + 1))
 184 [ "$N_ITEMS" -lt 1 ] && _exit "Initial sequence ($CLONE_SEQ_BEGIN) provided must be under final sequence value ($CLONE_SEQ_END) !!"
 185 [ "$CLONE_SEQ_END" -gt "99999999" ] && echo "Warning: some sequence value in range provided overflows __SEQ8__ and derived variables (__IPV4__ and __IPV4HEX__). Be care about using them ..."
 186
 187 if [ -z "$N_GROUPS" ]
 188 then
 189   N_GROUPS=$((N_ITEMS/25))
 190   [ $N_GROUPS -gt $MAX_NUMBER_GROUPS ] && N_GROUPS=$MAX_NUMBER_GROUPS
 191   [ $N_GROUPS -eq 0 ] && N_GROUPS=1
 192 fi
 193 GROUPS_SIZE=$((N_ITEMS/N_GROUPS))
 194 if [ "$GROUPS_SIZE" -eq 0 ]
 195 then
 196   echo "Assuming minimum allowed number of groups (one group per item): $N_ITEMS"
 197   GROUPS_SIZE=1
 198   N_GROUPS=$N_ITEMS
 199 fi
 200
 201 # Start cloning:
 202 timestamp_begin=$(echo "scale=3 ; $(date '+%s') + $(date '+%N') / 1000000000" | bc)
 203 children_before=$(children)
 204 offset=0
 205 $OPERATION "test|clear"
 206 [ $? -ne 0 ] && _exit "Clone aborted: failed to clean tests !"
 207 echo "Please be patient, this may take a while ..."
 208 #echo "Temporary directory: $CLONE_WKDIR"
 209 for group in `seq 1 $((N_GROUPS+1))`
 210 do
 211   n_begin=$((CLONE_SEQ_BEGIN + offset))
 212   n_end=$((n_begin + GROUPS_SIZE - 1))
 213   [ $n_end -gt $CLONE_SEQ_END ] && n_end=$CLONE_SEQ_END
 214   [ $n_end -lt $n_begin ] && break
 215   clone_group $group $n_begin $n_end &
 216   offset=$((group * GROUPS_SIZE))
 217 done
 218
 219 # Wait background jobs to finish:
 220 while true
 221 do
 222   sleep 1
 223   [ $(children) -eq $children_before ] && break
 224 done
 225
 226 # Programming:
 227 echo -n "Programming .."
 228 for file in $(ls $CLONE_WKDIR/*/testcase.txt)
 229 do
 230   echo -n .
 231   r_file=`readlink -f $file`
 232   dn_r_file=`dirname $r_file`
 233   $OPERATION -t 300 -f $r_file > $dn_r_file/result.txt
 234   res=$?
 235   if [ $res -ne 0 ]
 236   then
 237     bn_dn_r_file=`basename $dn_r_file`
 238     exception_dir=$ADML_DIR/exception_stuff_${bn_dn_r_file}
 239     rm -rf $exception_dir
 240     cp -r $dn_r_file $exception_dir
 241     cp $ADML_DIR/launcher.trace $exception_dir
 242     _exit "Exception detected programming a testcase. Check for '$exception_dir'"
 243   fi
 244   rm -rf $dn_r_file &
 245 done
 246
 247 timestamp_end=$(echo "scale=3 ; $(date '+%s') + $(date '+%N') / 1000000000" | bc)
 248 echo
 249 lasted=$(echo "scale=3 ; $timestamp_end - $timestamp_begin" | bc)
 250 echo "Total Lasted $lasted seconds"
 251 echo "Programming speed: $(echo "$N_ITEMS/$lasted" | bc) tests per second"
 252
 253 # Finish:
 254 _exit "Done!" 0
 255