antfarm-core 0.5.0.beta1

data/lib/antfarm/models/layer_three_network.rb

@@ -0,0 +1,151 @@
+################################################################################
+#                                                                              #
+# Copyright (2008-2010) Sandia Corporation. Under the terms of Contract        #
+# DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government retains       #
+# certain rights in this software.                                             #
+#                                                                              #
+# 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, distribute with     #
+# modifications, 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  #
+# ABOVE 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.                                                                    #
+#                                                                              #
+# Except as contained in this notice, the name(s) of the above copyright       #
+# holders shall not be used in advertising or otherwise to promote the sale,   #
+# use or other dealings in this Software without prior written authorization.  #
+#                                                                              #
+################################################################################
+
+module Antfarm
+  module Model
+    class LayerThreeNetwork
+      include DataMapper::Resource
+
+      storage_names[:default] = 'layer_three_networks'
+
+      property :id,               Serial
+      property :certainty_factor, Float, :required => true, :default => 0.8
+      property :protocol,         String
+      property :custom,           String
+
+      has n, :layer_three_interfaces, :constraint => :destroy
+      has 1, :ip_network,             :constraint => :destroy
+
+      validates_present :certainty_factor
+
+      before :save, :clamp_certainty_factor
+
+      # Take the given network and merge with it
+      # any sub_networks of the given network.
+      def self.merge(network, merge_certainty_factor = Antfarm::CF_PROVEN_TRUE)
+        unless network 
+          raise(ArgumentError, 'nil argument supplied to LayerThreeNetwork#merge', caller)
+        end
+
+        unless network.is_a?(Antfarm::Model::LayerThreeNetwork)
+          raise(ArgumentError, 'argument supplied to LayerThreeNetwork#merge must be LayerThreeNetwork', caller)
+        end
+
+        for sub_network in self.networks_contained_within(network.ip_network.address)
+          unless sub_network == network 
+            unless merge_certainty_factor
+              merge_certainty_factor = Antfarm::CF_LACK_OF_PROOF
+            end
+
+            merge_certainty_factor = Antfarm::Helpers.clamp(merge_certainty_factor)
+
+            sub_network.layer_three_interfaces.each { |interface| network.layer_three_interfaces << interface }
+            network.layer_three_interfaces.uniq!
+
+            # Clear out the layer 3 interfaces on the network to
+            # be destroyed such that they aren't destroyed too.
+            sub_network.layer_three_interfaces.clear
+
+            # TODO: update network's certainty factor using sub_network's certainty factor.
+            
+            network.save
+
+            # Because of :constraint => :destroy above, calling destroy
+            # here will also cause destroy to be called on ip_network.
+            # Calling destroy here should NOT destroy any layer 3 interface
+            # since they were all moved over to the network being merged to.
+            sub_network.destroy
+          end
+        end
+      end
+
+      # Find the Layer3Network with the given address.
+      def self.network_addressed(ip_net_str)
+        unless ip_net_str
+          raise(ArgumentError, 'nil argument supplied to LayerThreeNetwork#network_addressed', caller)
+        end
+
+        # Calling network_containing here because if a network already exists that encompasses
+        # the given network, we want to automatically use that network instead.
+        # TODO: figure out how to use alias with class methods
+        self.network_containing(ip_net_str)
+      end
+
+      # Find the network the given network is a sub_network of, if one exists.
+      def self.network_containing(ip_net_str)
+        unless ip_net_str
+          raise(ArgumentError, 'nil argument supplied to LayerThreeNetwork#network_containing', caller)
+        end
+
+        # Don't want to require a Layer3Network to be passed in case
+        # a check is being performed before a Layer3Network is created.
+        network = Antfarm::IPAddrExt.new(ip_net_str)
+
+        ip_nets = IpNetwork.all
+        for ip_net in ip_nets
+          if Antfarm::IPAddrExt.new(ip_net.address).network_in_network?(network)
+            return ip_net.layer_three_network
+          end
+        end
+
+        return nil
+      end
+
+      # Find any Layer3Networks that are sub_networks of the given network.
+      def self.networks_contained_within(ip_net_str)
+        unless ip_net_str
+          raise(ArgumentError, 'nil argument supplied to LayerThreeNetwork#networks_contained_within', caller)
+        end
+
+        # Don't want to require a Layer3Network to be passed in case
+        # a check is being performed before a Layer3Network is created.
+        network = Antfarm::IPAddrExt.new(ip_net_str)
+        sub_networks = Array.new
+
+        ip_nets = IpNetwork.all
+        for ip_net in ip_nets
+          sub_networks << ip_net.layer_three_network if network.network_in_network?(ip_net.address)
+        end
+
+        return sub_networks
+      end
+
+      #######
+      private
+      #######
+
+      def clamp_certainty_factor
+        Antfarm::Helpers.log :debug, '[PRIVATE METHOD CALLED] LayerThreeNetwork#clamp_certainty_factor'
+        self.certainty_factor = Antfarm::Helpers.clamp(self.certainty_factor)
+      end
+    end
+  end
+end

data/lib/antfarm/models/layer_two_interface.rb

@@ -0,0 +1,96 @@
+################################################################################
+#                                                                              #
+# Copyright (2008-2010) Sandia Corporation. Under the terms of Contract        #
+# DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government retains       #
+# certain rights in this software.                                             #
+#                                                                              #
+# 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, distribute with     #
+# modifications, 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  #
+# ABOVE 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.                                                                    #
+#                                                                              #
+# Except as contained in this notice, the name(s) of the above copyright       #
+# holders shall not be used in advertising or otherwise to promote the sale,   #
+# use or other dealings in this Software without prior written authorization.  #
+#                                                                              #
+################################################################################
+
+module Antfarm
+  module Model
+    class LayerTwoInterface
+      include DataMapper::Resource
+
+      storage_names[:default] = 'layer_two_interfaces'
+
+      property :id,               Serial
+      property :certainty_factor, Float, :required => true, :default => 0.8
+      property :media_type,       String
+      property :custom,           String
+
+#     has n,     :layer3_interfaces
+#     has 1,     :ethernet_interface, :child_key => :id, :constraint => :destroy
+      has 1,     :ethernet_interface, :constraint => :destroy
+      belongs_to :node, :required => true
+
+      validates_present :certainty_factor
+
+      # Need to do this before validation
+      # since :required => true is specified
+      # on the node association above.
+      before :valid?, :create_node
+      before :save,   :clamp_certainty_factor
+#     after  :save,   :destroy_orphaned_nodes # TODO: be sure to write test if used!
+
+      #######
+      private
+      #######
+
+      # If a hash is passed into the node variable,
+      # parameters matching variables on the node
+      # class will be used to create a new node object.
+      def create_node
+        Antfarm::Helpers.log :debug, '[PRIVATE METHOD CALLED] Layer2Interface#create_node'
+
+        # Only create a new node if a node model
+        # isn't already associated with this model.
+        # This protects against new nodes being
+        # created when one is already provided or
+        # when this model is being saved rather
+        # than created (since a node will be
+        # automatically created and associated with
+        # this model on creation).
+        self.node ||= Antfarm::Model::Node.create
+      end
+
+      def clamp_certainty_factor
+        Antfarm::Helpers.log :debug, '[PRIVATE METHOD CALLED] LayerTwoInterface#clamp_certainty_factor'
+        self.certainty_factor = Antfarm::Helpers.clamp(self.certainty_factor)
+      end
+
+      def destroy_orphaned_nodes
+        Antfarm::Helpers.log :debug, '[PRIVATE METHOD CALLED] LayerTwoInterface#destroy_orphaned_nodes'
+
+        Node.all.each do |n|
+          if n.layer2_interfaces.empty?
+            Antfarm::Helpers.log :debug, "LayerTwoInterface - destroying orphaned node #{node}"
+            n.destroy
+          end
+        end
+      end
+    end
+  end
+end

data/lib/antfarm/models/node.rb

@@ -0,0 +1,61 @@
+################################################################################
+#                                                                              #
+# Copyright (2008-2010) Sandia Corporation. Under the terms of Contract        #
+# DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government retains       #
+# certain rights in this software.                                             #
+#                                                                              #
+# 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, distribute with     #
+# modifications, 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  #
+# ABOVE 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.                                                                    #
+#                                                                              #
+# Except as contained in this notice, the name(s) of the above copyright       #
+# holders shall not be used in advertising or otherwise to promote the sale,   #
+# use or other dealings in this Software without prior written authorization.  #
+#                                                                              #
+################################################################################
+
+module Antfarm
+  module Model
+    class Node
+      include DataMapper::Resource
+
+      storage_names[:default] = 'nodes'
+
+      property :id,               Serial
+      property :certainty_factor, Float, :required => true, :default => 0.8
+      property :name,             String
+      property :device_type,      String
+      property :custom,           String
+
+      has n, :layer_two_interfaces, :constraint => :destroy
+
+      validates_present :certainty_factor
+
+      before :save, :clamp_certainty_factor
+
+      #######
+      private
+      #######
+
+      def clamp_certainty_factor
+        Antfarm::Helpers.log :debug, '[PRIVATE METHOD CALLED] Node#clamp_certainty_factor'
+        self.certainty_factor = Antfarm::Helpers.clamp(self.certainty_factor)
+      end
+    end
+  end
+end

data/lib/antfarm/plugin.rb

@@ -0,0 +1,177 @@
+################################################################################
+#                                                                              #
+# Copyright (2008-2010) Sandia Corporation. Under the terms of Contract        #
+# DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government retains       #
+# certain rights in this software.                                             #
+#                                                                              #
+# 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, distribute with     #
+# modifications, 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  #
+# ABOVE 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.                                                                    #
+#                                                                              #
+# Except as contained in this notice, the name(s) of the above copyright       #
+# holders shall not be used in advertising or otherwise to promote the sale,   #
+# use or other dealings in this Software without prior written authorization.  #
+#                                                                              #
+################################################################################
+
+require 'find'
+
+module Antfarm
+  class PluginExistanceError   < Antfarm::AntfarmError; end
+  class PluginInheritanceError < Antfarm::AntfarmError; end
+  class PluginOptionsError     < Antfarm::AntfarmError; end
+
+  module Plugin
+    attr_accessor :name
+
+    PLUGIN_ROOTS  = ["#{File.dirname(__FILE__)}/plugins"]
+    PLUGIN_ROOTS << Antfarm::Helpers.user_plugins_dir
+
+    # perform a quick discovery of plugins that exist
+    # TODO <scrapcoder>: add 'custom/' to the front of
+    # plugins that don't originate in the 'root plugins'
+    # directory.
+    def self.discover
+      PLUGIN_ROOTS.each do |root|
+        Find.find("#{root}/") do |path|
+          unless File.directory?(path)
+            if File.file?(path) && path =~ /rb$/
+              path.sub! /.rb/, ''
+              yield path.sub /^.*#{root}\//, ''
+            end
+          end
+        end
+      end
+    end
+
+    def self.load(plugin = nil)
+      if plugin.nil? # load them all!
+        plugins = Hash.new
+
+        PLUGIN_ROOTS.each do |root|
+          # dive into the root directory to look for plugins
+          Find.find("#{root}/") do |path|
+            # don't operate on directories directly
+            unless File.directory?(path)
+              # only proceed if the file looks like a ruby file
+              if path =~ /rb$/ and File.file?(path)
+                instance = self.load_single_plugin(path, root)
+                plugins[instance.name] = instance unless instance.nil?
+              end
+            end
+          end
+        end
+
+        return plugins
+      else
+        begin
+          found = false
+
+          PLUGIN_ROOTS.each do |root|
+            path = "#{root}/#{plugin}.rb"
+
+            if File.file?(path)
+              instance = self.load_single_plugin(path, root)
+              return instance unless instance.nil?
+            end
+          end
+
+          # If we get here, a plugin was never
+          # loaded and returned.
+          raise Antfarm::PluginExistanceError, message
+        rescue Exception => e
+          raise Antfarm::AntfarmError, e.message
+        end
+      end
+    end
+
+    # TODO <scrapcoder>: check to see if module is already defined.
+    # If so, raise an error, passing the name of the created plugin
+    # object so a note can be presented to the user with the name/author
+    # of the plugin already created.
+    def self.load_single_plugin(path, root)
+      begin
+        # remove .rb from the end of the path
+        path.sub! /.rb/, ''
+        # the name of the plugin is the full file name (directories included)
+        # without everything up to and including the 'root plugins' directory
+        #
+        # NOTE at this point name now == plugin variable passed to 'load()'
+        name = path.sub /^.*#{root}\//, ''
+        require path.untaint
+        # capitalize each of the directory names since they signify modules
+        # remove underscore and capitalize first letter after underscore/hyphen
+        # taken from ActiveSupport's Inflector#camelize method
+        camelized_name = name.gsub(/\/(.?)/) { "::" + $1.upcase }.gsub(/(^|_|-)(.)/) { $2.upcase }
+        # create class object for plugin
+        plugin_class = eval("Antfarm::Plugin::#{camelized_name}")
+        # make sure plugin inherits from this class
+        unless plugin_class < self
+          raise Antfarm::PluginInheritanceError, "#{name} does not inherit from Antfarm::Plugin - this plugin will be unavailable"
+          return nil
+        end
+        # create a new plugin object
+        plugin = plugin_class.new
+        # tell the plugin what its name is
+        plugin.name = name
+        # return the plugin
+        return plugin
+      rescue LoadError
+        raise Antfarm::AntfarmError, "An error occurred while trying to load #{name} - this plugin will be unavailable"
+        return nil
+      rescue Exception => ex
+        Antfarm::Helpers.log :error, ex.message
+        raise Antfarm::AntfarmError, "An error occurred while initializing #{name} - this plugin will be unavailable"
+        return nil
+      end
+    end
+
+    ALLOWED_INFO    = [:name, :author, :desc ]
+    ALLOWED_OPTIONS = [:name, :desc, :long, :short, :type, :default, :required]
+
+    attr_reader :info
+    attr_reader :options
+
+    def initialize(info = nil, options = nil)
+      @info    = info
+      @options = [options].flatten
+
+      if @info
+        @info.reject! { |k,v| !ALLOWED_INFO.include?(k) }
+      end
+
+      if @options
+        for option in @options
+          raise Antfarm::PluginOptionsError, 'Each option must specify a name'        unless option[:name]
+          raise Antfarm::PluginOptionsError, 'Each option must specify a description' unless option[:desc]
+          option.reject! { |k,v| !ALLOWED_OPTIONS.include?(k) }
+          option[:type]    = :flag unless option.key?(:type)
+          option[:default] = false if option[:type] == :flag
+        end
+      end
+    end
+
+    def print_message(message)
+      Antfarm::Helpers.output "Message: #{message}"
+    end
+
+    def print_error(message)
+      Antfarm::Helpers.output "Error: #{message}"
+    end
+  end
+end