Class: OnosTopologyProvider

Inherits:
ITopologyProvider show all
Defined in:
lib/providers/apis/onos_topology_provider.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(new_uri_resource) ⇒ OnosTopologyProvider

Returns a new instance of OnosTopologyProvider.

Raises:

  • (ArgumentError) 


11
12
13
14
15
 
# File 'lib/providers/apis/onos_topology_provider.rb', line 11

def initialize(new_uri_resource)
      raise ArgumentError, 'No uri recieved as parameter' unless new_uri_resource
      @uri_resource = new_uri_resource
      @topology = Topology.new
end

Instance Attribute Details

#uri_resource ⇒ Object

Returns the value of attribute uri_resource.



9
10
11
 
# File 'lib/providers/apis/onos_topology_provider.rb', line 9

def uri_resource
  @uri_resource
end

Instance Method Details

#add_hosts ⇒ Object

This is the info that represents a Host

{

"id"=>"9A:4A:43:D4:36:45/None", 
"mac"=>"9A:4A:43:D4:36:45", 
"vlan"=>"None", 
"configured"=>false, 
"ipAddresses"=>["10.0.0.1"], 
"location"=>{
  "elementId"=>"of:0000000000000002", 
  "port"=>"1"
}

}



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/providers/apis/onos_topology_provider.rb', line 79

def add_hosts
    hosts_response = get_from_api 'hosts'
    hosts_info = (JSON.parse hosts_response.body)['hosts']
    hosts_info.each_with_index  do |host_info, index|
      
      host = @topology.add_host host_info['id'], host_info['ipAddresses'], host_info['mac']
        
      
      @topology.add_link "Link#{index}host_to_router",
                                  host, 
                                  0,
                                  host_info['location']['elementId'],
                                  host_info['location']['port'].to_i

      @topology.add_link "Link#{index}router_to_host",
                                  host_info['location']['elementId'], 
                                  host_info['location']['port'].to_i,
                                  host,
                                  0                                      
    end        
end

#add_links ⇒ Object

links_between_routers_info is an array of elements of this kind {

"src"=>{
  "port"=>"2",
  "device"=>"of:0000000000000001"
},
"dst"=>{
  "port"=>"3",
  "device"=>"of:0000000000000005"
},
"type"=>"DIRECT",
"state"=>"ACTIVE"

}



116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/providers/apis/onos_topology_provider.rb', line 116

def add_links
    links_between_routers_response = get_from_api 'links'
    links_between_routers_info = (JSON.parse links_between_routers_response.body)['links']
      
    index_offset = @topology.links.size + 1 
    links_between_routers_info.each_with_index do |link_between_routers_info, index|
      @topology.add_link "Link#{index+index_offset}", 
                                 link_between_routers_info['src']['device'],
                                 link_between_routers_info['src']['port'].to_i,
                                 link_between_routers_info['dst']['device'],
                                 link_between_routers_info['dst']['port'].to_i
    end
end

#add_routers ⇒ Object

This is the info that represents a router {

"id"=>"of:0000000000000003", 
"type"=>"SWITCH", 
"available"=>true, 
"role"=>"MASTER", 
"mfr"=>"Nicira, Inc.", 
"hw"=>"Open vSwitch", 
"sw"=>"2.5.0", 
"serial"=>"None", 
"chassisId"=>"3", 
"annotations"=>{
  "managementAddress"=>"127.0.0.1", 
  "protocol"=>"OF_13", 
  "channelId"=>"127.0.0.1:59170"
  }

}



51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/providers/apis/onos_topology_provider.rb', line 51

def add_routers
    #Devices represents either hosts or routers. This function will make difference between them
    devices_response = get_from_api 'devices'
    graph_elements_info = (JSON.parse devices_response.body)['devices']
    graph_elements_info.each do |element_info|
        # To identify if a device is either a router or a host, we can ask for it flows. If the device has no flows, 
        # then it's a host
        flows_response = get_from_api "flows/#{element_info['id']}"
        @topology.add_router element_info['id'] if flows_response.code == 200
    end        
end

#find_link(link_representation_in_path, src_key, dst_key) ⇒ Object 



156
157
158
159
160
161
162
163
164
 
# File 'lib/providers/apis/onos_topology_provider.rb', line 156

def find_link(link_representation_in_path, src_key, dst_key)
  links_found = @topology.topology_elements.select { |elem| 
    (elem.is_a? Link) && 
    (elem.src_element.id == link_representation_in_path['src'][src_key]) && 
    (elem.dst_element.id == link_representation_in_path['dst'][dst_key]) }

  raise "It was suppossed to find one link with the representation #{link_representation_in_path}, but #{links_found.size} were found" unless links_found.size == 1
  links_found.first
end

#get_from_api(resource) ⇒ Object 



28
29
30
 
# File 'lib/providers/apis/onos_topology_provider.rb', line 28

def get_from_api(resource)
    Typhoeus.get "#{@uri_resource}#{resource}", userpwd:"onos:rocks"
end

#get_path_between(source, destination) ⇒ Object

Raises:

  • (Exception) 


130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/providers/apis/onos_topology_provider.rb', line 130

def get_path_between(source, destination)
    raise Exception, "Source must be either from class Router or class Host to ask for a path" unless [Host, Router].include? source.class
    raise Exception, "Destination must be either from class Router or class Host to ask for a path" unless [Host, Router].include? destination.class
    
    paths_response = get_from_api "paths/#{CGI.escape(source.id)}/#{CGI.escape(destination.id)}"
    paths_info = (JSON.parse paths_response.body)['paths']
    path = Path.new(source,destination)
    
    return path if paths_info.size == 0
    
    links_info = paths_info.first['links']

    #If either the source or the destination are hosts, the path will return host instead of device
    first_link = links_info.shift
    last_link = links_info.pop
    
    path.add_link (find_link first_link, 'host', 'device')

    links_info.each do |link|
      path.add_link (find_link link, 'device', 'device')
    end
    path.add_link (find_link last_link, 'device', 'host')

    path
end

#get_topology ⇒ Object 



17
18
19
20
21
22
23
24
25
26
 
# File 'lib/providers/apis/onos_topology_provider.rb', line 17

def get_topology

  return @topology.topology_elements if @topology.topology_elements.size != 0
        
  add_routers 
  add_hosts
  add_links 
  
  @topology.topology_elements
end