antfarm 0.3.0 → 0.4.0

data/lib/antfarm/ip_interface.rb

@@ -87,7 +87,7 @@ class IpInterface < ActiveRecord::Base
     super(@ip_addr.to_s)
   end
 
-  validates_presence_of :address
+  validates_presence_of   :address
 
   # Validate data for requirements before saving interface to the database.
   #
@@ -95,9 +95,20 @@ class IpInterface < ActiveRecord::Base
   # on anything saved to the database at any time, including a create and an update.
   def validate #:nodoc:
     # Don't save the interface if it's a loopback address.
-    unless !@ip_addr.loopback_address?
+    if @ip_addr.loopback_address?
       errors.add(:address, "loopback address not allowed")
     end
+
+    # 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.
+    unless @ip_addr.private_address?
+      interfaces = IpInterface.find :all, :conditions => { :address => address }
+      if interfaces && interfaces.length > 0
+        create_ip_network
+        errors.add(:address, 'address already exists, but a new IP Network was created')
+      end
+    end
   end
 
   # This is for ActiveScaffold
@@ -122,30 +133,7 @@ class IpInterface < ActiveRecord::Base
       if @layer3_network
         layer3_interface.layer3_network = @layer3_network
       else
-        # Check to see if a network exists that contains this address.
-        # If not, create a small one that does.
-        layer3_network = Layer3Network.network_containing(@ip_addr.to_cidr_string)
-        unless layer3_network
-          network = @ip_addr.clone
-          if network == network.network
-            network.netmask = network.netmask << 3
-          end
-
-          ip_network = IpNetwork.new :address => network.to_cidr_string
-          ip_network.layer3_network_protocol = @layer3_network_protocol if @layer3_network_protocol
-          if ip_network.save
-            logger.info("IpInterface: Created IP Network")
-          else
-            logger.warn("IpInterface: Errors occured while creating IP Network")
-            ip_network.errors.each_full do |msg|
-              logger.warn(msg)
-            end
-          end
-
-          layer3_network = ip_network.layer3_network
-        end
-
-        layer3_interface.layer3_network = layer3_network
+        layer3_interface.layer3_network = create_ip_network
       end
 
       if @layer2_interface
@@ -174,4 +162,28 @@ class IpInterface < ActiveRecord::Base
       self.layer3_interface = layer3_interface
     end
   end
+
+  def create_ip_network
+    # Check to see if a network exists that contains this address.
+    # If not, create a small one that does.
+    layer3_network = Layer3Network.network_containing(@ip_addr.to_cidr_string)
+    unless layer3_network
+      network = @ip_addr.clone
+      if network == network.network
+        network.netmask = network.netmask << 3
+      end
+      ip_network = IpNetwork.new :address => network.to_cidr_string
+      ip_network.layer3_network_protocol = @layer3_network_protocol if @layer3_network_protocol
+      if ip_network.save
+        logger.info("IpInterface: Created IP Network")
+      else
+        logger.warn("IpInterface: Errors occured while creating IP Network")
+        ip_network.errors.each_full do |msg|
+          logger.warn(msg)
+        end
+      end
+      layer3_network = ip_network.layer3_network
+    end
+    return layer3_network
+  end
 end

data/lib/antfarm/ip_network.rb

@@ -28,9 +28,9 @@ class IpNetwork < ActiveRecord::Base
   belongs_to :layer3_network, :foreign_key => "id"
   belongs_to :private_network
 
-  before_validation :set_private_address
   before_create :create_layer3_network
-  after_create :merge_layer3_networks
+  before_create :set_private_address
+  after_create  :merge_layer3_networks
 
   # Protocol of the layer 3 network automatically
   # created for this IP network.
@@ -75,7 +75,7 @@ class IpNetwork < ActiveRecord::Base
   def set_private_address
     self.private = @ip_net.private_address?
     # TODO: Create private network objects.
-    return true
+    return # if we don't do this, then a false is returned and the save fails
   end
 
   def create_layer3_network

data/lib/antfarm/layer2_interface.rb

@@ -75,9 +75,22 @@ class Layer2Interface < ActiveRecord::Base
 
   def create_node
     unless self.node
-      node = Node.new :certainty_factor => 0.75
-      node.name = @node_name if @node_name
-      node.device_type = @node_device_type if @node_device_type
+      if @node_name
+        nodes = Node.find(:all, :conditions => { :name => @node_name })
+        case nodes.length
+        when 0
+          node = Node.new :certainty_factor => 0.75
+          node.name = @node_name
+        when 1
+          node = nodes.first
+        else
+          node = nodes.first
+          #TODO: do something here with certainty factor?
+        end
+      else
+        node = Node.new :certainty_factor => 0.75
+      end
+      node.device_type = @node_device_type
       if node.save
         logger.info("Layer2Interface: Created Node")
       else

data/lib/antfarm/layer3_network.rb

@@ -47,13 +47,13 @@ class Layer3Network < ActiveRecord::Base
 
         merge_certainty_factor = Antfarm.clamp(merge_certainty_factor)
 
-        l3_ifs = network.layer3_interfaces
-        l3_ifs << sub_network.layer3_interfaces
-        l3_ifs.flatten!
+        network.layer3_interfaces << sub_network.layer3_interfaces
+        network.layer3_interfaces.flatten!
+        network.layer3_interfaces.uniq!
 
         # TODO: update network's certainty factor using sub_network's certainty factor.
         
-        network.update_attributes :layer3_interfaces => l3_ifs
+        network.save false
 
         # Because of :dependent => :destroy above, calling destroy
         # here will also cause destroy to be called on ip_network

data/lib/antfarm/node.rb

@@ -26,6 +26,8 @@
 class Node < ActiveRecord::Base
   has_many :layer2_interfaces
   has_many :layer3_interfaces, :through => :layer2_interfaces
+  has_many :services
+  has_one  :operating_system
 
   before_save :clamp_certainty_factor
 
@@ -67,6 +69,10 @@ class Node < ActiveRecord::Base
     end
   end
 
+  def to_label
+    return self
+  end
+
   #######
   private
   #######

data/lib/antfarm/operating_system.rb

@@ -0,0 +1,25 @@
+# Copyright (2008) Sandia Corporation.
+# Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
+# the U.S. Government retains certain rights in this software.
+#
+# Original Author: Bryan T. Richardson, Sandia National Laboratories <btricha@sandia.gov>
+# Derived From: code written by Michael Berg <mjberg@sandia.gov>
+#
+# This library is free software; you can redistribute it and/or modify it
+# under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation; either version 2.1 of the License, or (at
+# your option) any later version.
+#
+# This library is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+# details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this library; if not, write to the Free Software Foundation, Inc.,
+# 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 
+
+class OperatingSystem < ActiveRecord::Base
+  belongs_to :action
+  belongs_to :node
+end

data/lib/antfarm/service.rb

@@ -0,0 +1,25 @@
+# Copyright (2008) Sandia Corporation.
+# Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
+# the U.S. Government retains certain rights in this software.
+#
+# Original Author: Bryan T. Richardson, Sandia National Laboratories <btricha@sandia.gov>
+# Derived From: code written by Michael Berg <mjberg@sandia.gov>
+#
+# This library is free software; you can redistribute it and/or modify it
+# under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation; either version 2.1 of the License, or (at
+# your option) any later version.
+#
+# This library is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+# details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this library; if not, write to the Free Software Foundation, Inc.,
+# 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 
+
+class Service < ActiveRecord::Base
+  belongs_to :action
+  belongs_to :node
+end

data/lib/console.rb

@@ -0,0 +1,9 @@
+options = { :irb => 'irb' }
+
+ENV['ANTFARM_ENV'] = ARGV.shift
+libs =  " -r irb/completion"
+libs << %( -r "#{ANTFARM_ROOT}/config/environment")
+
+puts "Loading #{ENV['ANTFARM_ENV']} environment"
+
+exec "#{options[:irb]} #{libs} --simple-prompt"

data/lib/cpscript.rb

@@ -0,0 +1,70 @@
+# Copyright (2008) Sandia Corporation.
+# Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
+# the U.S. Government retains certain rights in this software.
+#
+# Original Author: Bryan T. Richardson, Sandia National Laboratories <btricha@sandia.gov>
+#
+# This library is free software; you can redistribute it and/or modify it
+# under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation; either version 2.1 of the License, or (at
+# your option) any later version.
+#
+# This library is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+# details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this library; if not, write to the Free Software Foundation, Inc.,
+# 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 
+
+require 'fileutils'
+
+module Antfarm
+
+  # Extends SCParse::Command so it can be considered as a command.
+  class CPScript < SCParse::Command
+    def initialize
+      # set the command name to 'cp'
+      super('cp-script')
+    end
+
+    def execute(args)
+      super(args)
+
+      if defined?(USER_DIR)
+        script = args.pop + '.rb'
+        parents = args.join('/')
+        location = File.expand_path("#{ANTFARM_ROOT}/lib/scripts/#{parents}/#{script}")
+        if File.exists?(location)
+          FileUtils.makedirs("#{USER_DIR}/scripts/#{parents}")
+          FileUtils.cp(location, "#{USER_DIR}/scripts/#{parents}/")
+          if parents.empty?
+            puts "The script #{script} has been copied to #{USER_DIR}/scripts/"
+          else
+            puts "The script #{script} has been copied to #{USER_DIR}/scripts/#{parents}/"
+          end
+        else
+          if parents.empty?
+            puts "The script #{script} doesn't seem to exist.  Please try again."
+          else
+            puts "The script #{parents}/#{script} doesn't seem to exist.  Please try again."
+          end
+        end
+      else
+        puts "No custom user directory exists.  Please run 'antfarm db --initialize' first."
+      end
+    end
+
+    def show_help
+      super
+
+      puts "This command is used to copy scripts available in the core ANTFARM package to"
+      puts "your user directory.  This is useful for utilizing existing core ANTFARM scripts"
+      puts "as a basis for creating your own custom scripts."
+      puts
+      puts "As arguments to this command, specify the script you want to copy to your user"
+      puts "directory.  For example: antfarm cp-script cisco parse-arp"
+    end
+  end
+end

data/lib/dbmanage.rb

@@ -34,6 +34,7 @@ module Antfarm
       @opts.migrate = false
       @opts.remove = false
       @opts.reset = false
+      @opts.console = false
 
       @options = OptionParser.new do |opts|
         opts.on('--initialize', "Initialize user's environment") do
@@ -47,6 +48,7 @@ module Antfarm
           @opts.migrate = true
         end
         opts.on('--reset', "Reset tables in database and clear the log file for the given environment") { @opts.reset = true }
+        opts.on('--console', "Start up an SQLite3 console using the database for the given environment") { @opts.console = true }
       end
     end
 
@@ -63,6 +65,8 @@ module Antfarm
         db_migrate
       elsif @opts.reset
         db_reset
+      elsif @opts.console
+        db_console
       end
     end
 
@@ -101,6 +105,10 @@ module Antfarm
       Find.find(Antfarm.log_dir_to_use) do |path|
         `rm #{path}` unless File.basename(path) == 'log'
       end
+
+      Find.find(Antfarm.tmp_dir_to_use) do |path|
+        `rm #{path}` unless File.basename(path) == 'tmp'
+      end
     end
 
     # Creates a new database and schema file.  The location of the newly created
@@ -108,13 +116,22 @@ module Antfarm
     # configuration hash, and is based on the current ANTFARM environment.
     def db_migrate
       if File.exists?(File.expand_path("#{ANTFARM_ROOT}/db/schema.rb"))
-        load(File.expand_path("#{ANTFARM_ROOT}/db/schema.rb"))
+        begin
+          load(File.expand_path("#{ANTFARM_ROOT}/db/schema.rb"))
+        rescue PGError
+          puts "Looks like you are using the PostgreSQL database and you haven't yet created a database for this environment."
+          puts "Please execute 'psql #{ANTFARM_ENV}' to create the database, then try running 'antfarm db --migrate' again."
+        end
       else
         puts "A schema file did not exist. Running migrations instead."
-
-        ActiveRecord::Migration.verbose = true
-        ActiveRecord::Migrator.migrate(ANTFARM_ROOT + "/db/migrate/", nil)
-        db_schema_dump if ActiveRecord::Base.schema_format == :ruby
+        begin
+          ActiveRecord::Migration.verbose = true
+          ActiveRecord::Migrator.migrate(ANTFARM_ROOT + "/db/migrate/", nil)
+          db_schema_dump if ActiveRecord::Base.schema_format == :ruby
+        rescue PGError
+          puts "Looks like you are using the PostgreSQL database and you haven't yet created a database for this environment."
+          puts "Please execute 'psql #{ANTFARM_ENV}' to create the database, then try running 'antfarm db --migrate' again."
+        end
       end
     end
 
@@ -123,6 +140,18 @@ module Antfarm
       db_migrate
     end
 
+    def db_console
+      if (defined? USER_DIR) && File.exists?("#{USER_DIR}/config/defaults.yml")
+        config = YAML::load(IO.read("#{USER_DIR}/config/defaults.yml"))
+      end
+      puts "Loading #{ANTFARM_ENV} environment"
+      if config && config[ANTFARM_ENV] && config[ANTFARM_ENV]['adapter'] == 'postgresql'
+        exec "psql #{ANTFARM_ENV}"
+      else
+        exec "sqlite3 #{Antfarm.db_file_to_use}"
+      end
+    end
+
     def db_schema_dump
       require 'active_record/schema_dumper'
 

data/lib/init/initializer.rb

@@ -20,6 +20,7 @@
 #
 # This script is modeled after the Rails initializer class.
 
+require 'yaml'
 require 'rubygems'
 require 'active_record'
 
@@ -61,10 +62,31 @@ module Antfarm
       require 'antfarm'
     end
 
-    # Currently, sqlite3 databases are the only ones supported. The name of the ANTFARM environment
-    # (which defaults to 'antfarm') is the name used for the database file and the log file.
+    # Currently, SQLite3 and PostgreSQL databases are the only ones supported.
+    # The name of the ANTFARM environment (which defaults to 'antfarm') is the
+    # name used for the database file and the log file.
     def initialize_database
-      config = { ANTFARM_ENV => { 'adapter' => 'sqlite3', 'database' => Antfarm.db_file_to_use } }
+      if (defined? USER_DIR) && File.exists?("#{USER_DIR}/config/defaults.yml")
+        config = YAML::load(IO.read("#{USER_DIR}/config/defaults.yml"))
+      end
+      # Database setup based on adapter specified
+      if config && config[ANTFARM_ENV] && config[ANTFARM_ENV].has_key?('adapter')
+        if config[ANTFARM_ENV]['adapter'] == 'sqlite3'
+          config[ANTFARM_ENV]['database'] = Antfarm.db_file_to_use
+        elsif config[ANTFARM_ENV]['adapter'] == 'postgresql'
+          config[ANTFARM_ENV]['database'] = ANTFARM_ENV
+        else
+          # If adapter specified isn't one of sqlite3 or postgresql,
+          # default to SQLite3 database configuration.
+          config = nil
+        end
+      else
+        # If the current environment configuration doesn't specify a
+        # database adapter, default to SQLite3 database configuration.
+        config = nil
+      end
+      # Default to SQLite3 database configuration
+      config ||= { ANTFARM_ENV => { 'adapter' => 'sqlite3', 'database' => Antfarm.db_file_to_use } }
       ActiveRecord::Base.configurations = config
       ActiveRecord::Base.establish_connection(ActiveRecord::Base.configurations[ANTFARM_ENV])
     end

data/lib/scparse.rb

@@ -66,7 +66,7 @@ module SCParse
     end
 
     def add_command(command)
-      @commands = CommandHash.new unless @commands
+      @commands ||= CommandHash.new
       @commands[command.name] = command
       command.parent = self
     end
@@ -90,6 +90,12 @@ module SCParse
       return parents
     end
 
+    # Does this command have a given subcommand?
+    # Note: returns the command or nil, not true/false.
+    def has_command?(command)
+      return @commands[command]
+    end
+
     # Does this command have any subcommands it's a parent to?
     def has_commands?
       return @commands.nil? ? false : true
@@ -268,6 +274,13 @@ module SCParse
       @main.add_command(command)
     end
 
+    # Does this application have a command with
+    # the given name?
+    # Note: returns command or nil, not true/false.
+    def has_command?(command)
+      @main.has_command?(command)
+    end
+
     # Returns any options in the main command object.
     def options
       @main.options