Disable workflows when scheduler doesn’t support them (#5395)

Author: bstepanovski

apps/dashboard/app/controllers/application_controller.rb

@@ -9,6 +9,12 @@ class ApplicationController < ActionController::Base
   before_action :set_featured_group, :set_custom_navigation
   before_action :check_required_announcements
 
+  helper_method :workflows_supported?
+
+  def workflows_supported?
+    @workflows_supported ||= Workflow.supported?
+  end
+  
   def check_required_announcements
     return if instance_of?(SettingsController)
 

apps/dashboard/app/controllers/projects_controller.rb

@@ -15,7 +15,7 @@ def show
       end
     else
       @launchers = Launcher.all(@project.directory)
-      @workflows = Workflow.all(@project.directory)
+      @workflows = workflows_supported? ? Workflow.all(@project.directory) : []
       @valid_project = Launcher.clusters?
       @valid_scripts = Launcher.scripts?(@project.directory)
 

apps/dashboard/app/controllers/workflows_controller.rb

@@ -4,6 +4,8 @@
 class WorkflowsController < ApplicationController
   wrap_parameters false
 
+  before_action :ensure_workflows_supported!
+
   # GET /projects/:id/workflows/:id
   def show
     return unless load_project_and_workflow_objects
@@ -120,6 +122,17 @@ def submit
 
   private
 
+  def ensure_workflows_supported!
+    return if workflows_supported?
+
+    message = I18n.t('dashboard.jobs_workflows_not_supported')
+
+    respond_to do |format|
+      format.html { redirect_to(project_path(params[:project_id]), alert: message) }
+      format.json { render json: { message: message }, status: :not_implemented }
+    end
+  end
+
   def load_project_and_workflow_objects(render_json: false)
     @project = Project.find(project_id)
     @workflow = Workflow.find(workflow_id, project_directory)

apps/dashboard/app/models/launcher.rb

@@ -55,6 +55,10 @@ def scripts?(project_dir)
       script_attribute = SmartAttributes::AttributeFactory.build('auto_scripts', { directory: project_dir })
       script_attribute.select_choices(hide_excludable: false).any?
     end
+
+    def workflows_supported?
+      Workflow.supported?
+    end
   end
 
   ID_REX = /\A\w{8}\Z/.freeze

apps/dashboard/app/models/workflow.rb

@@ -5,6 +5,45 @@ class Workflow
   include ProjectPermissions
 
   class << self
+    def supported?
+      dependency_keys = %i[after afterok afternotok afterany].freeze
+
+      clusters_obj = OodAppkit.clusters
+      clusters =
+        if clusters_obj.respond_to?(:values)
+          Array(clusters_obj.values)
+        elsif clusters_obj.respond_to?(:to_a)
+          Array(clusters_obj.to_a)
+        elsif clusters_obj.respond_to?(:each)
+          clusters_obj.each.to_a
+        else
+          []
+        end.compact
+      return false if clusters.empty?
+
+      clusters.any? do |cluster|
+        job_adapter =
+          begin
+            cluster.respond_to?(:job_adapter) ? cluster.job_adapter : nil
+          rescue OodCore::AdapterNotSpecified => e
+            Rails.logger.debug("Workflow.supported?: adapter not specified for cluster: #{e.message}")
+            nil
+          end
+        next false if job_adapter.nil?
+
+        method = job_adapter.method(:submit)
+        params = method.parameters
+
+        next true if params.any? { |type, _name| type == :keyrest }
+
+        accepted_keys = params.select { |type, _name| type == :key || type == :keyreq }.map { |_type, name| name }.compact.map(&:to_sym)
+
+        (dependency_keys - accepted_keys).empty?
+      rescue NameError, NoMethodError
+        false
+      end
+    end
+
     def workflow_dir(project_dir)
       Pathname.new("#{project_dir}/.ondemand/workflows")
     end

apps/dashboard/app/views/projects/show.html.erb

@@ -52,7 +52,9 @@
         <%= t('dashboard.jobs_new_launcher') %>
       </a>
     </div>
-    <%= render partial: 'workflows/workflow', locals: { project: @project, workflows: @workflows } %>
+    <% if workflows_supported? %>
+      <%= render partial: 'workflows/workflow', locals: { project: @project, workflows: @workflows } %>
+    <% end %>
   </div>
 
   <div id="project_jobs_files_col" class="row col-sm-8 col-lg-10 d-flex">

apps/dashboard/config/locales/en.yml

@@ -9,6 +9,7 @@ en:
         used: "%{attribute} is already used"
   dashboard:
     active_jobs_close_details: "Close extended details panel."
+    jobs_workflows_not_supported: "Workflows are not supported by the configured scheduler."
     active_sessions_caption_html: <a href="%{all_sessions_url}"> view all (%{number_of_sessions})</a>
     active_sessions_title: Active interactive sessions
     add: Add

apps/dashboard/test/models/launcher_test.rb

@@ -157,4 +157,31 @@ def setup
       refute(Dir.exist?(Launcher.launchers_dir(tmp).to_s))
     end
   end
+
+  class PositionalHashSubmitAdapter
+    def submit(_script, _opts = {}); end
+  end
+
+  class KeywordSubmitAdapter
+    def submit(_script, after: [], afterok: [], afternotok: [], afterany: []); end
+  end
+
+  class KeyrestSubmitAdapter
+    def submit(_script, **_kwargs); end
+  end
+
+  test 'workflows_supported? returns false when submit does not accept keywords' do
+    OodAppkit.stubs(:clusters).returns({ test: OpenStruct.new(job_adapter: PositionalHashSubmitAdapter.new) })
+    assert_equal false, Launcher.workflows_supported?
+  end
+
+  test 'workflows_supported? returns true when submit accepts dependency keywords' do
+    OodAppkit.stubs(:clusters).returns({ test: OpenStruct.new(job_adapter: KeywordSubmitAdapter.new) })
+    assert_equal true, Launcher.workflows_supported?
+  end
+
+  test 'workflows_supported? returns true when submit accepts arbitrary keywords' do
+    OodAppkit.stubs(:clusters).returns({ test: OpenStruct.new(job_adapter: KeyrestSubmitAdapter.new) })
+    assert_equal true, Launcher.workflows_supported?
+  end
 end

apps/dashboard/test/system/project_manager_test.rb

@@ -1109,6 +1109,25 @@ def check_directory_breakpoints
     end
   end
 
+  test 'workflows are hidden and disabled when unsupported' do
+    Workflow.singleton_class.alias_method(:_supported_orig_for_test, :supported?)
+    Workflow.define_singleton_method(:supported?) { false }
+
+    Dir.mktmpdir do |dir|
+      project_id = setup_project(dir)
+
+      visit project_path(project_id)
+      assert_no_text(I18n.t('dashboard.jobs_workflows'))
+
+      visit new_project_workflow_path(project_id)
+      assert_current_path(project_path(project_id))
+      assert_selector('.alert-danger', text: I18n.t('dashboard.jobs_workflows_not_supported'))
+    end
+  ensure
+    Workflow.singleton_class.alias_method(:supported?, :_supported_orig_for_test)
+    Workflow.singleton_class.remove_method(:_supported_orig_for_test)
+  end
+
   # this test:
   # creates a project & launcher with auto_accounts
   # excludes some of the accounts from auto_accounts in launcher#edit