ood_core 0.22.0 → 0.23.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8700bb802df78b66c3bb58ec5464a7f5e54a4dc3ebdc978f9816b8b5e5f7373
-  data.tar.gz: 1e2b4ca05369c8072afe8d1069679a8f2744cdcb3ed766924a778e78af65afa2
+  metadata.gz: bd8cb5dc98cf0b2c2120fdb6234e5482fb40cbec59f6688318e0d33b050d0dc4
+  data.tar.gz: 0fe72b2fe29aa1e4ca2d5e28ca43e8b3f9e0381fe17f4678ea7218a5c062a3e7
 SHA512:
-  metadata.gz: a40fc234d2be728b697b9b68884b2286ac68e63ed36eeaa4a48487af99c262fdc1f9b3010554f9e369555734c6d2c0693ca54bc2308c5817f424ec4032759563
-  data.tar.gz: 5215f5c924002bfdc40576560898cae49b9a9750ff8d11c87d1e43cd43d0e86327a511ee97eea765a20f8ce6d6903acfaece7b26ad8e7733fd1d3f985b8a97e2
+  metadata.gz: 53bd81e896ae96b55e92732b86d9ca364449f8140bedbaba0b6fc9de73d5ffb06e65ea9ba84cc84e621bbf64af5b30a241a803b7fb4944745ebb50cc2a6ba39f
+  data.tar.gz: 9106dbc505aff7040bedeba9c0531cd539dbcd11e3aac54072e7bc01660f8f07147fb19be325631496215b6c1725bb68ca57968b39e377b0567747ef5569563c

data/CHANGELOG.md

@@ -7,6 +7,30 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [0.23.1] - 02-01-2023
+
+### Fixed
+
+- `QueueInfo` objects also upcase accounts when applicable in [792](https://github.com/OSC/ood_core/pull/792).
+
+### Added
+
+- `queue_name` has the alias `queue` in [790](https://github.com/OSC/ood_core/pull/790).
+
+## [0.23.0] - 01-17-2023
+
+### Added
+
+- [787](https://github.com/OSC/ood_core/pull/787) added the `queues` API to the adapter class with
+  support for Slurm.
+- [783](https://github.com/OSC/ood_core/pull/783) added the `accounts` API to the adapter class with
+  support for Slurm.
+
+### Fixed
+
+- The linux host adapter now supports apptainer in [788](https://github.com/OSC/ood_core/pull/788).
+
+
 ## [0.22.0] - 10-31-2022
 
 ### Added
@@ -455,7 +479,9 @@ Functionally the same as [0.17.3] but with some CI updates.
 ### Added
 - Initial release!
 
-[Unreleased]: https://github.com/OSC/ood_core/compare/v0.22.0...HEAD
+[Unreleased]: https://github.com/OSC/ood_core/compare/v0.23.1...HEAD
+[0.23.1]: https://github.com/OSC/ood_core/compare/v0.22.0...v0.23.0
+[0.23.0]: https://github.com/OSC/ood_core/compare/v0.22.0...v0.23.0
 [0.22.0]: https://github.com/OSC/ood_core/compare/v0.21.0...v0.22.0
 [0.21.0]: https://github.com/OSC/ood_core/compare/v0.20.2...v0.21.0
 [0.20.2]: https://github.com/OSC/ood_core/compare/v0.20.1...v0.20.2

data/lib/ood_core/data_formatter.rb

@@ -0,0 +1,14 @@
+module OodCore
+  module DataFormatter
+    # Determine whether to upcase account strings when returning adapter#accounts
+    def upcase_accounts?
+      env_var = ENV['OOD_UPCASE_ACCOUNTS']
+
+      if env_var.nil? || env_var.to_s.downcase == 'false'
+        false
+      else
+        true
+      end
+    end
+  end
+end

data/lib/ood_core/job/account_info.rb

@@ -0,0 +1,38 @@
+module OodCore
+  module Job
+
+    class AccountInfo
+
+      include OodCore::DataFormatter
+
+      # The name of the account.
+      attr_reader :name
+      alias to_s name
+
+      # The QoS values this account can use.
+      attr_reader :qos
+
+      # The cluster this account is associated with.
+      attr_reader :cluster
+
+      # The queue this account can use. nil means there is no queue info
+      # for this account.
+      attr_reader :queue
+
+      def initialize(**opts)
+        orig_name = opts.fetch(:name, 'unknown')
+        @name = upcase_accounts? ? orig_name.upcase : orig_name
+        @qos = opts.fetch(:qos, [])
+        @cluster = opts.fetch(:cluster, nil)
+        @queue = opts.fetch(:queue, nil)
+      end
+
+      def to_h
+        instance_variables.map do |var|
+          name = var.to_s.gsub('@', '').to_sym
+          [name, send(name)]
+        end.to_h
+      end
+    end
+  end
+end

data/lib/ood_core/job/adapter.rb

@@ -197,6 +197,22 @@ module OodCore
       def job_name_illegal_chars
         ENV["OOD_JOB_NAME_ILLEGAL_CHARS"].to_s
       end
+
+      # Retrieve the accounts available to use  for the current user.
+      #
+      # Subclasses that do not implement this will return empty arrays.
+      # @return [Array<AccountInfo>] the accounts available to the user.
+      def accounts
+        []
+      end
+
+      # Return the list of queues for this scheduler.
+      #
+      # Subclasses that do not implement this will return empty arrays.
+      # @return [Array<QueueInfo>]
+      def queues
+        []
+      end
     end
   end
 end

data/lib/ood_core/job/adapters/linux_host/launcher.rb

@@ -73,7 +73,7 @@ class OodCore::Job::Adapters::LinuxHost::Launcher
     # Get the tmux pane PID for the target session
     pane_pid=$(tmux list-panes -aF '\#{session_name} \#{pane_pid}' | grep '#{session_name}' | cut -f 2 -d ' ')
     # Find the Singularity sinit PID child of the pane process
-    pane_sinit_pid=$(pstree -p -l "$pane_pid" | egrep -o 'sinit[(][[:digit:]]*|shim-init[(][[:digit:]]*' | grep -o '[[:digit:]]*') 
+    pane_sinit_pid=$(pstree -p -l "$pane_pid" | egrep -o 'sinit[(][[:digit:]]*|shim-init[(][[:digit:]]|appinit[(][[:digit:]]' | grep -o '[[:digit:]]*')
     # Kill sinit which stops both Singularity-based processes and the tmux session
     kill "$pane_sinit_pid"
     SCRIPT

data/lib/ood_core/job/adapters/slurm.rb

@@ -1,4 +1,5 @@
 require "time"
+require 'etc'
 require "ood_core/refinements/hash_extensions"
 require "ood_core/refinements/array_extensions"
 require "ood_core/job/adapters/helper"
@@ -178,6 +179,27 @@ module OodCore
             return [{ id: id, state: 'undetermined' }]
           end
 
+          def accounts
+            user = Etc.getlogin
+            args = ['-nP', 'show', 'users', 'withassoc', 'format=account,cluster,partition,qos', 'where', "user=#{user}"]
+
+            [].tap do |accts|
+              call('sacctmgr', *args).each_line do |line|
+                acct, cluster, queue, qos = line.split('|')
+                next if acct.nil? || acct.chomp.empty?
+
+                args = {
+                  name: acct,
+                  qos: qos.to_s.chomp.split(','),
+                  cluster: cluster,
+                  queue: queue.to_s.empty? ? nil : queue
+                }
+                info = OodCore::Job::AccountInfo.new(**args) unless acct.nil?
+                accts << info unless acct.nil?
+              end
+            end
+          end
+
           def squeue_fields(attrs)
             if attrs.nil?
               all_squeue_fields
@@ -300,7 +322,37 @@ module OodCore
             }
           end
 
+          def queues
+            info_raw = call('scontrol', 'show', 'part', '-o')
+
+            [].tap do |ret_arr|
+              info_raw.each_line do |line|
+                ret_arr << str_to_acct_info(line)
+              end
+            end
+          end
+
           private
+            def str_to_acct_info(line)
+              hsh = line.split(' ').map do |token|
+                m = token.match(/^(?<key>\w+)=(?<value>.+)$/)
+                [m[:key], m[:value]]
+              end.to_h.symbolize_keys
+
+              hsh[:name] = hsh[:PartitionName]
+              hsh[:qos] =  hsh[:QoS].to_s == 'N/A' ? [] : hsh[:QoS].to_s.split(',')
+              hsh[:allow_accounts] = if hsh[:AllowAccounts].nil? || hsh[:AllowAccounts].to_s == 'ALL'
+                                       nil
+                                     else
+                                       hsh[:AllowAccounts].to_s.split(',')
+                                     end
+
+
+              hsh[:deny_accounts] = hsh[:DenyAccounts].nil? ? [] : hsh[:DenyAccounts].to_s.split(',')
+
+              OodCore::Job::QueueInfo.new(**hsh)
+            end
+
             # Modify the StringIO instance by advancing past the squeue header
             #
             # The first two "records" should always be discarded. Consider the
@@ -325,7 +377,7 @@ module OodCore
               cmd = OodCore::Job::Adapters::Helper.bin_path(cmd, bin, bin_overrides)
 
               args  = args.map(&:to_s)
-              args.concat ["-M", cluster] if cluster
+              args.concat ["-M", cluster] if cluster && cmd != 'sacctmgr'
 
               env = env.to_h
               env["SLURM_CONF"] = conf.to_s if conf
@@ -483,6 +535,13 @@ module OodCore
           @slurm.get_cluster_info
         end
 
+        # Retrieve the accounts available to use  for the current user.
+        #
+        # @return [Array<String>] the accounts available to the user.
+        def accounts
+          @slurm.accounts
+        end
+
         # Retrieve info for all jobs from the resource manager
         # @raise [JobAdapterError] if something goes wrong getting job info
         # @return [Array<Info>] information describing submitted jobs
@@ -605,6 +664,10 @@ module OodCore
           '#SBATCH'
         end
 
+        def queues
+          @slurm.queues
+        end
+
         private
           # Convert duration to seconds
           def duration_in_seconds(time)

data/lib/ood_core/job/queue_info.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# QueueInfo is information about a given queue on a scheduler.
+class OodCore::Job::QueueInfo
+
+  include OodCore::DataFormatter
+
+  # The name of the queue.
+  attr_reader :name
+  alias to_s name
+
+  # The QoSes associated with this queue
+  attr_reader :qos
+
+  # The accounts that are allowed to use this queue.
+  #
+  # nil means ALL accounts are allowed.
+  attr_reader :allow_accounts
+
+  # The accounts that are not allowed to use this queue.
+  attr_reader :deny_accounts
+
+  def initialize(**opts)
+    @name = opts.fetch(:name, 'unknown')
+    @qos = opts.fetch(:qos, [])
+
+    allow_accounts = opts.fetch(:allow_accounts, nil)
+    @allow_accounts = if allow_accounts.nil?
+                        nil
+                      else
+                        allow_accounts.compact.map { |acct| upcase_accounts? ? acct.to_s.upcase : acct }
+                      end
+
+    @deny_accounts = opts.fetch(:deny_accounts, []).compact.map do |acct|
+      upcase_accounts? ? acct.to_s.upcase : acct
+    end
+  end
+
+  def to_h
+    instance_variables.map do |var|
+      name = var.to_s.gsub('@', '').to_sym
+      [name, send(name)]
+    end.to_h
+  end
+end

data/lib/ood_core/job/script.rb

@@ -77,6 +77,7 @@ module OodCore
       # Name of the queue the job should be submitted to
       # @return [String, nil] queue name
       attr_reader :queue_name
+      alias queue queue_name
 
       # The scheduling priority for the job
       # @return [Integer, nil] scheduling priority

data/lib/ood_core/version.rb

@@ -1,4 +1,4 @@
 module OodCore
   # The current version of {OodCore}
-  VERSION = "0.22.0"
+  VERSION = "0.23.1"
 end

data/lib/ood_core.rb

@@ -3,6 +3,7 @@ require "ood_core/errors"
 require "ood_core/cluster"
 require "ood_core/clusters"
 require "ood_core/invalid_cluster"
+require "ood_core/data_formatter"
 
 # The main namespace for ood_core
 module OodCore
@@ -12,6 +13,8 @@ module OodCore
     require "ood_core/job/script"
     require "ood_core/job/info"
     require "ood_core/job/cluster_info"
+    require "ood_core/job/account_info"
+    require "ood_core/job/queue_info"
     require "ood_core/job/status"
     require "ood_core/job/adapter"
     require "ood_core/job/factory"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ood_core
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.23.1
 platform: ruby
 authors:
 - Eric Franz
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-31 00:00:00.000000000 Z
+date: 2023-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ood_support
@@ -176,8 +176,10 @@ files:
 - lib/ood_core/batch_connect/templates/vnc_container.rb
 - lib/ood_core/cluster.rb
 - lib/ood_core/clusters.rb
+- lib/ood_core/data_formatter.rb
 - lib/ood_core/errors.rb
 - lib/ood_core/invalid_cluster.rb
+- lib/ood_core/job/account_info.rb
 - lib/ood_core/job/adapter.rb
 - lib/ood_core/job/adapters/ccq.rb
 - lib/ood_core/job/adapters/drmaa.rb
@@ -217,6 +219,7 @@ files:
 - lib/ood_core/job/factory.rb
 - lib/ood_core/job/info.rb
 - lib/ood_core/job/node_info.rb
+- lib/ood_core/job/queue_info.rb
 - lib/ood_core/job/script.rb
 - lib/ood_core/job/status.rb
 - lib/ood_core/job/task.rb