netid-tools 0.5.4 → 0.6.0

data/Gemfile

@@ -4,6 +4,7 @@ gem "nokogiri"
 gem "colored"
 gem "net-ssh"
 gem 'terminal-table'
+gem 'rspec'
 group :development do
   gem "shoulda", ">= 0"
   gem "rdoc", "~> 3.12"

data/README.md

@@ -143,6 +143,15 @@ The NetID you want to check
 Version History
 ===============
 
+## 0.6.0
+
+* Add tests; refactor various methods
+* Switch more commands to use Response objects rather than bare responses. Documentation pending.
+
+## 0.5.5
+
+* Switch process listing to individual class
+
 ## 0.5.4
 
 * Switch table formatting on ua_check binary

data/Rakefile

@@ -44,3 +44,6 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')

data/VERSION

@@ -1 +1 @@
-0.5.4
+0.6.0

data/bin/ua_check

@@ -69,11 +69,19 @@ user.each do |netid|
     hosts.each do |host|
       processes = checkr.get_processes(host)
       if processes
-        puts "\nProcesses for #{host}:\n".cyan
-        processes.each do |l|
-          puts l
+        table = Terminal::Table.new do |t|
+          t.title = host
+          t.headings = processes.headers
+          processes.processes.each do |p|
+            if p[9].length > 80
+              p[9].slice!(80,p[9].length-80)
+            end
+            t << p
+          end
         end
+
       end
+      puts table
     end
   end
 

data/lib/generic-response.rb

@@ -1,4 +1,7 @@
 class GenericResponse
   attr_accessor :response, :error
+  # def inspect
+  #   response
+  # end
 end
 

data/lib/netid-tools.rb

@@ -3,13 +3,15 @@ require 'colored'
 require 'netid-validator'
 require 'system-connect'
 require 'generic-response'
+require 'unix-processes'
+require 'quota-response'
 
 class Netid
   include SystemConnect
 
-  attr_accessor :netid, :system_user, :systems, :single_host, :user_clusters
+  attr_accessor :netid, :system_user, :systems, :primary_host, :secondary_host
 
-  def initialize(netid,system_user=nil,systems=nil,single_host=nil)
+  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",
@@ -17,7 +19,8 @@ class Netid
                            "ovid03.u.washington.edu",
                            "vergil.u.washington.edu"
                            ]
-    @single_host = single_host || "ovid02.u.washington.edu"
+    @primary_host = primary_host || "ovid02.u.washington.edu"
+    @secondary_host = secondary_host || "vergil.u.washington.edu"
   end
 
   def validate_netid
@@ -37,7 +40,7 @@ class Netid
     result = run_remote_command(command,host)
     if result =~ /mysql/
       /port=(?<port>\d+)/ =~ result
-      [host,port]
+      [host,port.to_i]
     else
       false
     end
@@ -45,20 +48,44 @@ class Netid
 
   def get_processes(host)
     if /no such user/i =~ run_remote_command("id #{netid}",host)
-      result = nil
+      result = false
     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
+
+      command = "ps -o pid,user,cputime,nice,wchan,pcpu,pmem,rss,start_time,cmd --user #{netid}"
+      raw_processes = run_remote_command(command,host).lines.map{|l| l.chomp}
+      refined_processes = UnixProcesses.new(host)
+
+      refined_processes.headers = raw_processes[0].split
+      raw_processes.delete_at(0)
+
+      refined_processes.processes = raw_processes.map do |line|
+        line = line.split
+
+        if line.size > 9
+          process = line.slice!(9,line.size-9)
+          line[9] = process.join(" ")
+        end
+        line
+      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
-    result = run_remote_command("cpw -poh #{netid}",single_host)
+    result = run_remote_command("cpw -poh #{netid}",primary_host)
     if result =~ /Unknown/
       false
     else
@@ -69,9 +96,9 @@ class Netid
   def check_webtype
     result = []
     command = "webtype -user #{netid}"
-    result = run_remote_command(command,single_host).chomp.split
+    result = run_remote_command(command,primary_host).chomp.split
     if result[0] == "user"
-      result = run_remote_command(command,host).chomp.split(" ")
+      result = run_remote_command(command,secondary_host).chomp.split
     else
       result
     end
@@ -79,25 +106,29 @@ class Netid
 
 
   def check_quota
-    result = run_remote_command("quota #{netid}",single_host)
-    result = result.chomp.split("\n")
-    result.delete_at(0) if result.first == ''
-    uid = /uid\s(\d+)/.match(result.first)[1].to_i
-    result.delete_at(0)
-
-    headings = process_quota_headers(result)
 
-    results = []
-    results << headings
-    result.each do |line|
-      line = line.split
-      line.insert(4, 'n/a') if line.size == 6
+    command_result = run_remote_command("quota #{netid}",primary_host)
 
-      expand_cluster_path(line)
-
-      results << line
+    if command_result =~ /unknown user/
+      result = GenericResponse.new
+      result.error = "Unknown User #{netid} on #{primary_host}"
+      result.response = false
+    else
+      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
+
+      result.headers = process_quota_headers(command_result)
+      result.response = command_result.map do |line|
+        line = line.split
+        line.insert(4, 'n/a') if line.size == 6
+        expand_cluster_path(line)
+        line
+      end
     end
-    results
+    result
   end
 
   private
@@ -128,13 +159,14 @@ class Netid
     end
 
     def get_user_clusters
-      if user_clusters
-        user_clusters
+      if @user_clusters
+        @user_clusters
       else
         command = "gpw -D #{netid} | sed '1d' | sed 'N;$!P;$!D;$d' | sort | uniq"
-        run_remote_command(command,single_host).split("\n").map do |line|
+        @user_clusters = run_remote_command(command,primary_host).map do |line|
           line.chomp
         end
       end
     end
+
 end

data/lib/quota-response.rb

@@ -0,0 +1,6 @@
+class QuotaResponse < GenericResponse
+  attr_accessor :headers
+  def initialize
+    super
+  end
+end

data/lib/unix-processes.rb

@@ -0,0 +1,8 @@
+class UnixProcesses
+  attr_accessor :headers, :hostname, :processes
+  def initialize(hostname)
+    @hostname = hostname
+    @processes = []
+    @headers = nil
+  end
+end

data/netid-tools.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "netid-tools"
-  s.version = "0.5.4"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nikky Southerland"]
-  s.date = "2013-06-26"
+  s.date = "2013-06-27"
   s.description = "Gem with various methods to support UW NetIDs"
   s.email = "nikky@uw.edu"
   s.executables = ["ua_check"]
@@ -28,8 +28,13 @@ Gem::Specification.new do |s|
     "lib/generic-response.rb",
     "lib/netid-tools.rb",
     "lib/netid-validator.rb",
+    "lib/quota-response.rb",
     "lib/system-connect.rb",
-    "netid-tools.gemspec"
+    "lib/unix-processes.rb",
+    "netid-tools.gemspec",
+    "spec/netid_tools_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/unix_processes_spec.rb"
   ]
   s.homepage = "http://github.com/allynfolksjr/netid-tools"
   s.licenses = ["Apache License, Version 2.0"]
@@ -45,6 +50,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<colored>, [">= 0"])
       s.add_runtime_dependency(%q<net-ssh>, [">= 0"])
       s.add_runtime_dependency(%q<terminal-table>, [">= 0"])
+      s.add_runtime_dependency(%q<rspec>, [">= 0"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_development_dependency(%q<bundler>, [">= 0"])
@@ -57,6 +63,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<colored>, [">= 0"])
       s.add_dependency(%q<net-ssh>, [">= 0"])
       s.add_dependency(%q<terminal-table>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_dependency(%q<bundler>, [">= 0"])
@@ -70,6 +77,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<colored>, [">= 0"])
     s.add_dependency(%q<net-ssh>, [">= 0"])
     s.add_dependency(%q<terminal-table>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
     s.add_dependency(%q<bundler>, [">= 0"])

data/spec/netid_tools_spec.rb

@@ -0,0 +1,211 @@
+require 'spec_helper'
+require 'netid-tools'
+
+describe Netid do
+
+  def mock_system_response(*responses)
+    responses.each do |response|
+      @netid.should_receive(:run_remote_command).and_return(response)
+    end
+  end
+
+  before do
+    @netid = Netid.new('test')
+  end
+
+  context "sanity checks" do
+    it "responds to #netid" do
+      @netid.should respond_to :netid
+      @netid.netid.should eq 'test'
+    end
+    it "responds to #system_user" do
+      @netid.should respond_to :system_user
+      @netid.system_user.should eq `whoami`.chomp
+    end
+    it "responds to #systems" do
+      @netid.should respond_to :systems
+      @netid.systems.should respond_to :size
+    end
+    it "responds to #primary_host" do
+      @netid.should respond_to :primary_host
+      @netid.primary_host.should_not be_nil
+    end
+    it "responds to #secondary_host" do
+      @netid.should respond_to :secondary_host
+      @netid.secondary_host.should_not be_nil
+    end
+    it "requires a NetID to be initialized" do
+      expect do
+        Netid.new
+      end.to raise_error
+    end
+
+  end
+
+  context "#validate_netid" do
+    it "returns a GenericResponse of true on valid 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
+    end
+    it "returns a GenericResponse with error message on invalid netid" do
+      Netid.new('123test').validate_netid.error.should eq "Not a valid NetID"
+    end
+  end
+
+  context "#validate_netid?" do
+    it "returns true on valid 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
+    end
+    it "returns false on NetID that is too long" do
+      Netid.new('abcdefghijklmnop').validate_netid?.should be_false
+    end
+  end
+
+  context "::validate_netid?" do
+    it "returns true on valid NetID" do
+      Netid.validate_netid?('nikky').should be_true
+    end
+    it "returns false on invalid NetID" do
+      Netid.validate_netid?('123test').should be_false
+    end
+  end
+
+  context "#check_for_mysql_presence" do
+    it "returns array with host and port on valid return" do
+      valid_return = "nikky    10167  0.0  0.0 271528  2904 ?        SNl   2012
+      0:02 /da23/d38/nikky/mysql/bin/mysqld --basedir=/da23/d38/nikky/mysql
+      --datadir=/da23/d38/nikky/mysql/data
+      --plugin-dir=/da23/d38/nikky/mysql/lib/plugin
+      --log-error=/da23/d38/nikky/mysql/data/mysql-bin.err
+      --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]
+    end
+    it "returns false with no valid result" do
+      mock_system_response("")
+      @netid.check_for_mysql_presence('fake.example.com').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
+    end
+    it "returns a UnixProcesses object on success" do
+      mock_system_response("exists","1\n2\n3")
+      @netid.get_processes('example.com').class.should eq UnixProcesses
+    end
+    it "contains proper headers with successful return" do
+      mock_system_response("exists","a b c\n2\n3")
+      @netid.get_processes('example.com').headers.should eq %w(a b c)
+    end
+    it "properly merges commnds with spaces into one array element" do
+      mock_system_response("exists","a b c\n1 2 3 4 5 6 7 8 9 command with space\n2")
+      @netid.get_processes('example.com').processes.first[9].should eq "command with space"
+    end
+    it "properly handles commnds without spaces" do
+      mock_system_response("exists","a b c\n1 2 3 4 5 6 7 8 9 command_without_space\n2")
+      @netid.get_processes('example.com').processes.first[9].should eq "command_without_space"
+    end
+    it "doesn't contain newlines" do
+      mock_system_response("exists","1\n2\n3")
+      @netid.get_processes('example.com').processes.select{|s| s =~ /\/n/}.should be_empty
+    end
+    it "doesn't contain headers in main processes object" do
+      mock_system_response("exists","headers pid guid\n1 2 3 4 5 6 7 8 9 command with space\n2")
+      return_obj = @netid.get_processes('example.com')
+      return_obj.headers.should eq %w(headers pid guid)
+      return_obj.processes.should_not include %w(headers pid guid)
+    end
+    it "has processes which responds to .each" do
+      mock_system_response("exists","headers pid guid\n1 2 3 4 5 6 7 8 9 command with space\n2")
+      return_obj = @netid.get_processes('example.com')
+      return_obj.processes.should respond_to(:each)
+    end
+  end
+
+  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")
+    end
+    it "returns false if no result" do
+      mock_system_response("user Unknown")
+      @netid.check_for_localhome.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)
+    end
+    it "returns empty array if no webtypes found" do
+      mock_system_response("")
+      @netid.check_webtype.should be_empty
+    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)
+    end
+    it "returns empty array if no webtypes found on alternate host" do
+      mock_system_response("user Unknown","")
+      @netid.check_webtype.should eq %w()
+    end
+
+  end
+
+  context "#check_quota" do
+    default_quota_return_objects = []
+    it "returns an object of results on success" do
+      mock_system_response("\nuser uid 1 2 3\nheader a b c\nfilesystem usage quota limit files limit",default_quota_return_objects)
+      @netid.check_quota.should be_true
+    end
+    it "returns false upon failure" do
+      mock_system_response("unknown user")
+      @netid.check_quota.response.should be_false
+    end
+    it "return object has and responds to #response" do
+      mock_system_response("\nuser uid 1 2 3\nheader a b c\nfilesystem usage quota limit files limit",default_quota_return_objects)
+      @netid.check_quota.response.should eq [%w(filesystem usage quota limit n/a files limit)]
+    end
+    it "returns object with headers" do
+      mock_system_response("\nuser uid 1 2 3\nheader a b c\nfilesystem usage quota limit files limit",default_quota_return_objects)
+      @netid.check_quota.headers.should eq %w(header a b c)
+    end
+    it "will insert 'n/a' into 5th element if blank" do
+      mock_system_response("\nuser uid 1 2 3\nheader a b c\nfilesystem usage quota limit files limit\nfilesystem usage quota limit files limit",default_quota_return_objects)
+      @netid.check_quota.response.should eq [%w(filesystem usage quota limit n/a files limit), %w(filesystem usage quota limit n/a files limit)]
+    end
+    it "will not insert 'n/a' into 5th element if length is 7" do
+      mock_system_response("\nuser uid 1 2 3\nheader a b c\nfilesystem usage quota limit grace files limit\nfilesystem usage quota limit grace files limit",default_quota_return_objects)
+      @netid.check_quota.response.should eq [%w(filesystem usage quota limit grace files limit), %w(filesystem usage quota limit grace files limit)]
+    end
+    it "will handle mixed 5th element situations" do
+      mock_system_response("\nuser uid 1 2 3\nheader a b c\nfilesystem usage quota limit  files limit\nfilesystem usage quota limit grace files limit",default_quota_return_objects)
+      @netid.check_quota.response.should eq [%w(filesystem usage quota limit n/a files limit), %w(filesystem usage quota limit grace files limit)]
+    end
+    it "will translate cluster shortnames into full path, if available" do
+      mock_system_response("\nuser uid 1 2 3\nheader a b c\n/cg32 usage quota limit  files limit\n/hw00 usage quota limit grace files limit",
+       ["/cg32/rw00/derp", "/hw00/w00/ferp"])
+      @netid.check_quota.response.should eq [%w(/cg32/rw00/derp usage quota limit n/a files limit), %w(/hw00/w00/ferp usage quota limit grace files limit)]
+    end
+    it "will fall back to cluster shortnames if full path not found" do
+      mock_system_response("\nuser uid 1 2 3\nheader a b c\n/cg32 usage quota limit  files limit\n/hw00 usage quota limit grace files limit",
+       ["/cg31/rw00/derp", "/hw01/w00/ferp"])
+      @netid.check_quota.response.should eq [%w(/cg32 usage quota limit n/a files limit), %w(/hw00 usage quota limit grace files limit)]
+    end
+    it "will handle mixed matching and unmatching clusters" do
+      mock_system_response("\nuser uid 1 2 3\nheader a b c\n/cg32 usage quota limit  files limit\n/hw00 usage quota limit grace files limit",
+        ["/cg31/rw00/derp", "/hw00/w00/ferp"])
+      @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.5.4
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-26 00:00:00.000000000 Z
+date: 2013-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -75,6 +75,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
@@ -206,8 +222,13 @@ files:
 - lib/generic-response.rb
 - lib/netid-tools.rb
 - lib/netid-validator.rb
+- lib/quota-response.rb
 - lib/system-connect.rb
+- lib/unix-processes.rb
 - netid-tools.gemspec
+- spec/netid_tools_spec.rb
+- spec/spec_helper.rb
+- spec/unix_processes_spec.rb
 homepage: http://github.com/allynfolksjr/netid-tools
 licenses:
 - Apache License, Version 2.0
@@ -223,7 +244,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2601252175228595680
+      hash: -3395110718720004722
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: