tsm 0.9

data/README

@@ -0,0 +1,26 @@
+== Description
+	A wrapper for TSM dsmadmc and dsmc commands
+
+== Prerequisites
+	* Ruby 1.8.4 or later
+
+== Usage
+	TSM::Dsmadmc(id,pass) { |t|
+		t.add_observer(TestObserver.new())
+		t.command('q pr')
+	}
+
+	t = TSM::Dsmadmc(id,pass)
+	t.open
+	t.command('q pr')
+	t.command('quit')
+	t.open
+	t.command('select count(*) from volumes')
+	t.close
+
+== Installation
+=== Manual Installation
+=== Gem Installation
+	gem install tsm-<version>.gem
+
+== Notes

data/lib/tsm.rb

@@ -0,0 +1,283 @@
+
+require 'pty'
+require 'observer'
+require 'parsedate'
+
+module TSM
+	class Error < RuntimeError
+		class FatalError < Error; end
+		class CommandError < Error; end
+		class PTYError < Error; end
+
+		class SqlError < Error
+			class NoData < SqlError; end
+		end
+	end
+	class Command; end #:nodoc:
+
+	FORCE_OPT = {:displ => 'list',:out => true,:noc => true}
+
+	class Dsmadmc < Command
+		def initialize(id,password,opts = {},&block)
+			opts[:id] = id
+			opts[:pa] = password
+
+			@path = ['/opt/tivoli/tsm/client/ba/bin','/usr/tivoli/tsm/client/ba/bin']
+
+			super opts,&block
+		end
+	end
+
+	class Dsmc < Command
+		def initialize(opts = {},&block)
+			@path = ['/opt/tivoli/tsm/client/admin/bin','/usr/tivoli/tsm/client/ba/bin']
+
+			super
+		end
+	end
+
+	class Command
+		include Observable
+
+		attr_accessor :timeout
+		attr_reader :host, :header, :prompt
+		attr_reader :pty, :cmd
+		attr_accessor :path, :app
+
+		def initialize(opt = {},&block)
+			args = [find(self.class.to_s.split(":").last.downcase)]
+
+			opt.merge(FORCE_OPT).each{|k,v| args.push("-#{k.to_s}#{'=' << v.to_s if v.class != TrueClass}") }
+			opt.each_key do |k|
+				opt.each_key {|k2| opt.delete(k2) if k.to_s.casecmp(k2.to_s) == -1}
+			end
+
+			@cmd = args.join(" ")
+
+			yield self if block_given?
+
+			self
+		ensure
+			close if block_given? and not closed?
+		end
+
+		def open(&block)
+			return self unless closed?
+
+			r,w,pid = PTY.spawn(@cmd)
+			@header,@prompt,@host = r.prompt([/tsm: ([A-Z0-9]*)>/i,/Enter your password: /i],@timeout || 60)
+			Response.new(@header.to_s).validate(Error::CommandError) if @host.to_s.empty?
+
+			@established = Time.now()
+			@pty = {:r => r,:w => w,:pid => pid}
+
+			notify('open',{'host'=>@host})
+
+			yield self if block_given?
+
+			self
+		rescue PTY::ChildExited => details
+		ensure
+			close if block_given? and not closed?
+		end
+
+		def close
+			notify('close',{'closed' => closed?})
+			if @pty
+				@pty[:r].close unless @pty[:r].closed?
+				@pty[:w].close unless @pty[:w].closed?
+			end
+			@pty = nil
+		end
+
+		def closed?
+			return true unless @pty
+			return true if @pty[:r].closed? and @pty[:w].closed?
+
+			begin
+				Process.kill(0,@pty[:pid])
+			rescue Errno::ESRCH
+				return true
+			end
+
+			false
+		end
+
+		def command(cmd,&block)
+			cmd.to_s.strip!
+
+			notify('execute',{'command' => cmd,'closed'=>closed?})
+
+			begin
+				return self
+			ensure
+				close unless closed?
+			end if cmd =~ /quit*/i
+
+			raise Error::PTYError, 'No PTY' if closed?
+
+			@pty[:w].puts(cmd.to_s)
+
+			start = Time.now()
+			res = Response.new
+			@pty[:r].response(@prompt) do |line|
+				res.parse(line,&block)
+			end
+			duration = Time.now() - start
+
+			notify('complete',{'duration' => "%.2f" % duration,'rows' => res[:count] || 0})
+
+			res
+		rescue Error::PTYError
+			open
+			retry
+		end
+
+		def server
+			raise Error::PTYError, "No connection was established" unless @header
+
+			svr = {}
+			@header.each {|l|
+				l = l.chomp
+				l.strip!
+				next if l.empty?
+
+				if (m=/Command Line ([\S^-]+)([\s\S]+) - Version (\d+), Release (\d+), Level (\d(.\d))/i.match(l))
+					svr[:interface] = {:version => m[3],:release => m[4],:level =>m[5],:type => m[1].downcase}
+				elsif (m=/Session established with server (\w+): (\S+)/i.match(l))
+					svr[:host] = {:hostname => m[1],:arch => m[2]}
+				elsif (m=/Server Version (\d+), Release (\d+), Level (\d(.\d))/i.match(l))
+					svr[:version] = {:version => m[1],:release => m[2],:level => m[3]}
+				elsif (m=/Server date.time: ([0-9\/]+) ([0-9:]+)(\s+)Last access: ([0-9\/]+) ([0-9:]+)/i.match(l))
+					svr[:established] = Time.local(*(ParseDate.parsedate("#{m[1]} #{m[2]}")))
+					svr[:access] = Time.local(*(ParseDate.parsedate("#{m[4]} #{m[5]}")))
+				end
+			}
+			svr[:time] = @established if @established
+
+			svr
+		end
+
+                def path
+                        @path || ['/usr/local/bin']
+                end
+
+                def path=(path)
+                        @path = [path].flatten
+                end
+
+		protected
+
+		def notify(st,opts = {})
+			pid = @pty[:pid] if @pty
+			changed and notify_observers(opts.merge({'status' => st,'time' => Time.now,'pid' => pid || 0}))
+		end
+
+		def find(name)
+			(ENV['PATH'].split(File::PATH_SEPARATOR) + self.path).each { |p|
+				if File.executable?(f=File.join(p,name))
+					return f
+				end
+			}
+		end
+
+		class Response < Hash
+			def initialize(str=nil)
+				{:messages => [],:rows => [],:count => 0,:command => nil}.each do |k,v|
+					self.store(k,v)
+				end
+
+				self.parse(str) if str
+
+				self
+			end
+
+			def parse(chrs,&block)
+				chrs.each { |line|
+					line = line.chomp
+					line.strip!
+
+					if (m = /(([ABDEI][DEKNC][ERSDNOUIP])(\d+)([IESWK])) (.*)/.match(line))
+						self[:messages].push({:id=>m[1],:msg=>m[5]}) and next
+					end
+
+					self[:command] = line and next unless self[:command]
+
+					if line.empty? and not @tmp.empty?
+						self[:count] += 1
+
+						yield @tmp if block_given?
+
+						self[:rows].to_a.push(@tmp.dup)
+						@tmp.clear	
+
+						next
+					end if @tmp
+
+					if (sp = line.index(":")) != nil
+						@tmp = {} unless @tmp
+						@tmp[line[0...sp].downcase.tr(" ","_").to_sym] = line[(sp+1)..-1].lstrip
+					end
+				}
+
+				chrs
+			end
+
+			def validate(err=Error::FatalError)
+				self[:messages].each do |msg|
+					raise Error::SqlError::NoData, msg[:msg] if msg[:id] =~ /ANR2034E/i
+					raise err, msg[:msg] if msg[:id][-1..-1] =~ /^[ES]$/i
+				end
+			end
+		end
+	end
+end
+
+class IO
+	def prompt(pat,timeout=9999999)
+		buf = ''
+		pat = [pat] unless pat.respond_to?('each')
+		result = nil
+		while true
+			return result if IO.select([self],nil,nil,timeout).nil? or eof?
+			begin
+				buf << getc.chr
+			rescue Errno::EIO
+				result = [buf,''] and break
+			end
+
+			pat.each { |p|
+				if mat=p.match(buf)
+					result = [buf,*mat.to_a] and break
+				end
+			}
+			break if result
+		end
+		result
+  	end
+
+	def response(str,timeout=9999999,&block)
+		tbuf = '' and buf = ''
+		mode = :chr
+		while true
+			result = nil and break if IO.select([self],nil,nil,timeout).nil? or eof?
+			if mode == :chr
+				begin
+					tbuf << getc.chr
+				rescue Errno::EIO
+					result = result.to_s
+					result << tbuf and break
+				end
+				buf << tbuf and tbuf = '' and mode = :line if str[0...tbuf.size] != tbuf
+				buf << tbuf and result = buf and break if tbuf == str
+				buf << tbuf if tbuf[-($/.size)..-1] == $/
+				next
+			end
+
+			buf << gets and mode = :chr
+			yield buf
+			buf = ''
+		end 
+		result
+	end
+end

data/tests/ts_tsm.rb

@@ -0,0 +1,21 @@
+require 'tsm'
+require 'yaml'
+require 'test/unit'
+
+USER = YAML.load(File.open(File.expand_path("~/auth.yaml")))
+
+class TestTsm < Test::Unit::TestCase
+
+	def test_simple
+		assert_raise(TSM::Error::CommandError) {
+			TSM::Dsmadmc.new(USER[:user],'pass') { |t|
+				t.open
+			}
+		}
+		assert_raise(TSM::Error::PTYError) {
+			TSM::Dsmadmc.new(USER[:user],USER[:pass]) { |t|
+				t.server
+			}
+		}
+	end
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: tsm
+version: !ruby/object:Gem::Version 
+  version: "0.9"
+date: 2006-07-30 00:00:00 -05:00
+summary: Wrapper for TSM client and administrative command interfaces
+require_paths: 
+- lib
+email: s.e.collison@gmail.com
+homepage: http://tsm-command.rubyforge.org/
+rubyforge_project: 
+description: 
+autorequire: tsm
+default_executable: 
+bindir: bin
+has_rdoc: "true"
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Sarah Collison
+files: 
+- tests/ts_tsm.rb
+- lib/tsm.rb
+- README
+test_files: 
+- tests/ts_tsm.rb
+rdoc_options: []
+
+extra_rdoc_files: 
+- README
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+