pbs 2.0.4 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b212013b27cadbfb9bd8d45021f8e51a3b2fae9e
-  data.tar.gz: ea65f5cafc2aa97f110816e784c12b8d81a570fa
+  metadata.gz: 76a57e8e24fb6fba02e681f2d9dd2ada214d09f3
+  data.tar.gz: 04edfbd44cc1fbf2558f0c26ce6677e8d4fa8fef
 SHA512:
-  metadata.gz: d3a5352bd95687a144b9c8103479a112f475e37249da4031a8e87c5aa4811472a9325344e12124be6d146db4b590dcb3b4f2b1a05e3624370188d0779597c9c4
-  data.tar.gz: 2bfa0dc4d1f7754d76337b4bf4a463059f8de27e5e35669478afe7631213032d0878618eea95a25c463d8577f3bca027227def9a29ab3247a57c2ae0b6509c9c
+  metadata.gz: b5a98efcdb34c5679c078fbf6a151d9babb108ff3090b5517295b5d0a8c8f6f8676bbed1c2808c5e0369cb308f6b3013f87289822ae35e539509df9f8191583d
+  data.tar.gz: 0f32ca27b52b5afc182df01cb9a7d23581bbe69cb2e28eb096426b5a49f6d0db20209fd15d3c9af9ed74c15d2736f1b0557eab39d29b8c964c62688f95b8442d

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## Unreleased
 
+## 2.1.0 (2017-06-02)
+
+Features:
+
+  - added helpful scripts to setup and launch console
+  - provide support to get status of selected jobs on batch server
+
 ## 2.0.4 (2017-03-28)
 
 Bugfixes:

data/README.md

@@ -34,7 +34,7 @@ oakley = PBS::Batch.new(
 )
 
 # Get status information for this batch server
-# see http://linux.die.net/man/7/pbs_server_attributes
+# see https://linux.die.net/man/7/pbs_server_attributes
 oakley.get_status
 #=>
 #{
@@ -84,7 +84,7 @@ b.get_node("n0003")
 #=> { ... }
 
 # Get list of queues from batch server
-# see http://linux.die.net/man/7/pbs_queue_attributes
+# see https://linux.die.net/man/7/pbs_queue_attributes
 b.get_queues
 #=>
 #{
@@ -107,7 +107,7 @@ b.get_queue("serial")
 #=> { ... }
 
 # Get list of jobs from batch server
-# see http://linux.die.net/man/7/pbs_server_attributes
+# see https://linux.die.net/man/7/pbs_job_attributes
 b.get_jobs
 #=>
 #{
@@ -128,6 +128,25 @@ b.get_jobs
 # To get info about a single job
 b.get_job("6621251.oak-batch.osc.edu")
 #=> { ... }
+
+# Get selected list of jobs from batch server
+# see https://linux.die.net/man/3/pbs_selstat
+b.select_jobs(attribs: [{name: "User_List", value: "bob", op: :eq}])
+#=>
+#{
+#  "6621261.oak-batch.osc.edu" => {
+#    :Job_Name  => "FEA_solver_1",
+#    :Job_Owner => "bob@oakley01.osc.edu",
+#    :job_state => "R",
+#    ...
+#  },
+#  "6621262.oak-batch.osc.edu" => {
+#    :Job_Name  => "FEA_solver_2",
+#    :Job_Owner => "bob@oakley01.osc.edu",
+#    :job_state => "Q",
+#    ...
+#  }, ...
+#}
 ```
 
 ### Simple Job Submission

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pbs"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install --path=vendor/bundle
+
+# Do any other automated setup that you need to do here

data/lib/pbs/batch.rb

@@ -179,6 +179,35 @@ module PBS
       get_nodes(id: id, **kwargs)
     end
 
+    # Get a list of hashes of the selected jobs on the batch server
+    # @example Status info for jobs owned by Bob
+    #   my_conn.select_jobs(attribs: [{name: "User_List", value: "bob", op: :eq}])
+    #   #=>
+    #   #{
+    #   #  "10219837.oak-batch.osc.edu" => {
+    #   #    :Job_Owner => "bob@oakley02.osc.edu",
+    #   #    :Job_Name => "CFD_Solver",
+    #   #    ...
+    #   #  },
+    #   #  "10219839.oak-batch.osc.edu" => {
+    #   #    :Job_Owner => "bob@oakley02.osc.edu",
+    #   #    :Job_Name => "CFD_Solver2",
+    #   #    ...
+    #   #  },
+    #   #  ...
+    #   #}
+    # @param attribs [Array<#to_h>] list of hashes describing attributes to
+    #   select on
+    # @return [Hash] hash of details of selected jobs
+    #
+    def select_jobs(attribs: [])
+      connect do |cid|
+        attribs = PBS::Torque::Attropl.from_list(attribs.map(&:to_h))
+        batch_status = Torque.pbs_selstat cid, attribs, nil
+        batch_status.to_h.tap { Torque.pbs_statfree batch_status }
+      end
+    end
+
     # Get a list of hashes of the jobs on the batch server
     # @example Status info for OSC Oakley jobs
     #   my_conn.get_jobs
@@ -309,12 +338,22 @@ module PBS
     private
       # Submit a script using Torque library
       def pbs_submit(script, queue, headers, resources, envvars)
-        attribs = headers.dup
-        attribs[ATTR[:l]] = resources.dup unless resources.empty?
-        attribs[ATTR[:v]] = envvars.map{|k,v| "#{k}=#{v}"}.join(",") unless envvars.empty?
+        attribs = []
+        headers.each do |name, value|
+          attribs << { name: name, value: value }
+        end
+        resources.each do |rsc, value|
+          attribs << { name: :Resource_List, resource: rsc, value: value }
+        end
+        unless envvars.empty?
+          attribs << {
+            name: :Variable_List,
+            value: envvars.map {|k,v| "#{k}=#{v}"}.join(",")
+          }
+        end
 
         connect do |cid|
-          attropl = Torque::Attropl.from_hash attribs
+          attropl = Torque::Attropl.from_list attribs
           Torque.pbs_submit cid, attropl, script, queue, nil
         end
       end

data/lib/pbs/torque.rb

@@ -119,6 +119,16 @@ module PBS
     #   @return [BatchStatus] c-linked list of batch status objects
     #   @note It is up to the user to free the space of the batch status objects
 
+    # @!method self.pbs_selstat(connect, attrib, extend)
+    #   Obtain status of selected PBS batch jobs
+    #     batch_status * pbs_selstat(int connect, struct attropl *sel_list, char *extend)
+    #   @see http://linux.die.net/man/3/pbs_selstat
+    #   @param connect [Fixnum] connection identifier
+    #   @param attrib [Attropl] the attribute operation c-linked list object
+    #   @param extend [String] implementation defined extensions
+    #   @return [BatchStatus] c-linked list of batch status objects
+    #   @note It is up to the user to free the space of the batch status objects
+
     # @!method self.pbs_submit(connect, attrib, script, destination, extend)
     #   Submit a PBS batch job
     #     char *pbs_submit(int connect, struct attropl *attrib, char *script, char *destination, char *extend)
@@ -159,6 +169,7 @@ module PBS
       attach_function :pbs_statnode, [ :int, :string, Attrl.ptr, :string ], BatchStatus.ptr
       attach_function :pbs_statque, [ :int, :string, Attrl.ptr, :string ], BatchStatus.ptr
       attach_function :pbs_statserver, [ :int, Attrl.ptr, :string ], BatchStatus.ptr
+      attach_function :pbs_selstat, [ :int, Attropl.ptr, :string ], BatchStatus.ptr
 
       # FIXME: The space for the job_identifier string is allocated by
       # pbs_submit() and should be released via a call to free() when no longer
@@ -236,21 +247,19 @@ module PBS
              :value,    :pointer,         # string for value of attribute
              :op,       BatchOp           # operation to perform for this attribute
 
-      # Convert to C-linked list of structs from hash
-      # @param hash [Hash] hash representation of this c-linked list
+      # Convert to C-linked list of structs from list of hashes
+      # @param list [Array<#to_h>] list of hashes describing attribute
       # @return [Attropl] generated attribute operation c-linked list object
-      def self.from_hash(hash)
-        # Convert hash into array
-        # Format: {name: value, name: {resource: value, resource: value}}
-        # {a: 1, b: {c: 2, d: 3}} => [[:a,1],[:b,2,:c],[:b,3,:d]]
-        ary = hash.map{|k,v| [*v].map{|v2| [k,*[*v2].reverse]}}.flatten(1)
+      def self.from_list(list)
+        list = list.map(&:to_h)
         attropl = nil
         prev = Attropl.new(FFI::Pointer::NULL)
-        ary.each do |attrib|
+        list.each do |attrib|
           attropl = Attropl.new
-          attropl[:name]     = FFI::MemoryPointer.from_string attrib[0].to_s
-          attropl[:value]    = FFI::MemoryPointer.from_string attrib[1].to_s
-          attropl[:resource] = FFI::MemoryPointer.from_string attrib[2].to_s if attrib[2]
+          attropl[:name]     = FFI::MemoryPointer.from_string attrib[:name].to_s
+          attropl[:value]    = FFI::MemoryPointer.from_string attrib[:value].to_s
+          attropl[:resource] = FFI::MemoryPointer.from_string attrib[:resource].to_s
+          attropl[:op]       = (attrib[:op] || :eq).to_sym
           attropl[:next]     = prev
           prev = attropl
         end

data/lib/pbs/version.rb

@@ -1,4 +1,4 @@
 module PBS
   # The current version of PBS
-  VERSION = "2.0.4"
+  VERSION = "2.1.0"
 end

data/pbs.gemspec

@@ -15,7 +15,8 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
   spec.required_ruby_version = '>= 2.2.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pbs
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.1.0
 platform: ruby
 authors:
 - Jeremy Nicklas
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2017-03-28 00:00:00.000000000 Z
+date: 2017-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -86,6 +86,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - lib/pbs.rb
 - lib/pbs/attributes.rb
 - lib/pbs/batch.rb