topologygenerator 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31aed2824e654df2a0ba4b41686d7e08afd82e9c
-  data.tar.gz: 1d94117ecd066a17cacf7b83b8e89da848584ba7
+  metadata.gz: 6d250f12524f93774240d4b5fca2ad128efd821d
+  data.tar.gz: 58b14cb23e6186552fbb5c28e2eeda1f3529e015
 SHA512:
-  metadata.gz: bc9d9bf9f06357e2b4c13261ccb133eb058af3c2270578638270e85b4867df7723ecd6faafb011500f8bdd6fa3f7bdf92d3bdb193e4857b59d5c315b27366fd7
-  data.tar.gz: 02756b998240d4c41667f982f8f09959d58cd46ade91c2970936016c1833ea70868e9f3c7bdbe3e33fec58e85336468599df31cbf642f8ca121a2e8d24cf278f
+  metadata.gz: 77be69a01a75a271b1051364542efcac286864348aebfc0a901d7a4628336c25b55b899beea34d2d79db7eb2bc3161da7094943ed47a0f5ed39b834df7a40c9e
+  data.tar.gz: 8f8d5217a2a02f28220046ae952f3b8471cf592ed6851332e256836a15d0e81ae0014b37f34e14d1cfb74331874a35abde2eecdf0d7acb08f49e4038f623a911

data/Gemfile

@@ -1,5 +1,6 @@
 source 'https://rubygems.org'
 
+gem 'colorize'
 gem 'byebug'
 gem 'spec'
 gem 'rake'

data/README.md

@@ -1,3 +1,33 @@
+## What is this gem for?
+
+This gem was designed for the SDN enviorment. The idea of this gem is to obtain from a specified provider a network topology representation, and eventually some additional properties of the network which will be used to build a custom output. 
+Right now the gem supports two providers: 
+
+1. ONOS SDN Controller( http://onosproject.org/ ): This will obtain the network using the Rest API.
+2. Custom Topology: This provider allows to define a custom network using ruby, and check properties on the specified network.
+
+This is an image that explains the above explanation.
+
+![alt tag](images/topologygenerator.png)
+
+As you can see, the idea is to get the network topology from a provider, and build an output using the builders implemented. The builders and providers are supposed to be implemented by users, however some examples are provided to help the development.
+
+TODO: Add OpenDayLight Controller as provider.
+
+## Example of use
+
+### Case 1
+Suppose that you have a network that uses SDN. You can use this gem to obtain the network topology representation from the controller, and generate a graph model from this network to check some logic properties. See Providers Examples - Controller and Builders Examples - Ruby Builder for more information.
+
+### Case 2
+Suppose that you are designing your network, and you want to check if the designed network fulfills some properties, for example that the delay from one host is less that 0.02s . You can use this gem to describe your desired network in ruby, and generate an output for a network simulator to check the desired properties. See Providers Examples - Custom and Builders Examples - PowerDevs Builder for more information.
+
+## Who uses this gem?
+
+This gem is used by the Haikunet programming language for getting the initial topology and perform the semantic checker analysis. For more information of Haikunet, you can check the following link: 
+
+https://github.com/andyLaurito92/tesis/tree/master/haikunet
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -16,7 +46,50 @@ Or install it yourself as:
 
 ## Usage
 
-For using the topologygenerator gem, you will need to write your builder, and specify the uri from where the initial topology information will be get.
+For using the topologygenerator gem, you will need to write your output builder, and specify the uri from where the initial topology information will be get. 
+The use of the topology generator is as follow:
+
+```ruby
+my_topology_generator = TopologyGenerator.new({
+		"source" => "name_of_my_provider", #Actually ONOS and CUSTOM are the options supported
+		"directory_concrete_builders" => "my_directory", #The directory where to locate the output builders
+		"output_directory" => "my_output_directory", #The directory where the output will be saved
+		"uri_resource" => "path_to_source" #Must be the rest api uri if ONOS is choosed or the path of a file if CUSTOM is choosed.
+	})
+my_custom_topology = topology_generator.generate 
+```
+
+Suppose that you want to use the tree topology network example located at network_topologies_examples, and you want to use the PowerDevs builder located at builders_examples of this repository. This is how you would do this:
+
+```ruby
+my_topology_generator = Topologygenerator.new({
+		"source" => "CUSTOM",
+		"directory_concrete_builders" => "builders_examples/pdm_builders",
+		"output_directory" => "output",
+		"uri_resource" => "network_topologies_examples/tree_topology.rb" 
+	})
+my_custom_topology = topology_generator.generate
+```
+
+Now, if you want to use a ONOS controller running in your local host, and use the Ruby builder, this is what you have to do:
+
+```ruby
+my_topology_generator = Topologygenerator.new({
+		"source" => "ONOS",
+		"directory_concrete_builders" => "builders_examples/ruby_builders",
+		"output_directory" => "output",
+		"uri_resource" => "http://127.0.0.1:8181/onos/v1/docs/" 
+	}) 
+my_custom_topology = topology_generator.generate
+```
+
+If you need help to program either your provider or your builder, check the Providers Examples or Builders Examples for more information.
+
+You can also use the topologygenerator as an executable throw the createTopology.rb script. For using the topologygenerator as an executable, you have to use it like this:
+
+createTopology.rb source -n NAME_OF_SOURCE -o OUTPUT_DIRECTORY -u URI_RESOURCE -d CONCRETE_BUILDERS_DIRECTORY
+
+Where each of the options is the same as detailed above.
 
 ## Development
 
@@ -26,7 +99,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/topologygenerator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/andyLaurito92/topologygenerator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/lib/createTopology.rb

@@ -2,9 +2,25 @@
 
 require_relative 'command_line/command_line_arguments.rb'
 require_relative "./topology_generator.rb"
+require 'colorize'
 
-my_command_line_arguments = CommandLineArguments.new
-my_command_line_arguments.run
+begin
+    my_command_line_arguments = CommandLineArguments.new
+    my_command_line_arguments.run
 
-topo_gen = topologygenerator.new my_command_line_arguments
-topo_gen.generate
+    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.key? argument_name
+    end
+
+    topo_gen = topologygenerator.new({
+            "source" => my_command_line_arguments.source
+            "directory_concrete_builders" => my_command_line_arguments.directory_concrete_builders,
+            "output_directory" => my_command_line_arguments.output_directory,
+            "uri_resource" => my_command_line_arguments.uri_resource
+        })
+    topo_gen.generate
+rescue Exception => ex
+  puts "#{ex.class}".red 
+  puts "#{ex.message}".blue
+end

data/lib/topologygenerator.rb

@@ -2,6 +2,7 @@ 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'
+require 'byebug'
 
 "Main class that reads a topology from a source provider and writes it using a builder"
 class Topologygenerator
@@ -10,25 +11,25 @@ class Topologygenerator
     validate arguments
     @arguments = arguments
 
-    case @arguments.source
+    case @arguments['source']
         when 'ONOS'
-            @topology_provider = OnosTopologyProvider.new @arguments.uri_resource
+            @topology_provider = OnosTopologyProvider.new @arguments['uri_resource']
         when 'CUSTOM'
-            @topology_provider = CustomTopologyProvider.new @arguments.uri_resource
+            @topology_provider = CustomTopologyProvider.new @arguments['uri_resource']
         else
-            raise ArgumentError, "The source: #{@arguments.source} is not one of the expected"
+            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 = 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
+    ["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.key? argument_name
     end
   end
 end

data/lib/topologygenerator/version.rb

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

data/topologygenerator.gemspec

@@ -11,17 +11,17 @@ Gem::Specification.new do |spec|
   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.summary       = %q{Build a topology from a source provider and generates an output using a custom 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, 
+                          When building your builder 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.
+                          You can see examples of how to use this gem in the public github webpage.
                            }
-  spec.homepage      = "https://github.com/andyLaurito92"
+  spec.homepage      = "https://github.com/andyLaurito92/topologygenerator"
   spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: topologygenerator
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Andrés Laurito
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-30 00:00:00.000000000 Z
+date: 2016-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,12 +84,12 @@ description: "The topologygenerator gem is a tool for building from a network to
   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
+  \n                          for OpenDayLight support).\n                          When
+  building your builder 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                           "
+  of how to use this gem in the public github webpage.\n                           "
 email:
 - andy.laurito@gmail.com
 executables: []
@@ -106,6 +106,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- images/topologygenerator.png
 - 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
@@ -161,7 +162,7 @@ files:
 - lib/topologygenerator/version.rb
 - lib/utils/custom_files_utils.rb
 - topologygenerator.gemspec
-homepage: https://github.com/andyLaurito92
+homepage: https://github.com/andyLaurito92/topologygenerator
 licenses:
 - MIT
 metadata: {}
@@ -184,5 +185,6 @@ 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.
+summary: Build a topology from a source provider and generates an output using a custom
+  builder.
 test_files: []