tiny testcase creator and example
[anna.git] / example / diameter / launcher / resources / scripts / tinyTestcase.sh
index e08120f..f2b30d5 100755 (executable)
@@ -4,6 +4,7 @@
 # VARIABLES #
 #############
 SCR_DIR=`readlink -f $0 | xargs dirname`
+TESTCASE_BN=testcase.txt
 
 #############
 # FUNCTIONS #
@@ -16,19 +17,21 @@ _exit() {
 }
 
 usage() {
-  echo "Usage: $0 <source directory>"
+  echo "Usage: $0 <source_directory> \"[test_end_points]\" [timeout]"
   echo
-  echo "       The source directory may contain .xml and .metadata files grouped by pairs and alphabetically classified:"
+  echo "       source_directory:"
   echo
-  echo "          11.hex.as.xml  15.hex.as.xml  19.hex.as.xml ..."
-  echo "          11.metadata    15.metadata    19.metadata   ..."
-  echo "          13.hex.as.xml  17.hex.as.xml  21.hex.as.xml ..."
-  echo "          13.metadata    17.metadata    21.metadata   ..."
+  echo "         The source directory may contain .xml and .metadata files grouped by pairs and alphabetically classified:"
   echo
-  echo "       Normally the order comes from first dot-separated part, which is the decoded frame from pcap:"
+  echo "            11.hex.as.xml  15.hex.as.xml  19.hex.as.xml ..."
+  echo "            11.metadata    15.metadata    19.metadata   ..."
+  echo "            13.hex.as.xml  17.hex.as.xml  21.hex.as.xml ..."
+  echo "            13.metadata    17.metadata    21.metadata   ..."
   echo
-  echo "          11.hex.as.xml: would be the ANNA-Diameter decoded message from hexadecimal sniffed one."
-  echo "          11.metadata:   would contain parsed metadata from tshark or another fulfilling this information:"
+  echo "         The order comes from first dot-separated part, which is normally the decoded frame from a pcap file:"
+  echo
+  echo "            11.hex.as.xml: would be the ANNA-Diameter decoded message from hexadecimal sniffed one."
+  echo "            11.metadata:   would contain parsed metadata from tshark or another fulfilling this information:"
   echo
   echo "                           date=Sat Dec 19 11:50:55 CET 2015"
   echo "                           timestamp=1450522255.205673000"
@@ -38,35 +41,173 @@ usage() {
   echo "                           isrequest=1"
   echo "                           applicationid=0"
   echo
-  echo "       Presented example has been achieved using the 'example/diameter/pcapDecoder/tsharkDecoder.sh' script"
-  echo "        and then decoding with 'example/diameter/batchConverter' tool with appropiate diameter dictionaries."
+  echo "         Presented example has been achieved using the 'example/diameter/pcapDecoder/tsharkDecoder.sh' script"
+  echo "         and then decoding with 'example/diameter/batchConverter' tool with appropiate diameter dictionaries."
+  echo
+  echo
+  echo "       test_end_points: space-separated list of possible test end points (hostnames, ip addresses)"
+  echo
+  echo "         This script will create a basic testcase based on frames timeline (11, 13, 15, etc.), from the desired"
+  echo "         end-point list. For example, from the 'gentraf' point of view, outgoing requests will be translated as"
+  echo "         sendxml operations with corresponding waits for answers and successful result code (2001). CER/A are"
+  echo "         detected creating a symbolic link to better reference them, and DPR/A are ignored."
+  echo
+  echo "         The provided test end point list shall match metadata 'src' field in order to filter the valid testcase"
+  echo "         messages. In case of nothing provided (empty string) a list with the possible values from the source"
+  echo "         directory will be shown."
+  echo
   echo
-  echo "      This script will create a basic testcase based on frames timeline (11, 13, 15, etc.), from the desired"
-  echo "      end-point. For example, from the 'gentraf' point of view, outgoing requests will be translated as send"
-  echo "      operations with corresponding waits for answers and successful result code (2001). CER/A are detected"
-  echo "      creating a symbolic link to better reference them, and DPR/A are ignored."
+  echo "       timeout:"
   echo
-  echo "      The resulting 'testcase.txt' will have all the operations needed to program the test case and will be"
-  echo "      written on same source directory referencing xml files as local-relative ones. Probably, 'change-dir'"
-  echo "      operation will be used before programming to ease the procedure without having to copy the stuff into"
-  echo "      installed ADML execution directory."
+  echo "         Timeout in seconds for the testcase. By default, no timeout will be programmed for the testcase."
   echo
-  echo "      Connection issues (CER/A), disconnect procedures (DPR/A), database populations and sanity checks are"
-  echo "      not responsability for this script. Such operations shall be externally performed to guarantee that"
-  echo "      programming this testcase is going to be valid in context of test execution."
+  echo
+  echo
+  echo "       The resulting '$TESTCASE_BN' will have all the operations needed to program the test case and will be"
+  echo "       written on same source directory referencing xml files as local-relative ones. Probably, 'change-dir'"
+  echo "       operation will be used before programming to ease the procedure without having to copy the stuff into"
+  echo "       installed ADML execution directory."
+  echo
+  echo "       Connection issues (CER/A), disconnect procedures (DPR/A), database populations and sanity checks are"
+  echo "       not responsability for this script. Such operations shall be externally performed to guarantee that"
+  echo "       programming this testcase is going to be valid in context of test execution. Anyway, CER messages"
+  echo "       will be detected and symbolically linked with the name 'cer.<origin host>.xml'."
   _exit
 }
+# $1: frame number (there must be .metadata and .xml files); $2: check Result-Code indicator
+update_testcase () {
+  # metadata aspect:
+  #
+  # date=Wed Oct  7 01:51:16 CEST 2015
+  # timestamp=1444175476.212667000
+  # src=gt_traf
+  # dst=vcbavipt
+  # code=258
+  # isrequest=0
+  # applicationid=16777238
+  mtd=${1}.*metadata
+  xml=( `ls ${1}.*xml 2>/dev/null` )
+  [ ${#xml[@]} -ne 1 ] && _exit "There must be one xml message file corresponding to '$mtd' !!"
+  resultcode=$2
+
+  # Ignore disconnect peer messages on testcase format (they have no session-id):
+  grep "^code=282$" $mtd > /dev/null
+  [ $? -eq 0 ] && return
+
+  code=$(grep ^code $mtd | cut -d= -f2)
+  isrequest=$(grep ^isrequest $mtd | cut -d= -f2)
+  sessionid=$(grep Session-Id $xml | cut -d\" -f4)
+  lines=$(wc -l $TESTCASE_BN | awk '{ print $1 }')
+
+  s_waitfe="test|1|waitfe|$code|$((1-isrequest))"
+  [ -n "$sessionid" ] && s_waitfe="${s_waitfe}|||${sessionid}"
+
+  if [ $isrequest -eq 1 ]
+  then
+    echo "test|1|sendxml2e|$xml" >> $TESTCASE_BN
+    [ -n "$resultcode" ] && s_waitfe="${s_waitfe}|2001"
+    echo "$s_waitfe" >> $TESTCASE_BN
+  else
+    echo "$s_waitfe" >> $TESTCASE_BN
+    echo "test|1|sendxml2e|$xml|$((lines+1))" >> $TESTCASE_BN
+  fi
+}
 
 #############
 # EXECUTION #
 #############
-cd $SCR_DIR
-source ../../configure.sh
 echo
 SOURCE_DIR=$1
-[ -z "$SOURCE_DIR" ] && usage
 SOURCE_DIR=`readlink -f $SOURCE_DIR`
 [ ! -d "$SOURCE_DIR" ] && _exit "Can't found provided directory '$SOURCE_DIR'"
+# Work on source directory:
+cd $SOURCE_DIR
+
+# Must have metadata:
+ls *.*metadata >/dev/null 2>/dev/null
+[ $? -ne 0 ] && _exit "Cannot found '*.*metadata' files on '$SOURCE_DIR' !!"
+
+# Show possible end points if nothing provided:
+END_POINTS="$2"
+if [ -z "$END_POINTS" ]
+then
+  src_eps=( $(grep "^src=" *.*metadata | cut -d= -f2 | sort -u) )
+  [ ${#src_eps[@]} -eq 0 ] && _exit "No source end-points detected: metadata must have an 'src=xxx' line."
+  echo "Input a space-separated list for desired end-points to be processed as test side: "
+  echo " (available source end-points: ${src_eps[*]})"
+  read END_POINTS
+  [ -z "$END_POINTS" ] && _exit "Invalid empty input !!"
+fi
+
+# Identify useful frames: those which are created at test-bed side (all except frames coming from tested systems):
+rm -f *.needed
+for tag in $END_POINTS
+do
+  for metadata in $(grep "^src=$tag$" *.*metadata)
+  do
+    frame=$(echo $metadata | cut -d\. -f1)
+    touch ${frame}.needed
+  done
+done
+ls *.needed >/dev/null 2>/dev/null
+[ $? -ne 0 ] && _exit "No frame has been selected within '$SOURCE_DIR' for provided end-points ($END_POINTS) !!"
+
+# Messages classification:
+0> cers_4_starting
+0> requests_4_sending
+0> answers_4_programming
+0> $TESTCASE_BN
+
+# Optional timeout:
+TIMEOUT_SEC=$3
+[ -n "$TIMEOUT_SEC" ] && echo "test|1|timeout|$((TIMEOUT_SEC * 1000))" >> $TESTCASE_BN
+
+# Process frames:
+for frame in `ls *.needed | cut -d\. -f1 | sort -n`
+do
+  file=( `ls ${frame}.*metadata 2>/dev/null` )
+  [ ${#file[@]} -ne 1 ] && _exit "There must be one metadata file corresponding to frame '$frame' !!"
+  
+  # Ignore keep alives:
+  grep -q "^code=280$" $file
+  [ $? -eq 0 ] && continue
+  
+  grep -q "^isrequest=1$" $file
+  if [ $? -eq 0 ]
+  then
+    grep -q "^code=257$" $file
+    [ $? -eq 0 ] && { echo $frame >> cers_4_starting ; continue ; }
+    echo $frame >> requests_4_sending
+    update_testcase $frame check_result_code
+  else
+    # Ignore CEA's:
+    grep -q "^code=257$" $file
+    [ $? -eq 0 ] && continue
+    echo $frame >> answers_4_programming
+    update_testcase $frame
+  fi
+done
+rm -f *.needed
+
+# We will replace all the requests hop-by-hop's with a unique value, to avoid bad sniffing cases (different sources using bad values).
+# For example, the frame number could be valid enough.
+hbh_ini=
+hbh_fin=
+# involved frames:
+grep sendxml $TESTCASE_BN > .involved_frames
+n_involved=`wc -l .involved_frames | awk '{ print $1 }'`
+count=1
+for frame in `cat .involved_frames | cut -d\| -f4 | cut -d\. -f1`
+do
+  xml=( `ls ${frame}.*xml` )
+  mtd=( `ls ${frame}.*metadata` )
+  isrequest=$(grep "isrequest=1" $mtd)
+  if [ -n "$isrequest" ]
+  then
+    hbh_ini="$(grep -o "hop-by-hop-id=\"[0-9]*\"" $xml)"
+    sed -i 's/'$hbh_ini'/hop-by-hop-id="'$frame'"/' $xml
+  fi
+  count=$((count+1))
+done
 
-# UNDER CONSTRUCTION
-# .........