shu-san-scripts 0.1.0 → 0.1.1

data/lib/SANStore.rb

@@ -1,24 +0,0 @@
-### Copyright (c) 2010, 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
-
-  ## Define Application Global constants
-
-  # The current SANStore client version.
-  VERSION = '0.1'
-
-end
-

data/lib/SANStore/cli.rb

@@ -1,29 +0,0 @@
-### 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 'rubygems'
-
-# Load command line handling library
-require 'cri'
-
-# Install module for command line
-# interface
-module SANStore:CLI
-end
-
-# Load the command line handling modules
-require 'SANStore/cli/logger'
-require 'SANStore/cli/commands'
-require 'SANStore/cli/base'

data/lib/SANStore/cli/base.rb

@@ -1,102 +0,0 @@
-# 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 Denis Defreyne
-# @author David Love
-#
-# The +CLI+ module acts as the gathering place for all the gloabl options
-# and the sub-commands which the +SANStore+ command can deal with. 
-# Sub-commands are themselves defined in the {SANStore::CLI::Commands} 
-# module 
-module SANStore::CLI
-
-  # @author Denis Defreyne
-  # @author David Love
-  #
-  # Details the global options applicable to all commands, and the code necessary
-  # to process those options. Each sub-command also needs to be registered with 
-  # this class for it to work: strange things will happen if the sub-command is
-  # not set-up here!
-  #
-  # When creating a new sub-command, the constructor for that sub-command needs
-  # to be added to the {Base#initialize} function of *this* class as well. Be sure to 
-  # also add the path to the file where the sub-command is defined to the file 
-  # +lib/SANStore/cli/commands.rb+, otherwise you will get warnings of unknown
-  # classes.
-  class Base < Cri::Base
-
-    # Instantiates the sub-commands by creating a single reference to each
-    # known sub-command.
-    # 
-    # @note This means that if your sub-command is not in this constructor
-    #   it *will not* be found, and *will not* appear as a valid sub-command.
-    #   If something is missing from the 'help' command, check this method! 
-    def initialize
-      super('SANStore')
-
-      # Add help command
-      self.help_command = SANStore::CLI::Commands::Help.new
-      add_command(self.help_command)
-
-      # Add other commands
-      add_command(SANStore::CLI::Commands::NewVol.new)
-      #add_command(SANStore::CLI::Commands::ListVols.new)
-    end
-
-    # Returns the list of global option definitionss.
-    def global_option_definitions
-      [
-        {
-          :long => 'help', :short => 'h', :argument => :forbidden,
-          :desc => 'show this help message and quit'
-        },
-        {
-          :long => 'no-color', :short => 'C', :argument => :forbidden,
-          :desc => 'disable color'
-        },
-        {
-          :long => 'version', :short => 'v', :argument => :forbidden,
-          :desc => 'show version information and quit'
-        },
-        {
-          :long => 'verbose', :short => 'V', :argument => :forbidden,
-          :desc => 'make store command output more detailed'
-        }
-      ]
-    end
-
-    # Process the global options, and set/change the application state from them
-    def handle_option(option)
-      # Handle version option
-      if option == :version
-        puts "SANStore Bootstrap Client #{SANStore::VERSION} (c) 2011 David Love."
-        puts "Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) running on #{RUBY_PLATFORM}"
-        exit 0
-      # Handle verbose option
-      elsif option == :verbose
-        SANStore::CLI::Logger.instance.level = :low
-      # Handle no-color option
-      elsif option == :'no-color'
-        SANStore::CLI::Logger.instance.color = false
-      # Handle help option
-      elsif option == :help
-        show_help
-        exit 0
-      end
-    end
-
-  end
-
-end

data/lib/SANStore/cli/commands.rb

@@ -1,30 +0,0 @@
-# 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

@@ -1,106 +0,0 @@
-### 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

@@ -1,87 +0,0 @@
-# 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

@@ -1,119 +0,0 @@
-# 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.
-
-# Volume names are based on RFC 4122 UUIDs
-require "uuidtools"
-
-# Use the ZFS library
-require "SANStore/zfs/zfs"
-
-# Use the COMStar iSCSI library
-require "SANStore/iSCSI/comstar.rb"
-
-module SANStore::CLI::Commands
-
-  # @author David Love
-  #
-  # The +new_vol+ command adds a new ZFS volume to the specified volume
-  # store, and sets it up as an iSCSI target. Defaults are supplied to
-  # all arguments, but can be overridden by the user for slightly
-  # customised set-up of the volume store. However, the user interface
-  # should be kept as simple as possible. 
-  class NewVol < Cri::Command
-
-    # The name of the sub-command (as it appears in the command line app)
-    def name
-      'new_vol'
-    end
-
-    # The aliases this sub-command is known by
-    def aliases
-      [
-        "new", "add", "add_vol"
-      ]
-    end
-
-    # A short help text describing the purpose of this command
-    def short_desc
-      'Create a new iSCSI volume in the SAN volume store.'
-    end
-
-    # A longer description, detailing both the purpose and the
-    # use of this command
-    def long_desc
-      'By default, this command creates a 20G ZFS volume, and marks it for ' +
-      'sharing as an iSCSI target on the local network.' + "\n\n" +
-      'Warning: By default this commands sets up the iSCSI target with NO ' +
-      'security. This is fine for testing and use in the labs, but obviously ' +
-      'is not ideal if you care about the data stored on this new volume...'
-    end
-
-    # Show the user the basic syntax of this command
-    def usage
-      "store new_volume [--volume-store ZFS_PATH][--name GUID] [--size INTEGER]"
-    end
-    
-    # Define the options for this command
-    def option_definitions
-      [
-        { :short => 'v', :long => 'volume_store', :argument => :optional,
-          :desc => 'specifify the ZFS root of the new iSCSI volume. Defaults to "store/volumes".'
-        },
-        { :short => 'n', :long => 'name', :argument => :optional,
-          :desc => 'the name of the new volume. This must be a valid ZFS volume name, and defaults to ' +
-            'an RFC 4122 GUID.'
-        },
-        { :short => 's', :long => 'size', :argument => :optional,
-          :desc => 'the size of the new iSCSI volume. Note that while ZFS allows you to change the size ' +
-            'of the new volume relatively easily, because the iSCSI initiator sees this volume as a raw ' +
-            'device changing the size later may be very easy or very difficult depending on the initiators ' +
-            'operating system (and the specific file system being used). In other words, choose with care: ' +
-            'by default this command uses a size of 20G, which should be enough for most tasks in the labs.'  
-        },
-      ]
-    end
-
-    # Execute the command
-    def run(options, arguments)
-
-      # Look at the options, and if we don't find any (or some are
-      # missing), set them to the default values
-      if options[:volume_store].nil? or options[:volume_store].empty? then
-        volume_store = "store/volumes"
-        options[:volume_store] = volume_store
-      end
-      
-      if options[:name].nil? or options[:name].empty? then
-        name = UUIDTools::UUID.timestamp_create
-        options[:name] = name.to_s
-      end
-      
-      if options[:size].nil? or options[:size].empty? then
-        size = "20G" 
-        options[:size] = size
-      end
-
-      # Ask for a new volume
-      ZFS.new_volume(options[:volume_store] + "/" + options[:name], options[:size]) 
-
-      # Set the volume up as an iSCSI target
-      target_name = COMStar.new_target(options[:volume_store] + "/" + options[:name])
-
-      # Tell the caller what the new volume name is
-      puts target_name
-    end
-
-  end
-
-end