foreman_remote_execution 6.2.0 → 7.1.1

data/locale/zh_TW/foreman_remote_execution.po

@@ -23,6 +23,9 @@ msgstr "%s"
 msgid "%s ago"
 msgstr "%s 之前"
 
+msgid "%s job has been invoked"
+msgstr ""
+
 msgid "%{description} on %{host}"
 msgstr "%{description} 於 %{host} 之上"
 
@@ -67,15 +70,15 @@ msgstr "要使用執行這 script 的使用者。如果使用者與 SSH 使用
 msgid "Abort Job"
 msgstr ""
 
+msgid "Action with sub plans"
+msgstr ""
+
 msgid "Actions"
 msgstr "動作"
 
 msgid "Add Foreign Input Set"
 msgstr "新增外部輸入集"
 
-msgid "Advanced Fields"
-msgstr ""
-
 msgid "Advanced fields"
 msgstr ""
 
@@ -466,9 +469,15 @@ msgstr ""
 msgid "Import"
 msgstr "匯入"
 
+msgid "Import Puppet classes"
+msgstr ""
+
 msgid "Import a job template from ERB"
 msgstr ""
 
+msgid "Import facts"
+msgstr ""
+
 msgid "Include all inputs from the foreign template"
 msgstr ""
 
@@ -502,9 +511,6 @@ msgstr "祈願類型，%s 之一"
 msgid "Job"
 msgstr "工作"
 
-msgid "Job Category"
-msgstr ""
-
 msgid "Job Details"
 msgstr ""
 
@@ -826,7 +832,7 @@ msgstr "解析至"
 msgid "Results"
 msgstr ""
 
-msgid "Review Details"
+msgid "Review details"
 msgstr ""
 
 msgid "Run"
@@ -850,9 +856,6 @@ msgstr ""
 msgid "Running"
 msgstr ""
 
-msgid "SSH"
-msgstr "SSH"
-
 msgid "SSH Port"
 msgstr ""
 
@@ -868,6 +871,9 @@ msgstr "排程"
 msgid "Schedule Remote Job"
 msgstr ""
 
+msgid "Schedule a job"
+msgstr ""
+
 msgid "Schedule for future execution"
 msgstr ""
 
@@ -889,6 +895,9 @@ msgstr ""
 msgid "Scheduled to start before"
 msgstr ""
 
+msgid "Script"
+msgstr ""
+
 msgid "Scroll to bottom"
 msgstr "捲動至底端"
 
@@ -1209,16 +1218,16 @@ msgstr "使用者輸入"
 msgid "Value"
 msgstr "值"
 
-msgid "View All Jobs"
+msgid "View all jobs"
 msgstr ""
 
-msgid "View Finished Jobs"
+msgid "View finished jobs"
 msgstr ""
 
-msgid "View Running Jobs"
+msgid "View running jobs"
 msgstr ""
 
-msgid "View Scheduled Jobs"
+msgid "View scheduled jobs"
 msgstr ""
 
 msgid "Web Console"
@@ -1364,12 +1373,3 @@ msgstr ""
 
 msgid "using Smart Proxy"
 msgstr ""
-
-msgid "»Action with sub plans«"
-msgstr ""
-
-msgid "»Import Puppet classes«"
-msgstr ""
-
-msgid "»Import facts«"
-msgstr ""

data/test/unit/api_params_test.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+class ApiParamsTest < ActiveSupport::TestCase
+  describe '#format_datetime' do
+    let(:params) { JobInvocationComposer::ApiParams.allocate }
+
+    it 'leaves empty string as is' do
+      assert_equal params.send(:format_datetime, ''), ''
+    end
+
+    it 'honors explicitly supplied time zone' do
+      in_time_zone(ActiveSupport::TimeZone['America/New_York']) do
+        assert_equal '2022-07-08 08:53', params.send(:format_datetime, '2022-07-08 12:53:20 UTC')
+      end
+    end
+
+    it 'implicitly honors current user\'s time zone' do
+      in_time_zone(ActiveSupport::TimeZone['America/New_York']) do
+        assert_equal '2022-07-08 12:53', params.send(:format_datetime, '2022-07-08 12:53:20')
+      end
+    end
+  end
+
+  def in_time_zone(zone)
+    old_tz = Time.zone
+    Time.zone = zone
+    yield
+  ensure
+    Time.zone = old_tz
+  end
+end

data/test/unit/remote_execution_provider_test.rb

@@ -33,6 +33,10 @@ class RemoteExecutionProviderTest < ActiveSupport::TestCase
     it 'accepts strings' do
       RemoteExecutionProvider.provider_for('SSH').must_equal SSHExecutionProvider
     end
+
+    it 'returns a default one if unknown value is provided' do
+      RemoteExecutionProvider.provider_for('WinRM').must_equal ScriptExecutionProvider
+    end
   end
 
   describe '.provider_names' do
@@ -52,6 +56,28 @@ class RemoteExecutionProviderTest < ActiveSupport::TestCase
     end
   end
 
+  describe '.provider_proxy_features' do
+    it 'returns correct values' do
+      RemoteExecutionProvider.stubs(:providers).returns(
+        :SSH => SSHExecutionProvider,
+        :script => ScriptExecutionProvider
+      )
+
+      features = RemoteExecutionProvider.provider_proxy_features
+      _(features).must_include 'SSH'
+      _(features).must_include 'Script'
+      RemoteExecutionProvider.unstub(:providers)
+    end
+
+    it 'can deal with non-arrays' do
+      provider = OpenStruct.new(proxy_feature: 'Testing')
+      RemoteExecutionProvider.stubs(:providers).returns(:testing => provider)
+      features = RemoteExecutionProvider.provider_proxy_features
+      _(features).must_include 'Testing'
+      RemoteExecutionProvider.unstub(:providers)
+    end
+  end
+
   describe '.host_setting' do
     let(:host) { FactoryBot.create(:host) }
 

data/webpack/JobWizard/JobWizardConstants.js

@@ -19,9 +19,9 @@ export const repeatTypes = {
 export const WIZARD_TITLES = {
   categoryAndTemplate: __('Category and Template'),
   hostsAndInputs: __('Target hosts and inputs'),
-  advanced: __('Advanced Fields'),
+  advanced: __('Advanced fields'),
   schedule: __('Schedule'),
-  review: __('Review Details'),
+  review: __('Review details'),
 };
 
 export const initialScheduleState = {

data/webpack/JobWizard/__tests__/fixtures.js

@@ -193,7 +193,11 @@ export const gqlMock = [
       data: {
         hosts: {
           totalCount: 3,
-          nodes: [{ name: 'host1' }, { name: 'host2' }, { name: 'host3' }],
+          nodes: [
+            { id: 'MDE6SG9zdC0x', name: 'host1' },
+            { id: 'MDE6SG9zdC0y', name: 'host2' },
+            { id: 'MDE6SG9zdC0z', name: 'host3' },
+          ],
         },
       },
     },
@@ -211,9 +215,9 @@ export const gqlMock = [
         hostgroups: {
           totalCount: 3,
           nodes: [
-            { name: 'host_group1' },
-            { name: 'host_group2' },
-            { name: 'host_group3' },
+            { id: 'MDE6SG9zdGdyb3VwLTE=', name: 'host_group1' },
+            { id: 'MDE6SG9zdGdyb3VwLTI=', name: 'host_group2' },
+            { id: 'MDE6SG9zdGdyb3VwLTM=', name: 'host_group3' },
           ],
         },
       },

data/webpack/JobWizard/steps/AdvancedFields/AdvancedFields.js

@@ -16,6 +16,7 @@ import {
   TimeSpanLevelField,
   TemplateInputsFields,
   ExecutionOrderingField,
+  SSHUserField,
 } from './Fields';
 import { DescriptionField } from './DescriptionField';
 import { WIZARD_TITLES } from '../../JobWizardConstants';
@@ -40,6 +41,14 @@ export const AdvancedFields = ({
           value={advancedValues.templateValues}
           setValue={newValue => setAdvancedValues({ templateValues: newValue })}
         />
+        <SSHUserField
+          value={advancedValues.sshUser}
+          setValue={newValue =>
+            setAdvancedValues({
+              sshUser: newValue,
+            })
+          }
+        />
         {effectiveUser?.overridable && (
           <EffectiveUserField
             value={advancedValues.effectiveUserValue}

data/webpack/JobWizard/steps/AdvancedFields/Fields.js

@@ -203,6 +203,24 @@ export const ExecutionOrderingField = ({ isRandomizedOrdering, setValue }) => (
 export const TemplateInputsFields = ({ inputs, value, setValue }) => (
   <>{inputs?.map(input => formatter(input, value, setValue))}</>
 );
+
+export const SSHUserField = ({ value, setValue }) => (
+  <FormGroup
+    label={__('SSH user')}
+    labelIcon={helpLabel(__('A user to be used for SSH.'), 'ssh-user')}
+    fieldId="ssh-user"
+  >
+    <TextInput
+      aria-label="ssh user"
+      autoComplete="ssh-user"
+      id="ssh-user"
+      type="text"
+      value={value}
+      onChange={newValue => setValue(newValue)}
+    />
+  </FormGroup>
+);
+
 EffectiveUserField.propTypes = {
   value: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
   setValue: PropTypes.func.isRequired,
@@ -240,3 +258,6 @@ TemplateInputsFields.propTypes = {
 TemplateInputsFields.defaultProps = {
   value: {},
 };
+
+SSHUserField.propTypes = EffectiveUserField.propTypes;
+SSHUserField.defaultProps = EffectiveUserField.defaultProps;

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

@@ -143,7 +143,7 @@ describe('AdvancedFields', () => {
     );
 
     await act(async () => {
-      fireEvent.click(screen.getByText('Advanced Fields'));
+      fireEvent.click(screen.getByText('Advanced fields'));
     });
     expect(textField.value).toBe(textValue);
     expect(searchField.value).toBe(searchValue);
@@ -162,9 +162,14 @@ describe('AdvancedFields', () => {
       </MockedProvider>
     );
     await act(async () => {
-      fireEvent.click(screen.getByText('Advanced Fields'));
+      fireEvent.click(screen.getByText('Advanced fields'));
     });
 
+    expect(
+      screen.getByLabelText('ssh user', {
+        selector: 'input',
+      }).value
+    ).toBe('');
     expect(
       screen.getByLabelText('effective user', {
         selector: 'input',

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

@@ -5,6 +5,7 @@ import {
   useForemanOrganization,
   useForemanLocation,
 } from 'foremanReact/Root/Context/ForemanContext';
+import { decodeId } from 'foremanReact/common/globalIdHelpers';
 import { HOSTS, HOST_GROUPS, dataName } from '../../JobWizardConstants';
 import { SearchSelect } from '../form/SearchSelect';
 import hostsQuery from './hosts.gql';
@@ -35,7 +36,7 @@ export const useNameSearchGQL = apiKey => {
       subtotal: data?.[dataName[apiKey]]?.totalCount,
       results:
         data?.[dataName[apiKey]]?.nodes.map(node => ({
-          id: node.name,
+          id: decodeId(node.id),
           name: node.name,
         })) || [],
     },

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

@@ -15,7 +15,7 @@ const SelectedChip = ({ selected, setSelected, categoryName }) => {
       {selected.map(({ name, id }, index) => (
         <Chip
           key={index}
-          id={id}
+          id={`${categoryName}-${id}`}
           onClick={() => deleteItem(id)}
           closeBtnAriaLabel={`Close ${name}`}
         >

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

@@ -1,6 +1,6 @@
 export const buildHostQuery = (selected, search) => {
   const { hosts, hostCollections, hostGroups } = selected;
-  const hostsSearch = `(name ^ (${hosts.map(({ id }) => id).join(',')}))`;
+  const hostsSearch = `(id ^ (${hosts.map(({ id }) => id).join(',')}))`;
   const hostCollectionsSearch = `(host_collection_id ^ (${hostCollections
     .map(({ id }) => id)
     .join(',')}))`;

data/webpack/JobWizard/steps/HostsAndInputs/hostgroups.gql

@@ -2,6 +2,7 @@ query($search: String!) {
   hostgroups(first: 100, last: 100, search: $search) {
     totalCount
     nodes {
+      id
       name
     }
   }

data/webpack/JobWizard/steps/HostsAndInputs/hosts.gql

@@ -2,6 +2,7 @@ query($search: String!) {
   hosts(first: 100, last: 100, search: $search) {
     totalCount
     nodes {
+      id
       name
     }
   }

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

@@ -72,7 +72,7 @@ const ReviewDetails = ({
   };
   const [isAdvancedShown, setIsAdvancedShown] = useState(false);
   const detailsFirstHalf = [
-    { label: __('Job Category'), value: jobCategory },
+    { label: __('Job category'), value: jobCategory },
     { label: __('Job template'), value: jobTemplate },
     { label: __('Target hosts'), value: stringHosts() },
     ...templateInputs.map(({ name }) => ({
@@ -125,6 +125,7 @@ const ReviewDetails = ({
   ].filter(d => d);
 
   const advancedFields = [
+    { label: __('SSH user'), value: advancedValues.sshUser },
     { label: __('Effective user'), value: advancedValues.effectiveUserValue },
     { label: __('Description Template'), value: advancedValues.description },
     { label: __('Timeout to kill'), value: advancedValues.timeoutToKill },

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

@@ -186,7 +186,7 @@ describe('Schedule', () => {
     expect(
       screen.getByPlaceholderText('Repeat N times').hasAttribute('disabled')
     ).toBeTruthy();
-    expect(screen.getByText('Review Details').disabled).toBeFalsy();
+    expect(screen.getByText('Review details').disabled).toBeFalsy();
     await act(async () => {
       fireEvent.click(
         screen.getByLabelText('Does not repeat', { selector: 'button' })
@@ -196,7 +196,7 @@ describe('Schedule', () => {
     await act(async () => {
       fireEvent.click(screen.getByText('Cronline'));
     });
-    expect(screen.getByText('Review Details').disabled).toBeTruthy();
+    expect(screen.getByText('Review details').disabled).toBeTruthy();
     const newRepeatTimes = '3';
     const repeatNTimes = screen.getByPlaceholderText('Repeat N times');
     expect(repeatNTimes.value).toBe('');
@@ -216,7 +216,7 @@ describe('Schedule', () => {
       });
     });
     expect(cronline.value).toBe(newCronline);
-    expect(screen.getByText('Review Details').disabled).toBeFalsy();
+    expect(screen.getByText('Review details').disabled).toBeFalsy();
 
     await act(async () => {
       fireEvent.click(screen.getByText('Category and Template'));
@@ -236,7 +236,7 @@ describe('Schedule', () => {
       fireEvent.click(screen.getByText('Monthly'));
     });
 
-    expect(screen.getByText('Review Details').disabled).toBeTruthy();
+    expect(screen.getByText('Review details').disabled).toBeTruthy();
     const newDays = '1,2,3';
     const days = screen.getByLabelText('days');
     expect(days.value).toBe('');
@@ -248,7 +248,7 @@ describe('Schedule', () => {
     });
     expect(days.value).toBe(newDays);
 
-    expect(screen.getByText('Review Details').disabled).toBeTruthy();
+    expect(screen.getByText('Review details').disabled).toBeTruthy();
     const newAtMonthly = '13:07';
     const at = () => screen.getByLabelText('repeat-at');
     expect(at().value).toBe('');
@@ -259,13 +259,13 @@ describe('Schedule', () => {
     });
     expect(at().value).toBe(newAtMonthly);
 
-    expect(screen.getByText('Review Details').disabled).toBeFalsy();
+    expect(screen.getByText('Review details').disabled).toBeFalsy();
     fireEvent.click(screen.getByText('Monthly'));
     await act(async () => {
       fireEvent.click(screen.getByText('Weekly'));
     });
 
-    expect(screen.getByText('Review Details').disabled).toBeTruthy();
+    expect(screen.getByText('Review details').disabled).toBeTruthy();
     const dayTue = screen.getByLabelText('Tue checkbox');
     const daySat = screen.getByLabelText('Sat checkbox');
     expect(dayTue.checked).toBe(false);
@@ -293,19 +293,19 @@ describe('Schedule', () => {
     });
     expect(at().value).toBe(newAtWeekly);
 
-    expect(screen.getByText('Review Details').disabled).toBeFalsy();
+    expect(screen.getByText('Review details').disabled).toBeFalsy();
     fireEvent.click(screen.getByText('Weekly'));
     await act(async () => {
       fireEvent.click(screen.getByText('Daily'));
     });
 
-    expect(screen.getByText('Review Details').disabled).toBeFalsy();
+    expect(screen.getByText('Review details').disabled).toBeFalsy();
     await act(async () => {
       fireEvent.change(at(), {
         target: { value: '' },
       });
     });
-    expect(screen.getByText('Review Details').disabled).toBeTruthy();
+    expect(screen.getByText('Review details').disabled).toBeTruthy();
     const newAtDaily = '17:07';
     expect(at().value).toBe('');
     await act(async () => {
@@ -314,14 +314,14 @@ describe('Schedule', () => {
       });
     });
     expect(at().value).toBe(newAtDaily);
-    expect(screen.getByText('Review Details').disabled).toBeFalsy();
+    expect(screen.getByText('Review details').disabled).toBeFalsy();
 
     fireEvent.click(screen.getByText('Daily'));
     await act(async () => {
       fireEvent.click(screen.getByText('Hourly'));
     });
 
-    expect(screen.getByText('Review Details').disabled).toBeTruthy();
+    expect(screen.getByText('Review details').disabled).toBeTruthy();
     const newMinutes = '6';
     const atHourly = screen.getByLabelText('repeat-at-minute-typeahead');
     expect(atHourly.value).toBe('');
@@ -331,7 +331,7 @@ describe('Schedule', () => {
     await act(async () => {
       fireEvent.click(screen.getByText(newMinutes));
     });
-    expect(screen.getByText('Review Details').disabled).toBeFalsy();
+    expect(screen.getByText('Review details').disabled).toBeFalsy();
     expect(atHourly.value).toBe(newMinutes);
   });
   it('should show invalid error on start date after end', async () => {
@@ -353,7 +353,7 @@ describe('Schedule', () => {
     expect(
       screen.queryAllByText('End time needs to be after start time')
     ).toHaveLength(0);
-    expect(screen.getByText('Review Details').disabled).toBeFalsy();
+    expect(screen.getByText('Review details').disabled).toBeFalsy();
     await act(async () => {
       await fireEvent.change(startsDateField, {
         target: { value: '2020/10/15' },
@@ -368,7 +368,7 @@ describe('Schedule', () => {
       screen.queryAllByText('End time needs to be after start time')
     ).toHaveLength(1);
 
-    expect(screen.getByText('Review Details').disabled).toBeTruthy();
+    expect(screen.getByText('Review details').disabled).toBeTruthy();
   });
   it('purpose and ends should be disabled when no reaccurence ', async () => {
     render(

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

@@ -93,7 +93,6 @@ export const SearchSelect = ({
         autoSearch(value || '');
       }}
       placeholderText={placeholderText}
-      onFilter={() => null} // https://github.com/patternfly/patternfly-react/issues/6321
       typeAheadAriaLabel={`${name} typeahead input`}
     >
       {selectOptions}

data/webpack/JobWizard/submit.js

@@ -23,6 +23,7 @@ export const submit = ({
     purpose,
   } = scheduleValue;
   const {
+    sshUser,
     effectiveUserValue,
     effectiveUserPassword,
     description,
@@ -64,6 +65,7 @@ export const submit = ({
         : 'dynamic_query',
       randomized_ordering: isRandomizedOrdering,
       inputs: { ...templateValues, ...advancedTemplateValues },
+      ssh_user: sshUser,
       ssh: {
         effective_user: effectiveUserValue,
         effective_user_password: effectiveUserPassword,

data/webpack/__mocks__/foremanReact/common/globalIdHelpers.js

@@ -0,0 +1 @@
+export const decodeId = whatever => whatever;

data/webpack/global_index.js

@@ -1,14 +1,8 @@
 import { registerRoutes } from 'foremanReact/routes/RoutingService';
 import routes from './Routes/routes';
-import fillregistrationAdvanced from './react_app/extend/fillregistrationAdvanced';
-import fillRecentJobsCard from './react_app/extend/fillRecentJobsCard';
-import fillFeaturesDropdown from './react_app/extend/fillRexFeaturesDropdown';
-import fillKebabItems from './react_app/extend/fillKebabItems';
 import registerReducers from './react_app/extend/reducers';
+import registerFills from './react_app/extend/Fills';
 
 registerReducers();
 registerRoutes('foreman_remote_execution', routes);
-fillFeaturesDropdown();
-fillRecentJobsCard();
-fillregistrationAdvanced();
-fillKebabItems();
+registerFills();

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

@@ -52,7 +52,7 @@ const FeaturesDropdown = ({ hostId }) => {
       toggle={
         <DropdownToggle
           splitButtonItems={scheduleJob}
-          toggleVariant="primary"
+          toggleVariant="secondary"
           onToggle={() => setIsOpen(prev => !prev)}
           isDisabled={status === STATUS.PENDING}
           splitButtonVariant="action"

data/webpack/react_app/components/HostKebab/KebabItems.js

@@ -13,7 +13,12 @@ const HostKebabItems = () => {
 
   if (!consoleUrl) return null;
   return (
-    <DropdownItem icon={<CodeIcon />} href={consoleUrl}>
+    <DropdownItem
+      icon={<CodeIcon />}
+      href={consoleUrl}
+      target="_blank"
+      rel="noreferrer"
+    >
       {__('Web Console')}
     </DropdownItem>
   );

data/webpack/react_app/components/RecentJobsCard/RecentJobsCard.js

@@ -28,7 +28,7 @@ const RecentJobsCard = ({ hostDetails: { name, id } }) => {
           href={foremanUrl(`${JOB_BASE_URL}${name}`)}
           key="link-to-all"
         >
-          {__('View All Jobs')}
+          {__('View all jobs')}
         </DropdownItem>,
         <DropdownItem
           href={foremanUrl(
@@ -36,19 +36,19 @@ const RecentJobsCard = ({ hostDetails: { name, id } }) => {
           )}
           key="link-to-finished"
         >
-          {__('View Finished Jobs')}
+          {__('View finished jobs')}
         </DropdownItem>,
         <DropdownItem
           href={foremanUrl(`${JOB_BASE_URL}${name}+and+status+%3D+running`)}
           key="link-to-running"
         >
-          {__('View Running Jobs')}
+          {__('View running jobs')}
         </DropdownItem>,
         <DropdownItem
           href={foremanUrl(`${JOB_BASE_URL}${name}+and+status+%3D+queued`)}
           key="link-to-scheduled"
         >
-          {__('View Scheduled Jobs')}
+          {__('View scheduled jobs')}
         </DropdownItem>,
       ]}
     >

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

@@ -1 +1,2 @@
 export const TARGETING_HOSTS = 'TARGETING_HOSTS';
+export const TARGETING_HOSTS_AUTOCOMPLETE = 'targeting_hosts_search';