foreman_remote_execution 4.5.1 → 4.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6f79124fa44d1ce9756c7c680a43ea7c9c1d309836641e4f1d91fe713a75fdb
-  data.tar.gz: 1db640940ff3ba7a44b183c017ee0c1c3262e5263553365e930695b5f1686b8e
+  metadata.gz: 8c01aa4397a7c931f0cda22e96e238bded98642267efbd24d450fc27bb656d0a
+  data.tar.gz: 4a07bd69223c941761dc3ad16001eeef969612e3f5b648bd168f141e6f087781
 SHA512:
-  metadata.gz: 9c105b218161cc5e509c5da55ca76d339d37d217e318aff139609361ece08ff0fa36c0b70fbb41e0c2bfac2633c86218fd4539e762e1c4f0e1ed49dc778ec728
-  data.tar.gz: 9d148bc9b8af5f27c6b5bb91d8e28ea27bbff870ce1239a2e87413d5cf49b5740ccad18f713f22a1d348ff5fe185bdef015dd2bbd1b85f2efe802547e88fe193
+  metadata.gz: 56a50ffebf8864ec4851fc9e74c479a84b3af194502c5945e9c58cacc0068c283aab2d8cbc282a837aad686ebfe137477989fa572dce8e5d9914ae5c06b72736
+  data.tar.gz: c70b0c20e50b576841f96e8050b8be366d345758749b3c3d144af8e4364a65796d72a0874c382e3b13c5e73e36ef0d6266a1fa5544bf6b34805cb79de113c572

data/app/controllers/ui_job_wizard_controller.rb

@@ -10,9 +10,12 @@ class UiJobWizardController < ::Api::V2::BaseController
 
   def template
     job_template = JobTemplate.authorized.find(params[:id])
+    advanced_template_inputs, template_inputs = map_template_inputs(job_template.template_inputs_with_foreign).partition { |x| x["advanced"] }
     render :json => {
       :job_template => job_template,
       :effective_user => job_template.effective_user,
+      :template_inputs => template_inputs,
+      :advanced_template_inputs => advanced_template_inputs,
     }
   end
 
@@ -20,6 +23,10 @@ class UiJobWizardController < ::Api::V2::BaseController
     nested_resource || 'job_template'
   end
 
+  def map_template_inputs(template_inputs_with_foreign)
+    template_inputs_with_foreign.map { |input| input.attributes.merge({:resource_type => input.resource_type&.tableize }) }
+  end
+
   def resource_class
     JobTemplate
   end

data/app/helpers/remote_execution_helper.rb

@@ -7,6 +7,10 @@ module RemoteExecutionHelper
     @job_hosts_authorizer ||= Authorizer.new(User.current, :collection => @hosts)
   end
 
+  def host_tasks_authorizer
+    @host_tasks_authorizer ||= Authorizer.new(User.current, :collection => @job_invocation.sub_tasks)
+  end
+
   def host_counter(label, count)
     content_tag(:div, :class => 'host_counter') do
       content_tag(:div, label, :class => 'header') + content_tag(:div, count.to_s, :class => 'count')
@@ -36,7 +40,7 @@ module RemoteExecutionHelper
                   'data-method': 'get', id: "#{host.name}-actions-rerun" } }
     end
 
-    if host_task.present? && authorized_for(hash_for_foreman_tasks_task_path(host_task).merge(auth_object: host_task, permission: :view_foreman_tasks))
+    if host_task.present? && authorized_for(hash_for_foreman_tasks_task_path(host_task).merge(auth_object: host_task, permission: :view_foreman_tasks, authorizer: host_tasks_authorizer))
       links << { title: _('Host task'),
         action: { href: foreman_tasks_task_path(host_task),
                   'data-method': 'get', id: "#{host.name}-actions-task" } }

data/app/views/templates/ssh/module_action.erb

@@ -29,6 +29,7 @@ template_inputs:
   input_type: user
   required: false
   advanced: true
+feature: :katello_module_stream_action
 %>
 
 <%

data/app/views/templates/ssh/puppet_run_once.erb

@@ -10,6 +10,7 @@ template_inputs:
   description: Additional options to pass to puppet
   input_type: user
   required: false
+feature: puppet_run_host
 %>
 <% if @host.operatingsystem.family == 'Debian' -%>
 export PATH=/opt/puppetlabs/bin:$PATH

data/lib/foreman_remote_execution/version.rb

@@ -1,3 +1,3 @@
 module ForemanRemoteExecution
-  VERSION = '4.5.1'.freeze
+  VERSION = '4.5.2'.freeze
 end

data/webpack/JobWizard/JobWizard.js

@@ -1,3 +1,4 @@
+/* eslint-disable camelcase */
 import React, { useState, useEffect, useCallback } from 'react';
 import { useDispatch, useSelector } from 'react-redux';
 import { Wizard } from '@patternfly/react-core';
@@ -8,6 +9,7 @@ import CategoryAndTemplate from './steps/CategoryAndTemplate/';
 import { AdvancedFields } from './steps/AdvancedFields/AdvancedFields';
 import { JOB_TEMPLATE } from './JobWizardConstants';
 import { selectTemplateError } from './JobWizardSelectors';
+import Schedule from './steps/Schedule/';
 import './JobWizard.scss';
 
 export const JobWizard = () => {
@@ -16,13 +18,31 @@ export const JobWizard = () => {
   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 || '',
-    });
-  }, []);
+  const setDefaults = useCallback(
+    ({
+      data: {
+        advanced_template_inputs,
+        effective_user,
+        job_template: { executionTimeoutInterval, description_format },
+      },
+    }) => {
+      const advancedTemplateValues = {};
+      const advancedInputs = advanced_template_inputs;
+      if (advancedInputs) {
+        advancedInputs.forEach(input => {
+          advancedTemplateValues[input.name] = input?.default || '';
+        });
+      }
+      setAdvancedValues(currentAdvancedValues => ({
+        ...currentAdvancedValues,
+        effectiveUserValue: effective_user?.value || '',
+        timeoutToKill: executionTimeoutInterval || '',
+        templateValues: advancedTemplateValues,
+        description: description_format || '',
+      }));
+    },
+    []
+  );
   useEffect(() => {
     if (jobTemplateID) {
       dispatch(
@@ -72,7 +92,7 @@ export const JobWizard = () => {
     },
     {
       name: __('Schedule'),
-      component: <p>Schedule</p>,
+      component: <Schedule />,
       canJumpTo: isTemplate,
     },
     {

data/webpack/JobWizard/JobWizard.scss

@@ -10,5 +10,44 @@
     .advanced-fields-title {
       margin-bottom: 10px;
     }
+    #advanced-fields-job-template {
+      .foreman-search-field {
+        // Giving pf3 search bar a pf4 look
+        .search-bar {
+          display: block;
+        }
+        .input-group-btn {
+          display: none;
+        }
+        li {
+          font-size: 16px;
+        }
+        input {
+          font-size: 16px;
+          height: 36px;
+        }
+        .foreman-autocomplete .autocomplete-focus-shortcut {
+          top: 8px;
+          font-size: 16px;
+        }
+        .foreman-autocomplete .autocomplete-aux {
+          top: 8px;
+          font-size: 16px;
+          .autocomplete-clear-button {
+            font-size: 16px;
+          }
+        }
+      }
+    }
+  }
+
+  .schedule-tab {
+    input[type='radio'],
+    input[type='checkbox'] {
+      margin: 0;
+    }
+    .advanced-scheduling-button {
+      text-align: start;
+    }
   }
 }

data/webpack/JobWizard/JobWizardConstants.js

@@ -1,6 +1,16 @@
+import { translate as __ } from 'foremanReact/common/I18n';
 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');
+
+export const repeatTypes = {
+  noRepeat: __('Does not repeat'),
+  cronline: __('Cronline'),
+  monthly: __('Monthly'),
+  weekly: __('Weekly'),
+  daily: __('Daily'),
+  hourly: __('Hourly'),
+};

data/webpack/JobWizard/JobWizardSelectors.js

@@ -36,3 +36,12 @@ export const selectTemplateError = state =>
 
 export const selectJobTemplate = state =>
   selectAPIResponse(state, JOB_TEMPLATE);
+
+export const selectEffectiveUser = state =>
+  selectAPIResponse(state, JOB_TEMPLATE).effective_user;
+
+export const selectAdvancedTemplateInputs = state =>
+  selectAPIResponse(state, JOB_TEMPLATE).advanced_template_inputs || [];
+
+export const selectTemplateInputs = state =>
+  selectAPIResponse(state, JOB_TEMPLATE).template_inputs || [];

data/webpack/JobWizard/__tests__/fixtures.js

@@ -1,6 +1,8 @@
-const jobTemplate = {
+import configureMockStore from 'redux-mock-store';
+
+export const jobTemplate = {
   id: 178,
-  name: 'Run Command - Ansible Default',
+  name: 'template1',
   template:
     "---\n- hosts: all\n  tasks:\n    - shell:\n        cmd: |\n<%=       indent(10) { input('command') } %>\n      register: out\n    - debug: var=out",
   snippet: false,
@@ -23,4 +25,104 @@ export const jobTemplateResponse = {
     overridable: true,
     current_user: false,
   },
+  advanced_template_inputs: [
+    {
+      name: 'adv plain hidden',
+      required: true,
+      input_type: 'user',
+      description: 'some Description',
+      advanced: true,
+      value_type: 'plain',
+      resource_type: 'ansible_roles',
+      default: 'Default val',
+      hidden_value: true,
+    },
+    {
+      name: 'adv plain select',
+      required: false,
+      input_type: 'user',
+      options: 'option 1\r\noption 2\r\noption 3\r\noption 4',
+      advanced: true,
+      value_type: 'plain',
+      resource_type: 'ansible_roles',
+      default: '',
+      hidden_value: false,
+    },
+    {
+      name: 'adv search',
+      required: false,
+      options: '',
+      advanced: true,
+      value_type: 'search',
+      resource_type: 'foreman_tasks/tasks',
+      default: '',
+      hidden_value: false,
+    },
+    {
+      name: 'adv date',
+      required: false,
+      options: '',
+      advanced: true,
+      value_type: 'date',
+      resource_type: 'ansible_roles',
+      default: '',
+      hidden_value: false,
+    },
+  ],
+  template_inputs: [
+    {
+      name: 'plain hidden',
+      required: true,
+      input_type: 'user',
+      description: 'some Description',
+      advanced: false,
+      value_type: 'plain',
+      resource_type: 'ansible_roles',
+      default: 'Default val',
+      hidden_value: true,
+    },
+  ],
+};
+
+export const jobCategories = ['Ansible Commands', 'Puppet', 'Services'];
+
+export const testSetup = (selectors, api) => {
+  jest.spyOn(api, 'get');
+  jest.spyOn(selectors, 'selectJobTemplate');
+  jest.spyOn(selectors, 'selectJobTemplates');
+  jest.spyOn(selectors, 'selectJobCategories');
+  jest.spyOn(selectors, 'selectJobCategoriesStatus');
+
+  selectors.selectJobCategories.mockImplementation(() => jobCategories);
+  selectors.selectJobTemplates.mockImplementation(() => [
+    jobTemplate,
+    { ...jobTemplate, id: 2, name: 'template2' },
+  ]);
+  const mockStore = configureMockStore([]);
+  const store = mockStore({});
+  return store;
+};
+
+export const mockTemplate = selectors => {
+  selectors.selectJobTemplate.mockImplementation(() => jobTemplate);
+  selectors.selectJobCategoriesStatus.mockImplementation(() => 'RESOLVED');
+};
+export const mockApi = api => {
+  api.get.mockImplementation(({ handleSuccess, ...action }) => {
+    if (action.key === 'JOB_CATEGORIES') {
+      handleSuccess &&
+        handleSuccess({ data: { job_categories: jobCategories } });
+    } else if (action.key === 'JOB_TEMPLATE') {
+      handleSuccess &&
+        handleSuccess({
+          data: jobTemplateResponse,
+        });
+    } else if (action.key === 'JOB_TEMPLATES') {
+      handleSuccess &&
+        handleSuccess({
+          data: { results: [jobTemplate] },
+        });
+    }
+    return { type: 'get', ...action };
+  });
 };

data/webpack/JobWizard/__tests__/integration.test.js

@@ -1,40 +1,27 @@
 import React from 'react';
 import { Provider } from 'react-redux';
-import configureMockStore from 'redux-mock-store';
 import { mount } from '@theforeman/test';
 import { render, fireEvent, screen, act } from '@testing-library/react';
 import * as api from 'foremanReact/redux/API';
 import { JobWizard } from '../JobWizard';
 import * as selectors from '../JobWizardSelectors';
-import { jobTemplates, jobTemplateResponse as jobTemplate } from './fixtures';
+import {
+  testSetup,
+  mockApi,
+  jobCategories,
+  jobTemplateResponse as jobTemplate,
+} from './fixtures';
 
-jest.spyOn(api, 'get');
-jest.spyOn(selectors, 'selectJobTemplate');
-jest.spyOn(selectors, 'selectJobTemplates');
-jest.spyOn(selectors, 'selectJobCategories');
-jest.spyOn(selectors, 'selectJobCategoriesStatus');
+const store = testSetup(selectors, api);
 
-const jobCategories = ['Ansible Commands', 'Puppet', 'Services'];
+selectors.selectJobTemplate.mockImplementation(() => {});
 
 api.get.mockImplementation(({ handleSuccess, ...action }) => {
   if (action.key === 'JOB_CATEGORIES') {
     handleSuccess && handleSuccess({ data: { job_categories: jobCategories } });
-  } else if (action.key === 'JOB_TEMPLATE') {
-    handleSuccess &&
-      handleSuccess({
-        data: jobTemplate,
-      });
   }
   return { type: 'get', ...action };
 });
-
-selectors.selectJobTemplate.mockImplementation(() => null);
-selectors.selectJobCategories.mockImplementation(() => jobCategories);
-selectors.selectJobCategoriesStatus.mockImplementation(() => null);
-selectors.selectJobTemplates.mockImplementation(() => jobTemplates);
-
-const mockStore = configureMockStore([]);
-const store = mockStore({});
 describe('Job wizard fill', () => {
   it('should select template', async () => {
     const wrapper = mount(
@@ -51,7 +38,10 @@ describe('Job wizard fill', () => {
     selectors.selectJobTemplate.mockImplementation(() => jobTemplate);
     wrapper.find('.pf-c-button.pf-c-select__toggle-button').simulate('click');
     await act(async () => {
-      await wrapper.find('.pf-c-select__menu-item').simulate('click');
+      await wrapper
+        .find('.pf-c-select__menu-item')
+        .first()
+        .simulate('click');
       await wrapper.update();
     });
     expect(store.getActions().slice(-1)).toMatchSnapshot('select template');
@@ -60,74 +50,12 @@ describe('Job wizard fill', () => {
     );
   });
 
-  it('should save data between steps for advanced fields', async () => {
-    const wrapper = mount(
-      <Provider store={store}>
-        <JobWizard advancedValues={{}} setAdvancedValues={jest.fn()} />
-      </Provider>
-    );
-    // setup
-    selectors.selectJobCategoriesStatus.mockImplementation(() => 'RESOLVED');
-    selectors.selectJobTemplate.mockImplementation(() => jobTemplate);
-    wrapper.find('.pf-c-button.pf-c-select__toggle-button').simulate('click');
-    wrapper.find('.pf-c-select__menu-item').simulate('click');
-
-    // test
-    expect(wrapper.find('.pf-c-wizard__nav-link.pf-m-disabled')).toHaveLength(
-      0
-    );
-    wrapper
-      .find('.pf-c-wizard__nav-link')
-      .at(2)
-      .simulate('click'); // Advanced step
-    const effectiveUserInput = () => wrapper.find('input#effective-user');
-    const effectiveUesrValue = 'effective user new value';
-    effectiveUserInput().getDOMNode().value = effectiveUesrValue;
-    await act(async () => {
-      await effectiveUserInput().simulate('change');
-      wrapper.update();
-    });
-
-    expect(effectiveUserInput().prop('value')).toEqual(effectiveUesrValue);
-
-    wrapper
-      .find('.pf-c-wizard__nav-link')
-      .at(1)
-      .simulate('click');
-
-    expect(wrapper.find('.pf-c-wizard__nav-link.pf-m-current').text()).toEqual(
-      'Target Hosts'
-    );
-    wrapper
-      .find('.pf-c-wizard__nav-link')
-      .at(2)
-      .simulate('click'); // Advanced step
-
-    expect(effectiveUserInput().prop('value')).toEqual(effectiveUesrValue);
-  });
-
   it('have all steps', async () => {
     selectors.selectJobCategoriesStatus.mockImplementation(() => null);
     selectors.selectJobTemplate.mockRestore();
     selectors.selectJobTemplates.mockRestore();
     selectors.selectJobCategories.mockRestore();
-    api.get.mockImplementation(({ handleSuccess, ...action }) => {
-      if (action.key === 'JOB_CATEGORIES') {
-        handleSuccess &&
-          handleSuccess({ data: { job_categories: jobCategories } });
-      } else if (action.key === 'JOB_TEMPLATE') {
-        handleSuccess &&
-          handleSuccess({
-            data: jobTemplate,
-          });
-      } else if (action.key === 'JOB_TEMPLATES') {
-        handleSuccess &&
-          handleSuccess({
-            data: { results: [jobTemplate.job_template] },
-          });
-      }
-      return { type: 'get', ...action };
-    });
+    mockApi(api);
 
     render(
       <Provider store={store}>