################################################################################
#                                                                              #
#    Copyright 1997 - 2020 by IXIA  Keysight                                   #
#    All Rights Reserved.                                                      #
#                                                                              #
################################################################################

################################################################################
#                                                                              #
#                                LEGAL  NOTICE:                                #
#                                ==============                                #
# The following code and documentation (hereinafter "the script") is an        #
# example script for demonstration purposes only.                              #
# The script is not a standard commercial product offered by Ixia and have     #
# been developed and is being provided for use only as indicated herein. The   #
# script [and all modifications, enhancements and updates thereto (whether     #
# made by Ixia and/or by the user and/or by a third party)] shall at all times #
# remain the property of Ixia.                                                 #
#                                                                              #
# Ixia does not warrant (i) that the functions contained in the script will    #
# meet the user's requirements or (ii) that the script will be without         #
# omissions or error-free.                                                     #
# THE SCRIPT IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, AND IXIA        #
# DISCLAIMS ALL WARRANTIES, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE,          #
# INCLUDING BUT NOT LIMITED TO ANY WARRANTY OF MERCHANTABILITY AND FITNESS FOR #
# A PARTICULAR PURPOSE OR OF NON-INFRINGEMENT.                                 #
# THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SCRIPT  IS WITH THE #
# USER.                                                                        #
# IN NO EVENT SHALL IXIA BE LIABLE FOR ANY DAMAGES RESULTING FROM OR ARISING   #
# OUT OF THE USE OF, OR THE INABILITY TO USE THE SCRIPT OR ANY PART THEREOF,   #
# INCLUDING BUT NOT LIMITED TO ANY LOST PROFITS, LOST BUSINESS, LOST OR        #
# DAMAGED DATA OR SOFTWARE OR ANY INDIRECT, INCIDENTAL, PUNITIVE OR            #
# CONSEQUENTIAL DAMAGES, EVEN IF IXIA HAS BEEN ADVISED OF THE POSSIBILITY OF   #
# SUCH DAMAGES IN ADVANCE.                                                     #
# Ixia will not be required to provide any software maintenance or support     #
# services of any kind (e.g., any error corrections) in connection with the    #
# script or any part thereof. The user acknowledges that although Ixia may     #
# from time to time and in its sole discretion provide maintenance or support  #
# services for the script, any such services are subject to the warranty and   #
# damages limitations set forth herein and will not obligate Ixia to provide   #
# any additional maintenance or support services.                              #
#                                                                              #
################################################################################

################################################################################
#                                                                              #
# Description:                                                                 #
#    This sample configures 10 IPv4 sessions on each of the two ports,         # 
#    adds a traffic Item that uses IPv4 endpoints, sends traffic,              #
#    using statistics, the performs the following actions:                     #
#    - enable/disable CSV Logging                                              #
#    - Add Formula Column to view                                              #
#    - Edit the Formula Column added to view                                   #
#    - Take a Snapshot CSV for view Flow Statistics                            #
#    - Check the Tx Frames = Rx Frames for each IPv4 source address            #
#                                                                              #
################################################################################

namespace eval ::py {
     set ixTclServer 10.212.111.211
     set ixTclPort   8009
     set ports       {{10.212.111.180 3 1} {10.212.111.180 4 1}}
}

################################################################################
# Source the IxNet library
################################################################################
package req IxTclNetwork

################################################################################
# Connect to IxNet client
################################################################################

ixNet connect $::py::ixTclServer -port $::py::ixTclPort -version 7.40

################################################################################
# Cleaning up IxNetwork
################################################################################
puts "Cleaning up IxNetwork..."
ixNet exec newConfig

################################################################################
# Adding ports to configuration
################################################################################
puts "Adding ports to configuration"
set root [ixNet getRoot]
ixNet add [ixNet getRoot] vport
ixNet add [ixNet getRoot] vport
ixNet commit
set vPorts [ixNet getList [ixNet getRoot] vport]
set vport1 [lindex $vPorts 0]
set vport2 [lindex $vPorts 1]

################################################################################
# Configuring IPv4
################################################################################
puts "Add topologies"
ixNet add [ixNet getRoot] topology
ixNet add [ixNet getRoot] topology
ixNet commit

set topo1 [lindex [ixNet getList [ixNet getRoot] topology] 0]
set topo2 [lindex [ixNet getList [ixNet getRoot] topology] 1]

puts "Add ports to topologies"
ixNet setA $topo1 -vports $vport1
ixNet setA $topo2 -vports $vport2
ixNet commit

puts "Add device groups to topologies"
ixNet add $topo1 deviceGroup
ixNet add $topo2 deviceGroup
ixNet commit

set dg1 [ixNet getList $topo1 deviceGroup]
set dg2 [ixNet getList $topo2 deviceGroup]

puts "Add Ethernet stacks to device groups"
ixNet add $dg1 ethernet
ixNet add $dg2 ethernet
ixNet commit

set mac1 [ixNet getList $dg1 ethernet]
set mac2 [ixNet getList $dg2 ethernet]

puts "Add ipv4 stacks to Ethernets"
ixNet add $mac1 ipv4
ixNet add $mac2 ipv4
ixNet commit

set ipv4_1 [ixNet getList $mac1 ipv4]
set ipv4_2 [ixNet getList $mac2 ipv4]

puts "Setting multi values for ipv4 addresses"
ixNet setMultiAttribute [ixNet getAttribute $ipv4_1 -address]/counter -start 22.1.1.1 -step 0.0.1.0
ixNet setMultiAttribute [ixNet getAttribute $ipv4_1 -gatewayIp]/counter -start 22.1.1.2 -step 0.0.1.0
ixNet setMultiAttribute [ixNet getAttribute $ipv4_1 -resolveGateway]/singleValue -value true
ixNet setMultiAttribute [ixNet getAttribute $ipv4_2 -address]/counter -start 22.1.1.2 -step 0.0.1.0
ixNet setMultiAttribute [ixNet getAttribute $ipv4_2 -gatewayIp]/counter -start 22.1.1.1 -step 0.0.1.0
ixNet setMultiAttribute [ixNet getAttribute $ipv4_2 -resolveGateway]/singleValue -value true
ixNet commit

################################################################################
# Create Traffic for IPv4
################################################################################
puts ''
puts "Creating Traffic for IPv4"

ixNet add [ixNet getRoot]/traffic trafficItem
ixNet commit
set ti1 [lindex [ixNet getList [ixNet getRoot]/traffic trafficItem] 0]
ixNet setMultiAttribute $ti1                \
        -name                 "Traffic IPv4"\
        -trafficType          ipv4          \
        -allowSelfDestined    False         \
        -trafficItemType      l2L3          \
        -mergeDestinations    True          \
        -egressEnabled        False         \
        -srcDestMesh          manyToMany    \
        -enabled              True          \
        -routeMesh            fullMesh      \
        -transmitMode         interleaved   \
        -biDirectional        True          \
        -hostsPerNetwork      1
ixNet commit
ixNet setAttribute $ti1 -trafficType ipv4
ixNet commit
ixNet add $ti1 endpointSet              \
        -sources             $ipv4_1    \
        -destinations        $ipv4_2    \
        -name                "ep-set1"  \
        -sourceFilter        {}         \
        -destinationFilter   {}
ixNet commit
ixNet setMultiAttribute $ti1/configElement:1/frameSize \
        -type        fixed                             \
        -fixedSize   128
ixNet setMultiAttrs $ti1/configElement:1/frameRate   \
        -type       percentLineRate                         \
        -rate       100                                      \

ixNet setMultiAttrs $ti1/configElement:1/transmissionControl \
    -duration               1                                   \
    -iterationCount         1                                   \
    -startDelayUnits        bytes                               \
    -minGapBytes            12                                  \
    -frameCount             1000                               \
    -type                   continuous                     \
    -interBurstGapUnits     nanoseconds                         \
    -interBurstGap          0                                   \
    -enableInterBurstGap    False                               \
    -interStreamGap         0                                   \
    -repeatBurst            1                                   \
    -enableInterStreamGap   False                               \
    -startDelay             0                                   \
    -burstPacketCount       1

ixNet setMultiAttribute $ti1/tracking -trackBy {{ipv4SourceIp0}}
ixNet commit

################################################################################
# Assign ports 
################################################################################
set vPorts [ixNet getList [ixNet getRoot] vport]
puts "Assigning ports to $vPorts"
::ixTclNet::AssignPorts $py::ports {} $vPorts force

################################################################################
# Start All Protocols
################################################################################
puts "Starting All Protocols"
ixNet exec startAllProtocols
puts "Sleep 30sec for protocols to start"
after 30000

################################################################################
# Generate, apply and start traffic
################################################################################
ixNet exec generate $ti1
ixNet exec apply [ixNet getRoot]/traffic
ixNet exec start [ixNet getRoot]/traffic
puts "Sleep 30sec to send all traffic"
after 30000

################################################################################
# Define function to get the view object using the view name
################################################################################
proc getViewObject {viewName} {
    set views [ixNet getL [ixNet getRoot]/statistics view]
    set viewObj ""
    set editedViewName "::ixNet::OBJ-/statistics/view:\"$viewName\""
    if {[lsearch -regexp -inline $views $viewName] != ""} {
        return [lsearch -regexp -inline $views $viewName]
    }
    return $viewObj
}

################################################################################
# Define function to get the values for the statistics in the view
################################################################################

proc getValuesForStatInView {viewName statName} {
    puts "Get the stats for $statName in view $viewName"
    set views [ixNet getL [ixNet getRoot]/statistics view]
    set viewObj [getViewObject $viewName]
    set returned_values [ixNet exec getColumnValues $viewObj $statName]
    return $returned_values
}

################################################################################
# Define function to get all the statistics in the view
################################################################################

proc getAllStatsInView {viewName} {
    puts "Get the stats for $viewName"
    set mview [getViewObject $viewName]
    set mpage [lindex [ixNet getList $mview "page"] 0]
    set mrowvalues [ixNet getAttribute $mpage -rowValues]
    return $mrowvalues
}

################################################################################
# Define function to create a Snapshot CSV
################################################################################

proc takeViewCSVSnapshot { viewName {csvPath "C:/Snapshot_CSV"} {csvType "currentPage" } } {
    set pc_time [clock format [clock sec] -format "%Y_%m_%d_%H_%M"]
    set csvName "$viewName\_$pc_time"
    puts "Take Snapshot CSV"
	set location [file join $csvPath [lindex [split [info script] .] end-1]]
    set SnapSettingList [subst -nobackslashes {{Snapshot.View.Csv.Name: $csvName} {Snapshot.View.Csv.Location: $location} {Snapshot.View.Csv.GeneratingMode: "kOverwriteCSVFile"} { Snapshot.Settings.Name: $viewName } {Snapshot.View.Contents: $csvType }}]
    puts "$SnapSettingList"
    ixNet exec TakeViewCSVSnapshot \"$viewName\" $SnapSettingList
    puts "Snapshot CSV complete"
}

################################################################################
# Define function to Enable CSV Logging
################################################################################
proc setEnableCsvLogging {{state "False"}} {
    puts "Set enableCsvLogging to $state"
    ixNet setA [ixNet getRoot]/statistics -enableCsvLogging $state
    ixNet commit
}

################################################################################
# Define function to add formula column
################################################################################
proc addFormulaColumn {viewName columnName formula} {
    puts "Insert $columnName to $viewName as view"
    puts "Formula $formula"
    set viewObj [getViewObject $viewName]
    set formulaColumn [ixNet add $viewObj/formulaCatalog formulaColumn]
    ixNet setAttribute $formulaColumn -caption $columnName
    ixNet setAttribute $formulaColumn -formula $formula
    ixNet commit
}

################################################################################
# Define function to edit a formula column
################################################################################
proc editFormulaColumn {viewName columnName formula} {
    puts "Edit $columnName formula column $viewName in view"
    puts "New formula $formula"
    set viewObj [getViewObject $viewName]
    set formulaColumns [ixNet getL $viewObj/formulaCatalog formulaColumn]
    foreach column $formulaColumns {
        if {[ixNet getA $column -caption] == $columnName} {
        ixNet setAttribute $column -formula $formula
        ixNet commit
        }
     }
}
################################################################################
# Define procedure to parse a string
################################################################################

proc extractKString { in_str } {
    regsub -all kString, $in_str {} in_str
    regsub -all \{ $in_str {} in_str
    regsub -all \} $in_str {} in_str
    #set in_str [split $in_str ,]
    return $in_str
}

################################################################################
# Define function to compare 2 stats
################################################################################
proc compareTwoStats {viewName statA statB} {
    puts "Compare $statA = $statB"
    set stA [getValuesForStatInView $viewName $statA]
    set statsA [regexp -all -inline {\w+} [split $stA {::ixNet::OK-{kArray,{{kString,}]]}}}]]
    puts $statsA
    set stB [getValuesForStatInView $viewName $statB]
    set statsB [regexp -all -inline {\w+} [split $stB {::ixNet::OK-{kArray,{{kString,}]]}}}]]
    puts $statsB
    set ipv4source [getValuesForStatInView $viewName "\"IPv4 :Source Address\""]
    set ipv4source1 [extractKString $ipv4source]
    foreach ip $ipv4source1 st1 $statsA st2 $statsB {
        if {$st1 == $st2} {
            puts "Source IP: $ip --> OK"        
        } else { 
            puts "Source IP: $ip --> Failed $statA = $st1, $statB = $st2"
        }
    }
}



################################################################################
# Enable CSV Logging across all views 
################################################################################

puts "Enable CSV Logging across all views"
setEnableCsvLogging "True"

set viewName "Flow Statistics"

################################################################################
# Add Formula Column to view
################################################################################

puts "Add Formula Column to view"
addFormulaColumn "$viewName" "Formula Column Name:" "=\"Tx Frames\" * 2"


################################################################################
# Edit the Formula Column added to view
################################################################################

puts  "Edit the Formula Column added to view"
editFormulaColumn "$viewName" "Formula Column Name:" "=\"Tx Frames\" * 3"

################################################################################
# Create a Snapshot CSV for view
################################################################################

puts  "Take a Snapshot CSV for view $viewName"
takeViewCSVSnapshot "$viewName"

################################################################################
# Check the Tx Frames = Rx Frames for each IPv4 source address
################################################################################

puts  "Check the Tx Frames = Rx Frames for each IPv4 source address"
compareTwoStats "$viewName" "Tx Frames" "Rx Frames"

################################################################################
# Disable CSV Logging across all views"
################################################################################

puts "Disable CSV Logging across all views"
setEnableCsvLogging "False"