topologygenerator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 31aed2824e654df2a0ba4b41686d7e08afd82e9c
+  data.tar.gz: 1d94117ecd066a17cacf7b83b8e89da848584ba7
+SHA512:
+  metadata.gz: bc9d9bf9f06357e2b4c13261ccb133eb058af3c2270578638270e85b4867df7723ecd6faafb011500f8bdd6fa3f7bdf92d3bdb193e4857b59d5c315b27366fd7
+  data.tar.gz: 02756b998240d4c41667f982f8f09959d58cd46ade91c2970936016c1833ea70868e9f3c7bdbe3e33fec58e85336468599df31cbf642f8ca121a2e8d24cf278f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at andy.laurito@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'byebug'
+gem 'spec'
+gem 'rake'
+gem 'rspec-mocks' 
+gem 'simplecov', :require => false, :group => :test
+
+# Specify your gem's dependencies in topologygenerator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'topologygenerator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install topologygenerator
+
+## 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.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## 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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "topologygenerator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/behaviors/serialize_behavior.rb

@@ -0,0 +1,14 @@
+module SerializeBehavior
+    def transform_to_output_representation(path_to_templates_directory)
+        load "#{path_to_templates_directory}/#{self.class.name}_concrete_builder.rb"
+        self.class.send(:include, Kernel.const_get("#{self.class.name}ConcreteBuilder"))          
+        validate_concrete_builder
+        build_output_representation              
+    end
+
+    def validate_concrete_builder
+        [:build_output_representation].each do |method|
+           raise ArgumentError, "It was expected to load a #{self.class.name}ConcreteBuilder module from #{path_to_templates_directory}/builders/pdm that implements the method #{method}, but the one provided does not have this method implemented" unless self.respond_to? method
+        end
+    end
+end

data/lib/builders_examples/pdm_builders/PhaseI/Flow_concrete_builder.rb

@@ -0,0 +1,82 @@
+module FlowConcreteBuilder
+    def build_output_representation
+        scilab_definition = build_scilab_definition
+        cplusplus_definition = build_cplusplus_definition
+        {'scilab'=>scilab_definition, 'cplusplus'=>cplusplus_definition}
+    end
+
+    def build_scilab_definition
+        scilab_flows_definition = ''
+        scilab_flows_definition += "\n"
+        scilab_flows_definition += build_parameter_flow_distribution 'periodDistribution', distribution_rate
+        scilab_flows_definition += build_parameter_flow_distribution 'packetSizeDistribution', distribution_size
+        scilab_flows_definition
+    end
+
+    def build_parameter_flow_distribution(distribution_name, distribution_variable)
+        scilab_flow_parameter_distribution = ''
+        case distribution_variable
+        when ConstantDistribution
+            scilab_flow_parameter_distribution = "flow#{@id}.#{distribution_name} =  DISTRIBUTION_CONSTANT;\n"            
+            scilab_flow_parameter_distribution += "flow#{@id}.#{distribution_name}_value = #{distribution_variable.value};   // (in bits) value for the constant distribution\n"
+        when ExponentialDistribution
+            scilab_flow_parameter_distribution = "flow#{@id}.#{distribution_name} =  DISTRIBUTION_EXPONENTIAL;\n"
+            scilab_flow_parameter_distribution += "flow#{@id}.#{distribution_name}_mu = #{distribution_variable.mu};   // (in seconds) mean for the exponential distribution.\n"
+        when NormalDistribution
+            scilab_flow_parameter_distribution = "flow#{@id}.#{distribution_name} =  DISTRIBUTION_NORMAL;\n"
+            scilab_flow_parameter_distribution += "flow#{@id}.#{distribution_name}_mu = #{distribution_variable.mu}; \n"
+            scilab_flow_parameter_distribution += "flow#{@id}.#{distribution_name}_var = #{distribution_variable.var}; \n"
+        when ParetoDistribution
+            scilab_flow_parameter_distribution = "flow#{@id}.#{distribution_name} =  DISTRIBUTION_PARETO;\n"
+            scilab_flow_parameter_distribution += "flow#{@id}.#{distribution_name}_val1 = #{distribution_variable.val_1}; \n"
+            scilab_flow_parameter_distribution += "flow#{@id}.#{distribution_name}_val2 = #{distribution_variable.val_2}; \n"
+            scilab_flow_parameter_distribution += "flow#{@id}.#{distribution_name}_mean = #{distribution_variable.mean}; \n"
+        when SplitDistribution
+            scilab_flow_parameter_distribution = "flow#{@id}.#{distribution_name} =  DISTRIBUTION_SPLIT;\n"
+            scilab_flow_parameter_distribution += "flow#{@id}.#{distribution_name}_shape = #{distribution_variable.shape}; \n"
+            scilab_flow_parameter_distribution += "flow#{@id}.#{distribution_name}_scale = #{distribution_variable.scale}; \n"
+        else
+            raise "Distribution provided has a class which was unexpected. Class was: #{distribution_variable.class}"
+        end
+        scilab_flow_parameter_distribution
+    end
+
+  def build_cplusplus_definition
+          start_time_of_flow = 0
+          # flow
+          cplusplus_flows_definition = "\n"
+          cplusplus_flows_definition += "\t ///// definition of flow #{@id} \n"
+          cplusplus_flows_definition += "\t auto flow#{@id}PeriodDistribution = readDistributionParameter(\"flow#{@id}.periodDistribution\"); \n"
+          cplusplus_flows_definition += "\t auto flow#{@id}PacketSizeDistribution = readDistributionParameter(\"flow#{@id}.packetSizeDistribution\"); \n"
+          cplusplus_flows_definition += "\t auto flow#{@id} = std::make_shared<Flow>(\"#{@id}\", #{start_time_of_flow} /*startTime*/, #{priority} /*typeOfService*/, flow#{@id}PeriodDistribution, flow#{@id}PacketSizeDistribution); \n"
+                 
+          #routes
+          cplusplus_flows_definition += "\t // routes for flow #{@id} \n"
+          paths.each_with_index do |path, index| #  add each route/path in the flow       
+            cplusplus_flows_definition += "\t auto flow#{@id}_route#{index} = std::make_shared<Route>( std::deque<Route::Node>{ \n"
+            path.links.each do |link|
+                cplusplus_flows_definition += "\t\t\t {#{link.src_port}, \"#{link.src_element.id}.Routing\"}, \n"
+            end
+            last_link = path.links.last        
+            cplusplus_flows_definition += "\t\t\t {#{last_link.dst_port}, \"#{last_link.dst_element.id}.Routing\"} \n"
+            cplusplus_flows_definition += "\t });"
+            cplusplus_flows_definition += "\t \n"
+          end 
+          
+          
+          # registrations
+          cplusplus_flows_definition += "\t // register flow #{@id} with its routes\n"
+          unique_sources = paths.map{ |path| path.links.first.src_element.id }.uniq{|id| id}  # only add unique sources
+          unique_sources.each do |source|
+            cplusplus_flows_definition += "\t FlowDefinitions::registerFlowSourceNode(flow#{@id}, \"#{source}.GeneratorApplication\");  \n"  
+          end
+          
+          paths.each_with_index do |path, index| #  register each route/path in the flow  for each route
+            cplusplus_flows_definition += "\t FlowDefinitions::registerFlowRoute(flow#{@id}, flow#{@id}_route#{index});  \n"
+          end
+                  
+          cplusplus_flows_definition += "\t \n"
+          
+          cplusplus_flows_definition
+      end
+end

data/lib/builders_examples/pdm_builders/PhaseI/Host_concrete_builder.rb

@@ -0,0 +1,24 @@
+module HostConcreteBuilder    
+    def build_output_representation
+"     Atomic
+        {
+            Name = #{id}
+            Ports = #{in_elements.size} ; #{out_elements.size}
+            Path = PhaseI/FelixServer.h
+            Description = Generates jobs. Distribution for the rate and jobSize are retrieved from the Flows assigned to this server
+            Graphic
+                {
+                Position = #{-9975 + 750 * (my_number - 1)} ; -10285
+                Dimension = 700 ; 700
+                Direction = Down
+                Color = 15
+                Icon = %datanetworks%generator.png
+                }
+            Parameters
+                {
+                }
+         }
+      "
+    end
+      
+end

data/lib/builders_examples/pdm_builders/PhaseI/Link_concrete_builder.rb

@@ -0,0 +1,150 @@
+module LinkConcreteBuilder
+    def build_output_representation
+"   Coupled
+      {
+      Type = Coordinator
+      Name = #{@id}
+      Ports = 1; 1
+      Description = Coupled DEVS model
+      Graphic
+          {
+          Position = #{-9975 + 750 * (@my_number - 1)}; -9870
+          Dimension = 645; 705
+          Direction = Down
+          Color = 15
+          Icon = %datanetworks%ethernet.jpg
+          Window = 5000; 5000; 5000; 5000
+          }
+      Parameters
+          {
+          }
+      System
+          {
+          Inport
+              {
+              Name = Inport0
+              CoupledPort = 1
+              Description =
+              Graphic
+                  {
+                  Position = -4740 ; -3525
+                  Dimension = 480
+                  Direction = Right
+                  }
+              }
+          Outport
+              {
+              Name = Outport0
+              CoupledPort = 1
+              Description =
+              Graphic
+                  {
+                  Position = -930 ; 2850
+                  Dimension = 360
+                  Direction = Right
+                  }
+              }
+          Atomic
+              {
+              Name = InNICQueue
+              Ports = 2 ; 2
+              Path = PhaseI/NetworkQueue.h
+              Description = In0 Incomming packets to queueIn1 Incoming signal to request dequeueOut0 Outgoing dequeued packetsOut1 Outgoing queue lenght informationQueues incoming packets and enqueues them as required by aexternal entity. FIFO Policy (FirstInFirstOut). Provides information its internal state.
+              Graphic
+                  {
+                  Position = -3855 ; -1230
+                  Dimension = 675 ; 675
+                  Direction = Down
+                  Color = 15
+                  Icon = %datanetworks%queue.png
+                  }
+              Parameters
+                  {
+                  MaxCapacity = Str; FelixNICQueue1.maxBuffer ; Queue Capacity in Bytes. (Use -1 for INF capacity)
+                  ForcedPeriod = Str; -1 ; Force minimum period to transition. Use -1 for INF
+                  }
+              }
+          Atomic
+              {
+              Name = Link
+              Ports = 1 ; 1
+              Path = PhaseI/Link.h
+              Description = Vector to scalar signal
+              Graphic
+                  {
+                  Position = -3990 ; 585
+                  Dimension = 630 ; 630
+                  Direction = Down
+                  Color = 15
+                  Icon = %vectors%vec2scalar.svg
+                  }
+              Parameters
+                  {
+                  link.capacity = Str; FelixLink.capacity ; Signal Index
+                  link.delay = Str; link.delay ;
+                  }
+              }
+          Point
+              {
+              ConectedLines = 3 ; 4 ; 5
+              ConectedExtrems = Org ; Org ; Org
+              Position = -3675 ; 1950
+              }
+          Line
+              {
+              Source = Prt ;  1 ;  1 ; 0
+              Sink = Cmp ;  1 ;  1 ; -1
+              PointX = -4125 ; -3675 ; -3675
+              PointY = -3525 ; -3525 ; -1365
+              }
+          Line
+              {
+              Source = Cmp ;  1 ;  1 ; 0
+              Sink = Cmp ;  2 ;  1 ; -1
+              PointX = -3675 ; -3675 ; -3675
+              PointY = -450 ; -450 ; 435
+              }
+          Line
+              {
+              Source = Cmp ;  2 ;  1 ; 0
+              Sink = Pnt ;  1 ; -1 ; 0
+              PointX = -3675 ; -3675 ; -3675
+              PointY = 1350 ; 1350 ; 1950
+              }
+          Line
+              {
+              Source = Cmp ;  1 ;  2 ; -1
+              Sink = Pnt ;  1 ; -1 ; 0
+              PointX = -3375 ; -3375 ; -2325 ; -2325 ; -3675
+              PointY = -1365 ; -1650 ; -1650 ; 1950 ; 1950
+              }
+          Line
+              {
+              Source = Pnt ;  1 ; -1 ; 0
+              Sink = Prt ;  2 ;  1 ; -1
+              PointX = -3675 ; -3675 ; -1065 ; -1065
+              PointY = 1950 ; 2775 ; 2775 ; 2850
+              }
+          }
+      }
+      "
+    end
+   
+    def create_pdm_line_between_src_and_dst(src_element_pdm_pos, dst_element_pdm_pos, link_element_pdm_pos)
+    "Line
+                       {
+                       Source = Cmp ;  #{src_element_pdm_pos} ;   #{@src_port + 1} ; 0
+                       Sink = Cmp ;  #{link_element_pdm_pos} ;  1 ; -1
+                       PointX = -9675 ; -9675 ; -9675
+                       PointY = -10350 ; -10350 ; -9990
+                       }
+                       Line
+                       {
+                       Source = Cmp ;  #{link_element_pdm_pos} ;  1 ; 0
+                       Sink = Cmp ;  #{dst_element_pdm_pos} ;  #{@dst_port + 1} ; -1
+                       PointX = -9675 ; -9675 ; -9675
+                       PointY = -10350 ; -10350 ; -9990
+                       }
+                       "
+  end
+end

data/lib/builders_examples/pdm_builders/PhaseI/Router_concrete_builder.rb

@@ -0,0 +1,24 @@
+module RouterConcreteBuilder
+    def build_output_representation
+"Atomic
+  {
+  Name = #{@id}
+  Ports = #{in_elements.size} ; #{out_elements.size}
+  Path = PhaseI/Router.h
+  Description = In0: Incomming packetsInN: Outgoing packets from a single flowDemultiplexes a single packet flow in N input output streams.Each output stream contains packets belonging to a single flow identifier.
+  Graphic
+      {
+      Position = #{-9975 + 750 * (@my_number-1)} ; -8505
+      Dimension = 600 ; 800
+      Direction = Down
+      Color = 15
+      Icon = %datanetworks%router.jpg
+      }
+  Parameters
+      {
+      }
+  }
+"
+    end
+      
+end

data/lib/builders_examples/pdm_builders/PhaseI/output_concrete_builder.rb

@@ -0,0 +1,86 @@
+module OutputConcreteBuilder
+    OUTPUT_PDM_FILE_NAME = 'topology.pdm'
+    OUTPUT_CPP_FILE_NAME = 'FlowDefinitions.cpp'
+    OUTPUT_SCILAB_FILE_NAME = 'flows_definition.scilabParams'
+
+    def initialize_concrete_builder(topology_provider, directory_concrete_builders, output_directory)
+        @topology_provider = topology_provider
+        @directory_concrete_builders = directory_concrete_builders # make's sense?
+        @output_directory = output_directory
+    end
+
+    def build_output_content
+        build_pdm_output
+
+        build_flow_output
+    end
+
+    def build_pdm_output
+        graph_elements = topology_provider.get_topology
+        
+        graph_elements = graph_elements.select { |elem| [Host,Link,Router].include? elem.class }
+
+        pdm_topology = PDM_INITIAL_STRUCTURE 
+
+        graph_elements.each do |element|
+            pdm_topology += element.transform_to_output_representation @directory_concrete_builders
+        end
+        
+        pdm_topology += create_lines_between_graph_elements graph_elements
+
+        pdm_topology += PDM_FINAL_STRUCTURE
+
+        write_file "#{@output_directory}/#{OUTPUT_PDM_FILE_NAME}",
+                    pdm_topology
+    end
+
+    def create_lines_between_graph_elements(graph_elements)
+        links = graph_elements.select { |node| node.is_a? Link }
+        lines = ''
+        links.each do |link|
+            src_pdm_pos = get_pdm_position link.src_element
+            dst_pdm_pos = get_pdm_position link.dst_element
+            link_pdm_pos = get_pdm_position link
+            lines += link.create_pdm_line_between_src_and_dst src_pdm_pos, dst_pdm_pos, link_pdm_pos
+        end
+        lines
+    end
+
+    def get_pdm_position(network_elem)
+        #Here links have a modeled representation, so we have to count the link as well.
+        #We have routers, hosts and links as either atomic or compunded models
+        NUMBER_OF_PDM_MODELS_IN_STRUCTURE + network_elem.my_number
+    end 
+
+    def build_flow_output
+        graph_elements = topology_provider.get_topology 
+
+        flows = graph_elements.select { |elem| elem.is_a? Flow }        
+
+        scilab_flows_definition = ''
+        cplusplus_flows_defined = ''
+        flows.each do |flow|
+            flow_output = flow.transform_to_output_representation @directory_concrete_builders
+            scilab_flows_definition += flow_output['scilab']
+            cplusplus_flows_defined += flow_output['cplusplus']
+        end
+
+        write_file "#{@output_directory}/#{OUTPUT_SCILAB_FILE_NAME}",
+                    scilab_flows_definition
+
+        write_file  "#{@output_directory}/#{OUTPUT_CPP_FILE_NAME}",
+                   (build_cplusplus_output cplusplus_flows_defined)
+    end
+
+    def build_cplusplus_output(cplusplus_flows_defined)
+        cplusplus_flows_definition = "#include \"FlowDefinitions.h\" \n"
+        cplusplus_flows_definition += "\n"
+        cplusplus_flows_definition += "std::multimap<std::string, std::shared_ptr<Flow>> FlowDefinitions::Flows; \n"
+        cplusplus_flows_definition += "\n"
+        cplusplus_flows_definition += "void FlowDefinitions::defineFlows(){ \n"
+        cplusplus_flows_definition += "\n"
+        cplusplus_flows_definition += cplusplus_flows_defined
+        cplusplus_flows_definition += '}'
+        cplusplus_flows_definition
+    end   
+end