mu 5.7.2.3

data/lib/mu/api/netconfig.rb

@@ -0,0 +1,233 @@
+class Mu
+class Netconfig
+  include Helper
+  
+  attr_accessor :host, :username, :password, :docroot, :element, :response, :config
+
+  def initialize(host=ENV['MU_IP'], username=ENV['MU_ADMIN_USER'], password=ENV['MU_ADMIN_PASS'])
+    @host = host
+    @username  = username
+    @password  = password
+    @docroot = "/restlet/netconfig/"
+    @response = nil
+    @http = HttpHelper.new(@host, @username, @password, @docroot)
+    @element = "" # sticky variable will hold a default element, the last element specified
+    msg "Created Netconfig API object to :#{@host}", Logger::DEBUG
+  end
+
+  # get - with no params, returns the entire netconfig json object
+  #  * e = the element to retrieve (interfaces|hosts|routes, interfaces/a1 ...)
+  def get(e)   
+    response = @http.get_json(e)
+    msg response, Logger::DEBUG
+    return response
+  end
+
+  # PUT to modify netconfig element(s) to json values
+  #  * json = the json string containing the modified values
+  #  * e = the element to modify (interfaces|hosts|routes)
+  def modify(json, e)
+    response = do_modify(json, e)
+    msg response, Logger::DEBUG
+    return response
+=begin
+    jstring = json
+    @element = e
+    unless json.is_a? String
+      jstring = JSON.generate json
+    end
+    response = @http.put_json(e, jstring)
+    msg response, Logger::DEBUG
+    return response
+=end
+  end
+
+  # POST method to add a network element
+  #  * json = the json string containing the element values
+  #  * e = the element to create (interfaces|hosts|routes)
+  def create(json, e)   
+    jstring = json  
+    unless json.is_a? String
+      jstring = JSON.generate json
+    end
+    response = @http.post_json(e, jstring)
+    msg response, Logger::DEBUG
+    return response
+  end
+
+  # deletes the specified element
+  #  * e = the element to delete
+  def delete(e)
+    response = @http.delete(e)
+    msg response, Logger::DEBUG
+    return response
+  end
+
+  # updates a network configuration from file
+  #  * filepath = the path to the json file
+  #  * clear_existing - boolean determining whether or not existing elements should be cleared
+  def restore(filepath=nil,clear_existing=false)
+    unless filepath.nil?
+      @config = JSON.parse(File.read(filepath))
+    end
+    @config.each do |c|
+      case c.keys[0]
+      when "hosts"
+        msg "RESTORE HOSTS", Logger::DEBUG
+        clear_existing and clear_hosts
+        restore_hosts c["hosts"]
+      when "routes"
+        msg "RESTORE ROUTES", Logger::DEBUG
+        clear_existing and clear_routes
+        restore_routes c["routes"]
+      when "interfaces"
+        clear_existing and clear_vlans
+        msg "RESTORE INTERFACES", Logger::DEBUG
+        restore_interfaces c["interfaces"]
+      end
+    end
+  end
+
+  # clears the network hosts
+  def clear_hosts    
+    h = get("hosts")
+    h["hosts"].each do |h|
+      msg "Clear host: #{h['name']}", Logger::DEBUG
+      delete("hosts/#{h['name']}")
+    end
+  end
+
+  # restores the network hosts to the initial system states
+  def restore_hosts(hosts)  
+    hosts.each do |h|
+      msg "create host: #{h['name']}", Logger::DEBUG
+      delete "hosts/#{h['name']}" # harmlessly fails when host does not exist
+      create(h,"hosts")
+    end
+  end
+
+  # use Dns to update host ip addresses.
+  # A new Host is added if not present when the name is provided as argument
+  #  * name = the name of the host to resolve
+  def resolve_hosts(name=nil)  
+    hosts = Array.new
+    if name.nil?
+      hst = get "hosts"
+      hst["hosts"].each {|h| hosts << h["name"]}
+    else
+      hosts << name
+    end
+    hosts.each do |h|
+      msg "resolve host: #{h}", Logger::DEBUG
+      v4_addr = Socket::gethostbyname(h)[3].unpack("CCCC").join(".") rescue nil
+      next if v4_addr.nil?
+      json = get "hosts/#{h}"
+      if json["name"].nil?
+        json = {"name" => h, "v4_addr" => v4_addr}
+        create json, "hosts"
+      else
+        json["v4_addr"] = v4_addr
+        modify json, "hosts/#{h}"
+      end
+    end
+  end
+
+  # clears a network interface
+  #  * interface = the name of the interface to clear
+  def clear_interface(interface)
+    interface = interface
+    json = { "v4_addrs"=>[], "v4_mask"=>"", "v4_dhcp"=>false,
+      "v6_global_addrs"=>[], "v6_global_mask"=>""}
+    modify json,"interfaces/#{interface}"
+  end
+
+  # clears all network vlans
+  def clear_vlans
+    i = get "interfaces"
+    i["interfaces"].each do |i|
+      next if i['vlan'] == ""
+      msg "Clear vlan: #{i['name']}", Logger::DEBUG
+      delete "interfaces/#{i['name']}"
+    end
+  end
+
+  # restores network interfaces to system initial settings
+  #   * interfaces - the names of the interfaces to restore
+  def restore_interfaces(interfaces)  
+    interfaces.each do |i|
+      next if i['name'].include? "eth" # don't do eth0 or eth1
+      msg "configure interface: #{i['name']}", Logger::DEBUG
+      unless i['vlan'] == ""
+        interface,vlan = i['name'].split(".")
+        create [{"name"=>interface,"vlan"=>vlan},"interfaces"]
+      end
+      modify [i,"interfaces/#{i['name']}"]
+    end
+  end
+
+  # clears network routes
+  def clear_routes  
+    routes = get "routes"
+    routes["routes"].each do |r|
+      next if r['readonly'] == true
+      msg "Clear route: #{r['dst']}-#{r['gateway']}-#{r['interface_display_name'].downcase}", Logger::DEBUG
+      delete "routes/#{r['dst']}-#{r['gateway']}-#{r['interface_display_name'].downcase}"
+    end
+  end
+
+  # restores network routes to system initial settings
+  def restore_routes(routes)  
+    routes.each do |r|
+      next if r['readonly'] == true
+      msg "configure route: #{r['dst']}-#{r['gateway']}-#{r['interface_display_name'].downcase}", Logger::DEBUG
+      create r,"routes"
+    end
+  end
+
+  # writes the json config to filepath
+  #  * e = the element to save, or 'all'
+  #  * filepath - the fully qualified name of the file to save to
+  def save(e="all", filepath="config.json")   
+    json = get e
+    File.open(filepath,'w'){|f| f.write(JSON.pretty_generate(json))}
+  end
+
+private
+
+# restclient put was not recgonized as json
+# PUT to modify netconfig element(s) to json values
+  def do_modify(json, e)
+    jstring = json
+    unless json.is_a? String
+      jstring = JSON.generate json
+    end
+    msg jstring, Logger::DEBUG
+    uri = URI.parse("https://#{@host}")
+    escaped = URI.escape("#{@docroot}#{e}")
+    msg "Put: #{uri}#{escaped}", Logger::DEBUG
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    http.start do |http|
+      req = Net::HTTP::Put.new("#{escaped}",initheader = {"User-Agent" => @username, 'Content-Type' => 'application/json; charset=utf-8'})
+      req.body = jstring
+      response = http_request(http, req)
+    end
+    msg response, Logger::DEBUG
+    return response
+  end
+
+  def http_request(http, req)
+    req.basic_auth(@username, @password)
+    response = http.request(req)
+    if response.code != "200"
+      return "Error status code #{response.code}\n#{response.body}"
+    end
+    return response.body
+  end
+
+
+end 
+end # Mu
+
+

data/lib/mu/api/scale.rb

@@ -0,0 +1,199 @@
+class Mu
+class Scale
+  include Helper
+
+  attr_accessor :host, :username, :password, :docroot, :configuration, :config_file, :uuid
+
+  def initialize(host=ENV['MU_IP'], username=ENV['MU_ADMIN_USER'], password=ENV['MU_ADMIN_PASS'])
+    @host = host
+    @username  = username
+    @password  = password
+    @docroot = "/api/v5/scale/"
+    @uuid = nil
+    @http = HttpHelper.new(@host, @username, @password, @docroot)
+    @config_file = (ENV['SCALE_CONFIG_FILE'].nil?) ? "scale.json" : ENV['SCALE_CONFIG_FILE']
+    if File.readable? @config_file
+      msg "reading config file: #{@config_file}", Logger::DEBUG
+      @configuration = JSON.parse File.read(@config_file)
+    else
+      @configuration = {
+        "hosts"=> {
+          "host_0"=> "a1/*",
+          "host_1"=> "a2/*"
+        },
+        "timeout"=> 5000,
+        "delay"=> 0,
+        "volume"=> 1,
+        "holdConcurrency"=> true,
+        "limitConcurrency"=> false,
+        "vectorAddressPairing"=> false,
+        "musl" => "",
+        "csv" => "",
+        "pattern" => {}
+      }
+    end
+    @uuid = session
+    msg "Created Scale Api session [#{@uuid}] on :#{@host}", Logger::DEBUG
+  end
+
+  # creates a new Studio Scale session, returning the session id
+  def session
+     uuid = nil
+     list = get("list")
+     if !list.empty?
+         msg list
+         uuid = list[0]  # return existing session identifier if there is one
+         return uuid
+     end
+     uuid = get "new" # return a new session identifier
+     msg "uuid from /new = #{uuid}"
+     return uuid
+  end
+
+  # configures a parameter in the class @configuration object
+  #   * param = the parameter to configure (e.g. volume)
+  #   * value = the parameter's value ( e.g. 100)
+  def configure(param, value)
+     if param == "pattern" and value.is_a?(String)
+         value = JSON.parse(value)
+     end
+     @configuration[param] = value
+     File.open("scale_configuration.json",'w'){|f| f.write(JSON.pretty_generate(@configuration))}
+  end
+
+  # starts a scale test with the class @configuration object
+  def start
+      response = post "start", {"request" => @configuration}
+      msg response, Logger::DEBUG
+      return response
+  end
+
+  # verifies the class @configuration object
+  def verify
+      response = post "verify", {"request" => @configuration}
+      msg response, Logger::DEBUG
+      return response
+  end
+
+  # updates a running scale test, as long as the test pattern is 'none'
+  #   * params = a json object containing the information to update, such as { "volume" : 100 }
+  def update(params)
+      response = get "update", params
+      msg response, Logger::DEBUG
+      return response
+  end
+
+  # gets information about the currently running Scale test.
+  def status
+      response = get "status"
+      msg response, Logger::DEBUG
+      return response
+  end
+
+  # returns the current Scale Player's session id
+  def list
+      response = get "list"
+      msg response, Logger::DEBUG
+      return response
+  end
+
+  # lists information about the the Scale Player and all active and inactive Scale Engines
+  def about
+      response = get "about"
+      msg response, Logger::DEBUG
+      return response
+  end
+
+  # returns a packet capture file from scale verify
+  #   * bot_id = the id of the scale engine
+  #   * file = the name of the pcap file to retrieve
+  def pcap(bot_id, file)
+      response = get "pcap", "botId=#{bot_id}&file=#{file}"
+      msg response, Logger::DEBUG
+      return response
+  end
+
+  # gets the status of all active and inactive Scale engines
+  def statuses
+      response = get "statuses"
+      msg response, Logger::DEBUG
+      return response
+  end
+
+  # gets chart data for the Scale test
+  #   * view = the TIMELINE or CALLGRAPH chart.
+  #   * zoom = the zoom level (0 to 1). 1 returns data for 100% of the time range, 0.5 returns data for 50% of the time range, and 0 returns only the last minute of data
+  #   * position = 0.
+  #   * bot_id = the scale engine id
+  def data(view='TIMELINE', zoom="0", position="0", bot_id="")
+      response = get "data", "view=#{view.upcase}&zoom=#{zoom}&position=#{position}&bot_id=#{bot_id}"
+      msg response, Logger::DEBUG
+      return response
+  end
+
+  # returns scale test data for charting
+  #  * command-line args require a zoom level and position(0)
+  #   * zoom = the zoom level (0 to 1). 1 returns data for 100% of the time range, 0.5 returns data for 50% of the time range, and 0 returns only the last minute of data
+  #   * position = 0.
+  def pattern(zoom="0", position="0")
+      response = get "pattern", "zoom=#{zoom}&position=#{position}"
+      msg response, Logger::DEBUG
+      return response
+  end
+
+  # stops a scale test
+  def stop
+      response = get "stop"
+      msg response, Logger::DEBUG
+      return response
+  end
+
+  # releases the scale player
+  def release
+      response = get "release"
+      msg response, Logger::DEBUG
+      return response
+  end
+
+  # marks the specified Scale Engine as active (will participate in a Scale test
+  #  * bot_id = the scale engine id
+  def reserve_scale_engine(bot_id)
+      response = get "reserveScaleEngine", "botId=#{bot_id}"
+      msg response, Logger::DEBUG
+      return response
+  end
+
+  # marks the specified Scale Engine as inactive (will not participate in a Scale test)
+  #  * bot_id = the scale engine id
+  def release_scale_engine(bot_id)
+      response = get "releaseScaleEngine", "botId=#{bot_id}"
+      msg response, Logger::DEBUG
+      return response
+  end
+
+  # removes a Scale engine from the list of available engines
+  #  * bot_id = the scale engine id
+  def delete_scale_engine(bot_id)
+      response = get "deleteScaleEngine", "botId=#{bot_id}"
+      msg response, Logger::DEBUG
+      return response
+  end
+
+private
+
+  def get(e=@element, params=nil)
+      element = e
+      element << "?uuid=#{@uuid}" unless @uuid.nil?
+      element << "&#{params}" unless params.nil?
+      return @http.get_json(element)
+  end
+
+  # POST method
+  def post(e, json='{}')
+      element = e
+      element << "?uuid=#{@uuid}"
+      @http.post_json(element, JSON.generate(json))
+  end
+  
+end
+end

data/lib/mu/api/system.rb

@@ -0,0 +1,40 @@
+class Mu
+class System
+  include Helper
+
+  attr_accessor :host, :docroot, :username, :password
+
+  def initialize(host=ENV['MU_IP'], username=ENV['MU_ADMIN_USER'], password=ENV['MU_ADMIN_PASS'])
+    @host = host
+    @username  = username
+    @password  = password
+    @docroot = "/api/v5/system/"
+    @cookie = ""
+    @response = nil
+    @http = HttpHelper.new(@host, @username, @password, @docroot)
+    msg "Created System Api object to :#{@host}", Logger::DEBUG
+  end
+
+  # restarts the Mu system
+  def restart
+    response = @http.get("restart/")
+    msg response, Logger::DEBUG
+    return response
+  end
+
+  # returns Mu System status
+  def status
+    response =  @http.get("status/")
+    msg response, Logger::DEBUG
+    return response
+  end
+
+  # returns more Mu System status
+  def status2
+    response = @http.get("status2/")
+    msg response, Logger::DEBUG
+    return response
+  end
+ 
+end 
+end # Mu