foreman_remote_execution 4.4.0 → 4.5.0

data/app/models/ssh_execution_provider.rb

@@ -2,10 +2,10 @@ class SSHExecutionProvider < RemoteExecutionProvider
   class << self
     def proxy_command_options(template_invocation, host)
       super.merge(:ssh_user => ssh_user(host),
-                  :effective_user => effective_user(template_invocation),
-                  :effective_user_method => effective_user_method(host),
-                  :cleanup_working_dirs => cleanup_working_dirs?(host),
-                  :ssh_port => ssh_port(host))
+        :effective_user => effective_user(template_invocation),
+        :effective_user_method => effective_user_method(host),
+        :cleanup_working_dirs => cleanup_working_dirs?(host),
+        :ssh_port => ssh_port(host))
     end
 
     def humanized_name

data/app/overrides/execution_interface.rb

@@ -1,9 +1,9 @@
-Deface::Override.new(:virtual_path    => 'hosts/_form',
-                     :name            => 'add_execution_interface_js',
-                     :insert_before   => 'div#primary',
-                     :text            => '<%= javascript "foreman_remote_execution/execution_interface" %>')
+Deface::Override.new(:virtual_path => 'hosts/_form',
+  :name            => 'add_execution_interface_js',
+  :insert_before   => 'div#primary',
+  :text            => '<%= javascript "foreman_remote_execution/execution_interface" %>')
 
-Deface::Override.new(:virtual_path  => 'nic/_base_form',
-                     :name          => 'add_execution_interface',
-                     :insert_after  => 'erb[loud]:contains("interface_provision")',
-                     :partial       => 'overrides/nics/execution_interface')
+Deface::Override.new(:virtual_path => 'nic/_base_form',
+  :name          => 'add_execution_interface',
+  :insert_after  => 'erb[loud]:contains("interface_provision")',
+  :partial       => 'overrides/nics/execution_interface')

data/app/overrides/subnet_proxies.rb

@@ -1,9 +1,9 @@
 Deface::Override.new(:virtual_path => 'subnets/_form',
-                     :name => 'add_remote_execution_proxies_tab',
-                     :insert_after => 'li.active',
-                     :partial => 'overrides/subnets/rex_tab')
+  :name => 'add_remote_execution_proxies_tab',
+  :insert_after => 'li.active',
+  :partial => 'overrides/subnets/rex_tab')
 
 Deface::Override.new(:virtual_path => 'subnets/_form',
-                     :name => 'add_remote_execution_proxies_tab_pane',
-                     :insert_after => 'div#proxies',
-                     :partial => 'overrides/subnets/rex_tab_pane')
+  :name => 'add_remote_execution_proxies_tab_pane',
+  :insert_after => 'div#proxies',
+  :partial => 'overrides/subnets/rex_tab_pane')

data/config/routes.rb

@@ -44,6 +44,7 @@ Rails.application.routes.draw do
   end
   get 'cockpit/redirect', to: 'cockpit#redirect'
   get 'ui_job_wizard/categories', to: 'ui_job_wizard#categories'
+  get 'ui_job_wizard/template/:id', to: 'ui_job_wizard#template'
 
   match '/experimental/job_wizard', to: 'react#index', :via => [:get]
 

data/db/migrate/20180110104432_rename_template_invocation_permission.rb

@@ -16,7 +16,7 @@ class RenameTemplateInvocationPermission < ActiveRecord::Migration[4.2]
     return if old_permission.nil?
 
     new_permission = Permission.find_or_create_by(:name => new,
-                                                  :resource_type => 'TemplateInvocation')
+      :resource_type => 'TemplateInvocation')
     old_permission.filterings.each do |filtering|
       filtering.permission_id = new_permission.id
       filtering.save!

data/db/migrate/20190111153330_remove_remote_execution_without_proxy_setting.rb

@@ -5,9 +5,9 @@ class RemoveRemoteExecutionWithoutProxySetting < ActiveRecord::Migration[5.2]
 
   def down
     Setting.create!(:name => 'remote_execution_without_proxy',
-                    :description => N_('When enabled, the remote execution will try to run '\
-                                       'the commands directly, when no proxy with remote execution '\
-                                       'feature is configured for the host.'),
-                    :default => false, :full_name => N_('Fallback Without Proxy'))
+      :description => N_('When enabled, the remote execution will try to run '\
+                         'the commands directly, when no proxy with remote execution '\
+                         'feature is configured for the host.'),
+      :default => false, :full_name => N_('Fallback Without Proxy'))
   end
 end

data/extra/cockpit/foreman-cockpit-session

@@ -56,13 +56,13 @@ end
 
 def send_auth_challenge(challenge)
   send_control({ "command" => "authorize",
-                 "cookie" => "1234", # must be present, but value doesn't matter
-                 "challenge" => challenge})
+    "cookie" => "1234", # must be present, but value doesn't matter
+    "challenge" => challenge})
 end
 
 def send_auth_response(response)
   send_control({ "command" => "authorize",
-                 "response" => response})
+    "response" => response})
 end
 
 def read_auth_reply
@@ -76,9 +76,9 @@ end
 def exit_with_problem(problem, message, auth_methods)
   LOG.error("#{problem} - #{message}")
   send_control({ "command" => "init",
-                 "problem" => problem,
-                 "message" => message,
-                 "auth-method-results" => auth_methods})
+    "problem" => problem,
+    "message" => message,
+    "auth-method-results" => auth_methods})
   exit 1
 end
 

data/lib/foreman_remote_execution/engine.rb

@@ -51,14 +51,13 @@ module ForemanRemoteExecution
 
     initializer 'foreman_remote_execution.register_plugin', before: :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_remote_execution do
-        register_global_js_file 'global'
         requires_foreman '>= 2.2'
+        register_global_js_file 'global'
 
         apipie_documented_controllers ["#{ForemanRemoteExecution::Engine.root}/app/controllers/api/v2/*.rb"]
         ApipieDSL.configuration.dsl_classes_matchers += [
           "#{ForemanRemoteExecution::Engine.root}/app/lib/foreman_remote_execution/renderer/**/*.rb",
         ]
-        register_global_js_file 'global'
         automatic_assets(false)
         precompile_assets(*assets_to_precompile)
 
@@ -68,7 +67,7 @@ module ForemanRemoteExecution
                                             :'api/v2/job_templates' => [:index, :show, :revision, :export],
                                             :'api/v2/template_inputs' => [:index, :show],
                                             :'api/v2/foreign_input_sets' => [:index, :show],
-                                            :ui_job_wizard => [:categories]}, :resource_type => 'JobTemplate'
+                                            :ui_job_wizard => [:categories, :template]}, :resource_type => 'JobTemplate'
           permission :create_job_templates, { :job_templates => [:new, :create, :clone_template, :import],
                                               :'api/v2/job_templates' => [:create, :clone, :import] }, :resource_type => 'JobTemplate'
           permission :edit_job_templates, { :job_templates => [:edit, :update],
@@ -141,7 +140,7 @@ module ForemanRemoteExecution
           url_hash: { controller: 'job_wizard', action: :index },
           caption: N_('Job wizard'),
           parent: :lab_features_menu,
-          url: 'experimental/job_wizard',
+          url: '/experimental/job_wizard',
           after: :host_wizard
 
         register_custom_status HostStatus::ExecutionStatus
@@ -163,9 +162,15 @@ module ForemanRemoteExecution
 
         # Extend Registration module
         extend_allowed_registration_vars :remote_execution_interface
-        register_global_js_file 'fills'
         ForemanTasks.dynflow.eager_load_actions!
-        extend_observable_events(::Dynflow::Action.descendants.select { |klass| klass <= ::Actions::ObservableAction }.map(&:namespaced_event_names))
+        extend_observable_events(
+          ::Dynflow::Action.descendants.select do |klass|
+            klass <= ::Actions::ObservableAction
+          end.map(&:namespaced_event_names) +
+          RemoteExecutionFeature.all.pluck(:label).map do |label|
+            ::Actions::RemoteExecution::RunHostJob.feature_job_event_name(label)
+          end
+        )
       end
     end
 

data/lib/foreman_remote_execution/version.rb

@@ -1,3 +1,3 @@
 module ForemanRemoteExecution
-  VERSION = '4.4.0'.freeze
+  VERSION = '4.5.0'.freeze
 end

data/package.json

@@ -29,7 +29,8 @@
     "babel-eslint": "^10.0.0",
     "eslint": "^6.8.0",
     "prettier": "^1.19.1",
-    "@patternfly/react-catalog-view-extension": "^4.8.126"
+    "@patternfly/react-catalog-view-extension": "^4.8.126",
+    "redux-mock-store": "^1.2.2"
   },
   "peerDependencies": {
     "@theforeman/vendor": "^8.3.0"

data/test/functional/api/v2/job_invocations_controller_test.rb

@@ -114,11 +114,24 @@ module Api
             assert_response :success
           end
 
-          test 'search_query' do
+          test 'host ids as search_query' do
             @attrs[:host_ids] = 'name = testfqdn'
             post :create, params: { job_invocation: @attrs }
             assert_response :success
           end
+
+          test 'with search_query param' do
+            @attrs[:targeting_type] = 'static_query'
+            @attrs[:search_query] = 'name = testfqdn'
+            post :create, params: { job_invocation: @attrs }
+            assert_response :success
+          end
+
+          test 'with job_template_id param' do
+            @attrs[:job_template_id] = 12_345
+            post :create, params: { job_invocation: @attrs }
+            assert_response :error
+          end
         end
       end
 

data/test/unit/job_invocation_composer_test.rb

@@ -622,7 +622,7 @@ class JobInvocationComposerTest < ActiveSupport::TestCase
     end
   end
 
-  describe '#from_api_params' do
+  describe '.from_api_params' do
     let(:composer) do
       JobInvocationComposer.from_api_params(params)
     end
@@ -754,12 +754,23 @@ class JobInvocationComposerTest < ActiveSupport::TestCase
         assert composer.save!
         _(composer.job_invocation.remote_execution_feature).must_equal feature
       end
+
+      it 'sets the remote execution_feature id based on `feature` param' do
+        params[:remote_execution_feature_id] = nil
+        params[:feature] = feature.label
+        params[:job_template_id] = trying_job_template_1.id
+        refute_equal feature.job_template, trying_job_template_1
+
+        assert composer.save!
+        _(composer.job_invocation.remote_execution_feature).must_equal feature
+      end
     end
 
     context 'with invalid targeting' do
       let(:params) do
         { :job_category => trying_job_template_1.job_category,
           :job_template_id => trying_job_template_1.id,
+          :targeting_type => 'fake',
           :search_query => 'some hosts',
           :inputs => {input1.name => 'some_value'}}
       end
@@ -865,6 +876,39 @@ class JobInvocationComposerTest < ActiveSupport::TestCase
     end
   end
 
+  describe '.for_feature' do
+    let(:feature) { FactoryBot.create(:remote_execution_feature, job_template: trying_job_template_1) }
+    let(:host) { FactoryBot.create(:host) }
+    let(:bookmark) { Bookmark.create!(:query => 'b', :name => 'bookmark', :public => true, :controller => 'hosts') }
+
+    context 'specifying hosts' do
+      it 'takes a bookmarked search' do
+        composer = JobInvocationComposer.for_feature(feature.label, bookmark, {})
+        assert_equal bookmark.id, composer.params['targeting']['bookmark_id']
+      end
+
+      it 'takes an array of host ids' do
+        composer = JobInvocationComposer.for_feature(feature.label, [host.id], {})
+        assert_match(/#{host.name}/, composer.params['targeting']['search_query'])
+      end
+
+      it 'takes a single host object' do
+        composer = JobInvocationComposer.for_feature(feature.label, host, {})
+        assert_match(/#{host.name}/, composer.params['targeting']['search_query'])
+      end
+
+      it 'takes an array of host FQDNs' do
+        composer = JobInvocationComposer.for_feature(feature.label, [host.fqdn], {})
+        assert_match(/#{host.name}/, composer.params['targeting']['search_query'])
+      end
+
+      it 'takes a search query string' do
+        composer = JobInvocationComposer.for_feature(feature.label, 'host.example.com', {})
+        assert_equal 'host.example.com', composer.search_query
+      end
+    end
+  end
+
   describe '#resolve_job_category and #resolve job_templates' do
     let(:setting_template) { as_admin { FactoryBot.create(:job_template, :name => 'trying setting', :job_category => 'fluff') } }
     let(:other_template) { as_admin { FactoryBot.create(:job_template, :name => 'trying something', :job_category => 'fluff') } }

data/webpack/JobWizard/JobWizard.js

@@ -1,55 +1,96 @@
-import React, { useState } from 'react';
+import React, { useState, useEffect, useCallback } from 'react';
+import { useDispatch, useSelector } from 'react-redux';
 import { Wizard } from '@patternfly/react-core';
+import { get } from 'foremanReact/redux/API';
 import { translate as __ } from 'foremanReact/common/I18n';
 import history from 'foremanReact/history';
 import CategoryAndTemplate from './steps/CategoryAndTemplate/';
+import { AdvancedFields } from './steps/AdvancedFields/AdvancedFields';
+import { JOB_TEMPLATE } from './JobWizardConstants';
+import { selectTemplateError } from './JobWizardSelectors';
 import './JobWizard.scss';
 
 export const JobWizard = () => {
-  const [jobTemplate, setJobTemplate] = useState(null);
+  const [jobTemplateID, setJobTemplateID] = useState(null);
   const [category, setCategory] = useState('');
+  const [advancedValues, setAdvancedValues] = useState({});
+  const dispatch = useDispatch();
+
+  const setDefaults = useCallback(response => {
+    const responseJob = response.data;
+    setAdvancedValues({
+      effectiveUserValue: responseJob.effective_user?.value || '',
+      timeoutToKill: responseJob.job_template.execution_timeout_interval || '',
+    });
+  }, []);
+  useEffect(() => {
+    if (jobTemplateID) {
+      dispatch(
+        get({
+          key: JOB_TEMPLATE,
+          url: `/ui_job_wizard/template/${jobTemplateID}`,
+          handleSuccess: setDefaults,
+        })
+      );
+    }
+  }, [jobTemplateID, setDefaults, dispatch]);
+
+  const templateError = !!useSelector(selectTemplateError);
+  const isTemplate = !templateError && !!jobTemplateID;
   const steps = [
     {
-      name: __('Category and template'),
+      name: __('Category and Template'),
       component: (
         <CategoryAndTemplate
-          jobTemplate={jobTemplate}
-          setJobTemplate={setJobTemplate}
+          jobTemplate={jobTemplateID}
+          setJobTemplate={setJobTemplateID}
           category={category}
           setCategory={setCategory}
         />
       ),
     },
     {
-      name: __('Target hosts'),
-      component: <p>TargetHosts </p>,
-      canJumpTo: !!jobTemplate,
+      name: __('Target Hosts'),
+      component: <p>Target Hosts</p>,
+      canJumpTo: isTemplate,
     },
     {
-      name: __('Advanced fields'),
-      component: <p> AdvancedFields </p>,
-      canJumpTo: !!jobTemplate,
+      name: __('Advanced Fields'),
+      component: (
+        <AdvancedFields
+          advancedValues={advancedValues}
+          setAdvancedValues={newValues => {
+            setAdvancedValues(currentAdvancedValues => ({
+              ...currentAdvancedValues,
+              ...newValues,
+            }));
+          }}
+          jobTemplateID={jobTemplateID}
+        />
+      ),
+      canJumpTo: isTemplate,
     },
     {
       name: __('Schedule'),
       component: <p>Schedule</p>,
-      canJumpTo: !!jobTemplate,
+      canJumpTo: isTemplate,
     },
     {
-      name: __('Review details'),
-      component: <p>ReviewDetails</p>,
+      name: __('Review Details'),
+      component: <p>Review Details</p>,
       nextButtonText: 'Run',
-      canJumpTo: !!jobTemplate,
+      canJumpTo: isTemplate,
     },
   ];
-  const title = __('Run Job');
   return (
     <Wizard
       onClose={() => history.goBack()}
-      navAriaLabel={`${title} steps`}
+      navAriaLabel="Run Job steps"
       steps={steps}
-      height="70vh"
+      height="100%"
       className="job-wizard"
     />
   );
 };
+
+export default JobWizard;

data/webpack/JobWizard/JobWizard.scss

@@ -1,6 +1,5 @@
 .job-wizard {
   .pf-c-wizard__main {
-    overflow: visible;
     z-index: calc(
       var(--pf-c-wizard__footer--ZIndex) + 1
     ); // So the select box can be shown above the wizard footer
@@ -8,5 +7,8 @@
 
   .pf-c-wizard__main-body {
     max-width: 500px;
+    .advanced-fields-title {
+      margin-bottom: 10px;
+    }
   }
 }

data/webpack/JobWizard/JobWizardConstants.js

@@ -2,4 +2,5 @@ import { foremanUrl } from 'foremanReact/common/helpers';
 
 export const JOB_TEMPLATES = 'JOB_TEMPLATES';
 export const JOB_CATEGORIES = 'JOB_CATEGORIES';
+export const JOB_TEMPLATE = 'JOB_TEMPLATE';
 export const templatesUrl = foremanUrl('/api/v2/job_templates');

data/webpack/JobWizard/JobWizardSelectors.js

@@ -1,9 +1,14 @@
 import {
   selectAPIResponse,
   selectAPIStatus,
+  selectAPIErrorMessage,
 } from 'foremanReact/redux/API/APISelectors';
 
-import { JOB_TEMPLATES, JOB_CATEGORIES } from './JobWizardConstants';
+import {
+  JOB_TEMPLATES,
+  JOB_CATEGORIES,
+  JOB_TEMPLATE,
+} from './JobWizardConstants';
 
 export const selectJobTemplatesStatus = state =>
   selectAPIStatus(state, JOB_TEMPLATES);
@@ -19,3 +24,15 @@ export const selectJobCategories = state =>
 
 export const selectJobCategoriesStatus = state =>
   selectAPIStatus(state, JOB_CATEGORIES);
+
+export const selectCategoryError = state =>
+  selectAPIErrorMessage(state, JOB_CATEGORIES);
+
+export const selectAllTemplatesError = state =>
+  selectAPIErrorMessage(state, JOB_TEMPLATES);
+
+export const selectTemplateError = state =>
+  selectAPIErrorMessage(state, JOB_TEMPLATE);
+
+export const selectJobTemplate = state =>
+  selectAPIResponse(state, JOB_TEMPLATE);