add test enforcing adapter interface

lib/ood_core/job/adapter.rb

@@ -52,8 +52,15 @@ def cluster_info
       #
       #   For certain adapters this may speed up the response since
       #   adapters can get by without populating the entire Info object
+      #
+      # @param host [#to_s, nil] defaults to nil (and all hosts are queried)
+      #   Restricts the listing to the specified host. Only meaningful for adapters
+      #   that manage jobs across multiple hosts, like LinuxHost or Systemd. Adapters
+      #   that talk to a single scheduler will accept and ignore it. Adapters
+      #   that honor it will raise unless the specified host is included in
+      #   the ssh_hosts adapter configuration.
       # @return [Array<Info>] information describing submitted jobs
-      def info_all(attrs: nil)
+      def info_all(attrs: nil, host: nil)
         raise NotImplementedError, "subclass did not define #info_all"
       end
 

lib/ood_core/job/adapters/ccq.rb

@@ -72,7 +72,7 @@ def submit(script, after: [], afterok: [], afternotok: [], afterany: [])
 
         # Retrieve info for all jobs from the resource manager
         # @return [Array<Info>] information describing submitted jobs
-        def info_all(attrs: nil)
+        def info_all(attrs: nil, host: nil)
           args = []
           args.concat ["-s", scheduler] unless scheduler.nil?
 
@@ -104,24 +104,6 @@ def status(id)
           info(id).status
         end
 
-        # This adapter does not implement hold and will always raise
-        #   an exception.
-        # @param id [#to_s] the id of the job
-        # @raise [JobAdapterError] always
-        # @return [void]
-        def hold(_)
-          raise NotImplementedError, "subclass did not define #hold"
-        end
-
-        # This adapter does not implement release and will always raise
-        #   an exception.
-        # @param id [#to_s] the id of the job
-        # @raise [JobAdapterError] always
-        # @return [void]
-        def release(_)
-          raise NotImplementedError, "subclass did not define #release"
-        end
-
         # Delete the submitted job
         # @param id [#to_s] the id of the job
         # @return [void]

lib/ood_core/job/adapters/coder.rb

@@ -89,7 +89,7 @@ def submit(script, after: [], afterok: [], afternotok: [], afterany: [])
         #   For certain adapters this may speed up the response since
         #   adapters can get by without populating the entire Info object
         # @return [Array<Info>] information describing submitted jobs
-        def info_all(attrs: nil)
+        def info_all(attrs: nil, host: nil)
           []
         end
 

lib/ood_core/job/adapters/fujitsu_tcs.rb

@@ -273,7 +273,7 @@ def submit(script, after: [], afterok: [], afternotok: [], afterany: [])
         # @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)
+        def info_all(attrs: nil, host: nil)
           @fujitsu_tcs.get_jobs().map do |v|
             parse_job_info(v)
           end

lib/ood_core/job/adapters/htcondor.rb

@@ -314,7 +314,7 @@ def initialize(opts = {})
                 # @raise [JobAdapterError] if something goes wrong submitting a job
                 # @return [String] the job id returned after successfully submitting a
                 #   job
-                def submit(script)
+                def submit(script, after: [], afterok: [], afternotok: [], afterany: [])
                     validate_native(script, Hash)
                     args = []
                     args.concat ["-batch-name", "#{script.job_name}"] unless script.job_name.nil?
@@ -432,7 +432,7 @@ def info(id)
                 # Retrieve information for all jobs
                 # @raise [JobAdapterError] if something goes wrong retrieving job info
                 # @return [Array<Info>] list of information describing submitted jobs
-                def info_all(attrs: nil)
+                def info_all(attrs: nil, host: nil)
                     jobs = @htcondor.get_jobs
                     jobs.map { |job| parse_job_info(job) }
                 rescue Batch::Error => e

lib/ood_core/job/adapters/kubernetes.rb

@@ -72,7 +72,7 @@ def submit(script, after: [], afterok: [], afternotok: [], afterany: [])
         #   For certain adapters this may speed up the response since
         #   adapters can get by without populating the entire Info object
         # @return [Array<Info>] information describing submitted jobs
-        def info_all(attrs: nil)
+        def info_all(attrs: nil, host: nil)
           batch.info_all(attrs: attrs)
         rescue Batch::Error => e
           raise JobAdapterError, e.message

lib/ood_core/job/adapters/linux_host.rb

@@ -107,7 +107,7 @@ def info_all(attrs: nil, host: nil)
         # @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)
+        def info_where_owner(owner, attrs: nil)
           info_all
         end
 

lib/ood_core/job/adapters/lsf.rb

@@ -104,7 +104,7 @@ def info(id)
         # @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)
+        def info_all(attrs: nil, host: nil)
           batch.get_jobs.map { |v| info_for_batch_hash(v) }
         rescue Batch::Error => e
           raise JobAdapterError, e.message

lib/ood_core/job/adapters/pbspro.rb

@@ -360,7 +360,7 @@ def cluster_info
         # @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)
+        def info_all(attrs: nil, host: nil)
           @pbspro.get_jobs.map do |v|
             parse_job_info(v)
           end

lib/ood_core/job/adapters/psij.rb

@@ -345,7 +345,7 @@ def info(id)
           end
         end
 
-        def info_all(attrs: nil)
+        def info_all(attrs: nil, host: nil)
           @psij.get_jobs.map do |v|
             parse_job_info(v)
           end

lib/ood_core/job/adapters/sge.rb

@@ -93,7 +93,7 @@ def submit(script, after: [], afterok: [], afternotok: [], afterany: [])
 
         # Retrieve info for all jobs from the resource manager
         # @return [Array<Info>] information describing submitted jobs
-        def info_all(attrs: nil)
+        def info_all(attrs: nil, host: nil)
           @batch.get_all(owner: '*')
         rescue Batch::Error => e
           raise JobAdapterError, e.message

lib/ood_core/job/adapters/slurm.rb

@@ -755,7 +755,7 @@ def accounts
         # @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)
+        def info_all(attrs: nil, host: nil)
           @slurm.get_jobs(attrs: attrs).map do |v|
             parse_job_info(v)
           end

lib/ood_core/job/adapters/systemd.rb

@@ -95,7 +95,7 @@ def info_all(attrs: nil, host: nil)
         # @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)
+        def info_where_owner(owner, attrs: nil)
           info_all
         end
 

lib/ood_core/job/adapters/torque.rb

@@ -187,7 +187,7 @@ def submit(script, after: [], afterok: [], afternotok: [], afterany: [])
         # @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)
+        def info_all(attrs: nil, host: nil)
           @pbs.get_jobs.map do |k, v|
             parse_job_info(k, v)
           end

test/job/adapter_test.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+require 'ood_core/job/adapter.rb'
+
+ADAPTER_FILES = Dir[File.join('ood_core', 'job', 'adapters', '*.rb')]
+ADAPTER_FILES.each { |file| require file }
+
+class AdapterTest < Minitest::Test
+  BASE = OodCore::Job::Adapter
+
+  # Every concrete class descending from the base adapter 
+  def adapters
+    ObjectSpace.each_object(Class).select { |klass| klass < BASE }
+  end
+
+  # Public methods defined by the base class itself (not inherited from Object)
+  def base_methods
+    BASE.public_instance_methods(false)
+  end
+
+  def test_adapters_were_found
+    refute_empty adapters, 'No subclasses of OodCore::Job::Adapter were found'
+  end
+
+  def test_adapter_interfaces_match_base_class
+    adapters.each do |adapter|
+      base_methods.each do |name|
+        impl = adapter.instance_method(name)
+
+        # If the method is not overridden, the base class method runs
+        next if impl.owner == BASE
+
+        # If it is overridden, the signature must match the base exactly
+        expected = BASE.instance_method(name).parameters
+        actual   = impl.parameters
+
+        assert_equal expected, actual,
+          "#{adapter}##{name} (defined in #{impl.owner}) has parameters " \
+          "#{actual.inspect}, but #{BASE}##{name} defines #{expected.inspect}"
+      end
+    end
+  end
+end