shu-san-scripts 0.0.2

data/lib/SANStore/cli/commands.rb

@@ -0,0 +1,30 @@
+# Copyright (c) 2009 Denis Defreyne, 2010-2011 David Love
+#
+# Permission to use, copy, modify, and/or distribute this software for 
+# any purpose with or without fee is hereby granted, provided that the 
+# above copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+# @author David Love
+#
+# The +Commands+ module acts as the gathering place for all the sub-commands 
+# which the +store+ command can deal with. Each sub-command defines both 
+# the command action, options, and associated help text.
+#
+# All commands should live under +lib/SANStore/cli/commands+, with the 
+# file-name named after the sub-command defined within it. 
+
+module SANStore::CLI::Commands
+end
+
+require 'SANStore/cli/commands/help'
+
+#require 'SANStore/cli/commands/new_vol'
+#require 'SANStore/cli/commands/list_vols'

data/lib/SANStore/cli/commands/help.rb

@@ -0,0 +1,106 @@
+### Copyright (c) 2009 Denis Defreyne, 2010-2011 David Love
+###
+### Permission to use, copy, modify, and/or distribute this software for 
+### any purpose with or without fee is hereby granted, provided that the 
+### above copyright notice and this permission notice appear in all copies.
+###
+### THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+### WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+### MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+### ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+### WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+### ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+### OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+###
+
+module SANStore::CLI::Commands
+
+  # @author Denis Defreyne
+  # @author David Love
+  #
+  # The +help+ command show the user a brief summary of the available
+  # sub-commands, and the short description of each of those commands.
+  #
+  # Further help is available to the user, if one of the sub-commands
+  # is named as an argument to this command. In that case, the longer
+  # help for the command is displayed.
+  #
+  # @note This class is merely a helper class: the actual text, options
+  #   and other details are drawn directly from the source code of those
+  #   commands. In the execution of this command, we rely on the +cri+
+  #   and +cli+ libraries to do the hard work of actually processing the
+  #   sub-commands.
+  class Help < Cri::Command
+
+    # The name of the sub-command (as it appears in the command line app)
+    def name
+      'help'
+    end
+
+    # The aliases this sub-command is known by
+    def aliases
+      []
+    end
+
+    # A short help text describing the purpose of this command
+    def short_desc
+      'Show help for a command'
+    end
+
+    # A longer description, detailing both the purpose and the
+    # use of this command
+    def long_desc
+      'Show help for the given command, or show general help. When no ' +
+      'command is given, a list of available commands is displayed, as ' +
+      'well as a list of global command-line options. When a command is ' +
+      'given, a command description as well as command-specific ' +
+      'command-line options are shown.'
+    end
+
+    # Show the user the basic syntax of this command
+    def usage
+      "store help [command]"
+    end
+
+    # Execute the command
+    def run(options, arguments)
+      # Check arguments
+      if arguments.size > 1
+        $stderr.puts "usage: #{usage}"
+        exit 1
+      end
+
+      if arguments.length == 0
+        # Build help text
+        text = ''
+
+        # Add title
+        text << "A command-line tool for managing iSCSI targets on OpenSolaris.\n"
+
+        # Add available commands
+        text << "\n"
+        text << "Available commands:\n"
+        text << "\n"
+        @base.commands.sort.each do |command|
+          text << sprintf("    %-20s %s\n", command.name, command.short_desc)
+        end
+
+        # Add global options
+        text << "\n"
+        text << "Global options:\n"
+        text << "\n"
+        @base.global_option_definitions.sort { |x,y| x[:long] <=> y[:long] }.each do |opt_def|
+          text << sprintf("    -%1s --%-15s %s\n", opt_def[:short], opt_def[:long], opt_def[:desc])
+        end
+
+        # Display text
+        puts text
+      elsif arguments.length == 1
+        command = @base.command_named(arguments[0])
+        puts command.help
+      end
+    end
+
+  end
+
+end

data/lib/SANStore/cli/commands/list_vols.rb

@@ -0,0 +1,87 @@
+# Copyright (c) 2011 David Love
+#
+# Permission to use, copy, modify, and/or distribute this software for 
+# any purpose with or without fee is hereby granted, provided that the 
+# above copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+#
+# @author David Love
+#
+
+module WhiteCloth::CLI::Commands
+
+  # @author David Love
+  #
+  # Displays a summary of the realm data found in the configured WhiteCloth
+  # server.
+  class Show < Cri::Command
+    
+    # The name of the sub-command (as it appears in the command line app)
+    def name
+      'show-status'
+    end
+
+    # The aliases this sub-command is known by
+    def aliases
+      []
+    end
+
+    # A short help text describing the purpose of this command
+    def short_desc
+      'Create or update information from the network'
+    end
+
+    # A longer description, detailing both the purpose and the
+    # use of this command
+    def long_desc
+      "Displays the current state of the evironemnt " +
+      "to update the host files (held in the 'hosts' directory). Existing " +
+      "information will be updated, and missing information inserted.\n"
+    end
+    
+    # Show the user the basic syntax of this command
+    def usage
+      "bootstrap show-status"
+    end
+
+    # Define the options for this command
+    def option_definitions
+      []
+    end
+
+    # Execute the command
+    def run(options, arguments)
+
+      # Load the list of groups
+      group_list = YAML::load( File.open("config/groups.yaml"))
+      
+      # Load the list of networks
+      network_list = YAML::load( File.open("config/networks.yaml"))
+
+      # Update the information in each group-network directory
+      gn_name_list = Array.new
+
+      network_list.each{|network|
+        puts network[1]
+        
+        net_block = network[1]['ip4-address-block'].to_s
+
+        # Scan this network
+        # parser = Nmap::Parser.parsescan("nmap", "-sVC " + net_block)
+
+        puts parser
+      }
+
+    end
+  
+  end
+
+end

data/lib/SANStore/cli/commands/new_vol.rb

@@ -0,0 +1,103 @@
+# Copyright (c) 2009 Denis Defreyne, 2010-2011 David Love
+#
+# Permission to use, copy, modify, and/or distribute this software for 
+# any purpose with or without fee is hereby granted, provided that the 
+# above copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+
+module WhiteCloth::CLI::Commands
+
+  # @author David Love
+  #
+  # The +bootstrap+ command prepared the basic WhiteCloth realms (if 
+  # needed), and then links the current host to those realms. The basic
+  # realms consists of
+  #
+  # +Realm 0+: *Namespace*. All the named realms stored in this domain.
+  # 
+  # +Realm 1+: *Realm Handlers*. The basic gateways needed to create/store/update
+  # other realms.
+  # 
+  # +Realm 5+: *Realm Code*. Libraries and other code which the realm handlers
+  # should use by preference when conducting operations on the realms.
+  #
+  # If the IP address of a server (or a server name) is given to as an argument
+  # to this command, then we will use that IP address (name) for as the WhiteCloth
+  # realm server to contact. Otherwise we will look for the same data from the file
+  # +/etc/whitecloth.conf+: aborting if the file cannot be found.
+  #
+  # Once we have made contact with the server, we look at the basic realms listed
+  # above, and attempt to ensure they can be found. If not, an attempt is made to
+  # create the basic realms: aborting if this attempt fails.
+  #
+  # Finally, once everything has been set-up, we upload the core realm code (or 
+  # update the existing code)
+  class Bootstrap < Cri::Command
+
+    # The name of the sub-command (as it appears in the command line app)
+    def name
+      'bootstrap'
+    end
+
+    # The aliases this sub-command is known by
+    def aliases
+      []
+    end
+
+    # A short help text describing the purpose of this command
+    def short_desc
+      'Create a link between this host and the whitecloth servers.'
+    end
+
+    # A longer description, detailing both the purpose and the
+    # use of this command
+    def long_desc
+      'Look for the specified server, adding the data required to link the ' +
+      'current host to that server. If the found server has not been set-up ' +
+      'then this command also performs the setup of the base realms as well. '
+    end
+
+    # Show the user the basic syntax of this command
+    def usage
+      "whitecloth bootstrap [-s server]"
+    end
+    
+    # Define the options for this command
+    def option_definitions
+      [
+        { :short => 's', :long => 'server', :argument => :optional }
+      ]
+    end
+
+    # Execute the command
+    def run(options, arguments)
+      
+      # The first thing we need to do is to find the relevant server. So we 
+      # check the options and see if they can help
+      unless options[:server].nil? or options[:server].empty? then
+        #
+      else
+      
+        # The user has not specified a server, so we will attempt to get one
+        # from the system configuration
+        if File.exists?("/etc/whitecloth.conf") then
+          #
+        
+        # Everything has failed, so we abort        
+        else
+          WhiteCloth::CLI::Logger.instance.log_level(:high, :error, "Cannot locate a WhiteCloth server. Either specify the server to connect to using the 'server' option, or create an appropriate configuration file.")
+        end
+      end  
+    end
+
+  end
+
+end

data/lib/SANStore/cli/logger.rb

@@ -0,0 +1,88 @@
+# Copyright (c) 2009 Denis Defreyne, 2010-2011 David Love
+#
+# Permission to use, copy, modify, and/or distribute this software for 
+# any purpose with or without fee is hereby granted, provided that the 
+# above copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+
+require 'singleton'
+require 'facets'
+
+module SANStore::CLI
+
+  # SANStore::CLI::Logger is a singleton class responsible for generating
+  # feedback in the terminal.
+  class Logger
+
+    # ANSI console codes (escape sequences) for highlighting particular
+    # log outputs.
+    ACTION_COLORS = {
+      :error          => "\e[1m" + "\e[31m", # bold + red
+      :warning        => "\e[1m" + "\e[33m", # bold + yellow
+      :info           => "\e[1m" + "\e[32m", # bold + green
+    }
+
+    include Singleton
+
+    # The log level, which can be :high, :low or :off (which will log all
+    # messages, only high-priority messages, or no messages at all,
+    # respectively).
+    attr_accessor :level
+
+    # Whether to use color in log messages or not
+    attr_accessor :color
+    alias_method :color?, :color
+
+    def initialize
+      @level = :high
+      @color = true
+    end
+
+    # Logs a messsage, using appropriate colours to highlight different
+    # levels.
+    #
+    # +level+:: The importance of this action. Can be :high or :low.
+    #
+    # +action+:: The kind of file action. Can be :create, :update or
+    #            :identical.
+    #
+    # +message+:: The identifier of the item the action was performed on.
+    def log_level(level, action, message)
+      log(
+        level,
+        '%s%12s%s:  %s' % [
+          color? ? ACTION_COLORS[action.to_sym] : '',
+          action.capitalize,
+          color? ? "\e[0m" : '',
+          message.word_wrap(60).indent(15).lstrip
+        ]
+      )
+    end
+
+    # Logs a message.
+    #
+    # +level+:: The importance of this message. Can be :high or :low.
+    #
+    # +message+:: The message to be logged.
+    #
+    # +io+:: The IO instance to which the message will be written. Defaults to
+    #        standard output.
+    def log(level, message, io=$stdout)
+      # Don't log when logging is disabled
+      return if @level == :off
+
+      # Log when level permits it
+      io.puts(message) if (@level == :low or @level == level)
+    end
+
+  end
+
+end

data/lib/SANStore/cri.rb

@@ -0,0 +1,12 @@
+module Cri
+
+  # The current Cri version.
+  CRI_VERSION = '1.0'
+
+end
+
+# Load Cri
+require 'SANStore/cri/base'
+require 'SANStore/cri/command'
+require 'SANStore/cri/core_ext'
+require 'SANStore/cri/option_parser'

data/lib/SANStore/cri/base.rb

@@ -0,0 +1,153 @@
+module Cri
+
+  # Cri::Base is the central class representing a commandline tool. It has a
+  # list of commands.
+  class Base
+
+    # The CLI's list of commands (should also contain the help command)
+    attr_reader :commands
+
+    # The CLI's help command (required)
+    attr_accessor :help_command
+
+    # Creates a new instance of the commandline tool.
+    def initialize(tool_name)
+      @tool_name = tool_name
+
+      @commands = []
+    end
+
+    # Parses the given commandline arguments and executes the requested
+    # command.
+    def run(args)
+      # Check arguments
+      if args.length == 0
+        @help_command.run([], [])
+        exit 1
+      end
+
+      # Partition options
+      opts_before_command         = []
+      command_name                = nil
+      opts_and_args_after_command = []
+      stage = 0
+      args.each do |arg|
+        # Update stage if necessary
+        stage = 1 if stage == 0 && !is_option?(arg)
+
+        # Add
+        opts_before_command << arg         if stage == 0
+        command_name = arg                 if stage == 1
+        opts_and_args_after_command << arg if stage == 2
+
+        # Update stage if necessary
+        stage = 2 if stage == 1
+      end
+
+      # Handle options before command
+      begin
+        parsed_arguments = Cri::OptionParser.parse(opts_before_command, global_option_definitions)
+      rescue Cri::OptionParser::IllegalOptionError => e
+        $stderr.puts "illegal option -- #{e}"
+        exit 1
+      end
+      parsed_arguments[:options].keys.each do |option|
+        handle_option(option)
+      end
+
+      # Get command
+      if command_name.nil?
+        $stderr.puts "no command given"
+        exit 1
+      end
+      command = command_named(command_name)
+      if command.nil?
+        $stderr.puts "no such command: #{command_name}"
+        exit 1
+      end
+
+      # Parse arguments
+      option_definitions = command.option_definitions + global_option_definitions
+      begin
+        parsed_arguments = Cri::OptionParser.parse(opts_and_args_after_command, option_definitions)
+      rescue Cri::OptionParser::IllegalOptionError => e
+        $stderr.puts "illegal option -- #{e}"
+        exit 1
+      rescue Cri::OptionParser::OptionRequiresAnArgumentError => e
+        $stderr.puts "option requires an argument -- #{e}"
+        exit 1
+      end
+
+      # Handle global options
+      global_options = global_option_definitions.map { |o| o[:long] }
+      global_options.delete_if { |o| !parsed_arguments[:options].keys.include?(o.to_sym) }
+      global_options.each { |o| handle_option(o.to_sym) }
+
+      if parsed_arguments[:options].has_key?(:help)
+        # Show help for this command
+        show_help(command)
+      else
+        # Run command
+        command.run(parsed_arguments[:options], parsed_arguments[:arguments])
+      end
+    end
+
+    # Returns the command with the given name.
+    def command_named(name)
+      # Find by exact name or alias
+      command = @commands.find { |c| c.name == name or c.aliases.include?(name) }
+      return command unless command.nil?
+
+      # Find by approximation
+      commands = @commands.select { |c| c.name[0, name.length] == name }
+      if commands.length > 1
+        $stderr.puts "#{@tool_name}: '#{name}' is ambiguous:"
+        $stderr.puts "  #{commands.map { |c| c.name }.join(' ') }"
+        exit 1
+      elsif commands.length == 0
+        $stderr.puts "#{@tool_name}: unknown command '#{name}'\n"
+        show_help
+        exit 1
+      else
+        return commands[0]
+      end
+    end
+
+    # Shows the help text for the given command, or shows the general help
+    # text if no command is given.
+    def show_help(command=nil)
+      if command.nil?
+        @help_command.run([], [])
+      else
+        @help_command.run([], [ command.name ])
+      end
+    end
+
+    # Returns the list of global option definitionss.
+    def global_option_definitions
+      []
+    end
+
+    # Adds the given command to the list of commands. Adding a command will
+    # also cause the command's +base+ to be set to this instance.
+    def add_command(command)
+      @commands << command
+      command.base = self
+    end
+
+    # Handles the given optio
+    def handle_option(option)
+      false
+    end
+
+  private
+
+    # Returns true if the given string is an option (i.e. -foo or --foo),
+    # false otherwise.
+    def is_option?(string)
+      string =~ /^-/
+    end
+
+  end
+
+end