netid-tools 0.6.3 → 0.7.0

data/README.md

@@ -145,90 +145,97 @@ The NetID you want to check
 Version History
 ===============
 
-## 0.6.3
+### 0.7.0
+
+* [API] Convert netid-tools to use hash for initialization
+* [API] Switch to response objects for all methods
+* [Improvement/Experimental] Add ability to pre-load connections. See commit e328e1 for more details
+
+
+### 0.6.3
 
 * Spec fix
 
-## 0.6.2
+### 0.6.2
 
 * Fix executable
 
-## 0.6.1
+### 0.6.1
 
 * Add TravisCI
 
-## 0.6.0
+### 0.6.0
 
 * Add tests; refactor various methods
 * Switch more commands to use Response objects rather than bare responses. Documentation pending.
 
-## 0.5.5
+### 0.5.5
 
 * Switch process listing to individual class
 
-## 0.5.4
+### 0.5.4
 
 * Switch table formatting on ua_check binary
 
-## 0.5.3
+### 0.5.3
 
 * Remove debug function
 
-## 0.5.2
+### 0.5.2
 
 * Expand cluster paths if available in quota output
 
-## 0.5.0
+### 0.5.0
 
 * Switch to new SSH connection method; reuse already existing SSH connection for host if it exists
 * Tighten up code
 * Fix bugs
 
-## 0.4.2
+### 0.4.2
 
 * Rename check_quota -> quota_check
 
-## 0.4.0
+### 0.4.0
 
 * Switch most methods from Class->Instance
 
-## 0.3.10
+### 0.3.10
 
 * Add -p flag for full process check on hosts.
 
-## 0.3.9
+### 0.3.9
 
 * Add webtype check to list of returned results in ua_check executable
 * Add Netid.check_webtype method
 
-## 0.3.8
+### 0.3.8
 
 * Remove ovid21.u.washington.edu from host list; retired system
 
-## 0.3.7
+### 0.3.7
 
 * Allow validate_netid? to return true for NetIDs that have a hyphen in them
 
-## 0.3.6
+### 0.3.6
 
 * Add concise mode via -c flag to ua_check (skips quota results)
 * Add OptionParser to ua_check
 * Tweak formatting for results
 * Allow multiple lookups per execption
 
-## 0.3.3
+### 0.3.3
 
 * Fix broken code so that it properly displays localhome
 
-## 0.3.2
+### 0.3.2
 
 * Added install notes
 
-## 0.3.1
+### 0.3.1
 
 * Initial documented release
 * Swich to Apache License
 
-## 0.3.0
+### 0.3.0
 
 Initial release

data/VERSION

@@ -1 +1 @@
-0.6.3
+0.7.0

data/bin/ua_check

@@ -45,23 +45,24 @@ user.each do |netid|
   puts "#{netid}".bold.green
   puts "-"*netid.length
   results = 0
-  checkr = Netid.new(netid,system_user)
+  checkr = Netid.new({netid: netid,system_user:system_user})
+  checkr.pre_load_ssh(*hosts)
   hosts.each do |host|
     result = checkr.check_for_mysql_presence(host)
-    if result
+    if result.response
       results += 1
-      puts "MySQLd detected on #{result[0]}:#{result[1]}".blue
+      puts "MySQLd detected on #{result.response[0]}:#{result.response[1]}".blue
     end
   end
 
   result = checkr.check_for_localhome
   if result
-    puts "Localhome: #{result}".cyan
+    puts "Localhome: #{result.response}".cyan
   else
     puts "No localhome detected"
   end
 
-  puts "Webtypes set: #{checkr.check_webtype}"
+  puts "Webtypes set: #{checkr.check_webtype.response}"
 
   puts "No MySQLds Detected".bold.blue if results == 0
 

data/lib/netid-tools.rb

@@ -11,16 +11,25 @@ class Netid
 
   attr_accessor :netid, :system_user, :systems, :primary_host, :secondary_host
 
-  def initialize(netid,system_user=nil,systems=nil,primary_host=nil,secondary_host=nil)
-    @netid = netid
-    @system_user = system_user || `whoami`.chomp
-    @systems = systems || ["ovid01.u.washington.edu",
+  def initialize(options)
+
+    if options[:netid]
+      @netid = options[:netid]
+    else
+      raise "NetID required in options hash."
+    end
+
+    @system_user = options[:system_user] || `whoami`.chomp
+    @systems = options[:systems] || ["ovid01.u.washington.edu",
                            "ovid02.u.washington.edu",
                            "ovid03.u.washington.edu",
                            "vergil.u.washington.edu"
                            ]
-    @primary_host = primary_host || "ovid02.u.washington.edu"
-    @secondary_host = secondary_host || "vergil.u.washington.edu"
+    @primary_host = options[:primary_host] || "ovid02.u.washington.edu"
+    @secondary_host = options[:secondary_host] || "vergil.u.washington.edu"
+
+    @debug = options[:debug] || false
+
   end
 
   def validate_netid
@@ -36,19 +45,29 @@ class Netid
   end
 
   def check_for_mysql_presence(host)
+    response = GenericResponse.new
     command = "ps -F -U #{netid} -u #{netid}"
     result = run_remote_command(command,host)
     if result =~ /mysql/
       /port=(?<port>\d+)/ =~ result
-      [host,port.to_i]
+      response.response = [host,port.to_i]
+      response
     else
-      false
+      response.response = false
     end
+    response
+  end
+
+  # Experimental feature
+  def pre_load_ssh(*hosts)
+    threaded_connect(system_user,*hosts)
   end
 
   def get_processes(host)
     if /no such user/i =~ run_remote_command("id #{netid}",host)
-      result = false
+      result = GenericResponse.new
+      result.response = false
+      result
     else
 
       command = "ps -o pid,user,cputime,nice,wchan,pcpu,pmem,rss,start_time,cmd --user #{netid}"
@@ -56,7 +75,7 @@ class Netid
       refined_processes = UnixProcesses.new(host)
 
       refined_processes.headers = raw_processes[0].split
-      raw_processes.delete_at(0)
+      raw_processes.shift
 
       refined_processes.processes = raw_processes.map do |line|
         line = line.split
@@ -69,39 +88,30 @@ class Netid
       end
       refined_processes
     end
-
-
-    # if /no such user/i =~ run_remote_command("id #{netid}",host)
-    #   result = nil
-    # else
-    #   result = run_remote_command("ps -F --user=#{netid}",host).lines.map{|l| l.chomp}
-    #   result = remove_extra_processes(result)
-    # end
-    # if result.nil? || result.count == 1
-    #   false
-    # else
-    #   result
-    # end
   end
 
   def check_for_localhome
+    response = GenericResponse.new
     result = run_remote_command("cpw -poh #{netid}",primary_host)
     if result =~ /Unknown/
-      false
+      response.response = false
     else
-      result.chomp
+      response.response = result.chomp
     end
+    response
   end
 
   def check_webtype
-    result = []
+    response = GenericResponse.new
     command = "webtype -user #{netid}"
-    result = run_remote_command(command,primary_host).chomp.split
-    if result[0] == "user"
-      result = run_remote_command(command,secondary_host).chomp.split
+    command_result = run_remote_command(command,primary_host).chomp
+    if command_result =~ /user/
+      response.response = run_remote_command(command,secondary_host).chomp.split
     else
-      result
+      response.response = command_result.chomp.split
     end
+    response.response = false if response.response.empty?
+    response
   end
 
 
@@ -117,8 +127,11 @@ class Netid
       result = QuotaResponse.new
 
       command_result = command_result.chomp.split("\n")
-      command_result.delete_at(0) if command_result.first == ""
-      command_result.delete_at(0) # remove uid line
+      if command_result.first == ""
+        command_result.shift(2)
+      else
+        command_result.shift
+      end
 
       result.headers = process_quota_headers(command_result)
       result.response = command_result.map do |line|
@@ -140,7 +153,7 @@ class Netid
 
     def process_quota_headers(quota_results)
       headings = quota_results.first.split
-      quota_results.delete_at(0)
+      quota_results.shift
       headings
     end
 
@@ -168,5 +181,4 @@ class Netid
         end
       end
     end
-
 end

data/lib/system-connect.rb

@@ -2,10 +2,36 @@ module SystemConnect
 
   private
 
+  def connections
+    unless @connections
+      @connections = []
+    end
+    @connections
+  end
+
+  def connections=(var)
+    @connections = var
+  end
+
   def connect(host,user)
     Net::SSH.start(host,user,{auth_methods: %w(publickey)})
   end
 
+  def threaded_connect(user,*hosts)
+    connection_objects = []
+    threads = []
+    hosts.each do |host|
+      threads << Thread.new do
+        connections << SystemSSH.new(host,connect(host,user))
+      end
+    end
+    threads.each do |thr|
+      thr.join
+    end
+  end
+
+
+
   def run_remote_command(command, host)
     connection = find_connection_for_host(host)
     connection.exec!(command)
@@ -28,9 +54,8 @@ module SystemConnect
   end
 
   def find_connection_for_host(host)
-    @connections ||= []
-    unless @connections.select{ |conn| conn.hostname == host}.empty?
-      @connections.select{ |conn| conn.hostname == host}.first.connection_object
+    unless connections.select{ |conn| conn.hostname == host}.empty?
+      connections.select{ |conn| conn.hostname == host}.first.connection_object
     else
       lazy_load_connection_for_host(host)
       find_connection_for_host(host)

data/netid-tools.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "netid-tools"
-  s.version = "0.6.3"
+  s.version = "0.7.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nikky Southerland"]
-  s.date = "2013-06-28"
+  s.date = "2013-07-03"
   s.description = "Gem with various methods to support UW NetIDs"
   s.email = "nikky@uw.edu"
   s.executables = ["ua_check"]

data/spec/netid_tools_spec.rb

@@ -10,10 +10,38 @@ describe Netid do
   end
 
   before do
-    @netid = Netid.new('test')
+    @netid = Netid.new({netid:'test'})
   end
 
   context "sanity checks" do
+    it "raises on two or more arguments" do
+      expect do
+        Netid.new('doop','derp')
+      end.to raise_error
+    end
+    it "expects an options hash" do
+      Netid.new({netid: 'nikky'}).netid.should eq 'nikky'
+    end
+    it "requires a NetID in hash" do
+      expect do
+        Netid.new({system_user: 'derp'})
+      end.to raise_error
+    end
+    it "knows about the usual options" do
+      full_object = Netid.new({
+        netid: 'netid2',
+        system_user: 'bob',
+        systems: %w(sylvan.uw.edu),
+        primary_host: 'hiigara.cac',
+        secondary_host: 'uvb76.cac'
+      })
+
+      full_object.netid.should eq 'netid2'
+      full_object.system_user.should eq 'bob'
+      full_object.systems.should eq ["sylvan.uw.edu"]
+      full_object.primary_host.should eq "hiigara.cac"
+      full_object.secondary_host.should eq "uvb76.cac"
+    end
     it "responds to #netid" do
       @netid.should respond_to :netid
       @netid.netid.should eq 'test'
@@ -47,10 +75,10 @@ describe Netid do
       @netid.validate_netid.response.should eq true
     end
     it "returns a GenericResponse of false on invalid netid" do
-      Netid.new('123test').validate_netid.response.should be_false
+      Netid.new({netid:'123test'}).validate_netid.response.should be_false
     end
     it "returns a GenericResponse with error message on invalid netid" do
-      Netid.new('123test').validate_netid.error.should eq "Not a valid NetID"
+      Netid.new({netid:'123test'}).validate_netid.error.should eq "Not a valid NetID"
     end
   end
 
@@ -59,10 +87,10 @@ describe Netid do
       @netid.validate_netid?.should be_true
     end
     it "returns false on NetID that starts with number" do
-      Netid.new('123test').validate_netid?.should be_false
+      Netid.new({netid:'123test'}).validate_netid?.should be_false
     end
     it "returns false on NetID that is too long" do
-      Netid.new('abcdefghijklmnop').validate_netid?.should be_false
+      Netid.new({netid:'abcdefghijklmnop'}).validate_netid?.should be_false
     end
   end
 
@@ -85,18 +113,18 @@ describe Netid do
       --pid-file=/da23/d38/nikky/mysql/data/ovid02.u.washington.edu.pid
       --socket=/da23/d38/nikky/mysql.sock --port=5280"
       mock_system_response(valid_return)
-      @netid.check_for_mysql_presence('fake.example.com').should eq ['fake.example.com', 5280]
+      @netid.check_for_mysql_presence('fake.example.com').response.should eq ['fake.example.com', 5280]
     end
     it "returns false with no valid result" do
       mock_system_response("")
-      @netid.check_for_mysql_presence('fake.example.com').should be_false
+      @netid.check_for_mysql_presence('fake.example.com').response.should be_false
     end
   end
 
   context "#get_processes" do
     it "returns false if a user is not detected" do
       mock_system_response("no such user")
-      @netid.get_processes('example.com').should be_false
+      @netid.get_processes('example.com').response.should be_false
     end
     it "returns a UnixProcesses object on success" do
       mock_system_response("exists","1\n2\n3")
@@ -134,30 +162,30 @@ describe Netid do
   context "#check_for_localhome" do
     it "returns the localhome location upon success" do
       mock_system_response("/ov03/dw21/derp")
-      @netid.check_for_localhome.should eq ("/ov03/dw21/derp")
+      @netid.check_for_localhome.response.should eq ("/ov03/dw21/derp")
     end
     it "returns false if no result" do
       mock_system_response("user Unknown")
-      @netid.check_for_localhome.should be_false
+      @netid.check_for_localhome.response.should be_false
     end
   end
 
   context "#check_webtype" do
     it "returns array of webtypes upon success" do
       mock_system_response("depts\ncourses")
-      @netid.check_webtype.should eq %w(depts courses)
+      @netid.check_webtype.response.should eq %w(depts courses)
     end
-    it "returns empty array if no webtypes found" do
+    it "returns false if no webtypes found" do
       mock_system_response("")
-      @netid.check_webtype.should be_empty
+      @netid.check_webtype.response.should be_false
     end
     it "tries alternate host if primary returns no user found" do
       mock_system_response("user Unknown","depts\ncourses")
-      @netid.check_webtype.should eq %w(depts courses)
+      @netid.check_webtype.response.should eq %w(depts courses)
     end
     it "returns empty array if no webtypes found on alternate host" do
       mock_system_response("user Unknown","")
-      @netid.check_webtype.should eq %w()
+      @netid.check_webtype.response.should be_false
     end
 
   end
@@ -208,4 +236,5 @@ describe Netid do
       @netid.check_quota.response.should eq [%w(/cg32 usage quota limit n/a files limit), %w(/hw00/w00/ferp usage quota limit grace files limit)]
     end
   end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: netid-tools
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-28 00:00:00.000000000 Z
+date: 2013-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored
@@ -229,7 +229,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2948455287693453037
+      hash: 3274686386078058042
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: