antfarm-core 0.5.0.beta1

data/lib/antfarm/models.rb

@@ -0,0 +1,51 @@
+################################################################################
+#                                                                              #
+# 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 'data_objects'
+require 'do_sqlite3'
+
+require 'dm-constraints'
+require 'dm-validations'
+
+# require all the models
+require 'antfarm/models/ethernet_interface'
+require 'antfarm/models/ip_interface'
+require 'antfarm/models/ip_network'
+require 'antfarm/models/layer_two_interface'
+require 'antfarm/models/layer_three_interface'
+require 'antfarm/models/layer_three_network'
+require 'antfarm/models/node'
+# require 'antfarm/models/private_network'
+# require 'antfarm/models/traffic'
+# require 'antfarm/models/dns_entry'
+# require 'antfarm/models/action'
+# require 'antfarm/models/service'
+# require 'antfarm/models/operating_system'

data/lib/antfarm/models/ethernet_interface.rb

@@ -0,0 +1,84 @@
+################################################################################
+#                                                                              #
+# 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 EthernetInterface
+      include DataMapper::Resource
+
+      storage_names[:default] = 'ethernet_interfaces'
+
+      property :id,      Serial
+      property :address, String, :required => true
+      property :custom,  String
+
+      # See the IpInterface model for an explanation of why we're doing this.
+      property :layer_two_interface_id, Integer, :required => true, :auto_validation => false
+
+      belongs_to :layer_two_interface #, :required => true, :auto_validation => false
+
+      before :create, :create_layer_two_interface
+
+      # This ensures that the MAC address entered
+      validates_format :address, :with => %r{\A([0-9a-fA-F]{2}[:-]){5}[0-9a-fA-F]{2}\z},
+                                 :message => 'invalid MAC address format'
+
+      #######
+      private
+      #######
+
+      # If a hash is passed into the layer2_interface
+      # variable, parameters matching variables on the
+      # layer 2 interface class will be used to create
+      # a new layer 2 interface object. This also works
+      # for nested hashes - i.e. if the hash passed into
+      # the layer2_interface variable contains a 'node'
+      # key that has a hash as a value, parameters in
+      # that hash that match variables on the node class
+      # will be used to create the node created by the
+      # layer 2 interface. w00t!
+      def create_layer_two_interface
+        Antfarm::Helpers.log :debug, '[PRIVATE METHOD CALLED] EthernetInterface#create_layer_two_interface'
+
+        # Only create a new layer 2 interface if
+        # a layer 2 interface  model isn't already
+        # associated with this model. This protects
+        # against new layer 2 interfaces being
+        # created when one is already provided or
+        # when this model is being saved rather
+        # than created (since a layer 2 interface
+        # will be automatically created and associated
+        # with this model on creation).
+        self.layer_two_interface ||= Antfarm::Model::LayerTwoInterface.create
+      end
+    end
+  end
+end

data/lib/antfarm/models/ip_interface.rb

@@ -0,0 +1,134 @@
+################################################################################
+#                                                                              #
+# 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 IpInterface
+      include DataMapper::Resource
+
+      storage_names[:default] = 'ip_interfaces'
+
+      property :id, Serial
+
+      # I turn auto_validation off here since we are manually
+      # validating that an address was provided below in the
+      # 'validates_with_block' declaration below. Read below
+      # for why we do this manually...
+      property :address, String,  :required => true, :auto_validation => false
+      property :virtual, Boolean, :required => true, :default => false
+      property :custom,  String
+
+      # So right now we have a problem... currently we do NOT
+      # want to create a layer 3 interface (and consequently
+      # an IP network and layer 3 network) if the data given
+      # for a new IP interface is not valid. This can be done
+      # by requiring a layer_three_interface_id to exist for
+      # an IpInterface, but not auto-validating, which will
+      # allow us to validate the data given BEFORE creating
+      # a new layer 3 interface. However, currently the
+      # 'belongs_to' method does not act on ':auto_validation'
+      # (it will in a future dm-validations release) so we
+      # have to specify the 'layer_three_interface_id' property
+      # explicitly here until the new version is out. For more
+      # information, see the GitHub Gist and comments between
+      # dkubb and ccss-sandia.
+      property :layer_three_interface_id, Integer, :required => true, :auto_validation => false
+
+      belongs_to :layer_three_interface #, :required => true, :auto_validation => false
+
+      before :create, :create_layer_three_interface
+
+#     validates_format :address,
+#       :with    => %r{\A(?:25[0-5]|(?:2[0-4]|1\d|[1-9])?\d)(?:\.(?:25[0-5]|(?:2[0-4]|1\d|[1-9])?\d)){3}(?:\/[1-3]\d)?\z},
+#       :message => 'invalid IP address format'
+
+      # We're doing all the validations here manually
+      # (rather than using the shortcuts above) so they
+      # will be executed in order. If the shortcut methods
+      # are used, this validation is ran first so when
+      # an invalid address is given the @ip_addr object
+      # doesn't exist and NoMethodErrors are thrown.
+      validates_with_block :address do
+        format     = %r{\A(?:25[0-5]|(?:2[0-4]|1\d|[1-9])?\d)(?:\.(?:25[0-5]|(?:2[0-4]|1\d|[1-9])?\d)){3}(?:\/[1-3]\d)?\z}
+        @ip_addr ||= Antfarm::IPAddrExt.new(self.address) rescue nil
+
+        if self.address.nil?
+          [ false, 'must be present' ]
+        elsif not self.address =~ format
+          [ false, 'invalid IP address format' ]
+        elsif @ip_addr.loopback_address?
+          [ false, 'loopback address not allowed' ]
+        elsif not @ip_addr.private_address?
+          # If the address is public and it already exists in the database, don't create
+          # a new one but still create a new IP Network just in case the data given for
+          # this address includes more detailed information about its network.
+          #
+          # TODO: what should we do about multiple private networks?
+          # Right now, multiple private interfaces of the same address can exist,
+          # but they will just be associated with the same private network...
+          if interface = Antfarm::Model::IpInterface.find_by_address(self.address)
+            create_ip_network
+            [ false, "#{self.address} already exits, but a new IP network was created anyway" ]
+          else
+            true
+          end
+        else
+          true
+        end
+      end
+
+      #######
+      private
+      #######
+
+      def create_layer_three_interface
+        Antfarm::Helpers.log :debug, '[PRIVATE METHOD CALLED] IpInterface#create_layer_three_interface'
+
+        self.layer_three_interface ||= Antfarm::Model::LayerThreeInterface.create :layer_three_network => create_ip_network
+      end
+
+      def create_ip_network
+        Antfarm::Helpers.log :debug, '[PRIVATE METHOD CALLED] IpInterface#create_ip_network'
+
+        @ip_addr ||= Antfarm::IPAddrExt.new(self.address) rescue return nil
+
+        network = Antfarm::Model::LayerThreeNetwork.network_containing(@ip_addr.to_cidr_string)
+        return network unless network.nil?
+
+        net         = @ip_addr.clone
+        net.netmask = net.netmask << 2 if net == net.network
+
+        network = Antfarm::Model::IpNetwork.create :address => net.to_cidr_string
+        return network.layer_three_network
+      end
+    end
+  end
+end

data/lib/antfarm/models/ip_network.rb

@@ -0,0 +1,118 @@
+################################################################################
+#                                                                              #
+# 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 IpNetwork
+      include DataMapper::Resource
+
+      storage_names[:default] = 'ip_networks'
+
+      property :id, Serial
+
+      # I turn auto_validation off here since we are manually
+      # validating that an address was provided below in the
+      # 'validates_with_block' declaration below. Read below
+      # for why we do this manually...
+      property :address, String,  :required => true, :auto_validation => false
+      property :private, Boolean, :required => true, :default => false
+      property :custom,  String
+
+      # See the IpInterface model for an explanation of why we're doing this.
+      property :layer_three_network_id, Integer, :required => true, :auto_validation => false
+
+      belongs_to :layer_three_network #, :required => true, :auto_validation => false
+
+      before :create, :create_layer_three_network
+      before :create, :set_private_address
+      after  :create, :merge_layer_three_networks
+
+#     validates_format :address,
+#       :with    => %r{\A(?:25[0-5]|(?:2[0-4]|1\d|[1-9])?\d)(?:\.(?:25[0-5]|(?:2[0-4]|1\d|[1-9])?\d)){3}(?:\/[1-3]\d)?\z},
+#       :message => 'invalid IP network format'
+
+      # We're doing all the validations here manually
+      # (rather than using the shortcuts above) so they
+      # will be executed in order. If the shortcut methods
+      # are used, this validation is ran first so when
+      # an invalid address is given the @ip_net object
+      # doesn't exist and NoMethodErrors are thrown.
+      validates_with_block :address do
+        format    = %r{\A(?:25[0-5]|(?:2[0-4]|1\d|[1-9])?\d)(?:\.(?:25[0-5]|(?:2[0-4]|1\d|[1-9])?\d)){3}(?:\/[1-3]\d)?\z}
+        @ip_net ||= Antfarm::IPAddrExt.new(self.address) rescue nil
+
+        if self.address.nil?
+          [ false, 'must be present' ]
+        elsif not self.address =~ format
+          [ false, 'invalid IP network format' ]
+        elsif @ip_net.loopback_address?
+          [ false, 'loopback address not allowed' ]
+        else
+          true
+        end
+      end
+
+      #######
+      private
+      #######
+
+      def create_layer_three_network
+        Antfarm::Helpers.log :debug, '[PRIVATE METHOD CALLED] IpNetwork#create_layer_three_network'
+
+        # Only create a new layer 3 network if
+        # a layer 3 network  model isn't already
+        # associated with this model. This protects
+        # against new layer 3 networks being
+        # created when one is already provided or
+        # when this model is being saved rather
+        # than created (since a layer 3 network
+        # will be automatically created and associated
+        # with this model on creation).
+        self.layer_three_network ||= Antfarm::Model::LayerThreeNetwork.create
+      end
+
+      def set_private_address
+        Antfarm::Helpers.log :debug, '[PRIVATE METHOD CALLED] IpNetwork#set_private_address'
+
+        @ip_net    ||= Antfarm::IPAddrExt.new(self.address) rescue return nil
+        self.private = @ip_net.private_address?
+        # TODO: Create private network objects.
+        return # if we don't do this, then a false is returned and the save fails
+      end
+
+      def merge_layer_three_networks
+        # Merge any existing networks already in the database that are
+        # sub_networks of this new network.
+        LayerThreeNetwork.merge(self.layer_three_network, 0.80)
+      end
+    end
+  end
+end

data/lib/antfarm/models/layer_three_interface.rb

@@ -0,0 +1,88 @@
+################################################################################
+#                                                                              #
+# 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 LayerThreeInterface
+      include DataMapper::Resource
+
+      storage_names[:default] = 'layer_three_interfaces'
+
+      property :id,               Serial
+      property :certainty_factor, Float, :required => true, :default => 0.8
+      property :protocol,         String
+      property :custom,           String
+
+      belongs_to :layer_two_interface, :required => true
+      belongs_to :layer_three_network, :required => true
+
+      validates_present :certainty_factor
+
+      # Need to do this before validation since
+      # :required => true is specified on the
+      # layer 2 interface association above.
+      #
+      # Note that we do NOT automatically create
+      # a layer 3 network on creation. That should
+      # ALWAYS be provided to this model by the
+      # IP interface model when it's being created.
+      before :valid?, :create_layer_two_interface
+      before :save,   :clamp_certainty_factor
+
+      #######
+      private
+      #######
+
+      # If a hash is passed into the layer 2 interface variable,
+      # parameters matching variables on the layer 2 interface
+      # class will be used to create a new layer 2 interface object.
+      def create_layer_two_interface
+        Antfarm::Helpers.log :debug, '[PRIVATE METHOD CALLED] LayerThreeInterface#create_layer_two_interface'
+
+        # Only create a new layer 2 interface if a
+        # layer 2 interface model isn't already
+        # associated with this model. This protects
+        # against new layer 2 interfaces being
+        # created when one is already provided or
+        # when this model is being saved rather
+        # than created (since a layer 2 interface
+        # will be automatically created and
+        # associated with this model on creation).
+        self.layer_two_interface ||= Antfarm::Model::LayerTwoInterface.create
+      end
+
+      def clamp_certainty_factor
+        Antfarm::Helpers.log :debug, '[PRIVATE METHOD CALLED] LayerThreeInterface#clamp_certainty_factor'
+        self.certainty_factor = Antfarm::Helpers.clamp(self.certainty_factor)
+      end
+    end
+  end
+end