pbs 1.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b86e26918976f01fb7df0c1add6b90fe7d72bb62
+  data.tar.gz: ceb18d0411222ecf32bcca3c2c5a50df95faa5ad
+SHA512:
+  metadata.gz: ba43a215a3fcf0db521e1cb7fdedadf1b022d96afe4b7d31a9688a7274a10b511bfe3c2d9e121a979eb6529979fb5078b4838148b77de456b1a44c50cdca628c
+  data.tar.gz: 86d41f545c90f662d35aa3a5971b57c14e8c1a74aaf6f847559406e2ea0a73f06b7fdadde79f8c04e26b696ae035b386aee716076d450500c131d929b31eaefd

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pbs.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014-2016 Ohio Supercomputer Center
+
+MIT License
+
+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.md

@@ -0,0 +1,34 @@
+# PBS Ruby
+
+## Description
+
+Trimmed down Ruby wrapper for the Torque C Library utilizing Ruby-FFI.
+
+## Requirements
+
+At minimum you will need:
+* Ruby 2.0
+* Ruby-FFI gem
+* Torque >= 4.2.10
+
+## Installation
+
+Add this to your application's Gemfile:
+
+```ruby
+  gem 'pbs'
+```
+
+And then execute:
+
+```bash
+  $ bundle install
+```
+
+## Usage
+
+Most useful features are outlined in the `examples/simplejob.rb` provided. To run this simple example, type:
+
+```bash
+  $ ruby -Ilib examples/simplejob.rb
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/config/batch.yml

@@ -0,0 +1,24 @@
+oakley: &oakley
+    lib: '/usr/local/torque/default/lib/libtorque.so'
+    server: &oakley_server 'oak-batch.osc.edu'
+    qsub: 'LD_LIBRARY_PATH=/usr/local/torque/default/lib:$LD_LIBRARY_PATH /usr/local/torque/default/bin/qsub'
+*oakley_server:
+  <<: *oakley
+ruby: &ruby
+    lib: '/usr/local/torque/default/lib/libtorque.so'
+    server: &ruby_server 'ruby-batch.ten.osc.edu'
+    qsub: 'LD_LIBRARY_PATH=/usr/local/torque/default/lib:$LD_LIBRARY_PATH /usr/local/torque/default/bin/qsub'
+*ruby_server:
+  <<: *ruby
+oxymoron: &oxymoron
+    lib: '/usr/local/torque/default/lib/libtorque.so'
+    server: &oxymoron_server 'oak-batch.osc.edu:17001'
+    qsub: 'LD_LIBRARY_PATH=/usr/local/torque/default/lib:$LD_LIBRARY_PATH /usr/local/torque/default/bin/qsub'
+*oxymoron_server:
+  <<: *oxymoron
+quick: &quick
+    lib: '/usr/local/torque/default/lib/libtorque.so'
+    server: &quick_server 'quick-batch.osc.edu'
+    qsub: 'LD_LIBRARY_PATH=/usr/local/torque/default/lib:$LD_LIBRARY_PATH /usr/local/torque/default/bin/qsub'
+*quick_server:
+  <<: *quick

data/config/websvcs02.osc.edu.yml

@@ -0,0 +1,24 @@
+oakley: &oakley
+    lib: '/usr/local/torque-4.2.8/lib/libtorque.so'
+    server: &oakley_server 'oak-batch.osc.edu'
+    qsub: 'LD_LIBRARY_PATH=/usr/local/torque-4.2.8/lib:$LD_LIBRARY_PATH /usr/local/torque-4.2.8/bin/qsub'
+*oakley_server:
+  <<: *oakley
+ruby: &ruby
+    lib: '/usr/local/torque-4.2.8/lib/libtorque.so'
+    server: &ruby_server 'ruby-batch.ten.osc.edu'
+    qsub: 'LD_LIBRARY_PATH=/usr/local/torque-4.2.8/lib:$LD_LIBRARY_PATH /usr/local/torque-4.2.8/bin/qsub'
+*ruby_server:
+  <<: *ruby
+oxymoron: &oxymoron
+    lib: '/usr/local/torque-4.2.8/lib/libtorque.so'
+    server: &oxymoron_server 'oak-batch.osc.edu:17001'
+    qsub: 'LD_LIBRARY_PATH=/usr/local/torque-4.2.8/lib:$LD_LIBRARY_PATH /usr/local/torque-4.2.8/bin/qsub'
+*oxymoron_server:
+  <<: *oxymoron
+quick: &quick
+    lib: '/usr/local/torque-4.2.8/lib/libtorque.so'
+    server: &quick_server 'quick-batch.osc.edu'
+    qsub: 'LD_LIBRARY_PATH=/usr/local/torque-4.2.8/lib:$LD_LIBRARY_PATH /usr/local/torque-4.2.8/bin/qsub'
+*quick_server:
+  <<: *quick

data/config/websvcs08.osc.edu.yml

@@ -0,0 +1,18 @@
+oakley: &oakley
+  lib: '/usr/local/torque/5.1.1-1_fba25d92/lib/libtorque.so'
+  server: &oakley_server 'oak-batch.osc.edu'
+  qsub: 'LD_LIBRARY_PATH=/usr/local/torque/5.1.1-1_fba25d92/lib:$LD_LIBRARY_PATH /usr/local/torque/5.1.1-1_fba25d92/bin/qsub'
+*oakley_server:
+  <<: *oakley
+ruby: &ruby
+  lib: '/usr/local/torque/5.1.1-1_fba25d92/lib/libtorque.so'
+  server: &ruby_server 'ruby-batch.ten.osc.edu'
+  qsub: 'LD_LIBRARY_PATH=/usr/local/torque/5.1.1-1_fba25d92/lib:$LD_LIBRARY_PATH /usr/local/torque/5.1.1-1_fba25d92/bin/qsub'
+*ruby_server:
+  <<: *ruby
+quick: &quick
+  lib: '/usr/local/torque/5.1.1-1_fba25d92/lib/libtorque.so'
+  server: &quick_server 'quick-batch.osc.edu'
+  qsub: 'LD_LIBRARY_PATH=/usr/local/torque/5.1.1-1_fba25d92/lib:$LD_LIBRARY_PATH /usr/local/torque/5.1.1-1_fba25d92/bin/qsub'
+*quick_server:
+  <<: *quick

data/examples/simplejob.rb

@@ -0,0 +1,66 @@
+require 'pbs'
+require 'yaml'
+
+# Set up connection to local server
+c = PBS::Conn.batch 'oakley'
+
+# Check info for local server
+q = PBS::Query.new(conn: c, type: :server)
+puts "# Batch server information ---"
+puts q.find.to_yaml
+puts ""
+
+# Check if I have any jobs currently running
+q = PBS::Query.new(conn: c, type: :job)
+filters = [PBS::ATTR[:state], PBS::ATTR[:owner]]
+puts "# All jobs you currently have in the batch ---"
+puts q.where.user(ENV['USER']).find(filters: filters).to_yaml
+puts ""
+
+# Setup new job
+j = PBS::Job.new(conn: c)
+
+headers = { PBS::ATTR[:N] => "SimpleJob" }
+resources = { walltime: "00:10:00" }
+envvars = { WORLD: "world" }
+script = "echo \"Hello ${WORLD}!\""
+
+
+# Submit new job
+puts "# Submitting new job ---"
+puts j.submit(string: script, headers: headers, resources: resources, envvars: envvars, qsub: true).id
+puts ""
+
+# Show details of new job
+puts "# Details of submitted job ---"
+puts j.status.to_yaml
+puts ""
+
+# Hold job
+puts "# Holding job now ---"
+j.hold
+puts j.status(filter: PBS::ATTR[:state]).to_yaml
+puts ""
+
+# Show only jobs on hold
+puts "# All running jobs on hold ---"
+puts q.where.user(ENV['USER']).where(PBS::ATTR[:state]) {|v| v == 'H'}.find(filters: filters).to_yaml
+puts ""
+puts "# All running jobs not on hold ---"
+puts q.where.user(ENV['USER']).where.not(PBS::ATTR[:state] => 'H').find(filters: filters).to_yaml
+puts ""
+puts "# All running jobs not queued ---"
+puts q.where.user(ENV['USER']).where.is(PBS::ATTR[:state] => 'H').find(filters: filters).to_yaml
+puts ""
+
+# Release job
+puts "# Releasing job now ---"
+j.release
+puts j.status(filter: PBS::ATTR[:state]).to_yaml
+puts ""
+
+# Delete submitted job
+puts "# Deleting job now ---"
+j.delete
+puts "Complete."
+puts ""

data/lib/pbs.rb

@@ -0,0 +1,38 @@
+require 'yaml'
+require 'socket'
+
+require_relative 'pbs/error'
+require_relative 'pbs/attributes'
+require_relative 'pbs/torque'
+require_relative 'pbs/conn'
+require_relative 'pbs/query'
+require_relative 'pbs/job'
+require_relative 'pbs/version'
+
+module PBS
+    # Path to the batch config yaml file describing the batch servers for
+    # local batch schedulers.
+    # @return [String] Path to the batch config yaml file.
+    def self.default_batch_config_path
+      default_config = File.expand_path("../../config/batch.yml", __FILE__)
+      host_config = File.expand_path("../../config/#{Socket.gethostname}.yml", __FILE__)
+      File.file?(host_config) ? host_config : default_config
+    end
+
+    # Get the path to the batch config yaml file.
+    def self.batch_config_path
+      @batch_config_path ||= self.default_batch_config_path
+    end
+
+    # Set the path to the batch config yaml file.
+    # @param path [String] The path to the batch config yaml file.
+    def self.batch_config_path=(path)
+      @batch_config_path = File.expand_path(path)
+    end
+
+    # Hash generated from reading the batch config yaml file.
+    # @return [Hash] Batch configuration generated from config yaml file.
+    def self.batch_config
+      YAML.load_file(batch_config_path)
+    end
+end

data/lib/pbs/attributes.rb

@@ -0,0 +1,110 @@
+# Maintains a constant Hash of defined PBS attribute types
+#
+#   Includes:
+#     Attribute names used by user commands
+#     Additional job and general attribute names
+#     Additional queue attribute names
+#     Additional server attribute names
+#     Additional node attribute names
+module PBS
+  ATTR = {
+    # Attribute names used by user commands
+    a:                 :Execution_Time,
+    c:                 :Checkpoint,
+    e:                 :Error_Path,
+    f:                 :fault_tolerant,
+    g:                 :group_list,
+    h:                 :Hold_Types,
+    j:                 :Join_Path,
+    k:                 :Keep_Files,
+    l:                 :Resource_List,
+    m:                 :Mail_Points,
+    o:                 :Output_Path,
+    p:                 :Priority,
+    q:                 :destination,
+    r:                 :Rerunable,
+    t:                 :job_array_request,
+    array_id:          :job_array_id,
+    u:                 :User_List,
+    v:                 :Variable_List,
+    A:                 :Account_Name,
+    args:              :job_arguments,
+    reservation_id:    :reservation_id,
+    login_node_id:     :login_node_id,
+    login_prop:        :login_property,
+    external_nodes:    :external_nodes,
+    multi_req_alps:    :multi_req_alps,
+    M:                 :Mail_Users,
+    N:                 :Job_Name,
+    S:                 :Shell_Path_List,
+    depend:            :depend,
+    inter:             :interactive,
+    stagein:           :stagein,
+    stageout:          :stageout,
+    jobtype:           :jobtype,
+    submit_host:       :submit_host,
+    init_work_dir:     :init_work_dir,
+
+    # Additional job and general attribute names
+    ctime:             :ctime,
+    exechost:          :exec_host,
+    execport:          :exec_port,
+    mtime:             :mtime,
+    qtime:             :qtime,
+    session:           :session_id,
+    euser:             :euser,
+    egroup:            :egroup,
+    hashname:          :hashname,
+    hopcount:          :hop_count,
+    security:          :security,
+    sched_hint:        :sched_hint,
+    substate:          :substate,
+    name:              :Job_Name,
+    owner:             :Job_Owner,
+    used:              :resources_used,
+    state:             :job_state,
+    queue:             :queue,
+    server:            :server,
+    maxrun:            :max_running,
+    maxreport:         :max_report,
+    total:             :total_jobs,
+    comment:           :comment,
+    cookie:            :cookie,
+    qrank:             :queue_rank,
+    altid:             :alt_id,
+    etime:             :etime,
+    exitstat:          :exit_status,
+    forwardx11:        :forward_x11,
+    submit_args:       :submit_args,
+    tokens:            :tokens,
+    netcounter:        :net_counter,
+    umask:             :umask,
+    start_time:        :start_time,
+    start_count:       :start_count,
+    checkpoint_dir:    :checkpoint_dir,
+    checkpoint_name:   :checkpoint_name,
+    checkpoint_time:   :checkpoint_time,
+    checkpoint_restart_status:  :checkpoint_restart_status,
+    restart_name:      :restart_name,
+    comp_time:         :comp_time,
+    reported:          :reported,
+    intcmd:            :inter_cmd,
+    job_radix:         :job_radix,
+    sister_list:       :sister_list,
+    total_runtime:     :total_runtime,
+    P:                 :proxy_user,
+    node_exclusive:    :node_exclusive,
+    exec_gpus:         :exec_gpus,
+    exec_mics:         :exec_mics,
+    J:                 :job_id,
+    pagg:              :pagg_id,
+    system_start_time: :system_start_time,
+    gpu_flags:         :gpu_flags,
+
+    # Additional queue attribute names
+
+    # Additional server attribute names
+
+    # Additional node attribute names
+  }
+end

data/lib/pbs/conn.rb

@@ -0,0 +1,75 @@
+module PBS
+  class Conn
+    # @example Torque 4.2.8
+    #   "/usr/local/torque-4.2.8/lib/libtorque.so"
+    # @return [String] The torque library to use for connection.
+    attr_reader :lib
+
+    # @example Oakley
+    #   "oak-batch.osc.edu"
+    # @return [String] The batch server to connect to.
+    attr_reader :server
+
+    # @example Torque 4.2.8
+    #   "PATH=/usr/local/torque-4.2.8/bin:$PATH LD_LIBRARY_PATH=/usr/local/torque-4.2.8/lib:$LD_LIBRARY_PATH"
+    # @return [String] The qsub command to be called from the command line.
+    attr_reader :qsub
+
+    # @return [Fixnum, nil] The connection id number if connected.
+    attr_reader :conn_id
+
+    # Create a new connection object from pre-defined batch server defined in
+    # batch config yaml.
+    # @example Create Oakley connection
+    #   PBS::Conn.batch 'oakley'
+    #
+    # @param name [String] The name of the pre-defined batch server.
+    # @param opts [Hash] The options to create a connection object with.
+    # @option opts [String] :lib The torque library used to establish connection.
+    # @option opts [String] :server The batch server to connect to.
+    # @option opts [String] :qsub The qsub command to be called from the command line.
+    # @raise [Error] if pre-defined batch server doesn't exist.
+    def self.batch(name, opts = {})
+      context = PBS.batch_config[name] || raise(PBS::Error, "No pre-defined batch server (#{name})")
+      lib = opts[:lib]    || context.fetch('lib', nil)
+      svr = opts[:server] || context.fetch('server', nil)
+      qsb = opts[:qsub]   || context.fetch('qsub', nil)
+      Conn.new(lib: lib, server: svr, qsub: qsb)
+    end
+
+    # @param opts [Hash] The options to create a connection object with.
+    # @option opts [String] :lib The torque library used to establish connection.
+    # @option opts [String] :server The batch server to connect to.
+    # @option opts [String] :qsub The qsub command to be called from the command line.
+    def initialize(opts)
+      @lib    = opts[:lib] || "torque"
+      @server = opts[:server]
+      @qsub   = opts[:qsub] || "qsub"
+    end
+
+    # Creates a torque connection
+    #
+    # @return [Integer] The connection id.
+    def connect
+      Torque.init lib: lib          # reset library used in Torque
+      disconnect if connected?      # clean up any old connection
+      @conn_id = Torque.pbs_connect(server)
+      Torque.raise_error(@conn_id.abs) if @conn_id < 0  # raise error if negative conn_id
+      Torque.check_for_error        # check for any other error that slipped by
+      conn_id
+    end
+
+    # Disconnects from the connection and sets the connection id to nil.
+    def disconnect
+      Torque.pbs_disconnect(@conn_id)
+      @conn_id = nil    # reset connection id
+    end
+
+    # Returns true if the connection id is not nil and is greater than zero.
+    #
+    # @return [Boolean] Are we connected?
+    def connected?
+      !@conn_id.nil? && @conn_id > 0
+    end
+  end
+end