foreman_remote_execution 5.0.0 → 6.0.0

data/package.json

@@ -30,7 +30,9 @@
     "eslint": "^6.8.0",
     "prettier": "^1.19.1",
     "@patternfly/react-catalog-view-extension": "^4.8.126",
-    "redux-mock-store": "^1.2.2"
+    "redux-mock-store": "^1.2.2",
+    "graphql-tag": "^2.11.0",
+    "graphql": "^15.5.0"
   },
   "peerDependencies": {
     "@theforeman/vendor": "^8.16.0"

data/test/unit/job_invocation_report_template_test.rb

@@ -9,7 +9,7 @@ class JobReportTemplateTest < ActiveSupport::TestCase
 
   context 'with valid job invocation report template' do
     let(:job_invocation_template) do
-      file_path = File.read(File.expand_path(Rails.root + "app/views/unattended/report_templates/jobs_-_invocation_report_template.erb"))
+      file_path = File.read(File.expand_path(Rails.root + "app/views/unattended/report_templates/job_invocation_-_report_template.erb"))
       template = ReportTemplate.import_without_save("Job Invocation Report Template", file_path)
       template.save!
       template

data/test/unit/targeting_test.rb

@@ -61,7 +61,7 @@ class TargetingTest < ActiveSupport::TestCase
       users(:one).destroy
     end
 
-    it { assert targeting.reload.user.nil? }
+    it { assert_nil targeting.reload.user }
     it do
       -> { targeting.resolve_hosts! }.must_raise(Foreman::Exception)
     end

data/webpack/JobWizard/JobWizard.js

@@ -20,6 +20,7 @@ import {
   selectTemplateError,
   selectJobTemplate,
   selectIsSubmitting,
+  selectRouterSearch,
 } from './JobWizardSelectors';
 import Schedule from './steps/Schedule/';
 import HostsAndInputs from './steps/HostsAndInputs/';
@@ -41,6 +42,7 @@ export const JobWizard = () => {
     hostGroups: [],
   });
   const [hostsSearchQuery, setHostsSearchQuery] = useState('');
+  const [fills, setFills] = useState(useSelector(selectRouterSearch));
   const dispatch = useDispatch();
 
   const setDefaults = useCallback(
@@ -49,17 +51,26 @@ export const JobWizard = () => {
         template_inputs,
         advanced_template_inputs,
         effective_user,
-        job_template: { name, execution_timeout_interval, description_format },
+        job_template: {
+          name,
+          execution_timeout_interval,
+          description_format,
+          job_category,
+        },
       },
     }) => {
+      if (!category.length) {
+        setCategory(current => (current.length ? current : job_category));
+      }
       const advancedTemplateValues = {};
       const defaultTemplateValues = {};
       const inputs = template_inputs;
       const advancedInputs = advanced_template_inputs;
       if (inputs) {
-        setTemplateValues(() => {
+        setTemplateValues(prev => {
           inputs.forEach(input => {
-            defaultTemplateValues[input.name] = input?.default || '';
+            defaultTemplateValues[input.name] =
+              prev[input.name] || input?.default || '';
           });
           return defaultTemplateValues;
         });
@@ -67,7 +78,8 @@ export const JobWizard = () => {
       setAdvancedValues(currentAdvancedValues => {
         if (advancedInputs) {
           advancedInputs.forEach(input => {
-            advancedTemplateValues[input.name] = input?.default || '';
+            advancedTemplateValues[input.name] =
+              currentAdvancedValues[input.name] || input?.default || '';
           });
         }
         const generateDefaultDescription = () => {
@@ -89,7 +101,7 @@ export const JobWizard = () => {
         };
       });
     },
-    []
+    [category.length]
   );
   useEffect(() => {
     if (jobTemplateID) {
@@ -108,8 +120,12 @@ export const JobWizard = () => {
     templateValues,
   });
   useAutoFill({
+    fills,
+    setFills,
     setSelectedTargets,
     setHostsSearchQuery,
+    setJobTemplateID,
+    setTemplateValues,
   });
   const templateError = !!useSelector(selectTemplateError);
   const templateResponse = useSelector(selectJobTemplate);
@@ -126,6 +142,7 @@ export const JobWizard = () => {
           setJobTemplate={setJobTemplateID}
           category={category}
           setCategory={setCategory}
+          isFeature={!!fills.feature}
         />
       ),
       enableNext: isTemplate,

data/webpack/JobWizard/JobWizard.scss

@@ -103,4 +103,9 @@
       margin-left: 10px;
     }
   }
+  .foreman-search-field {
+    .autocomplete-search-btn {
+      display: none;
+    }
+  }
 }

data/webpack/JobWizard/JobWizardConstants.js

@@ -47,7 +47,7 @@ export const hostMethods = {
   searchQuery: __('Search query'),
 };
 
-export const hostQuerySearchID = 'searchBar'; // until https://projects.theforeman.org/issues/33737 is used
+export const hostQuerySearchID = 'mainHostQuery';
 export const hostsController = 'hosts';
 
 export const dataName = {
@@ -58,3 +58,4 @@ export const HOSTS_TO_PREVIEW_AMOUNT = 20;
 
 export const DEBOUNCE_HOST_COUNT = 700;
 export const HOST_IDS = 'HOST_IDS';
+export const REX_FEATURE = 'REX_FEATURE';

data/webpack/JobWizard/__tests__/fixtures.js

@@ -69,6 +69,7 @@ export const jobTemplateResponse = {
       default: '',
       hidden_value: false,
       url: 'foreman_tasks/tasks',
+      resource_type_tableize: 'hosts',
     },
     {
       name: 'adv date',
@@ -96,7 +97,7 @@ export const jobTemplateResponse = {
   ],
 };
 
-export const jobCategories = ['Ansible Commands', 'Puppet', 'Services'];
+export const jobCategories = ['Services', 'Ansible Commands', 'Puppet'];
 
 export const testSetup = (selectors, api) => {
   jest.spyOn(api, 'get');
@@ -149,7 +150,12 @@ export const mockApi = api => {
   api.get.mockImplementation(({ handleSuccess, ...action }) => {
     if (action.key === 'JOB_CATEGORIES') {
       handleSuccess &&
-        handleSuccess({ data: { job_categories: jobCategories } });
+        handleSuccess({
+          data: {
+            job_categories: jobCategories,
+            default_category: 'Ansible Commands',
+          },
+        });
     } else if (action.key === 'JOB_TEMPLATE') {
       handleSuccess &&
         handleSuccess({
@@ -165,6 +171,11 @@ export const mockApi = api => {
         handleSuccess({
           data: { results: [{ name: 'host1' }, { name: 'host3' }] },
         });
+    } else if (action.key === 'REX_FEATURE') {
+      handleSuccess &&
+        handleSuccess({
+          data: { job_template_id: 178 },
+        });
     }
     return { type: 'get', ...action };
   });

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

@@ -22,7 +22,12 @@ describe('Job wizard fill', () => {
     api.get.mockImplementation(({ handleSuccess, ...action }) => {
       if (action.key === 'JOB_CATEGORIES') {
         handleSuccess &&
-          handleSuccess({ data: { job_categories: jobCategories } });
+          handleSuccess({
+            data: {
+              job_categories: jobCategories,
+              default_category: 'Ansible Commands',
+            },
+          });
       } else if (action.key === 'JOB_TEMPLATE') {
         handleSuccess &&
           handleSuccess({

data/webpack/JobWizard/autofill.js

@@ -1,22 +1,29 @@
 import { useEffect } from 'react';
-import { useDispatch, useSelector } from 'react-redux';
+import { useDispatch } from 'react-redux';
 import { get } from 'foremanReact/redux/API';
-import { HOST_IDS } from './JobWizardConstants';
-import { selectRouterSearch } from './JobWizardSelectors';
+import { HOST_IDS, REX_FEATURE } from './JobWizardConstants';
 import './JobWizard.scss';
 
-export const useAutoFill = ({ setSelectedTargets, setHostsSearchQuery }) => {
-  const fills = useSelector(selectRouterSearch);
+export const useAutoFill = ({
+  fills,
+  setFills,
+  setSelectedTargets,
+  setHostsSearchQuery,
+  setJobTemplateID,
+  setTemplateValues,
+}) => {
   const dispatch = useDispatch();
 
   useEffect(() => {
     if (Object.keys(fills).length) {
-      if (fills['host_ids[]']) {
+      const { 'host_ids[]': hostIds, search, feature, ...rest } = { ...fills };
+      setFills({});
+      if (hostIds) {
         dispatch(
           get({
             key: HOST_IDS,
             url: '/api/hosts',
-            params: { search: `id = ${fills['host_ids[]'].join(' or id = ')}` },
+            params: { search: `id = ${hostIds.join(' or id = ')}` },
             handleSuccess: ({ data }) => {
               setSelectedTargets(currentTargets => ({
                 ...currentTargets,
@@ -29,8 +36,26 @@ export const useAutoFill = ({ setSelectedTargets, setHostsSearchQuery }) => {
           })
         );
       }
-      if (fills.search) {
-        setHostsSearchQuery(fills.search);
+      if (search) {
+        setHostsSearchQuery(search);
+      }
+      if (feature) {
+        dispatch(
+          get({
+            key: REX_FEATURE,
+            url: `/api/remote_execution_features/${feature}`,
+            handleSuccess: ({ data }) => {
+              setJobTemplateID(data.job_template_id);
+            },
+          })
+        );
+        Object.keys(rest).forEach(key => {
+          const re = /inputs\[(?<input>.*)\]/g;
+          const input = re.exec(key)?.groups?.input;
+          if (input) {
+            setTemplateValues(prev => ({ ...prev, [input]: rest[key] }));
+          }
+        });
       }
     }
     // eslint-disable-next-line react-hooks/exhaustive-deps

data/webpack/JobWizard/index.js

@@ -1,5 +1,4 @@
 import React from 'react';
-import PropTypes from 'prop-types';
 import { Title, Divider } from '@patternfly/react-core';
 import { translate as __ } from 'foremanReact/common/I18n';
 import PageLayout from 'foremanReact/routes/common/PageLayout/PageLayout';
@@ -30,10 +29,4 @@ const JobWizardPage = () => {
   );
 };
 
-JobWizardPage.propTypes = {
-  location: PropTypes.shape({
-    search: PropTypes.string,
-  }).isRequired,
-};
-
 export default JobWizardPage;

data/webpack/JobWizard/steps/CategoryAndTemplate/index.js

@@ -25,6 +25,7 @@ const ConnectedCategoryAndTemplate = ({
   setJobTemplate,
   category,
   setCategory,
+  isFeature,
 }) => {
   const dispatch = useDispatch();
 
@@ -36,12 +37,23 @@ const ConnectedCategoryAndTemplate = ({
         get({
           key: JOB_CATEGORIES,
           url: '/ui_job_wizard/categories',
-          handleSuccess: response =>
-            setCategory(response.data.job_categories[0] || ''),
+          handleSuccess: ({
+            data: {
+              default_category: defaultCategory,
+              job_categories: jobCategories,
+              default_template: defaultTemplate,
+            },
+          }) => {
+            if (!isFeature) {
+              setCategory(defaultCategory || jobCategories[0] || '');
+              if (defaultTemplate) setJobTemplate(defaultTemplate);
+            }
+          },
         })
       );
     }
-  }, [jobCategoriesStatus, dispatch, setCategory]);
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [jobCategoriesStatus]);
 
   const jobCategories = useSelector(selectJobCategories);
   useEffect(() => {
@@ -55,14 +67,19 @@ const ConnectedCategoryAndTemplate = ({
             per_page: 'all',
           }),
           handleSuccess: response => {
-            setJobTemplate(
-              Number(filterJobTemplates(response?.data?.results)[0]?.id) || null
-            );
+            if (!jobTemplate)
+              setJobTemplate(
+                current =>
+                  current ||
+                  Number(filterJobTemplates(response?.data?.results)[0]?.id) ||
+                  null
+              );
           },
         })
       );
     }
-  }, [category, dispatch, setJobTemplate]);
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [category, dispatch]);
 
   const jobTemplates = useSelector(selectJobTemplates);
 
@@ -89,6 +106,7 @@ ConnectedCategoryAndTemplate.propTypes = {
   setJobTemplate: PropTypes.func.isRequired,
   category: PropTypes.string.isRequired,
   setCategory: PropTypes.func.isRequired,
+  isFeature: PropTypes.bool.isRequired,
 };
 ConnectedCategoryAndTemplate.defaultProps = { jobTemplate: null };
 

data/webpack/JobWizard/steps/HostsAndInputs/HostSearch.js

@@ -10,7 +10,7 @@ import { noop } from '../../../helpers';
 
 export const HostSearch = ({ value, setValue }) => {
   const searchQuery = useSelector(
-    state => state.autocomplete?.hostsSearch?.searchQuery
+    state => state.autocomplete?.[hostQuerySearchID]?.searchQuery
   );
   useEffect(() => {
     setValue(searchQuery || '');

data/webpack/JobWizard/steps/HostsAndInputs/__tests__/HostsAndInputs.test.js

@@ -148,4 +148,32 @@ describe('Hosts', () => {
     });
     expect(screen.queryAllByText('os=gnome')).toHaveLength(1);
   });
+
+  it('input fill from url', async () => {
+    const inputText = 'test text';
+    routerSelectors.selectRouterLocation.mockImplementation(() => ({
+      search: `feature=test_feature&inputs[plain hidden]=${inputText}`,
+    }));
+    render(
+      <MockedProvider mocks={gqlMock} addTypename={false}>
+        <Provider store={store}>
+          <JobWizard />
+        </Provider>
+      </MockedProvider>
+    );
+    api.get.mock.calls.forEach(call => {
+      if (call[0].key === 'REX_FEATURE') {
+        expect(call[0].url).toEqual(
+          '/api/remote_execution_features/test_feature'
+        );
+      }
+    });
+    await act(async () => {
+      fireEvent.click(screen.getByText('Target hosts and inputs'));
+    });
+    const textField = screen.getByLabelText('plain hidden', {
+      selector: 'textarea',
+    });
+    expect(textField.value).toBe(inputText);
+  });
 });

data/webpack/JobWizard/steps/Schedule/RepeatOn.js

@@ -21,7 +21,7 @@ export const RepeatOn = ({
 }) => {
   const [repeatValidated, setRepeatValidated] = useState('default');
   const handleRepeatInputChange = newValue => {
-    setRepeatValidated(newValue >= 1 ? 'default' : 'error');
+    setRepeatValidated(!newValue || newValue >= 1 ? 'default' : 'error');
     setRepeatAmount(newValue);
   };
 

data/webpack/JobWizard/steps/form/Formatter.js

@@ -1,9 +1,11 @@
 import React, { useEffect } from 'react';
-import { useSelector } from 'react-redux';
+import { useSelector, useDispatch } from 'react-redux';
 import { FormGroup, TextInput, TextArea } from '@patternfly/react-core';
 import PropTypes from 'prop-types';
 import SearchBar from 'foremanReact/components/SearchBar';
 import { getControllerSearchProps } from 'foremanReact/constants';
+import { TRIGGERS } from 'foremanReact/components/AutoComplete/AutoCompleteConstants';
+import { getResults } from 'foremanReact/components/AutoComplete/AutoCompleteActions';
 import { helpLabel } from './FormHelpers';
 import { SelectField } from './SelectField';
 import { ResourceSelectAPI } from './ResourceSelect';
@@ -22,12 +24,25 @@ const TemplateSearchField = ({
   const searchQuery = useSelector(
     state => state.autocomplete?.[name]?.searchQuery
   );
+  const dispatch = useDispatch();
   useEffect(() => {
     setValue({ ...values, [name]: searchQuery });
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [searchQuery]);
   const id = name.replace(/ /g, '-');
   const props = getControllerSearchProps(controller.replace('/', '_'), name);
+
+  const setSearch = newSearchQuery => {
+    dispatch(
+      getResults({
+        url,
+        searchQuery: newSearchQuery,
+        controller,
+        trigger: TRIGGERS.INPUT_CHANGE,
+        id: name,
+      })
+    );
+  };
   return (
     <FormGroup
       label={name}
@@ -45,9 +60,9 @@ const TemplateSearchField = ({
             url,
             useKeyShortcuts: true,
           },
-          bookmarks: null,
         }}
         onSearch={noop}
+        onBookmarkClick={search => setSearch(search)}
       />
     </FormGroup>
   );
@@ -152,7 +167,7 @@ export const formatter = (input, values, setValue) => {
         key={id}
         name={name}
         defaultValue={value}
-        controller={resourceType}
+        controller={controller}
         url={`/${controller}/auto_complete_search`}
         labelText={labelText}
         required={required}

data/webpack/__mocks__/foremanReact/components/Pagination.js

@@ -0,0 +1,2 @@
+const Pagination = () => jest.fn();
+export default Pagination;

data/webpack/__mocks__/foremanReact/constants.js

@@ -17,6 +17,7 @@ export const getControllerSearchProps = (
     useKeyShortcuts: true,
   },
   bookmarks: {
+    id,
     url: '/api/bookmarks',
     canCreate,
     documentationUrl: `4.1.5Searching`,

data/webpack/react_app/components/TargetingHosts/TargetingHostsHelpers.js

@@ -4,7 +4,7 @@ export const getApiUrl = (searchQuery, pagination) => {
   const baseUrl = getURI()
     .search('')
     .addQuery('page', pagination.page)
-    .addQuery('per_page', pagination.perPage);
+    .addQuery('per_page', pagination.per_page);
 
   return searchQuery ? baseUrl.addQuery('search', searchQuery) : baseUrl;
 };

data/webpack/react_app/components/TargetingHosts/TargetingHostsPage.js

@@ -3,7 +3,7 @@ import PropTypes from 'prop-types';
 import { Grid } from 'patternfly-react';
 
 import SearchBar from 'foremanReact/components/SearchBar';
-import Pagination from 'foremanReact/components/Pagination/PaginationWrapper';
+import Pagination from 'foremanReact/components/Pagination';
 import { getControllerSearchProps } from 'foremanReact/constants';
 
 import TargetingHosts from './TargetingHosts';
@@ -15,7 +15,6 @@ const TargetingHostsPage = ({
   apiStatus,
   items,
   totalHosts,
-  pagination,
   handlePagination,
 }) => (
   <div id="targeting_hosts">
@@ -39,11 +38,8 @@ const TargetingHostsPage = ({
     <br />
     <TargetingHosts apiStatus={apiStatus} items={items} />
     <Pagination
-      viewType="table"
       itemCount={totalHosts}
-      pagination={pagination}
       onChange={args => handlePagination(args)}
-      dropdownButtonId="targeting-hosts-pagination-dropdown"
       className="targeting-hosts-pagination"
     />
   </div>
@@ -55,7 +51,6 @@ TargetingHostsPage.propTypes = {
   apiStatus: PropTypes.string,
   items: PropTypes.array.isRequired,
   totalHosts: PropTypes.number.isRequired,
-  pagination: PropTypes.object.isRequired,
   handlePagination: PropTypes.func.isRequired,
 };
 

data/webpack/react_app/components/TargetingHosts/__tests__/__snapshots__/TargetingHostsPage.test.js.snap

@@ -52,18 +52,10 @@ exports[`TargetingHostsPage renders 1`] = `
       ]
     }
   />
-  <PaginationWrapper
+  <Pagination
     className="targeting-hosts-pagination"
-    dropdownButtonId="targeting-hosts-pagination-dropdown"
     itemCount={1}
     onChange={[Function]}
-    pagination={
-      Object {
-        "page": 1,
-        "perPage": 20,
-      }
-    }
-    viewType="table"
   />
 </div>
 `;

data/webpack/react_app/components/TargetingHosts/index.js

@@ -30,14 +30,14 @@ const WrappedTargetingHosts = () => {
   const [searchQuery, setSearchQuery] = useState('');
   const [pagination, setPagination] = useState({
     page: 1,
-    perPage,
+    per_page: perPage,
     perPageOptions,
   });
   const [apiUrl, setApiUrl] = useState(getApiUrl(searchQuery, pagination));
   const intervalExists = useSelector(selectIntervalExists);
 
   const handleSearch = query => {
-    const defaultPagination = { page: 1, perPage: pagination.perPage };
+    const defaultPagination = { page: 1, per_page: pagination.per_page };
     stopApiInterval();
 
     setApiUrl(getApiUrl(query, defaultPagination));
@@ -88,7 +88,6 @@ const WrappedTargetingHosts = () => {
       apiStatus={apiStatus}
       items={items}
       totalHosts={totalHosts}
-      pagination={pagination}
       handlePagination={handlePagination}
     />
   );

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_remote_execution
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Foreman Remote Execution team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-16 00:00:00.000000000 Z
+date: 2022-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
@@ -263,7 +263,6 @@ files:
 - app/views/template_invocations/_refresh.js.erb
 - app/views/template_invocations/show.html.erb
 - app/views/template_invocations/show.js.erb
-- app/views/templates/README.md
 - app/views/templates/ssh/check_update.erb
 - app/views/templates/ssh/module_action.erb
 - app/views/templates/ssh/package_action.erb
@@ -463,7 +462,7 @@ files:
 - webpack/__mocks__/foremanReact/common/helpers.js
 - webpack/__mocks__/foremanReact/components/AutoComplete/AutoCompleteActions.js
 - webpack/__mocks__/foremanReact/components/AutoComplete/AutoCompleteConstants.js
-- webpack/__mocks__/foremanReact/components/Pagination/PaginationWrapper.js
+- webpack/__mocks__/foremanReact/components/Pagination.js
 - webpack/__mocks__/foremanReact/components/SearchBar.js
 - webpack/__mocks__/foremanReact/components/common/ActionButtons/ActionButtons.js
 - webpack/__mocks__/foremanReact/constants.js

data/app/views/templates/README.md

@@ -1,6 +0,0 @@
-# Job Templates
-
-**IMPORTANT** Do not submit pull requests here, these templates are only
-updated during the release process.  The
-[community-templates](https://github.com/theforeman/community-templates) repos
-is the canonical source for job templates.

data/webpack/__mocks__/foremanReact/components/Pagination/PaginationWrapper.js

@@ -1,2 +0,0 @@
-const PaginationWrapper = () => jest.fn();
-export default PaginationWrapper;