sloe 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8714f8414d785d2b2b4f7bfafb4fe42395568403
-  data.tar.gz: 24c7ae588e8274e03f745a3f761ec5d8dd0cb6a8
+  metadata.gz: 61017b98561bc3dbd93b0d9076c1464af7b29c07
+  data.tar.gz: c9d7d11560e9d05f3f1b90c677a83a3e4ee1f7ab
 SHA512:
-  metadata.gz: 1a58ad9986cfb3753c7501a8fb85f308b097193e7bcf316633b12693cebcaaadd90c2a62a42245c22abe787630248e2fab98b4345f49de7ecfc91e6ec1cc933e
-  data.tar.gz: f11f8457ff51e9743449d3536303cf243c60c9409184f1e15df5b4d76e5ffee4eaf8fe8ab0f67ecf3153f5269209c93cc53730c8ed5939763e81daab4a2cbf2c
+  metadata.gz: a198be45e3772a67e498e289a48698b5dda98782700361ea67a456c51bac8829f79472de3ecbc19732c4304852546395ce8d3569e61873e4872c12a0de3f4202
+  data.tar.gz: 3db695158c963b0e3cc3a3323aa3fedf2941d0e5e04f945efd88892efe2f6a6385dcd16f45478ad209cb25a3dc39b36df045e62e99c97ddf38ed2b01a9c933f4

data/lib/sloe/ixia.rb

@@ -0,0 +1,218 @@
+module Sloe
+  class Ixia
+
+    # Create Sloe::Ixia object. This assumes you have the Ixia Linux TCL library installed
+    # 
+    # @param host [String] IP or DNS name of the Linux TCL server
+    # @param port [FixNum] port number to connect Ixia IxN controller on
+    # @param version [String] version of the IxHal
+    # @param ixncfg [String] path to IxN config file
+    # @param traffic_duration [FixNum] duration that traffic should run for, in seconds
+    # @param ixia_exe [String] path to shell script that executes TCL
+    # @param clear_stats_after [FixNum] number of seconds to wait after configuring protocols before clearing stats
+    # @return [Sloe::Ixia] object that can execute IxN config file
+    def initialize(host: 'localhost', port: 8009, version: nil, ixncfg: nil, traffic_duration: 60, ixia_exe: '/root/ixos/bin/ixia_shell', clear_stats_after: 10)
+      if ixncfg == nil
+        fail ArgumentError, "missing mandatory IxNetwork script"
+      end
+
+      @host = host
+      @port = port
+      @ixncfg = ixncfg
+      @traffic_duration = traffic_duration
+      @ixia_exe = ixia_exe
+      @buildtime = Time.now.to_i
+      # base csv file name on IxN cfg file name
+      @csv_file = File.basename(ixncfg).sub('.ixncfg','')
+      @clear_stats_after = clear_stats_after
+
+      self
+    end
+
+    # Run IxN file and return Ixia stats as a CSV object
+    def run
+      run_setup
+      sleep @clear_stats_after
+      clear_stats
+      sleep @traffic_duration
+      csv = run_stats_gather
+      csv
+    end
+
+    # Load IxN file, start all protocols and then start traffic
+    def run_setup
+      setup_tcl = File.open("/var/tmp/setup-#{@buildtime}", 'w')
+      setup_tcl.write setup
+      setup_tcl.close
+      system "#@ixia_exe /var/tmp/setup-#{@buildtime}"
+      File.delete setup_tcl
+    end
+
+    # Clear all Ixia stats. This removes "invalid" drops observed
+    def clear_stats
+      clear_tcl = File.open("/var/tmp/clear-#{@buildtime}", 'w')
+      clear_tcl.write clear_traffic_stats
+      clear_tcl.close
+      system "#{@ixia_exe} /var/tmp/clear-#{@buildtime}"
+      File.delete clear_tcl
+    end
+
+    # Stop Ixia traffic flows and gather Ixia stats
+    def run_stats_gather
+      stats_tcl = File.open("/var/tmp/stats-#{@buildtime}", 'w')
+      stats_tcl.write finish
+      stats_tcl.close
+      system "#@ixia_exe /var/tmp/stats-#{@buildtime}"
+      File.delete stats_tcl
+      ftp = Net::FTP.new(@host)
+      ftp.login
+      file = "#{@csv_file}.csv"
+      Dir.chdir "#{$log_path}/ixia" do
+        ftp.get "Reports/#{file}"
+      end
+      ftp.delete "Reports/#{file}"
+      ftp.delete "Reports/#{file}.columns"
+      ftp.close
+      CSV.read("#{$log_path}/ixia/#{file}", headers: true)
+    end
+
+    # Just run protocols. Do not start traffic
+    def run_protocols
+      run_proto = File.open("/var/tmp/run-proto-#{@buildtime}", 'w')
+      tcl = connect
+      tcl << load_config
+      tcl << start_protocols
+      tcl << disconnect
+      run_proto.write tcl
+      run_proto.close
+      system "#{@ixia_exe} /var/tmp/run-proto-#{@buildtime}"
+      File.delete run_proto
+    end
+
+    private
+    
+    def setup
+      tcl = connect 
+      tcl << load_config 
+      tcl << start_protocols 
+      tcl << start_traffic 
+      tcl << disconnect
+      tcl
+    end
+
+    def clear_traffic_stats
+      tcl = connect
+      tcl << clear_ixia_traffic_stats
+      tcl << disconnect
+      tcl
+    end
+
+    def finish
+      tcl = connect
+      tcl << stop_traffic
+      tcl << get_stats
+      tcl << disconnect
+      tcl
+    end
+
+    def connect
+      code = <<-TCL.gsub(/^\s+\|/,'')
+        |set VERSION [package require IxTclNetwork]
+        |
+        |ixNet connect #@host -port #@port -version $VERSION
+      TCL
+      code
+    end
+
+    def load_config
+      code = <<-TCL.gsub(/^\s+\|/,'')
+        |ixNet exec loadConfig [ixNet readFrom "#@ixncfg"]
+        |set root [ixNet getRoot]
+        |set vportList [ixNet getList $root vport]
+        |after 120000
+        |ixTclNet::CheckLinkState $vportList doneList
+        |if {[llength $doneList]} {
+        |    puts "Error:  links are not up on $doneList"
+        |    return -1
+        |}
+      TCL
+      code
+    end
+
+    def start_protocols
+      code = <<-TCL.gsub(/^\s+\|/,'')
+        |ixNet exec startAllProtocols
+        |after 30000
+      TCL
+      code
+    end
+
+    def start_traffic
+      code = <<-TCL.gsub(/^\s+\|/,'')
+        |set root [ixNet getRoot]
+        |ixNet exec apply $root/traffic
+        |ixNet exec start $root/traffic
+        |for {set timeOut 10} {$timeOut >= 0} {incr timeOut -1} {
+        |  if {[ixNet getAttr $root/traffic -state] == "started"} {
+        |    break
+        |  }
+        |  update idletasks
+        |  after 1000
+        |}
+      TCL
+      code
+    end
+
+    def clear_ixia_traffic_stats
+      code = <<-TCL.gsub(/^\s+\|/,'')
+        |ixNet exec clearStats
+      TCL
+      code
+    end
+    
+    def stop_traffic
+      code = <<-TCL.gsub(/^\s+\|/,'')
+        |set root [ixNet getRoot]
+        |ixNet exec stop $root/traffic
+        |after 10000
+      TCL
+      code
+    end
+
+    def get_stats
+      code = <<-TCL.gsub(/^\s+\|/,'')
+        |set root [ixNet getRoot]
+        |set stats $root/statistics
+        |set csvWindowsPath "c:\\\\inetpub\\\\ftproot\\\\Reports"
+        |ixNet setAttr $stats -enableCsvLogging "true"
+        |ixNet setAttr $stats -csvFilePath $csvWindowsPath
+        |ixNet setAttr $stats -pollInterval 3
+        |ixNet commit
+        |set li1 [list "Flow Statistics"]
+        |set csvFileName "#{@csv_file}"
+        |set opts [::ixTclNet::GetDefaultSnapshotSettings]
+        |lset opts [lsearch $opts *Location*] [subst {Snapshot.View.Csv.Location: $csvWindowsPath}]
+        |lset opts [lsearch $opts *GeneratingMode*] {Snapshot.View.Csv.GeneratingMode: kAppendCSVFile}
+        |lset opts [lsearch $opts *Settings.Name*] [subst {Snapshot.Settings.Name: $csvFileName}]
+        |lset opts [lsearch $opts *Contents*] {Snapshot.View.Contents: "allPages"}
+        |lappend opts [subst {Snapshot.View.Csv.Name: $csvFileName}]
+        |ixTclNet::TakeViewCSVSnapshot $li1 $opts
+      TCL
+      code
+    end
+
+    def clean_up
+      code = <<-TCL.gsub(/^\s+\|/,'')
+        |cleanUp
+      TCL
+      code
+    end
+
+    def disconnect
+      code = <<-TCL.gsub(/^\s+\|/,'')
+        |ixNet disconnect
+      TCL
+      code
+    end
+  end
+end

data/lib/sloe/version.rb

@@ -1,4 +1,4 @@
 module Sloe
   # Current version
-  VERSION = "0.7.2"
+  VERSION = "0.8.0"
 end

data/sloe.gemspec

@@ -12,10 +12,10 @@ Gem::Specification.new do |gem|
   gem.summary       = %q{A one stop shop for collecting data from a network device using NETCONF or SNMP}
   gem.homepage      = "https://github.com/dgjnpr/Sloe"
 
-  gem.add_dependency('snmp', '>= 1.1.0')
-  gem.add_dependency('netconf', '~> 0.3.1')
-  gem.add_dependency('net-scp', '>= 1.0.4')
-  gem.add_development_dependency('rspec', '>= 2.12.0')
+  gem.add_dependency('snmp', '~> 1.1')
+  gem.add_dependency('netconf', '~> 0.3')
+  gem.add_dependency('net-scp', '~> 1.0')
+  gem.add_development_dependency('rspec', '~> 2.12')
   gem.add_development_dependency('yard')
   # gem.add_development_dependency('pry-debugger')
   gem.add_development_dependency('simplecov')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sloe
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
 platform: ruby
 authors:
 - David Gethings
@@ -14,58 +14,58 @@ dependencies:
   name: snmp
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: netconf
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: net-scp
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.4
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.4
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.12.0
+        version: '2.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.12.0
+        version: '2.12'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -141,6 +141,7 @@ files:
 - lib/sloe.rb
 - lib/sloe/common.rb
 - lib/sloe/device.rb
+- lib/sloe/ixia.rb
 - lib/sloe/junos.rb
 - lib/sloe/version.rb
 - mibs/ACCOUNTING-CONTROL-MIB.yaml