shu-san-scripts 0.0.2

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rvmrc

@@ -0,0 +1,27 @@
+ruby_string="ruby-1.8.7-p352"
+gemset_name="san-scripts"
+
+if rvm list strings | grep -q "${ruby_string}" ; then
+
+  # Load or create the specified environment
+  if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+    && -s "${rvm_path:-$HOME/.rvm}/environments/${ruby_string}@${gemset_name}" ]] ; then
+    \. "${rvm_path:-$HOME/.rvm}/environments/${ruby_string}@${gemset_name}"
+  else
+    rvm --create  "${ruby_string}@${gemset_name}"
+  fi
+
+  # Ensure that Bundler is installed, install it if it is not.
+  if ! command -v bundle ; then
+    gem install bundler
+  fi
+
+  # Bundle while reducing excess noise.
+  bundle | grep -v 'Using' | grep -v 'complete' | sed '/^$/d'
+
+else
+
+  # Notify the user to install the desired interpreter before proceeding.
+  echo "${ruby_string} was not found, please run 'rvm install ${ruby_string}' and then cd back into the project directory."
+
+fi

data/Gemfile

@@ -0,0 +1,34 @@
+###
+### Sources
+###
+
+# Main Ruby Gems site
+source "http://rubygems.org"
+
+###
+### Core Gems. These are required in _all_ environments (additional environments
+###            follow).
+###
+
+# Command Line Interface Library
+gem "cri", "~> 2.0.2"
+
+###
+### Development Gems. All _additional_ gems required by development (as opposed to
+###                   production environments). If it is required at run-time, it
+###                   belongs above.
+group :development do
+
+  # Gem management tools
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.0"
+  
+  # Documentation Tools
+  gem "yard", "~> 0.6.0"
+  gem "vclog", "~> 1.8.1"
+  
+  # Testing Tools
+  gem "minitest", ">= 0"
+  gem "riot"
+
+end

data/Gemfile.lock

@@ -0,0 +1,32 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ansi (1.3.0)
+    cri (2.0.2)
+    facets (2.9.2)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    minitest (2.6.0)
+    rake (0.9.2)
+    riot (0.12.5)
+      rr
+    rr (1.0.4)
+    vclog (1.8.1)
+      ansi (>= 1.2)
+      facets (>= 2.4)
+    yard (0.6.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  cri (~> 2.0.2)
+  jeweler (~> 1.6.0)
+  minitest
+  riot
+  vclog (~> 1.8.1)
+  yard (~> 0.6.0)

data/HISTORY

@@ -0,0 +1,29 @@
+RELEASE HISTORY
+
+v0.0.2 / 2011-09-23
+
+Regenerate gemspec for version 0.0.2 (David Love david@homeunix.org.uk)
+
+Changes:
+
+* 3 General Enhancements
+
+    * Version bump to 0.0.1
+    * Version bump to 0.0.0
+    * Initial commit to shu-san-scripts.
+
+* 1 Patch Enhancements
+
+    * Version bump to 0.0.2. Added infrastructure needed for minimally working version
+
+
+HEAD / 2011-09-24
+
+Current Development (David Love)
+
+Changes:
+
+* 1 General Enhancements
+
+    * Regenerate gemspec for version 0.0.2
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 David Love
+
+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, 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 AUTHORS OR 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.

data/README.rdoc

@@ -0,0 +1,55 @@
+= SHU SAN Scripts
+
+Together these scripts define a ''store'' command, used to simplify the
+task of creating iSCSI targets on OpenSolaris (Solaris > 11) based
+hosts. It has been tested on Nexenta NCP and Open Indiana, but with some
+modification it could be made to work on FreeBSD as well. 
+
+The user interface is deliberately as simple as possible: we assume the
+user has no underlying knowledge of (Open)Solaris, ZFS and not all that
+much of iSCSI. Instead the scripts aim to get iSCSI targets up and
+running as quickly as possible. Much more complex set-ups are indeed
+possible: see the relevant Oracle ZFS administrator's guides for more
+inspiration.
+
+== Using the Scripts
+
+Assuming Ruby Gems has been installed
+
+  gem install shu-san-scripts
+
+should install everything you need. A brief summary of the commands
+available can be obtained by
+
+  store --help
+
+once everything has been installed.
+
+**Note:** The scripts assume they are running (or at least have access to)
+the ''root'' user role, as they will manipulate your ZFS volumes. You
+can either install them with the appropriate privileges, or install the
+''sudo'' command to make life easier. With ''sudo''
+
+  sudo store --help
+
+should get you started. 
+
+**Warning:** We use these scripts in a *teaching* environment, and so we
+assume the host they are running on is somewhat disposable. Your needs
+may differ...
+
+== Contributing to the SHU SAN Scripts
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 David Love. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "shu-san-scripts"
+  gem.homepage = "http://github.com/dlove24/shu-san-scripts"
+  gem.license = "ISC"
+  gem.summary = %Q{Scripts used to set-up and manage iSCSI targets on OpenSolaris (ZFS) systems.}
+  gem.description = %Q{See the README file.}
+  gem.email = "david@homeunix.org.uk"
+  gem.authors = ["David Love"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "shu-san-scripts #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/bin/store

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+### Copyright (c) 2011 David Love <david@homeunix.org.uk>
+###
+### 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
+###
+### Boot straping Command. Used to initalize various aspects of the Mercury
+### environment.
+###
+### @note The sub-commands provided by the bootstrap command assume (at-least)
+### a minimally working Ruby environment, with the required gems installed. Various
+### 'First Boot' scripts are available in the `scripts` directory for different
+### platforms which will achieve at least this minimal state
+###
+
+# Add lib to load path
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
+
+# Load the rubygems library
+require 'rubygems'
+
+# Load core application library
+require 'SANStore'
+
+# Load command line handler
+require 'SANStore/cri'
+require 'SANStore/cli'
+
+# Load the commands from the cmds dir
+plugin_dir = File.expand_path(File.dirname(__FILE__) + '/../cmds')
+
+Dir[plugin_dir + '/*.rb'].sort.each{|file|
+  require file
+}
+
+# Run base
+SANStore::CLI::Base.new.run(ARGV)

data/lib/SANStore.rb

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

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

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