osc-machete 1.1.4 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 450e165bbf224474e8f17368ec8f020c8cd5b779
-  data.tar.gz: 5afa7fd230ddb23244a2ef805d37ce9b0335d4e7
+  metadata.gz: 02bb808f1fcf915c8b6c5cbe38b00e692e021b03
+  data.tar.gz: dbed1c7b521247a391709633bb67a8e87dd37d93
 SHA512:
-  metadata.gz: 6521c8f8a96856bb84ddf206f904b6a9482d254ca6cfceeff004c4557192eb79640523e0dad71b7eeac402f8059ee14ef13919746a04222bfda8252dbd3dbbb7
-  data.tar.gz: 42cae18851fb0184dce5e1ad3d124727067ddbd07ea2b191caae781f04229d949a9cba840824bbfbbd02504c8211cfbe2d4d7d9cc5a7b3e9f00b2be8cd5ffd1e
+  metadata.gz: 84d14aa284eeac069213601ccd58ef5e8ebbdcc533c20cc1b2c646f339bbcf25815c77093099f3e06ea44755f27b10808b14f8beda4d80a4585cb5a6795e6e7e
+  data.tar.gz: 67295194bd75c9cf59a6cdc077025e199051bb7144b8de17650cdb002ec095e9a2a199fb1786328a266ad584370ad1a0daa5825197db68cd9e34683c49fe714e

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+/vendor

data/CHANGELOG.md

@@ -5,6 +5,52 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [1.2.0] - 2016-09-06
+
+### Added
+
+- TorqueHelper.default= so we can specify a different TorqueHelper
+- TorqueHelper#pbs to get the PBS::Batch object for the given id, script, or host.
+  This lets us change the TorqueHelper instance used as a default with a
+  different TorqueHelper class or instance that has a different implementation
+  of TorqueHelper#pbs.
+- (OSC specific) Owens cluster support
+- (OSC specific) LIB and BIN for specifying torque lib locations
+
+### Changed
+
+- Depends on latest version of pbs ruby gem 2.0
+- TorqueHelper.default returns the same instance every time (which is now
+  memoized) instead of creating a new instance
+
+### Deprecated
+
+- `OSC::Machete::User` - use `OodSupport::User` instead
+- `OSC::Machete::Process` - use `OodSupport::Process` instead
+
+### Fixed
+
+- yardoc documentation for OSC::Machete::Status class methods
+- deprecation warnings by using File.exist? instead of File.exists?
+
+## [1.1.4] - 2016-08-17
+
+### Added
+
+- `Job#host` getter (which should have been there but was accidentally omitted)
+
+## [1.1.3] - 2016-06-07
+
+### Fixed
+
+- README and gemspec docs update for rubygems.org release
+
+## [1.1.2] - 2016-06-07
+
+### Fixed
+
+- Copyright in LICENSE.txt
+
 ## [1.1.1] - 2016-02-24
 
 ### Fixed
@@ -79,7 +125,11 @@ lib/osc/machete/torque_helper.rb _(still an internal class right now, not meant
 
 Previous release of osc-machete
 
-[Unreleased]: https://github.com/AweSim-OSC/osc-machete/compare/v1.1.1...master
+[Unreleased]: https://github.com/AweSim-OSC/osc-machete/compare/v1.2.0...master
+[1.2.0]: https://github.com/AweSim-OSC/osc-machete/compare/v1.1.4...v1.2.0
+[1.1.4]: https://github.com/AweSim-OSC/osc-machete/compare/v1.1.3...v1.1.4
+[1.1.3]: https://github.com/AweSim-OSC/osc-machete/compare/v1.1.2...v1.1.3
+[1.1.2]: https://github.com/AweSim-OSC/osc-machete/compare/v1.1.1...v1.1.2
 [1.1.1]: https://github.com/AweSim-OSC/osc-machete/compare/v1.1.0...v1.1.1
 [1.1.0]: https://github.com/AweSim-OSC/osc-machete/compare/v1.0.1...v1.1.0
 [1.0.1]: https://github.com/AweSim-OSC/osc-machete/compare/v1.0.0...v1.0.1

data/lib/osc/machete/job.rb

@@ -205,7 +205,7 @@ class OSC::Machete::Job
       # something if the script name is munged
 
       # recursively delete the directory after killing the job
-      Pathname.new(path).rmtree if path && rmdir && File.exists?(path)
+      Pathname.new(path).rmtree if path && rmdir && File.exist?(path)
     end
   end
 

data/lib/osc/machete/process.rb

@@ -1,10 +1,13 @@
 # Class that maintains the User and additional methods for the process.
 # Helper methods provided use the Process module underneath.
 #
+# @deprecated Please use {http://www.rubydoc.info/gems/ood_support/OodSupport/Process OodSupport::Process} instead.
 class OSC::Machete::Process
 
   def initialize
     @user = OSC::Machete::User.from_uid(Process.uid)
+
+    warn "[DEPRECATION] `OSC::Machete::Process` is deprecated. Please use `OodSupport::Process` instead (see ood_support gem)."
   end
 
   # The system name of the process user

data/lib/osc/machete/status.rb

@@ -55,27 +55,42 @@ class OSC::Machete::Status
   end
 
 
-  # TODO: these methods are previously declared so we can document them easily
-  # if there is a better way to document class methods we'll do that
-
-  # @return [Status]
-  def self.undetermined() end
-  # @return [Status] 
-  def self.not_submitted() end
-  # @return [Status]
-  def self.passed() end
-  # @return [Status] 
-  def self.failed() end
-  # @return [Status]
-  def self.running() end
-  # @return [Status] 
-  def self.queued() end
-  # @return [Status] 
-  def self.held() end
-  # @return [Status] 
-  def self.suspended() end
-
+  # NOTE: on yard documentation: to do something like what I do below,
+  # documenting a set of class methods, you must have the documentation block be
+  # inside the `class << self` block or else the last documented method will be
+  # ignored or hidden if newlines exist between each @!method block. If no
+  # newlines exist, like below, the entire block would have been ignored.
+  # Also, indenting the tags for the rest of the methods is required when
+  # omitting newlines, otherwise, each method includes all of the returns below
+  # it - so yard displays 6 return Status lines for the method.
+  #
+  # Why do we have no newlines here? So that "View source" on each of these
+  # class methods points to the block itself.
   class << self
+    # @!method undetermined
+    #   A 'null' special case for Status
+    #   @return [Status]
+    #
+    # @!method not_submitted
+    #   @return [Status]
+    #
+    # @!method passed
+    #   @return [Status]
+    #
+    # @!method failed
+    #   @return [Status]
+    #
+    # @!method running
+    #   @return [Status]
+    #
+    # @!method queued
+    #   @return [Status]
+    #
+    # @!method held
+    #   @return [Status]
+    #
+    # @!method suspended
+    #   @return [Status]
     VALUES_HASH.each do |char, name|
       define_method(name) do
         OSC::Machete::Status.new(char)
@@ -84,22 +99,28 @@ class OSC::Machete::Status
   end
 
   # @!method undetermined?
-  #   the Status value Null object
-  #   @return [Boolean] true if undetermined
+  # @return [Boolean] true if undetermined
+
   # @!method not_submitted?
-  #   @return [Boolean] true if not_submitted
+  # @return [Boolean] true if not_submitted
+
   # @!method failed?
-  #   @return [Boolean] true if failed
+  # @return [Boolean] true if failed
+
   # @!method passed?
-  #   @return [Boolean] true if passed
+  # @return [Boolean] true if passed
+
   # @!method held?
-  #   @return [Boolean] true if held
+  # @return [Boolean] true if held
+
   # @!method queued?
-  #   @return [Boolean] true if queued
+  # @return [Boolean] true if queued
+
   # @!method running?
-  #   @return [Boolean] true if running
+  # @return [Boolean] true if running
+
   # @!method suspended?
-  #   @return [Boolean] true if suspended
+  # @return [Boolean] true if suspended
   VALUES_HASH.each do |char, name|
     define_method("#{name}?") do
       self == OSC::Machete::Status.new(char)

data/lib/osc/machete/torque_helper.rb

@@ -7,18 +7,32 @@ require 'pbs'
 #
 # == FIXME: This contains no state whatsoever. It should probably be changed into a module.
 class OSC::Machete::TorqueHelper
-
-  # Alias to initialize a new object.
-  def self.default
-    self::new()
+  # FIXME: Use ood_cluster gem
+  LIB = ENV['TORQUE_LIB'] || '/opt/torque/lib64'
+  BIN = ENV['TORQUE_BIN'] || '/opt/torque/bin'
+  HOSTS = {
+    'oakley' => 'oak-batch.osc.edu',
+    'ruby'   => 'ruby-batch.osc.edu',
+    'quick'  => 'quick-batch.osc.edu',
+    'owens'  => 'owens-batch.ten.osc.edu',
+    :default => 'oak-batch.osc.edu'
+  }
+
+  class << self
+    #@!attribute default
+    #  @return [TorqueHelper] default TorqueHelper instance to use
+    attr_writer :default
+    def default
+      @default ||= self::new()
+    end
   end
 
   # Returns an OSC::Machete::Status ValueObject for a char
   #
   # @param [String] char The Torque status char
   #
-  # @example Completed
-  #   status_for_char("C") #=> OSC::Machete::Status.completed
+  # @example Passed
+  #   status_for_char("C") #=> OSC::Machete::Status.passed
   # @example Queued
   #   status_for_char("W") #=> OSC::Machete::Status.queued
   #
@@ -51,12 +65,6 @@ class OSC::Machete::TorqueHelper
   #
   # Bills against the project specified by the primary group of the user.
   def qsub(script, host: nil, depends_on: {}, account_string: nil)
-    # if the script is set to run on Oakley in PBS headers
-    # this is to obviate current torque filter defect in which
-    # a script with PBS header set to specify oak-batch ends
-    # isn't properly handled and the job gets limited to 4GB
-    pbs_job = get_pbs_job( host.nil? ? get_pbs_conn(script: script) : get_pbs_conn(host: host) )
-
     headers = { depend: qsub_dependencies_header(depends_on) }
     headers.clear if headers[:depend].empty?
 
@@ -70,7 +78,7 @@ class OSC::Machete::TorqueHelper
       headers[PBS::ATTR[:A]] = default_account_string
     end
 
-    pbs_job.submit(file: script, headers: headers, qsub: true).id
+    pbs(host: host, script: script).submit_script(script, headers: headers, qsub: true)
   end
 
   # convert dependencies hash to a PBS header string
@@ -103,16 +111,10 @@ class OSC::Machete::TorqueHelper
   #
   # @return [Status] The job state
   def qstat(pbsid, host: nil)
-
-    # Create a PBS::Job object based on the pbsid or the optional host param
-    pbs_conn = host.nil? ? get_pbs_conn(pbsid: pbsid.to_s) : get_pbs_conn(host: host)
-    pbs_job = get_pbs_job(pbs_conn, pbsid)
-
-    job_status = pbs_job.status
-    # Get the status char value from the job.
-    status_for_char job_status[:attribs][:job_state][0]
-
-  rescue PBS::UnkjobidError => err
+    id = pbsid.to_s
+    status = pbs(host: host, id: id).get_job(id, filters: [:job_state])
+    status_for_char status[id][:job_state][0] # get status from status char value
+  rescue PBS::UnkjobidError
     OSC::Machete::Status.passed
   end
 
@@ -122,54 +124,43 @@ class OSC::Machete::TorqueHelper
   #
   # @return [nil]
   def qdel(pbsid, host: nil)
-
-    pbs_conn   =   host.nil? ? get_pbs_conn(pbsid: pbsid.to_s) : get_pbs_conn(host: host)
-    pbs_job    =   get_pbs_job(pbs_conn, pbsid.to_s)
-
-    pbs_job.delete
-
-  rescue PBS::UnkjobidError => err
+    id = pbsid.to_s
+    pbs(host: host, id: id).delete_job(id)
+  rescue PBS::UnkjobidError
     # Common use case where trying to delete a job that is no longer in the system.
   end
 
-  private
+  def pbs(host: nil, id: nil, script: nil)
+    if host
+      # actually check if host is "oakley" i.e. a cluster key
+      host = HOSTS.fetch(host.to_s, host.to_s)
+    else
+      # try to determine host
+      key = host_from_pbsid(id) if id
+      key = host_from_script_pbs_header(script) if script && key.nil?
 
-    # Factory to return a PBS::Job object
-    def get_pbs_job(conn, pbsid=nil)
-      pbsid.nil? ? PBS::Job.new(conn: conn) : PBS::Job.new(conn: conn, id: pbsid.to_s)
+      host = HOSTS.fetch(key, HOSTS.fetch(:default))
     end
 
-    # Returns a PBS connection object
-    #
-    # @option [:script] A PBS script with headers as string
-    # @option [:pbsid] A valid pbsid as string
-    #
-    # @return [PBS::Conn] A connection option for the PBS host (Default: Oakley)
-    def get_pbs_conn(options={})
-      if options[:script]
-        PBS::Conn.batch(host_from_script_pbs_header(options[:script]))
-      elsif options[:pbsid]
-        PBS::Conn.batch(host_from_pbsid(options[:pbsid]))
-      elsif options[:host]
-        PBS::Conn.batch(options[:host])
-      else
-        PBS::Conn.batch("oakley")
-      end
-    end
+    PBS::Batch.new(
+      host: host,
+      lib: LIB,
+      bin: BIN
+    )
+  end
 
+  private
     # return the name of the host to use based on the pbs header
     # TODO: Think of a more efficient way to do this.
     def host_from_script_pbs_header(script)
       if (File.open(script) { |f| f.read =~ /#PBS -q @oak-batch/ })
         "oakley"
-      elsif (File.open(script) { |f| f.read =~ /#PBS -q @opt-batch/ })
-        "glenn"
       elsif (File.open(script) { |f| f.read =~ /#PBS -q @ruby-batch/ })
         "ruby"
       elsif (File.open(script) { |f| f.read =~ /#PBS -q @quick-batch/ })
         "quick"
-      else
-        "oakley"  # DEFAULT
+      elsif (File.open(script) { |f| f.read =~ /#PBS -q @owens-batch/ })
+        "owens"
       end
     end
 
@@ -177,14 +168,12 @@ class OSC::Machete::TorqueHelper
     def host_from_pbsid(pbsid)
       if (pbsid =~ /oak-batch/ )
         "oakley"
-      elsif (pbsid =~ /opt-batch/ )
-        "glenn"
       elsif (pbsid.to_s =~ /^\d+$/ )
         "ruby"
       elsif (pbsid =~ /quick/ )
         "quick"
-      else
-        "oakley"  # DEFAULT
+      elsif (pbsid =~ /owens/ )
+        "owens"
       end
     end
 end

data/lib/osc/machete/user.rb

@@ -1,6 +1,7 @@
 # Class that maintains the name and home identifiers of a User.
 # Helper methods provided use the Etc module underneath.
 #
+# @deprecated Please use {http://www.rubydoc.info/gems/ood_support/OodSupport/User OodSupport::User} instead.
 class OSC::Machete::User
 
   attr_reader :name
@@ -19,6 +20,8 @@ class OSC::Machete::User
   #
   def initialize(username = Etc.getpwuid.name)
     @name = username
+
+    warn "[DEPRECATION] `OSC::Machete::User` is deprecated. Please use `OodSupport::User` instead (see ood_support gem)."
   end
 
   # factory method to produce a User from specified uid

data/lib/osc/machete/version.rb

@@ -1,6 +1,6 @@
 module OSC
   module Machete
     # The current gem version
-    VERSION = "1.1.4"
+    VERSION = "1.2.0"
   end
 end

data/osc-machete.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = '~> 2.2'
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
@@ -25,6 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest", ">= 5.0"
 
   spec.add_runtime_dependency "mustache"
-  spec.add_runtime_dependency "pbs", "~> 1.1"
+  spec.add_runtime_dependency "pbs", "~> 2.0"
 end
 

data/test/test_job_dir.rb

@@ -34,6 +34,6 @@ class TestJobDir < Minitest::Test
     # Create unique directory
     new_jobdir = OSC::Machete::JobDir.new(@parent).new_jobdir
     Dir.mkdir(new_jobdir)
-    assert Dir.exists?("#{@parent}/9"), "Directory was not created: #{@parent}/9"
+    assert Dir.exist?("#{@parent}/9"), "Directory was not created: #{@parent}/9"
   end
 end

data/test/test_location.rb

@@ -24,41 +24,41 @@ class TestLocation < Minitest::Test
   def test_render_default_replace_template
     setup_render
     @location1.render("")
-    assert_equal true,  File.exists?("#{@dir1}/file.txt")
-    assert_equal false, File.exists?("#{@dir1}/file.txt.mustache")
+    assert_equal true,  File.exist?("#{@dir1}/file.txt")
+    assert_equal false, File.exist?("#{@dir1}/file.txt.mustache")
   end
 
   def test_render_user_replace_template
     setup_render
     @location1.render("", {replace: true})
-    assert_equal true,  File.exists?("#{@dir1}/file.txt")
-    assert_equal false, File.exists?("#{@dir1}/file.txt.mustache")
+    assert_equal true,  File.exist?("#{@dir1}/file.txt")
+    assert_equal false, File.exist?("#{@dir1}/file.txt.mustache")
   end
 
   def test_render_user_doesnt_replace_template
     setup_render
     @location1.render("", {replace: false})
-    assert_equal true,  File.exists?("#{@dir1}/file.txt")
-    assert_equal true,  File.exists?("#{@dir1}/file.txt.mustache")
+    assert_equal true,  File.exist?("#{@dir1}/file.txt")
+    assert_equal true,  File.exist?("#{@dir1}/file.txt.mustache")
   end
 
   def test_copy_to_shouldnt_copy_developer_files
     setup_copy_to
     
     @location1.copy_to(@dir2)
-    assert_equal true,  Dir.exists?("#{@dir2}")
-    assert_equal false, Dir.exists?("#{@dir2}/.git")
-    assert_equal false, Dir.exists?("#{@dir2}/.svn")
-    assert_equal false, Dir.exists?("#{@dir2}/test.dir.1")
-    assert_equal true,  Dir.exists?("#{@dir2}/test.dir.2")
-    assert_equal true,  File.exists?("#{@dir2}/test.1")
-    assert_equal false, File.exists?("#{@dir2}/test.2")
-    assert_equal true,  File.exists?("#{@dir2}/test.3")
-    assert_equal false, File.exists?("#{@dir2}/test.4")
-    assert_equal false, File.exists?("#{@dir2}/test.dir.2/test.1")
-    assert_equal false, File.exists?("#{@dir2}/test.dir.2/test.2")
-    assert_equal true,  File.exists?("#{@dir2}/test.dir.2/test.4")
-    assert_equal false, File.exists?("#{@dir2}/.gitignore")
+    assert_equal true,  Dir.exist?("#{@dir2}")
+    assert_equal false, Dir.exist?("#{@dir2}/.git")
+    assert_equal false, Dir.exist?("#{@dir2}/.svn")
+    assert_equal false, Dir.exist?("#{@dir2}/test.dir.1")
+    assert_equal true,  Dir.exist?("#{@dir2}/test.dir.2")
+    assert_equal true,  File.exist?("#{@dir2}/test.1")
+    assert_equal false, File.exist?("#{@dir2}/test.2")
+    assert_equal true,  File.exist?("#{@dir2}/test.3")
+    assert_equal false, File.exist?("#{@dir2}/test.4")
+    assert_equal false, File.exist?("#{@dir2}/test.dir.2/test.1")
+    assert_equal false, File.exist?("#{@dir2}/test.dir.2/test.2")
+    assert_equal true,  File.exist?("#{@dir2}/test.dir.2/test.4")
+    assert_equal false, File.exist?("#{@dir2}/.gitignore")
   end
   
   

data/test/test_torque_helper.rb

@@ -58,81 +58,81 @@ class TestTorqueHelper < Minitest::Test
   # end
   
   def test_qstat_state_no_job
-    PBS::Job.any_instance.stubs(:status).raises(PBS::UnkjobidError, "Unknown Job Id")
+    PBS::Batch.any_instance.stubs(:get_job).raises(PBS::UnkjobidError, "Unknown Job Id")
     assert_equal @job_state_completed, @shell.qstat("")
     assert_equal @job_state_completed, @shell.qstat(nil)
-    PBS::Job.any_instance.unstub(:status)
+    PBS::Batch.any_instance.unstub(:get_job)
   end
 
   # Test that qstat returns Running job StatusValue
   def test_qstat_state_running_oakley
-    PBS::Job.any_instance.stubs(:status).returns({ :attribs => { :job_state => "R" }})
+    PBS::Batch.any_instance.stubs(:get_job).returns({ "123.oak-batch.osc.edu" => { :job_state => "R" }})
     assert_equal @job_state_running, @shell.qstat("123.oak-batch.osc.edu")
-    PBS::Job.any_instance.unstub(:status)
+    PBS::Batch.any_instance.unstub(:get_job)
   end
 
   # Test that qstat returns Queued job StatusValue
   def test_qstat_state_queued_oakley
-    PBS::Job.any_instance.stubs(:status).returns({ :attribs => { :job_state => "Q" }})
+    PBS::Batch.any_instance.stubs(:get_job).returns({ "123.oak-batch.osc.edu" => { :job_state => "Q" }})
     assert_equal @job_state_queued, @shell.qstat("123.oak-batch.osc.edu")
-    PBS::Job.any_instance.unstub(:status)
+    PBS::Batch.any_instance.unstub(:get_job)
   end
 
   # Test that qstat returns Queued job StatusValue
   def test_qstat_state_running_ruby
-    PBS::Job.any_instance.stubs(:status).returns({ :attribs => { :job_state => "Q" }})
+    PBS::Batch.any_instance.stubs(:get_job).returns({ "12398765" => { :job_state => "Q" }})
     assert_equal @job_state_queued, @shell.qstat("12398765")
-    PBS::Job.any_instance.unstub(:status)
+    PBS::Batch.any_instance.unstub(:get_job)
   end
 
   # Test that qstat returns Completed job StatusValue when state is nil.
   def test_qstat_state_completed_oakley
-    PBS::Job.any_instance.stubs(:status).raises(PBS::UnkjobidError, "Unknown Job Id Error")
+    PBS::Batch.any_instance.stubs(:get_job).raises(PBS::UnkjobidError, "Unknown Job Id Error")
     assert_equal @job_state_completed, @shell.qstat("123.oak-batch.osc.edu")
-    PBS::Job.any_instance.unstub(:status)
+    PBS::Batch.any_instance.unstub(:get_job)
 
-    PBS::Job.any_instance.stubs(:status).raises(PBS::UnkjobidError, "Unknown Job Id")
+    PBS::Batch.any_instance.stubs(:get_job).raises(PBS::UnkjobidError, "Unknown Job Id")
     assert_equal @job_state_completed, @shell.qstat("123.oak-batch.osc.edu")
-    PBS::Job.any_instance.unstub(:status)
+    PBS::Batch.any_instance.unstub(:get_job)
   end
 
   # Test that qdel works for oakley
   def test_qdel_oakley_ok
-    PBS::Job.any_instance.stubs(:delete).returns(true)
+    PBS::Batch.any_instance.stubs(:delete_job).returns(true)
     assert_equal true, @shell.qdel("123.oak-batch.osc.edu")
-    PBS::Job.any_instance.unstub(:delete)
+    PBS::Batch.any_instance.unstub(:delete_job)
   end
 
   # Test that qdel works for quick batch
   def test_qdel_quick
-    PBS::Job.any_instance.stubs(:delete).returns(true)
+    PBS::Batch.any_instance.stubs(:delete_job).returns(true)
     assert_equal true, @shell.qdel("123.quick-batch.osc.edu")
-    PBS::Job.any_instance.unstub(:delete)
+    PBS::Batch.any_instance.unstub(:delete_job)
   end
 
   # Test that qdel works for Ruby cluster
   def test_qdel_ruby
-    PBS::Job.any_instance.stubs(:delete).returns(true)
+    PBS::Batch.any_instance.stubs(:delete_job).returns(true)
     assert_equal true, @shell.qdel("12365478")
-    PBS::Job.any_instance.unstub(:delete)
+    PBS::Batch.any_instance.unstub(:delete_job)
   end
 
   # Test that qdel throws exception on PBS exception
   def test_qdel_throws_exception
-    PBS::Job.any_instance.stubs(:delete).raises(PBS::Error)
+    PBS::Batch.any_instance.stubs(:delete_job).raises(PBS::Error)
     assert_raises(PBS::Error) { @shell.qdel("123.quick-batch.osc.edu") }
-    PBS::Job.any_instance.unstub(:delete)
+    PBS::Batch.any_instance.unstub(:delete_job)
 
-    PBS::Job.any_instance.stubs(:delete).raises(PBS::SystemError)
+    PBS::Batch.any_instance.stubs(:delete_job).raises(PBS::SystemError)
     assert_raises(PBS::SystemError) { @shell.qdel("123.quick-batch.osc.edu") }
-    PBS::Job.any_instance.unstub(:delete)
+    PBS::Batch.any_instance.unstub(:delete_job)
   end
 
   # Test that qdel doesn't throw exception if Unknown Job Id exception
   def test_qdel_doesnt_throw_exception_on_unknown_job_id
-    PBS::Job.any_instance.stubs(:delete).raises(PBS::UnkjobidError)
+    PBS::Batch.any_instance.stubs(:delete_job).raises(PBS::UnkjobidError)
     @shell.qdel("123.quick-batch.osc.edu")
-    PBS::Job.any_instance.unstub(:delete)
+    PBS::Batch.any_instance.unstub(:delete_job)
   end
   
   def assert_qsub_dependency_list(dependency_list, dependencies, host=nil)
@@ -188,22 +188,67 @@ class TestTorqueHelper < Minitest::Test
   end
 
   def test_account_string_passed_into_qsub_used_during_submit_call
-    PBS::Job.any_instance.expects(:submit).with(has_entry(headers: {Account_Name: "XXX"})).returns(PBS::Job.new(conn: 'oakley', id: '1234598.oak-batch.osc.edu'))
+    PBS::Batch.any_instance.expects(:submit_script).with(@script_oakley, has_entry(headers: {Account_Name: "XXX"})).returns('1234598.oak-batch.osc.edu')
     @shell.qsub(@script_oakley, account_string: "XXX")
-    PBS::Job.any_instance.unstub(:submit)
+    PBS::Batch.any_instance.unstub(:submit_script)
   end
 
   def test_default_account_string_used_in_qsub_during_submit_call
     @shell.stubs(:default_account_string).returns("PZS3000")
 
-    PBS::Job.any_instance.expects(:submit).with(has_entry(headers: {Account_Name: @shell.default_account_string})).returns(PBS::Job.new(conn: 'oakley', id: '1234598.oak-batch.osc.edu'))
+    PBS::Batch.any_instance.expects(:submit_script).with(@script_oakley, has_entry(headers: {Account_Name: @shell.default_account_string})).returns('1234598.oak-batch.osc.edu')
     @shell.qsub(@script_oakley)
 
     @shell.stubs(:default_account_string).returns("appl")
-    PBS::Job.any_instance.expects(:submit).with(has_entry(headers: {})).returns(PBS::Job.new(conn: 'oakley', id: '1234598.oak-batch.osc.edu'))
+    PBS::Batch.any_instance.expects(:submit_script).with(@script_oakley, has_entry(headers: {})).returns('1234598.oak-batch.osc.edu')
     @shell.qsub(@script_oakley)
 
-    PBS::Job.any_instance.unstub(:submit)
+    PBS::Batch.any_instance.unstub(:submit_script)
     @shell.unstub(:default_account_string)
   end
+
+  def test_pbs_default_host
+    s = @shell.pbs
+    assert_equal 'oak-batch.osc.edu', s.host
+    assert_equal OSC::Machete::TorqueHelper::LIB, s.lib.to_s
+    assert_equal OSC::Machete::TorqueHelper::BIN, s.bin.to_s
+  end
+
+  def test_pbs_host_variations
+    # you can use the cluster ids
+    assert_equal 'ruby-batch.osc.edu', @shell.pbs(host: 'ruby').host
+
+    # or you can use the host itself
+    assert_equal 'ruby-batch.osc.edu', @shell.pbs(host: 'ruby-batch.osc.edu').host
+    assert_equal '@ruby-batch', @shell.pbs(host: '@ruby-batch').host
+
+    assert_equal 'ruby-batch.osc.edu', @shell.pbs(id: '4567').host
+    assert_equal 'ruby-batch.osc.edu', @shell.pbs(script: @script_ruby).host
+    assert_equal 'oak-batch.osc.edu', @shell.pbs(script: @script_oakley).host
+  end
+
+  def test_setting_default_torque_helper
+    d = OSC::Machete::TorqueHelper.default
+
+    assert_equal 'oak-batch.osc.edu', OSC::Machete::TorqueHelper.default.pbs.host
+
+    # this is an example of how you can quickly modify the default behavior of
+    # a TorqueHelper instance to provide a new host, id, and script
+    d2 = OSC::Machete::TorqueHelper.new
+    class << d2
+      def pbs(host: nil, id: nil, script: nil)
+        PBS::Batch.new(
+          host: "ruby-batch.osc.edu",
+          lib: LIB,
+          bin: BIN
+        )
+      end
+    end
+
+    OSC::Machete::TorqueHelper.default = d2
+
+    assert_equal 'ruby-batch.osc.edu', OSC::Machete::TorqueHelper.default.pbs.host
+
+    OSC::Machete::TorqueHelper.default = d
+  end
 end

data/test/test_torque_helper_live.rb

@@ -2,6 +2,7 @@ require 'minitest/autorun'
 require 'osc/machete'
 require 'pbs'
 require 'mocha/setup'
+require 'socket'
 
 # test helper class
 class TestTorqueHelperLive < Minitest::Test
@@ -29,7 +30,7 @@ class TestTorqueHelperLive < Minitest::Test
     #   This raises an issue mentioning that it is not being submitted on the
     #   correct host, comment out the raise to skip the live tests.
     #   Maybe this would be better accomplished with a separate rake task.
-    @submit_host = "websvcs02.osc.edu"
+    @submit_host = "webdev02.hpc.osc.edu"
 
     @job_state_queued = OSC::Machete::Status.queued
     @job_state_completed = OSC::Machete::Status.passed
@@ -70,11 +71,11 @@ class TestTorqueHelperLive < Minitest::Test
 
       # Qstat it to make sure it's queued.
       live_status = torque.qstat(live_job)
-      assert_equal @job_state_queued, live_status
+      assert_includes OSC::Machete::Status.active_values, live_status
 
       # Delete it and assert true returned.
       live_delete_status = torque.qdel(live_job)
-      assert_equal nil, live_delete_status
+      assert_equal 0, live_delete_status
     else
       puts "Run test 'test_qsub_oakley' on the batch system from #{@submit_host}."
     end
@@ -101,11 +102,11 @@ class TestTorqueHelperLive < Minitest::Test
 
       # Qstat it to make sure it's queued.
       live_status = torque.qstat(live_job)
-      assert_equal @job_state_queued, live_status
+      assert_includes OSC::Machete::Status.active_values, live_status
 
       # Delete it and assert true returned.
       live_delete_status = torque.qdel(live_job)
-      assert_equal nil, live_delete_status
+      assert_equal 0, live_delete_status
     else
       puts "Run test 'test_qsub_ruby_with_oakley_script' on the batch system from #{@submit_host}."
     end
@@ -127,15 +128,15 @@ class TestTorqueHelperLive < Minitest::Test
     if Socket.gethostname == @submit_host
       # Submit a small job.
       live_job = torque.qsub(@script_ruby)
-      assert_match /^\d+$/, live_job
+      assert_match(/^\d+$/, live_job)
 
       # Qstat it to make sure it's queued.
       live_status = torque.qstat(live_job)
-      assert_equal @job_state_queued, live_status
+      assert_includes OSC::Machete::Status.active_values, live_status
 
       # Delete it and assert true returned.
       live_delete_status = torque.qdel(live_job)
-      assert_equal nil, live_delete_status
+      assert_equal 0, live_delete_status
     else
       puts "Run test 'test_qsub_ruby' on the batch system from #{@submit_host}."
     end
@@ -156,15 +157,15 @@ class TestTorqueHelperLive < Minitest::Test
     if Socket.gethostname == @submit_host
       # Submit a small job.
       live_job = torque.qsub(@script_quick, host: 'quick')
-      assert_match /\d+.quick-batch.osc.edu/, live_job
+      assert_match(/\d+.quick-batch.osc.edu/, live_job)
 
       # Qstat it to make sure it's queued.
       live_status = torque.qstat(live_job)
-      assert_equal @job_state_queued, live_status
+      assert_includes OSC::Machete::Status.active_values, live_status
 
       # Delete it and assert true returned.
       live_delete_status = torque.qdel(live_job)
-      assert_equal nil, live_delete_status
+      assert_equal 0, live_delete_status
     else
       puts "Run test 'test_qsub_quick' on the batch system from #{@submit_host}."
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: osc-machete
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.2.0
 platform: ruby
 authors:
 - Eric Franz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-17 00:00:00.000000000 Z
+date: 2016-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
 description: Common interface for PBS (and eventually other resource managers and
   batch schedulers - currently OSC specific)
 email:
@@ -144,9 +144,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -154,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Common interface for working with HPC batch jobs (currently OSC specific)
@@ -175,4 +175,3 @@ test_files:
 - test/test_status.rb
 - test/test_torque_helper.rb
 - test/test_torque_helper_live.rb
-has_rdoc: