ood_core 0.9.3 → 0.11.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 40ab5af1e1955af503e10a47b233d7b846ed5f16
-  data.tar.gz: 85c9e94a1d4a16b1d444ac02230fba8a8a7f5df9
+SHA256:
+  metadata.gz: 4f452bc936a1246bb7ac53d3aeafe36c7f54ad23a2d754d916b5701c40343288
+  data.tar.gz: f30a99239692b568b30453a0c519cbf8adb977589c4dfa35132bd4a0f6019c17
 SHA512:
-  metadata.gz: 4d617a6ab11b960e3a74d773084a7f8125601e1e27f7cca1b3ffe658abded249718481905282100a569f138eab07310171469c9135c7d82cbc91c9f7d2b99a85
-  data.tar.gz: 03f198b479fdbd06c1fe14d224db3400fce531c6d68abe7c3bdfc0fef4684d550aea054d713860a6831e92b46e3e35600193c6b186f5aa7681740618042e502a
+  metadata.gz: eb1d20267c147d723bfdafb1d169d6f7efc8323f66a749959672f5df23dc74d8503453f5a9214bf7bf35e5db74156ac3e48cdf18b19fa256d8a53fd331df5491
+  data.tar.gz: 1672bfd5d571492d9c5d6e97e1b2f3eeeeb26bd5580bca6e12b5e6282f05be9300b5b58aecb7ec20ecf8b9513983e1df5d78968bc6a23bacfc38262ffb1e1110

data/.travis.yml

@@ -1,8 +1,8 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.1
-before_install: gem install bundler -v 1.7.8
+  - 2.5.5
+before_install: gem install bundler -v '~> 1.17'
 notifications:
   email:
     on_success: never

data/CHANGELOG.md

@@ -6,6 +6,50 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+## [0.11.4] - 2020-05-27
+### Fixed
+- Environment exports in SLURM while implementing [#158](https://github.com/OSC/ood_core/issues/158)
+  and [#109](https://github.com/OSC/ood_core/issues/109) in [#163](https://github.com/OSC/ood_core/pull/163)
+
+## [0.11.3] - 2020-05-11
+### Fixed
+- LinuxhHost Adapter to work with any login shell ([#188](https://github.com/OSC/ood_core/pull/188))
+- LinuxhHost Adapter needs to display long lines in pstree to successfully parse
+  output ([#188](https://github.com/OSC/ood_core/pull/188))
+
+## [0.11.2] - 2020-04-23
+### Fixed
+- fix signature of `LinuxHost#info_where_owner`
+
+## [0.11.1] - 2020-03-18
+### Changed
+- Only the version changed. Had to republish to rubygems.org
+
+## [0.11.0] - 2020-03-18
+### Added
+- Added directive prefixes to each adapter (e.g. `#QSUB`) ([#161](https://github.com/OSC/ood_core/issues/161))
+- LHA supports `submit_host` field in native ([#164](https://github.com/OSC/ood_core/issues/164))
+- Cluster files can be yaml or yml extensions ([#171](https://github.com/OSC/ood_core/issues/171))
+- Users can add a flag `OOD_JOB_NAME_ILLEGAL_CHARS` to sanitize job names ([#183](https://github.com/OSC/ood_core/issues/183)
+
+### Changed
+- Simplified job array parsing ([#144](https://github.com/OSC/ood_core/issues/144))
+
+### Fixed
+- Issue where environment variables were not properly exported to the job ([#158](https://github.com/OSC/ood_core/issues/158))
+- Parsing bad cluster files ([#150](https://github.com/OSC/ood_core/issues/150) and [#178](https://github.com/OSC/ood_core/issues/178))
+- netcat is no longer a hard dependency. Now lsof, python and bash can be used ([153](https://github.com/OSC/ood_core/issues/153))
+- GE crash when nil config file was given ([#175](https://github.com/OSC/ood_core/issues/175))
+- GE sometimes reported incorrect core count ([#168](https://github.com/OSC/ood_core/issues/168))
+
+
+## [0.10.0] - 2019-11-05
+### Added
+- Added an adapter for submitting work on Linux hosted systems without using a scheduler
+
+### Fixed
+- Fixed bug where an unreadable cluster config would cause crashes
+
 ## [0.9.3] - 2019-05-08
 ### Fixed
 - Fixed bug relating to cluster comparison
@@ -27,7 +71,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Grid Engine adapter now starts scripts in the current directory like all other adapters
 - Fixed issue where Slurm comment field might break job info parsing
 - Fixed possible crash when comparing two clusters if the id of one of the clusters is nil
-- Fixed bug with the live system test that impacted non-Torque systems
+- Fixed bug with the live system test that impacted non-LSF systems
 - Fixed bug with Slurm adapter when submit time is not available
 
 ## [0.8.0] - 2019-01-29
@@ -189,7 +233,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 - Initial release!
 
-[Unreleased]: https://github.com/OSC/ood_core/compare/v0.9.3...HEAD
+[Unreleased]: https://github.com/OSC/ood_core/compare/v0.11.4...HEAD
+[0.11.4]: https://github.com/OSC/ood_core/compare/v0.11.3...v0.11.4
+[0.11.3]: https://github.com/OSC/ood_core/compare/v0.11.2...v0.11.3
+[0.11.2]: https://github.com/OSC/ood_core/compare/v0.11.1...v0.11.2
+[0.11.1]: https://github.com/OSC/ood_core/compare/v0.11.0...v0.11.1
+[0.11.0]: https://github.com/OSC/ood_core/compare/v0.10.0...v0.11.0
+[0.10.0]: https://github.com/OSC/ood_core/compare/v0.9.3...v0.10.0
 [0.9.3]: https://github.com/OSC/ood_core/compare/v0.9.2...v0.9.3
 [0.9.2]: https://github.com/OSC/ood_core/compare/v0.9.1...v0.9.2
 [0.9.1]: https://github.com/OSC/ood_core/compare/v0.9.0...v0.9.1

data/lib/ood_core.rb

@@ -2,6 +2,7 @@ require "ood_core/version"
 require "ood_core/errors"
 require "ood_core/cluster"
 require "ood_core/clusters"
+require "ood_core/invalid_cluster"
 
 # The main namespace for ood_core
 module OodCore

data/lib/ood_core/batch_connect/template.rb

@@ -117,11 +117,47 @@ module OodCore
                 }
                 export -f random_number
 
+                port_used_python() {
+                  python -c "import socket; socket.socket().connect(('$1',$2))" >/dev/null 2>&1
+                }
+
+                port_used_python3() {
+                  python3 -c "import socket; socket.socket().connect(('$1',$2))" >/dev/null 2>&1
+                }
+
+                port_used_nc(){
+                  nc -w 2 "$1" "$2" < /dev/null > /dev/null 2>&1
+                }
+
+                port_used_lsof(){
+                  lsof -i :"$2" >/dev/null 2>&1
+                }
+
+                port_used_bash(){
+                  local bash_supported=$(strings /bin/bash 2>/dev/null | grep tcp)
+                  if [ "$bash_supported" == "/dev/tcp/*/*" ]; then
+                    (: < /dev/tcp/$1/$2) >/dev/null 2>&1
+                  else
+                    return 127
+                  fi
+                }
+
                 # Check if port $1 is in use
                 port_used () {
                   local port="${1#*:}"
                   local host=$((expr "${1}" : '\\(.*\\):' || echo "localhost") | awk 'END{print $NF}')
-                  nc -w 2 "${host}" "${port}" < /dev/null &> /dev/null
+                  local port_strategies=(port_used_nc port_used_lsof port_used_bash port_used_python port_used_python3)
+
+                  for strategy in ${port_strategies[@]};
+                  do
+                    $strategy $host $port
+                    status=$?
+                    if [[ "$status" == "0" ]] || [[ "$status" == "1" ]]; then
+                      return $status
+                    fi
+                  done
+
+                  return 127
                 }
                 export -f port_used
 
@@ -143,8 +179,14 @@ module OodCore
                   local port="${1}"
                   local time="${2:-30}"
                   for ((i=1; i<=time*2; i++)); do
-                    if port_used "${port}"; then
+                    port_used "${port}"
+                    port_status=$?
+                    if [ "$port_status" == "0" ]; then
                       return 0
+                    elif [ "$port_status" == "127" ]; then
+                       echo "commands to find port were either not found or inaccessible."
+                       echo "command options are lsof, nc, bash's /dev/tcp, or python (or python3) with socket lib."
+                       return 127
                     fi
                     sleep 0.5
                   done

data/lib/ood_core/cluster.rb

@@ -28,6 +28,10 @@ module OodCore
     # @return [Hash] the acls configuration
     attr_reader :acls_config
 
+    # The errors encountered with configuring this cluster
+    # @return Array<String> the errors
+    attr_reader :errors
+
     # @param cluster [#to_h] the cluster object
     # @option cluster [#to_sym] :id The cluster id
     # @option cluster [#to_h] :metadata ({}) The cluster's metadata
@@ -39,6 +43,8 @@ module OodCore
     #   against
     # @option cluster [#to_h] :batch_connect ({}) Configuration for batch
     #   connect templates
+    # @option cluster [#to_a] :errors ([]) List of configuration errors
+    #
     def initialize(cluster)
       c = cluster.to_h.symbolize_keys
 
@@ -52,6 +58,9 @@ module OodCore
       @custom_config   = c.fetch(:custom, {})  .to_h.symbolize_keys
       @acls_config     = c.fetch(:acls, [])    .map(&:to_h)
       @batch_connect_config = c.fetch(:batch_connect, {}).to_h.symbolize_keys
+
+      # side affects from object creation and validation
+      @errors          = c.fetch(:errors, [])  .to_a
     end
 
     # Metadata that provides extra information about this cluster
@@ -159,6 +168,12 @@ module OodCore
       }
     end
 
+    # This cluster is always valid
+    # @return true
+    def valid?
+      return true
+    end
+
     private
       # Build acl adapter objects from array
       def build_acls(ary)

data/lib/ood_core/clusters.rb

@@ -19,20 +19,32 @@ module OodCore
 
         clusters = []
         if config.file?
-          CONFIG_VERSION.any? do |version|
-            YAML.safe_load(config.read).fetch(version, {}).each do |k, v|
-              clusters << Cluster.new(send("parse_#{version}", id: k, cluster: v))
+          if config.readable?
+            CONFIG_VERSION.any? do |version|
+              begin
+                YAML.safe_load(config.read)&.fetch(version, {}).each do |k, v|
+                  clusters << Cluster.new(send("parse_#{version}", id: k, cluster: v))
+                end
+              rescue Psych::SyntaxError => e
+                clusters << InvalidCluster.new(
+                  id: config.basename(config.extname).to_s,
+                  errors: [ e.message.to_s ]
+                )
+              end
             end
-            !clusters.empty?
           end
         elsif config.directory?
-          Pathname.glob(config.join("*.yml")).each do |p|
+          Pathname.glob([config.join("*.yml"), config.join("*.yaml")]).select(&:file?).select(&:readable?).each do |p|
             CONFIG_VERSION.any? do |version|
-              if cluster = YAML.safe_load(p.read).fetch(version, nil)
-                clusters << Cluster.new(send("parse_#{version}", id: p.basename(".yml").to_s, cluster: cluster))
-                true
-              else
-                false
+              begin
+                if cluster = YAML.safe_load(p.read)&.fetch(version, nil)
+                  clusters << Cluster.new(send("parse_#{version}", id: p.basename(p.extname()).to_s, cluster: cluster))
+                end
+              rescue Psych::SyntaxError => e
+                clusters << InvalidCluster.new(
+                  id: p.basename(p.extname).to_s,
+                  errors: [ e.message.to_s ]
+                )
               end
             end
           end

data/lib/ood_core/invalid_cluster.rb

@@ -0,0 +1,37 @@
+module OodCore
+  # A special case of an OodCore::Cluster where something went awry in the
+  # creation and it's invalid for some reason.  Users should only be able
+  # to rely on id and metadata.error_msg. All *allow? related functions
+  # false, meaning nothing is allowed.
+  class InvalidCluster < Cluster
+    # Jobs are not allowed
+    # @return false
+    def login_allow?
+      false
+    end
+
+    # Jobs are not allowed
+    # @return false
+    def job_allow?
+      false
+    end
+
+    # Custom features are not allowed
+    # @return false
+    def custom_allow?(_)
+      false
+    end
+
+    # This cluster is not allowed to be used
+    # @return false
+    def allow?
+      false
+    end
+
+    # This cluster is never valid
+    # @return false
+    def valid?
+      return false
+    end
+  end
+end

data/lib/ood_core/job/adapter.rb

@@ -36,7 +36,7 @@ module OodCore
       # Retrieve info for all jobs from the resource manager
       # @abstract Subclass is expected to implement {#info_all}
       # @raise [NotImplementedError] if subclass did not define {#info_all}
-      # @param attrs [Array<symbol>] defaults to nil (and all attrs are provided) 
+      # @param attrs [Array<symbol>] defaults to nil (and all attrs are provided)
       #   This array specifies only attrs you want, in addition to id and status.
       #   If an array, the Info object that is returned to you is not guarenteed
       #   to have a value for any attr besides the ones specified and id and status.
@@ -51,7 +51,7 @@ module OodCore
       # Retrieve info for all jobs for a given owner or owners from the
       # resource manager
       # @param owner [#to_s, Array<#to_s>] the owner(s) of the jobs
-      # @param attrs [Array<symbol>] defaults to nil (and all attrs are provided) 
+      # @param attrs [Array<symbol>] defaults to nil (and all attrs are provided)
       #   This array specifies only attrs you want, in addition to id and status.
       #   If an array, the Info object that is returned to you is not guarenteed
       #   to have a value for any attr besides the ones specified and id and status.
@@ -69,7 +69,7 @@ module OodCore
       end
 
       # Iterate over each job Info object
-      # @param attrs [Array<symbol>] defaults to nil (and all attrs are provided) 
+      # @param attrs [Array<symbol>] defaults to nil (and all attrs are provided)
       #   This array specifies only attrs you want, in addition to id and status.
       #   If an array, the Info object that is returned to you is not guarenteed
       #   to have a value for any attr besides the ones specified and id and status.
@@ -88,7 +88,7 @@ module OodCore
 
       # Iterate over each job Info object
       # @param owner [#to_s, Array<#to_s>] the owner(s) of the jobs
-      # @param attrs [Array<symbol>] defaults to nil (and all attrs are provided) 
+      # @param attrs [Array<symbol>] defaults to nil (and all attrs are provided)
       #   This array specifies only attrs you want, in addition to id and status.
       #   If an array, the Info object that is returned to you is not guarenteed
       #   to have a value for any attr besides the ones specified and id and status.
@@ -157,6 +157,37 @@ module OodCore
       def delete(id)
         raise NotImplementedError, "subclass did not define #delete"
       end
+
+      # Return the scheduler-specific directive prefix
+      #
+      # Examples of directive prefixes include #QSUB, #BSUB and allow placing what would
+      # otherwise be command line options inside the job launch script.
+      #
+      # The method should return nil if the adapter does not support prefixes
+      #
+      # @abstract Subclass is expected to implement {#directive_prefix}
+      # @raise [NotImplementedError] if subclass did not defined {#directive_prefix}
+      # @return [String]
+      def directive_prefix
+        raise NotImplementedError, "subclass did not define #directive_prefix"
+      end
+
+      # Replace illegal chars in job name with a dash
+      #
+      # @return [String] job name with dashes replacing illegal chars
+      def sanitize_job_name(job_name)
+        # escape ^ and omit -
+        chars = job_name_illegal_chars.to_s.gsub("^", "\\^").gsub("-", "")
+        job_name.tr(chars, "-")
+      end
+
+      # Illegal chars that should not be used in a job name
+      # A dash is assumed to be legal in job names in all batch schedulers
+      #
+      # @return [String] string of chars
+      def job_name_illegal_chars
+        ENV["OOD_JOB_NAME_ILLEGAL_CHARS"].to_s
+      end
     end
   end
 end

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

@@ -13,7 +13,7 @@
 #  The contents of this file are subject to the Sun Industry Standards
 #  Source License Version 1.2 (the "License"); You may not use this file
 #  except in compliance with the License. You may obtain a copy of the
-#  License at http://gridengine.sunsource.net/Gridengine_SISSL_license.html
+#  License at http://gridscheduler.sourceforge.net/Gridengine_SISSL_license.html
 #
 #  Software provided under this License is provided on an "AS IS" basis,
 #  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,

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

@@ -0,0 +1,245 @@
+require "ood_core/refinements/hash_extensions"
+require "ood_core/refinements/array_extensions"
+require "ood_core/job/adapters/helper"
+require "set"
+
+module OodCore
+  module Job
+    class Factory
+      using Refinements::HashExtensions
+
+      # Build the LinuxHost adapter from a configuration
+      # @param config [#to_h] the configuration for job adapter
+      # @option config [Object] :contain (false) Pass `--contain` flag to Singularity; allows overriding bind mounts in singularity.conf
+      # @option config [Object] :debug (false) Use the adapter in a debug mode
+      # @option config [Object] :max_timeout (nil) The longest 'wall_clock' permissible
+      # @option config [Object] :singularity_bin ('/usr/bin/singularity') The path to the Singularity executable
+      # @option config [Object] :singularity_bindpath ('/etc,/media,/mnt,/opt,/srv,/usr,/var,/users') A comma delimited list of paths to bind between the host and the guest
+      # @option config [Object] :singularity_image The path to the Singularity image to use
+      # @option config [Object] :ssh_hosts (nil) The list of permissable hosts, defaults to :submit_host
+      # @option config [Object] :strict_host_checking (true) Set to false to disable strict host checking and updating the known_hosts file
+      # @option config [Object] :submit_host The SSH target to connect to, may be the head of a round-robin
+      # @option config [Object] :tmux_bin ('/usr/bin/tmux') The path to the Tmux executable
+      def self.build_linux_host(config)
+        c = config.to_h.symbolize_keys
+        contain = c.fetch(:contain, false)
+        debug = c.fetch(:debug, false)
+        max_timeout = c.fetch(:max_timeout, nil)
+        singularity_bin = c.fetch(:singularity_bin, '/usr/bin/singularity')
+        singularity_bindpath = c.fetch(:singularity_bindpath, '/etc,/media,/mnt,/opt,/srv,/usr,/var,/users')
+        singularity_image = c[:singularity_image]
+        ssh_hosts = c.fetch(:ssh_hosts, [c[:submit_host]])
+        strict_host_checking = c.fetch(:strict_host_checking, true)
+        submit_host = c[:submit_host]
+        tmux_bin = c.fetch(:tmux_bin, '/usr/bin/tmux')
+
+        Adapters::LinuxHost.new(
+          ssh_hosts: ssh_hosts,
+          launcher: Adapters::LinuxHost::Launcher.new(
+            contain: contain,
+            debug: debug,
+            max_timeout: max_timeout,
+            singularity_bin: singularity_bin,
+            singularity_bindpath: singularity_bindpath,  # '/etc,/media,/mnt,/opt,/srv,/usr,/var,/users',
+            singularity_image: singularity_image,
+            ssh_hosts: ssh_hosts,
+            strict_host_checking: strict_host_checking,
+            submit_host: submit_host,
+            tmux_bin: tmux_bin,
+          )
+        )
+      end
+    end
+
+    module Adapters
+      # An adapter object that describes the communication with a remote host
+      # for job management.
+      class LinuxHost < Adapter
+        using Refinements::ArrayExtensions
+
+        require "ood_core/job/adapters/linux_host/launcher"
+
+        def initialize(ssh_hosts:, launcher:)
+          @launcher = launcher
+          @ssh_hosts = Set.new(ssh_hosts)
+        end
+
+        # Submit a job with the attributes defined in the job template instance
+        # @param script [Script] script object that describes the script and
+        #   attributes for the submitted job
+        # @param after [#to_s, Array<#to_s>] No scheduling is available is used; setting raises JobAdapterError
+        # @param afterok [#to_s, Array<#to_s>] No scheduling is available is used; setting raises JobAdapterError
+        # @param afternotok [#to_s, Array<#to_s>] No scheduling is available is used; setting raises JobAdapterError
+        # @param afterany [#to_s, Array<#to_s>] No scheduling is available is used; setting raises JobAdapterError
+        # @raise [JobAdapterError] if something goes wrong submitting a job
+        # @return [String] the job id returned after successfully submitting a
+        #   job
+        # @see Adapter#submit
+        def submit(script, after: [], afterok: [], afternotok: [], afterany: [])
+          unless (after.empty? && afterok.empty? && afternotok.empty? && afterany.empty?)
+            raise JobAdapterError, 'Scheduling subsequent jobs is not available.'
+          end
+
+          @launcher.start_remote_session(script)
+        rescue Launcher::Error => e
+          raise JobAdapterError, e.message
+        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
+        # @see Adapter#info_all
+        def info_all(attrs: nil, host: nil)
+          host_permitted?(host) if host
+
+          @launcher.list_remote_sessions(host: host).map{
+            |ls_output| ls_to_info(ls_output)
+          }
+        rescue Launcher::Error => e
+          raise JobAdapterError, e.message
+        end
+
+        # Retrieve info for all jobs for a given owner or owners from the
+        # resource manager
+        # Note: owner and attrs are present only to complete the interface and are ignored
+        # Note: since this API is used in production no errors or warnings are thrown / issued
+        # @param owner [#to_s, Array<#to_s>] the owner(s) of the jobs
+        # @raise [JobAdapterError] if something goes wrong getting job info
+        # @return [Array<Info>] information describing submitted jobs
+        def info_where_owner(_, attrs: nil)
+          info_all
+        end
+
+        # Iterate over each job Info object
+        # @param attrs [Array<symbol>] attrs is present only to complete the interface and is ignored
+        # @yield [Info] of each job to block
+        # @return [Enumerator] if no block given
+        def info_all_each(attrs: nil)
+          return to_enum(:info_all_each, attrs: attrs) unless block_given?
+
+          info_all(attrs: attrs).each do |job|
+            yield job
+          end
+        end
+
+        # Iterate over each job Info object
+        # @param owner [#to_s, Array<#to_s>] owner is present only to complete the interface and is ignored
+        # @param attrs [Array<symbol>] attrs is present only to complete the interface and is ignored
+        # @yield [Info] of each job to block
+        # @return [Enumerator] if no block given
+        def info_where_owner_each(owner, attrs: nil)
+          return to_enum(:info_where_owner_each, owner, attrs: attrs) unless block_given?
+
+          info_where_owner(owner, attrs: attrs).each do |job|
+            yield job
+          end
+        end
+
+        # Whether the adapter supports job arrays
+        # @return [Boolean] - false
+        def supports_job_arrays?
+          false
+        end
+
+        # Retrieve job info from the SSH host
+        # @param id [#to_s] the id of the job
+        # @raise [JobAdapterError] if something goes wrong getting job info
+        # @return [Info] information describing submitted job
+        # @see Adapter#info
+        def info(id)
+          _, host = parse_job_id(id)
+          job = info_all(host: host).select{|info| info.id == id}.first
+          (job) ? job : Info.new(id: id, status: :completed)
+        rescue Launcher::Error => e
+          raise JobAdapterError, e.message
+        end
+
+        # Retrieve job status from resource manager
+        # @note Optimized slightly over retrieving complete job information from server
+        # @abstract Subclass is expected to implement {#status}
+        # @raise [NotImplementedError] if subclass did not define {#status}
+        # @param id [#to_s] the id of the job
+        # @return [Status] status of job
+        def status(id)
+          _, host = parse_job_id(id)
+          job = info_all(host: host).select{|info| info.id == id}.first
+
+          Status.new(state: (job) ? :running : :completed)
+        rescue Launcher::Error => e
+          raise JobAdapterError, e.message
+        end
+
+        # Put the submitted job on hold
+        # @abstract Subclass is expected to implement {#hold}
+        # @raise [NotImplementedError] if subclass did not define {#hold}
+        # @param id [#to_s] the id of the job
+        # @return [void]
+        def hold(id)
+          # Consider sending SIGSTOP?
+          raise NotImplementedError, "subclass did not define #hold"
+        end
+
+        # Release the job that is on hold
+        # @abstract Subclass is expected to implement {#release}
+        # @raise [NotImplementedError] if subclass did not define {#release}
+        # @param id [#to_s] the id of the job
+        # @return [void]
+        def release(id)
+          # Consider sending SIGCONT
+          raise NotImplementedError, "subclass did not define #release"
+        end
+
+        # Delete the submitted job
+        # @abstract Subclass is expected to implement {#delete}
+        # @raise [NotImplementedError] if subclass did not define {#delete}
+        # @param id [#to_s] the id of the job
+        # @return [void]
+        def delete(id)
+          session_name, destination_host = parse_job_id(id)
+          @launcher.stop_remote_session(session_name, destination_host)
+        rescue Launcher::Error => e
+          raise JobAdapterError, e.message
+        end
+
+        def directive_prefix
+          nil
+        end
+
+        private
+
+        def host_permitted?(destination_host)
+          raise JobAdapterError, "Requested destination host (#{destination_host}) not permitted" unless @ssh_hosts.include?(destination_host)
+        end
+
+        def parse_job_id(id)
+          raise JobAdapterError, "#{id} is not a valid LinuxHost adapter id because it is missing the '@'." unless id.include?('@')
+
+          return id.split('@')
+        end
+
+        # Convert the returned Hash into an Info object
+        def ls_to_info(ls_output)
+          started = ls_output[:session_created].to_i
+          now = Time.now.to_i
+          ellapsed = now - started
+          Info.new(
+              accounting_id: nil,
+              allocated_nodes: [NodeInfo.new(name: ls_output[:destination_host], procs: 1)],
+              cpu_time: ellapsed,
+              dispatch_time: started,
+              id: ls_output[:id],
+              job_name: nil,  # TODO
+              job_owner: Etc.getlogin,
+              native: ls_output,
+              procs: 1,
+              queue_name: "LinuxHost adapter for #{@submit_host}",
+              status: :running,
+              submission_time: ellapsed,
+              submit_host: @submit_host,
+              wallclock_time: ellapsed
+          )
+        end
+      end
+    end
+  end
+end