osc-reservations 1.0.3

data/lib/osc/reservations/batch.rb

@@ -0,0 +1,39 @@
+module OSC
+  module Reservations
+    # Batch server that utilizes reservations in the batch scheduler.
+    class Batch
+      # @return [String] the batch server to connect to.
+      attr_reader :server
+
+      # @param server [String] The server to connect to.
+      # @param context [Hash] An optional hash of values that may be required by chosen adapter.
+      def initialize(server, context = {})
+        @server = server
+
+        # symbolize keys
+        @context = {}
+        context.each do |key, value|
+          @context[key.to_sym] = value
+        end
+      end
+
+      # See if the method call exists as a key in @context.
+      #
+      # @param method_name the method name called
+      # @param arguments the arguments to the call
+      # @param block an optional block for the call
+      def method_missing(method_name, *arguments, &block)
+        @context.fetch(method_name) { super }
+      end
+
+      # Checks if the method responds to an instance method, or is able to
+      # proxy it to @context.
+      #
+      # @param method_name the method name to check
+      # @return [Boolean]
+      def respond_to_missing?(method_name, include_private = false)
+        @context.include?(method_name) || super
+      end
+    end
+  end
+end

data/lib/osc/reservations/node.rb

@@ -0,0 +1,42 @@
+module OSC
+  module Reservations
+    # Provides a way for the developer to view the properties of any given
+    # reserved node.
+    class Node
+      # @return [String] The ID of this node.
+      attr_accessor :id
+
+      # @return [Fixnum] Number of cores on this node.
+      attr_accessor :np
+
+      # @return [Array<String>] A list of properties for this node.
+      attr_accessor :props
+
+      # @return [Array<String>] A list of job id's running on this node.
+      attr_accessor :jobs
+
+      # @return [Array<String>] A list of users running on this node.
+      attr_accessor :users
+
+      # @param opts [Hash] Options used to create a node.
+      # @option opts [String] :id The ID of this node.
+      # @option opts [Fixnum] :np The number of processors on this node.
+      # @option opts [Array<String>] :props An array of properties for this node.
+      # @option opts [Array<String>] :jobs An array of job IDs running on this node.
+      # @option opts [Array<String>] :users An array of users running on this node.
+      def initialize(opts)
+        @id    = opts[:id]
+        @np    = opts[:np]
+        @props = opts[:props]
+        @jobs  = opts[:jobs]
+        @users = opts[:users]
+      end
+
+      # Is this node free to use?
+      # @return [Boolean] is node free?
+      def free?
+        jobs.empty?
+      end
+    end
+  end
+end

data/lib/osc/reservations/query.rb

@@ -0,0 +1,60 @@
+require 'yaml'
+
+module OSC
+  module Reservations
+    # Factory for creating reservation objects that detail the current user's
+    # reservations on the given batch server.
+    class Query
+      # See if the method call exists as a key in batch config yaml file.
+      # Examples:
+      #   Query.glenn()
+      #   Query.oakley()
+      #
+      # @param method_name the method name called
+      # @param arguments the arguments to the call
+      # @param block an optional block for the call
+      def self.method_missing(method_name, *arguments, &block)
+        context = Reservations.batch_config[method_name.to_s]
+        if context
+          adapter_type  = context['adapter']['type']
+          batch_server  = context['batch'].delete('server')
+          batch_context = context['batch']
+          a = Object.const_get(adapter_type).new
+          b = Batch.new(batch_server, batch_context)
+          new(a, b)
+        else
+          super
+        end
+      end
+
+      # Checks if the method responds to an instance method, or is able to
+      # proxy it to the batch config yaml file.
+      #
+      # @param method_name the method name to check
+      # @return [Boolean]
+      def self.respond_to_missing?(method_name, include_private = false)
+        Reservations.batch_config.include?(method_name.to_s) || super
+      end
+
+      # @param adapter [Adapter] The adapter used to communicate with the scheduler.
+      # @param batch [Batch] The batch server to communicate with.
+      def initialize(adapter, batch)
+        @adapter = adapter
+        @batch = batch
+      end
+
+      # Query the reservation information for a given reservation id.
+      # @param id [String] The reservation id to query for.
+      # @return [Reservation, nil] The reservation queried for.
+      def reservation(id)
+        @adapter.query_reservation(@batch, id)
+      end
+
+      # Query for all the reservations.
+      # @return [Array<Reservation>] A list of reservations for the user.
+      def reservations
+        @adapter.query_reservations(@batch)
+      end
+    end
+  end
+end

data/lib/osc/reservations/reservation.rb

@@ -0,0 +1,53 @@
+module OSC
+  module Reservations
+    # Provides a way for developers to interact with a scheduler independent
+    # reservation.
+    class Reservation
+      # @return [String] The ID for this reservation.
+      attr_accessor :id
+
+      # @return [Time] The time when this reservation begins.
+      attr_accessor :starttime
+
+      # @return [Time] The time when this reservation ends.
+      attr_accessor :endtime
+
+      # @return [Array<Node>] The list of nodes reserved under this reservation.
+      attr_accessor :nodes
+
+      # @return [String] The accounting creds user (who gets charged for unused resources).
+      attr_accessor :auser
+
+      # @return [Array<String>] The list of users who have access to this reservation.
+      attr_accessor :users
+
+      # @param opts [Hash] The options to create a reservation with.
+      # @option opts [String] :id The ID of the reservation.
+      # @option opts [Time] :starttime The time the reservations begins.
+      # @option opts [Time] :endtime The time the reservation ends.
+      # @option opts [Array<Node>] :nodes An array of nodes allocated for the reservation.
+      # @option opts [String] :auser The accounting user to be charged for unused CPU of reservation.
+      # @option opts [Array<String>] :users An array of users who have access to this reservation.
+      def initialize(opts)
+        @id        = opts[:id]
+        @starttime = opts[:starttime]
+        @endtime   = opts[:endtime]
+        @nodes     = opts[:nodes]
+        @auser     = opts[:auser]
+        @users     = opts[:users]
+      end
+
+      # List of nodes that are free to use for this reservation.
+      # @return [Array<Node>] The list of nodes free to use.
+      def free_nodes
+        nodes.select(&:free?)
+      end
+
+      # Has this reservation started yet?
+      # @return [Boolean] Whether this reservation has started yet.
+      def started?
+        Time.now >= starttime
+      end
+    end
+  end
+end

data/lib/osc/reservations/version.rb

@@ -0,0 +1,6 @@
+module OSC
+  module Reservations
+    # The current version of OSC::Reservations.
+    VERSION = "1.0.3"
+  end
+end

data/osc-reservations.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'osc/reservations/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "osc-reservations"
+  spec.version       = OSC::Reservations::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ["Jeremy Nicklas"]
+  spec.email         = ["jnicklas@osc.edu"]
+  spec.summary       = %q{Query current OSC reservations for running user}
+  spec.description   = %q{This library queries active OSC reservations for the running user.}
+  spec.homepage      = "https://github.com/OSC/osc-reservations"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.add_runtime_dependency "nokogiri", "~> 1.6"
+  spec.add_runtime_dependency "pbs", "~> 1.0"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/test/adapters/test_osc_moab.rb

@@ -0,0 +1,115 @@
+require 'minitest/autorun'
+require 'osc/reservations'
+
+require 'ostruct'
+require 'yaml'
+
+# Stub out command line methods
+module Open3
+  def popen3(*cmd,&block)
+    line = cmd[0]
+
+    wait_thr = nil
+    if line =~ /NIL_RSV/
+      wait_thr = OpenStruct.new(value: OpenStruct.new(:'success?' => false))
+    else
+      wait_thr = OpenStruct.new(value: OpenStruct.new(:'success?' => true))
+    end
+
+    file = "osc_rsv.xml" if line =~ /mrsvctl/
+    file = "osc_rsvs.xml" if line =~ /mrsvctl/ && line =~ /ALL/
+    File.open("test/files/#{file}", "r") do |f|
+      yield "", f, "", wait_thr
+    end
+  end
+  module_function :popen3
+end
+
+# Stub out PBS methods
+module PBS
+  class Conn
+    def self.batch(name)
+      name
+    end
+  end
+  class Query
+    def initialize(opts)
+      @conn = opts[:conn]
+      @type = opts[:type]
+    end
+    def find(opts)
+      YAML.load_file("test/files/osc_#{@conn}_#{@type}_#{opts[:id]}.yml")
+    end
+  end
+end
+
+class TestOSCMoab < Minitest::Test
+  def setup
+    @batch = OpenStruct.new(server: 'a.b.c', torque_name: 'oakley', mrsvctl: 'mrsvctl')
+    @adapter = OSC::Reservations::Adapters::OSCMoab.new
+  end
+
+  def test_osc_moab
+    assert_respond_to @adapter, :query_reservation
+    assert_respond_to @adapter, :query_reservations
+    assert_respond_to @adapter, :submit_reservation
+  end
+
+  def test_query_reservation
+    rsv = @adapter.query_reservation(@batch, 'NIL_RSV')
+    assert_equal nil, rsv
+
+    rsv = @adapter.query_reservation(@batch, 'wiag.1809')
+    test_wiag_rsv(rsv)
+  end
+
+  def test_query_reservations
+    rsv_list = @adapter.query_reservations(@batch)
+    assert_equal 2, rsv_list.length
+
+    rsv = rsv_list.first
+    test_wiag_rsv(rsv)
+
+    # reservation that hasn't started yet
+    rsv = rsv_list[1]
+    assert_equal 4, rsv.nodes.length
+    assert_operator Time.now, :<, rsv.starttime
+  end
+
+  def test_submit_reservation
+    @adapter.submit_reservation(@batch, nil)
+  end
+
+  private
+
+  def test_wiag_rsv(rsv)
+    assert_equal "wiag.1809", rsv.id
+    assert_equal Time.at(1433854480), rsv.starttime
+    assert_equal Time.at(1633854480), rsv.endtime
+    assert_equal "judithg", rsv.auser
+    assert_equal ["bmcmichael", "jnicklas", "awe0011", "ndem0009", "efranz", "ndem0010", "bgohar"], rsv.users
+
+    nodes = rsv.nodes
+    assert_equal 4, nodes.length
+
+    # node with no jobs
+    node = nodes[0]
+    assert_equal "n0613", node.id
+    assert_equal 12, node.np
+    assert_equal ["cbb15", "partdual", "udapl"], node.props
+    assert_equal [], node.jobs
+    assert_equal [], node.users
+
+    # node with one job using all cores
+    node = nodes[3]
+    assert_equal "n0609", node.id
+    assert_equal ["4691489.oak-batch.osc.edu"], node.jobs
+    assert_equal ["jnicklas"], node.users
+
+    # node with multiple jobs on it
+    node2 = nodes[2]
+    assert_equal "n0611", node2.id
+    assert_equal ["4691490.oak-batch.osc.edu", "4691491.oak-batch.osc.edu"], node2.jobs
+    assert_equal ["jnicklas"], node2.users
+  end
+end

data/test/files/batch.yml

@@ -0,0 +1,4 @@
+batch1:
+  adapter: 'FakeAdapter'
+  server: 'batch1.domain.com'
+  extra1: 'EXTRA1'

data/test/files/osc_oakley_job_4691489.oak-batch.osc.edu.yml

@@ -0,0 +1,47 @@
+---
+- :name: 4691489.oak-batch.osc.edu
+  :attribs:
+    :Job_Name: TestJob
+    :Job_Owner: jnicklas@oakley01.osc.edu
+    :resources_used:
+      :cput: '00:00:00'
+      :energy_used: '0'
+      :mem: 2208kb
+      :vmem: 211332kb
+      :walltime: '00:00:14'
+    :job_state: R
+    :queue: serial
+    :server: oak-batch.osc.edu:15001
+    :Checkpoint: u
+    :ctime: '1443626884'
+    :Error_Path: oakley01.osc.edu:/nfs/17/jnicklas/ttt/TestJob.e4845720
+    :exec_host: n0675/0-11
+    :exec_port: '15003'
+    :Hold_Types: n
+    :Join_Path: n
+    :Keep_Files: n
+    :Mail_Points: a
+    :mtime: '1443626959'
+    :Output_Path: oakley01.osc.edu:/nfs/17/jnicklas/ttt/TestJob.o4845720
+    :Priority: '0'
+    :qtime: '1443626884'
+    :Rerunable: 'True'
+    :Resource_List:
+      :gattr: fs17
+      :nodect: '1'
+      :nodes: 1:ppn=12
+      :walltime: '03:00:00'
+    :session_id: '22136'
+    :Variable_List: PBS_O_QUEUE=batch,PBS_O_HOME=/nfs/17/jnicklas,PBS_O_LOGNAME=jnicklas,PBS_O_PATH=/nfs/gpfs/PZS0645/local-oakley/tree/1.7.0/bin:/nfs/gpfs/PZS0645/local-oakley/git/2.3.6/bin:/nfs/gpfs/PZS0645/local-oakley/vim/7.4/bin:/nfs/17/jnicklas/bin:/usr/lib64/qt-3.3/bin:/usr/local/mvapich2/intel/15/2.1/bin:/usr/local/intel/vtune_amplifier_xe_2015.3.0.403110/bin64:/usr/local/intel/inspector_xe_2015.1.2.379161/bin64:/usr/local/intel/composer_xe_2015.3.187/bin/intel64:/usr/local/moab/8.1.1.2-2015080516-eb28ad0-el6/bin:/usr/local/torque/5.1.1-1_fba25d92/bin:/usr/local/bin:/bin:/usr/bin:/usr/local/sbin:/usr/sbin:/sbin,PBS_O_MAIL=/var/spool/mail/jnicklas,PBS_O_SHELL=/bin/bash,PBS_O_LANG=en_US.UTF-8,PBS_O_SUBMIT_FILTER=/usr/local/sbin/torque_submitfilter,PBS_O_WORKDIR=/nfs/17/jnicklas/ttt,PBS_O_HOST=oakley01.osc.edu,PBS_O_SERVER=oak-batch.osc.edu
+    :euser: jnicklas
+    :egroup: appl
+    :queue_type: E
+    :etime: '1443626884'
+    :submit_args: -l nodes=1:ppn=12 -l walltime=03:00:00 -N TestJob
+    :start_time: '1443626959'
+    :Walltime:
+      :Remaining: '10756'
+    :start_count: '1'
+    :fault_tolerant: 'False'
+    :job_radix: '0'
+    :submit_host: oakley01.osc.edu

data/test/files/osc_oakley_job_4691490.oak-batch.osc.edu.yml

@@ -0,0 +1,47 @@
+---
+- :name: 4691489.oak-batch.osc.edu
+  :attribs:
+    :Job_Name: TestJob
+    :Job_Owner: jnicklas@oakley01.osc.edu
+    :resources_used:
+      :cput: '00:00:00'
+      :energy_used: '0'
+      :mem: 2208kb
+      :vmem: 211332kb
+      :walltime: '00:00:14'
+    :job_state: R
+    :queue: serial
+    :server: oak-batch.osc.edu:15001
+    :Checkpoint: u
+    :ctime: '1443626884'
+    :Error_Path: oakley01.osc.edu:/nfs/17/jnicklas/ttt/TestJob.e4845720
+    :exec_host: n0675/0-11
+    :exec_port: '15003'
+    :Hold_Types: n
+    :Join_Path: n
+    :Keep_Files: n
+    :Mail_Points: a
+    :mtime: '1443626959'
+    :Output_Path: oakley01.osc.edu:/nfs/17/jnicklas/ttt/TestJob.o4845720
+    :Priority: '0'
+    :qtime: '1443626884'
+    :Rerunable: 'True'
+    :Resource_List:
+      :gattr: fs17
+      :nodect: '1'
+      :nodes: 1:ppn=12
+      :walltime: '03:00:00'
+    :session_id: '22136'
+    :Variable_List: PBS_O_QUEUE=batch,PBS_O_HOME=/nfs/17/jnicklas,PBS_O_LOGNAME=jnicklas,PBS_O_PATH=/nfs/gpfs/PZS0645/local-oakley/tree/1.7.0/bin:/nfs/gpfs/PZS0645/local-oakley/git/2.3.6/bin:/nfs/gpfs/PZS0645/local-oakley/vim/7.4/bin:/nfs/17/jnicklas/bin:/usr/lib64/qt-3.3/bin:/usr/local/mvapich2/intel/15/2.1/bin:/usr/local/intel/vtune_amplifier_xe_2015.3.0.403110/bin64:/usr/local/intel/inspector_xe_2015.1.2.379161/bin64:/usr/local/intel/composer_xe_2015.3.187/bin/intel64:/usr/local/moab/8.1.1.2-2015080516-eb28ad0-el6/bin:/usr/local/torque/5.1.1-1_fba25d92/bin:/usr/local/bin:/bin:/usr/bin:/usr/local/sbin:/usr/sbin:/sbin,PBS_O_MAIL=/var/spool/mail/jnicklas,PBS_O_SHELL=/bin/bash,PBS_O_LANG=en_US.UTF-8,PBS_O_SUBMIT_FILTER=/usr/local/sbin/torque_submitfilter,PBS_O_WORKDIR=/nfs/17/jnicklas/ttt,PBS_O_HOST=oakley01.osc.edu,PBS_O_SERVER=oak-batch.osc.edu
+    :euser: jnicklas
+    :egroup: appl
+    :queue_type: E
+    :etime: '1443626884'
+    :submit_args: -l nodes=1:ppn=12 -l walltime=03:00:00 -N TestJob
+    :start_time: '1443626959'
+    :Walltime:
+      :Remaining: '10756'
+    :start_count: '1'
+    :fault_tolerant: 'False'
+    :job_radix: '0'
+    :submit_host: oakley01.osc.edu