################################################################################
#                                                                              #
#    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 users 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 script intends to demonstrate how IxNetwork-IxReporter API can be   #
#     used in order to generate a basic html report using default template     #
# Module:                                                                      #
#    The sample was tested on an XMVDC16 module.                               #
################################################################################

set IXN_TCL_SERVER 10.200.113.27
set CHASSIS_IP     10.200.113.61
set PORT_LIST      [list {1 11} {1 12}]

puts " load ixNetwork Tcl API package"
package req IxTclNetwork

puts " connect to ixNetwork Tcl server"
ixNet connect $IXN_TCL_SERVER -port 8009 -version 6.0

puts " load the binary config with 2 ports pre configured with traffic"
ixNet exec loadConfig [ixNet readFrom "ixReporter.ixncfg"]

puts " creating variables for the list of virtual ports and also for each virtual port"
set vport_list [ixNet getList [ixNet getRoot] vport]

set vport1 [lindex $vport_list 0]
set card1 [lindex [lindex $PORT_LIST 0] 0]
set port1 [lindex [lindex $PORT_LIST 0] 1]

set vport2 [lindex $vport_list 1]
set card2 [lindex [lindex $PORT_LIST 1] 0]
set port2 [lindex [lindex $PORT_LIST 1] 1]

puts " assign the virtual ports to real ports"
ixTclNet::AssignPorts [list [list $CHASSIS_IP $card1 $port1] [list $CHASSIS_IP $card2 $port2]] {} [list $vport1 $vport2] force

after 10000
puts " starting ospf"
ixNet exec startAllProtocols

after 10000

puts " apply and start traffic"
ixNet exec apply [ixNet getRoot]/traffic
ixNet exec start [ixNet getRoot]/traffic

puts " let traffic run for 30 sec"
after 30000

puts " stopping traffic"
ixNet exec stop [ixNet getRoot]/traffic

after 10000

puts " configuring reporter settings"
ixNet setMultiAttrs [ixNet getRoot]/reporter/testParameters  \
    -testCategory     "Ixia Demo IxReporter API"             \
    -testDUTName      "No DUT just Ixia ports"               \
    -testerName       "Ixia tester"                          \
    -testHighlights   "Ixia test summary pdf report sample"  \
    -testName         "an Ixia sample"                       \
    -testObjectives   "to demo the IxReporter API"
ixNet commit

ixNet setMultiAttrs [ixNet getRoot]/reporter/generate        \
    -outputFormat    html                                    \
    -outputPath      {c:\summaryReport.html}
puts " -templatePath can be used to specify a custom template"
    
ixNet commit

puts " saving summary results"
ixNet exec saveSummaryResults [ixNet getRoot]/reporter/saveResults

while  {[ixNet getAttribute [ixNet getRoot]/reporter/saveResults -state] != "done"} {
    after  1000
}
    
puts " generating report"    
ixNet exec generateReport [ixNet getRoot]/reporter/generate

while  {[ixNet getAttribute [ixNet getRoot]/reporter/generate -state] != "done"} {
    after  1000
}

puts "report c:\\summaryReport.html generation done"
puts "TEST END ."
puts " "
puts " "
puts " for more info on IxNetwork-IxReporter API please refer to the user manual or the build-in help"
puts " "
puts "ixNet help [ixNet getRoot]/reporter"
puts "[ixNet help [ixNet getRoot]/reporter]"
puts " "
puts "ixNet help [ixNet getRoot]/reporter/testParameters"
puts "[ixNet help [ixNet getRoot]/reporter/testParameters]"
puts " "
puts "ixNet help [ixNet getRoot]/reporter/generate"
puts "[ixNet help [ixNet getRoot]/reporter/generate]"
puts " "
puts "ixNet help [ixNet getRoot]/reporter/saveResults"
puts "[ixNet help [ixNet getRoot]/reporter/saveResults]"