topologygenerator 0.0.1

data/lib/output_builder.rb

@@ -0,0 +1,39 @@
+require_relative 'utils/custom_files_utils.rb'
+
+class OutputBuilder
+    
+    attr_reader :topology_provider, :directory_concrete_builders, :output_directory
+
+    include CustomFileUtils
+
+    def initialize(topology_provider, directory_concrete_builders, output_directory)
+        validate_params topology_provider, directory_concrete_builders, output_directory
+
+        @topology_provider = topology_provider
+        @directory_concrete_builders = directory_concrete_builders
+        @output_directory = output_directory
+    end
+
+    def build_output
+        Dir["#{@directory_concrete_builders}/*.rb"].each { |file| require "./#{file}" }
+        self.class.send(:include,OutputConcreteBuilder)
+        validate_output_concrete_builder
+
+        initialize_concrete_builder @topology_provider, @directory_concrete_builders, @output_directory
+
+        build_output_content
+    end
+
+    def validate_output_concrete_builder
+        [:initialize_concrete_builder, :build_output_content].each do |method|
+            raise ArgumentError, "It was expected to load an OutputConcreteBuilder module from #{@directory_concrete_builders}/builders/output_files_format that implements the method #{method}, but the one provided does not has this method implemented" unless self.respond_to? method
+        end
+    end
+
+    def validate_params(topology_provider, directory_concrete_builders, output_directory)
+        raise ArgumentError, 'The topology provider given cannot be nil' unless topology_provider
+        raise ArgumentError, 'The template directory given cannot be nil' unless directory_concrete_builders
+        raise ArgumentError, "It was expected to find builders files in directory #{directory_concrete_builders}, but nothing was found." if Dir["#{directory_concrete_builders}/*.rb"].size == 0
+        raise ArgumentError, 'The output directory given cannot be nil' unless output_directory    
+    end
+end

data/lib/providers/apis/onos_topology_provider.rb

@@ -0,0 +1,146 @@
+require 'cgi'
+require 'typhoeus'
+require_relative "../interface_topology_provider.rb"
+require_relative "../../network_entities/topology.rb"
+require_relative '../../network_entities/abstracts/path.rb'
+
+class OnosTopologyProvider < ITopologyProvider
+
+    attr_accessor :uri_resource
+    
+    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
+    
+    def get_topology
+
+      return @topology.topology_elements if @topology.topology_elements.size != 0
+            
+      add_routers 
+      add_hosts
+      add_links 
+      
+      @topology.topology_elements
+    end    
+
+    def get_from_api(resource)
+        Typhoeus.get "#{@uri_resource}#{resource}", userpwd:"onos:rocks"
+    end
+
+=begin
+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"
+    }
+}
+=end
+    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
+
+    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['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
+
+=begin
+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"
+}
+=end    
+    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
+
+    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)}"
+        links_info = (JSON.parse paths_response.body)['paths'].first['links']
+
+        path = Path.new(source,destination)
+
+        #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
+
+    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
+end

data/lib/providers/customs/custom_topology_provider.rb

@@ -0,0 +1,14 @@
+require 'json'
+
+class CustomTopologyProvider < ITopologyProvider
+  attr_reader :uri_resource
+
+  def initialize(new_uri_resource)
+      raise ArgumentError, 'No uri recieved as parameter' unless new_uri_resource
+      @topology = Topology.new
+      
+      @uri_resource = new_uri_resource
+      require (Pathname.new @uri_resource).realpath.to_s
+      self.class.send(:include, NetworkTopology)
+  end
+end

data/lib/providers/interface_topology_provider.rb

@@ -0,0 +1,11 @@
+"Interface for topology providers"
+class ITopologyProvider
+  "returns a list with the topology elements (nodes, routers, links)"
+  def get_topology
+     raise NotImplementedError, "ITopologyProvider: Implement this method in a child class"
+  end
+
+  def get_path_between(source, destination)
+  	raise NotImplementedError, "ITopologyProvider: Implement this method in a child class"
+  end
+end

data/lib/topologygenerator/version.rb

@@ -0,0 +1,3 @@
+class Topologygenerator
+  VERSION = "0.0.1"
+end

data/lib/topologygenerator.rb

@@ -0,0 +1,34 @@
+require_relative "topologygenerator/version"
+require_relative 'providers/apis/onos_topology_provider.rb'
+require_relative 'providers/customs/custom_topology_provider.rb'
+require_relative 'output_builder.rb'
+
+"Main class that reads a topology from a source provider and writes it using a builder"
+class Topologygenerator
+  
+  def initialize(arguments)
+    validate arguments
+    @arguments = arguments
+
+    case @arguments.source
+        when 'ONOS'
+            @topology_provider = OnosTopologyProvider.new @arguments.uri_resource
+        when 'CUSTOM'
+            @topology_provider = CustomTopologyProvider.new @arguments.uri_resource
+        else
+            raise ArgumentError, "The source: #{@arguments.source} is not one of the expected"
+    end
+  end
+  
+  def generate
+    output_builder = OutputBuilder.new @topology_provider, @arguments.directory_concrete_builders, @arguments.output_directory
+    output_builder.build_output    
+  end
+
+  def validate(arguments)
+    raise ArgumentError, 'No arguments received' unless arguments
+    [:source,:directory_concrete_builders,:output_directory, :uri_resource].each do |argument_name|
+      raise ArgumentError, "It is mandatory that arguments has a #{argument_name}" unless arguments.respond_to? argument_name
+    end
+  end
+end

data/lib/utils/custom_files_utils.rb

@@ -0,0 +1,16 @@
+module CustomFileUtils
+    def create_empty_file(full_file_path)
+        dir = File.dirname(full_file_path)
+
+        FileUtils.mkdir_p(dir) unless File.directory?(dir)
+        
+        File.new(full_file_path, 'w').close()
+    end
+
+    def write_file(path_to_file, file_content)
+        create_empty_file path_to_file 
+		open(path_to_file, 'w') do |f|		  
+            f.puts file_content
+        end
+    end
+end

data/topologygenerator.gemspec

@@ -0,0 +1,45 @@
+require 'byebug'
+
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'topologygenerator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "topologygenerator"
+  spec.version       = Topologygenerator::VERSION
+  spec.authors       = ["Andrés Laurito"]
+  spec.email         = ["andy.laurito@gmail.com"]
+
+  spec.summary       = %q{Build a topology from a source provider and writes it using a builder.}
+  spec.description   = %q{The topologygenerator gem is a tool for building from a network topology a custom output. 
+                          This network topology can be obtained from a custom file written in ruby by the user, or 
+                          by a SDN controller specifying the API uri (actually ONOS is support, and we are working 
+                          for OpenDayLight support).
+                          In case of the custom output, you have to write for each class defined in the network topology, 
+                          a module that describes how to build this class. The topologygenerator gem will then use this 
+                          module's defined to generate the output desired.
+                          You can see examples of use in my public github webpage.
+                           }
+  spec.homepage      = "https://github.com/andyLaurito92"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  #else
+  #  raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  #end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "typhoeus"
+  spec.add_development_dependency 'commander'
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: topologygenerator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrés Laurito
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "The topologygenerator gem is a tool for building from a network topology
+  a custom output. \n                          This network topology can be obtained
+  from a custom file written in ruby by the user, or \n                          by
+  a SDN controller specifying the API uri (actually ONOS is support, and we are working
+  \n                          for OpenDayLight support).\n                          In
+  case of the custom output, you have to write for each class defined in the network
+  topology, \n                          a module that describes how to build this
+  class. The topologygenerator gem will then use this \n                          module's
+  defined to generate the output desired.\n                          You can see examples
+  of use in my public github webpage.\n                           "
+email:
+- andy.laurito@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/behaviors/serialize_behavior.rb
+- lib/builders_examples/pdm_builders/PhaseI/Flow_concrete_builder.rb
+- lib/builders_examples/pdm_builders/PhaseI/Host_concrete_builder.rb
+- lib/builders_examples/pdm_builders/PhaseI/Link_concrete_builder.rb
+- lib/builders_examples/pdm_builders/PhaseI/Router_concrete_builder.rb
+- lib/builders_examples/pdm_builders/PhaseI/output_concrete_builder.rb
+- lib/builders_examples/pdm_builders/PhaseI/pdm_constants.rb
+- lib/builders_examples/pdm_builders/PhaseIWithPriorityQueues/Flow_concrete_builder.rb
+- lib/builders_examples/pdm_builders/PhaseIWithPriorityQueues/Host_concrete_builder.rb
+- lib/builders_examples/pdm_builders/PhaseIWithPriorityQueues/Link_concrete_builder.rb
+- lib/builders_examples/pdm_builders/PhaseIWithPriorityQueues/Router_concrete_builder.rb
+- lib/builders_examples/pdm_builders/PhaseIWithPriorityQueues/output_concrete_builder.rb
+- lib/builders_examples/ruby_builders/Flow_concrete_builder.rb
+- lib/builders_examples/ruby_builders/Host_concrete_builder.rb
+- lib/builders_examples/ruby_builders/Link_concrete_builder.rb
+- lib/builders_examples/ruby_builders/Router_concrete_builder.rb
+- lib/builders_examples/ruby_builders/output_concrete_builder.rb
+- lib/command_line/command_line_arguments.rb
+- lib/createTopology.rb
+- lib/flows_distributions/constant_distribution.rb
+- lib/flows_distributions/exponential_distribution.rb
+- lib/flows_distributions/normal_distribution.rb
+- lib/flows_distributions/pareto_distribution.rb
+- lib/flows_distributions/split_distribution.rb
+- lib/network_entities/abstracts/flow.rb
+- lib/network_entities/abstracts/network_element.rb
+- lib/network_entities/abstracts/path.rb
+- lib/network_entities/physical/host.rb
+- lib/network_entities/physical/link.rb
+- lib/network_entities/physical/router.rb
+- lib/network_entities/topology.rb
+- lib/network_topologies_examples/PhaseI_onlyLAr_1FelixTo1SWROD.rb
+- lib/network_topologies_examples/octopus_topology.rb
+- lib/network_topologies_examples/phase1_topology_mininet/tdaq
+- lib/network_topologies_examples/phase1_topology_mininet/tdaq.py
+- lib/network_topologies_examples/sofisticated_octopus_topology.rb
+- lib/network_topologies_examples/tdaq_network_topology.rb
+- lib/network_topologies_examples/tdaq_topology_example.rb
+- lib/network_topologies_examples/tree_topology.rb
+- lib/output/FlowDefinitions.cpp
+- lib/output/copy_files.sh
+- lib/output/flows_definition.scilabParams
+- lib/output/hosts_definition.scilabParams
+- lib/output/links_definition.scilabParams
+- lib/output/routers_definition.scilabParams
+- lib/output/ruby_network_topology.rb
+- lib/output/topology.pdm
+- lib/output_builder.rb
+- lib/providers/apis/onos_topology_provider.rb
+- lib/providers/customs/custom_topology_provider.rb
+- lib/providers/interface_topology_provider.rb
+- lib/topologygenerator.rb
+- lib/topologygenerator/version.rb
+- lib/utils/custom_files_utils.rb
+- topologygenerator.gemspec
+homepage: https://github.com/andyLaurito92
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Build a topology from a source provider and writes it using a builder.
+test_files: []