Cer and cea helper
[anna.git] / example / diameter / launcher / resources / scripts / tinyTestcase.sh
index e08120f..08145fd 100755 (executable)
@@ -4,6 +4,8 @@
 # VARIABLES #
 #############
 SCR_DIR=`readlink -f $0 | xargs dirname`
+TESTCASE_BN=testcase.txt
+WHAT=?????????
 
 #############
 # FUNCTIONS #
@@ -16,19 +18,22 @@ _exit() {
 }
 
 usage() {
-  echo "Usage: $0 <source directory>"
   echo
-  echo "       The source directory may contain .xml and .metadata files grouped by pairs and alphabetically classified:"
+  echo "Usage: $0 <source_directory> \"[test_end_points]\" [timeout]"
   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 "       source_directory:"
   echo
-  echo "       Normally the order comes from first dot-separated part, which is the decoded frame from pcap:"
+  echo "         The source directory may contain .xml and .metadata files grouped by pairs and alphabetically classified:"
   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 "            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 "         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 +43,311 @@ 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 corresponding result codes (normally 2001)"
+  echo "         if those answers are provided (2001 will be assigned as result-code condition if no answer is found)."
+  echo "         CER/A are 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 "       timeout:"
   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 in seconds for the testcase. If not provided, no timeout will be programmed for the testcase."
   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
-  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 "       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'."
+  echo
+  echo "       PCAPS WITHOUT CER/CEA MESSAGES:"
+  echo
+  echo "       There is a helper tool to build CER/CEA messages for involved origin hosts. This is useful when the"
+  echo "       pcap file analyzed miss the capabilities exchange messages: touch the file 'create_cer_and_cea' inside"
+  echo "       the source directory, and follow the instructions." 
   _exit
 }
 
+# $1: xml file
+getOriginHost () {
+  grep "<avp name=\"Origin-Host\"" $1 | cut -d\" -f4
+}
+# $1: xml file
+# Nested Result-Code's not supported here (i.e. charging application)
+getResultCode () {
+  grep "<avp name=\"Result-Code\"" $1 | awk -F'data=' '{ print $2 }' | cut -d\" -f2
+}
+# $1: metadata file; $2: xml file; $3: 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
+  local mtd=$1
+  local xml=$2
+  local resultcode=$3
+
+  # Ignore disconnect peer messages on testcase format (they have no session-id):
+  grep "^code=282$" $mtd > /dev/null
+  [ $? -eq 0 ] && return
+
+  local code=$(grep ^code $mtd | cut -d= -f2)
+  local isrequest=$(grep ^isrequest $mtd | cut -d= -f2)
+  local sessionid=$(grep Session-Id $xml | cut -d\" -f4)
+  local lines=$(wc -l $TESTCASE_BN | awk '{ print $1 }')
+
+  local 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
+    if [ -n "$resultcode" ]
+    then
+      local hbh="$(grep -o "hop-by-hop-id=\"[0-9]*\"" $xml)"
+      local hbh_matchs=( $(grep -l "$hbh" *.xml) )
+      local ans_xml=${hbh_matchs[1]}
+      local rc=2001
+      if [ -n "$ans_xml" ]
+      then 
+        _rc=$(getResultCode $ans_xml)
+        [ -n "$_rc" ] && rc=$_rc
+      fi
+      s_waitfe="${s_waitfe}|${rc}"
+    fi
+    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."
+  if [ ${#src_eps[@]} -eq 1 ]
+  then
+    END_POINTS=$src_eps
+    echo "Detected a unique end-point: $END_POINTS"
+  else
+    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
+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> ceas_4_establishing
+0> cers_4_starting_origin_hosts
+0> ceas_4_establishing_origin_hosts
+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
+  mtd=( `ls ${frame}.*metadata 2>/dev/null` )
+  [ ${#mtd[@]} -ne 1 ] && _exit "There must be one metadata file corresponding to frame '$frame' !!"
+  xml=( `ls ${frame}.*xml 2>/dev/null` )
+  [ ${#xml[@]} -ne 1 ] && _exit "There must be one xml message file corresponding to '$mtd' (frame '$frame') !!"
+
+  # Ignore keep alives:
+  grep -q "^code=280$" $mtd
+  [ $? -eq 0 ] && continue
+  
+  grep -q "^isrequest=1$" $mtd
+  if [ $? -eq 0 ]
+  then
+    # CER's:
+    grep -q "^code=257$" $mtd
+    if [ $? -eq 0 ]
+    then
+      echo $frame >> cers_4_starting
+      originHost=$(getOriginHost $xml)
+      [ -z "$originHost" ] &&  _exit "Missing Origin-Host (frame $frame, CER message) !!"
+      echo "$originHost" >> cers_4_starting_origin_hosts
+      ln -sf $xml cer.${originHost}.xml
+      continue
+    fi
+    # Other requests:
+    echo $frame >> requests_4_sending
+    update_testcase $mtd $xml check_result_code
+  else
+    # CEA's:
+    grep -q "^code=257$" $mtd
+    if [ $? -eq 0 ]
+    then
+      echo $frame >> ceas_4_establishing
+      originHost=$(getOriginHost $xml)
+      [ -z "$originHost" ] &&  _exit "Missing Origin-Host (frame $frame, CEA message) !!"
+      echo "$originHost" >> ceas_4_establishing_origin_hosts
+      ln -sf $xml cea.${originHost}.xml
+      continue
+    fi
+    # Other answers:
+    echo $frame >> answers_4_programming
+    update_testcase $mtd $xml
+  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:
+involved_xmls=
+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` )
+  involved_xmls="$involved_xmls $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
+
+if [ -f $SOURCE_DIR/create_cer_and_cea ]
+then
+  # PCAPs without CER messages ...
+  if [ ! -s cers_4_starting_origin_hosts ]
+  then
+    if [ $n_involved -ne 0 ]
+    then 
+      grep "<avp name=\"Origin-Host\"" $involved_xmls | cut -d\" -f4 | sort -u > cers_4_starting_origin_hosts
+      for oh in `cat cers_4_starting_origin_hosts`
+      do
+        cer_file=cer.${oh}.xml
+        touch $cer_file
+        echo "WARNING: perhaps you should configure '$cer_file' because it is missing in the pcap file provided."
+        echo "         Currently it contains a basic template but you must fill/fix the unknowns '$WHAT'."
+        cat << EOF > $cer_file
+<message version="1" name="CER" application-id="0" hop-by-hop-id="1" end-by-end-id="1">
+   <avp name="Origin-Host" data="$oh"/>
+   <avp name="Origin-Realm" data="$(echo $oh | cut -d\. -f2-) $WHAT"/>
+   <avp name="Auth-Application-Id" data="16777236 $WHAT 16777238 $WHAT"/>
+   <avp name="Origin-State-Id" data="1"/>
+   <avp name="Host-IP-Address" data="1|192.168.14.42 $WHAT"/>
+   <avp name="Vendor-Id" data="193"/>
+   <avp name="Product-Name" data="afNode $WHAT ggsnNode $WHAT"/>
+   <avp name="Firmware-Revision" data="1"/>
+</message>
+EOF
+      done
+    #else
+    #  echo "WARNING: No 'sendxml' primitives on testcase ??"
+    fi
+  fi
+
+  # PCAPs without CEA messages ...
+  if [ ! -s ceas_4_establishing_origin_hosts ]
+  then
+    if [ $n_involved -ne 0 ]
+    then 
+      grep "<avp name=\"Origin-Host\"" $involved_xmls | cut -d\" -f4 | sort -u > ceas_4_establishing_origin_hosts
+      for oh in `cat ceas_4_establishing_origin_hosts`
+      do
+        cea_file=cea.${oh}.xml
+        touch $cea_file
+        echo "WARNING: perhaps you should configure '$cea_file' because it is missing in the pcap file provided."
+        echo "         Currently it contains a basic template but you must fill/fix the unknowns '$WHAT'."
+        cat << EOF > $cea_file
+<message version="1" name="CEA" application-id="0" hop-by-hop-id="1" end-by-end-id="1">
+   <avp name="Result-Code" data="2001" alias="DIAMETER_SUCCESS"/>
+   <avp name="Origin-Host" data="$oh"/>
+   <avp name="Origin-Realm" data="$(echo $oh | cut -d\. -f2-) $WHAT"/>
+   <avp name="Host-IP-Address" data="1|192.168.12.42 $WHAT"/>
+   <avp name="Vendor-Id" data="193"/>
+   <avp name="Product-Name" data="SAPC"/>
+   <avp name="Supported-Vendor-Id" data="5535"/>
+   <avp name="Supported-Vendor-Id" data="10415"/>
+   <avp name="Auth-Application-Id" data="16777238"/>
+   <avp name="Auth-Application-Id" data="16777236"/>
+   <avp name="Vendor-Specific-Application-Id">
+      <avp name="Vendor-Id" data="10415"/>
+      <avp name="Auth-Application-Id" data="16777238"/>
+   </avp>
+   <avp name="Vendor-Specific-Application-Id">
+      <avp name="Vendor-Id" data="10415"/>
+      <avp name="Auth-Application-Id" data="16777236"/>
+   </avp>
+   <avp name="Firmware-Revision" data="1"/>
+</message>
+EOF
+      done
+    #else
+    #  echo "WARNING: No 'sendxml' primitives on testcase ??"
+    fi
+  fi
+fi
+
+exit 0
 
-# UNDER CONSTRUCTION
-# .........