foreman_remote_execution 8.0.0 → 8.1.0

data/lib/foreman_remote_execution/tasks/explain_proxy_selection.rake

@@ -0,0 +1,131 @@
+namespace :foreman_remote_execution do
+  desc <<~DESC
+    Explains which proxies can be used for remote execution against HOST using a specified PROVIDER.
+
+      * HOST         : A scoped search query to find hosts by
+      * PROVIDER     : The PROVIDER to scope by
+      * FORMAT       : Output format, one of verbose (or unset), json, pretty-json, csv
+      * FOREMAN_USER : Run as if FOREMAN_USER triggered a job (runs as anonymous_admin if unset)
+      * ORGANIZATION : Run in the context of ORGANIZATION (runs in any context if unset)
+      * LOCATION     : Run in the context of LOCATION (runs in any context if unset)
+  DESC
+  task :explain_proxy_selection => ['environment'] do
+    options = {}
+    options[:host] = ENV['HOST']
+    options[:provider] = ENV['PROVIDER']
+
+    raise 'Environment variable HOST has to be set' unless options[:host]
+    raise 'Environment variable PROVIDER has to be set' unless options[:provider]
+
+    if ENV['FOREMAN_USER']
+      User.current = User.friendly.find(ENV['FOREMAN_USER'])
+    else
+      User.current = User.anonymous_admin
+    end
+    Location.current = Location.friendly.find(ENV['LOCATION']) if ENV['LOCATION']
+    Organization.current = Organization.friendly.find(ENV['ORGANIZATION']) if ENV['ORGANIZATION']
+
+    selector = ::RemoteExecutionProxySelector.new
+
+    results = Host.search_for(options[:host]).map do |host|
+      host_base = { :host => host }
+      proxies = selector.available_proxies(host, options[:provider])
+      determined_proxy = selector.determine_proxy(host, options[:provider])
+      counts = selector.instance_variable_get('@tasks')
+      counts.default = 0
+
+      strategies = selector.strategies.map do |strategy|
+        base = { :name => strategy, :enabled => !proxies[strategy].nil? }
+        next base if proxies[strategy].nil?
+
+        base.merge(:proxies =>  proxies[strategy].sort_by { |proxy| counts[proxy] }.map do |proxy|
+                                  {:proxy => proxy, :count => counts[proxy]}
+                                end)
+      end
+
+      case determined_proxy
+      when :not_defined
+        settings = {
+          global_proxy: 'remote_execution_global_proxy',
+          fallback_proxy: 'remote_execution_fallback_proxy',
+          provider: options[:provider],
+        }
+
+        host_base[:detail] = _('Could not use any proxy for the %{provider} job. Consider configuring %{global_proxy}, ' +
+                               '%{fallback_proxy} in settings') % settings
+      when :not_available
+        offline_proxies = selector.offline
+        settings = { :count => offline_proxies.count, :proxy_names => offline_proxies.map(&:name).join(', ') }
+        host_base[:detail] = n_('The only applicable proxy %{proxy_names} is down',
+          'All %{count} applicable proxies are down. Tried %{proxy_names}',
+          offline_proxies.count) % settings
+      else
+        winning_strategy = selector.strategies.find { |strategy| !proxies[strategy].empty? && proxies[strategy].include?(determined_proxy) }
+      end
+
+      {
+        :host => host,
+        :strategies => strategies,
+        :selected_proxy => determined_proxy,
+        :winning_strategy => winning_strategy,
+      }
+    end
+
+    case ENV['FORMAT']
+    when nil, 'verbose'
+      output_verbose(results, options[:provider])
+    when 'csv'
+      require 'csv'
+      output_csv(results)
+    when 'json'
+      require 'json'
+      puts JSON.generate(results)
+    when 'pretty-json'
+      require 'json'
+      puts JSON.pretty_generate(results)
+    end
+  end
+
+  def output_verbose(results, provider)
+    errors = [:not_defined, :not_available]
+
+    results.each do |host|
+      puts "=> Host #{host[:host]}"
+      host[:strategies].each do |strategy|
+        puts "==> Strategy #{strategy[:name]}"
+        unless strategy[:enabled]
+          puts " strategy is disabled"
+          puts
+          next
+        end
+        if strategy[:proxies].empty?
+          puts " no proxies available using this strategy"
+        else
+          strategy[:proxies].each_with_index do |proxy_record, i|
+            puts " #{i + 1}) #{proxy_record[:proxy]} - #{proxy_record[:count]} tasks"
+          end
+        end
+        puts
+      end
+      if errors.include? host[:selected_proxy]
+        puts host[:detail]
+      else
+        puts "As of now, #{provider} job would use proxy #{host[:selected_proxy]}, determined by strategy #{host[:winning_strategy]}."
+      end
+      puts
+    end
+  end
+
+  def output_csv(results)
+    writer = CSV.new($stdout)
+    writer << %w(host strategy proxy)
+    results.each do |host|
+      writer << [
+        host[:host].name,
+        host[:winning_strategy],
+        host[:selected_proxy],
+      ]
+    end
+    writer.close
+  end
+end

data/lib/foreman_remote_execution/version.rb

@@ -1,3 +1,3 @@
 module ForemanRemoteExecution
-  VERSION = '8.0.0'.freeze
+  VERSION = '8.1.0'.freeze
 end

data/test/unit/remote_execution_provider_test.rb

@@ -56,6 +56,28 @@ class RemoteExecutionProviderTest < ActiveSupport::TestCase
     end
   end
 
+  describe '.proxy_feature' do
+    # rubocop:disable Naming/ConstantName
+    it 'handles provider subclasses properly' do
+      old = ::RemoteExecutionProvider
+
+      class P2 < old
+      end
+      ::RemoteExecutionProvider = P2
+
+      class CustomProvider < ::RemoteExecutionProvider
+      end
+
+      ::RemoteExecutionProvider.register('custom', CustomProvider)
+
+      feature = CustomProvider.proxy_feature
+      _(feature).must_equal 'custom'
+    ensure
+      ::RemoteExecutionProvider = old
+    end
+    # rubocop:enable Naming/ConstantName
+  end
+
   describe '.provider_proxy_features' do
     it 'returns correct values' do
       RemoteExecutionProvider.stubs(:providers).returns(

data/webpack/JobWizard/JobWizard.js

@@ -25,6 +25,7 @@ import {
   selectIsSubmitting,
   selectRouterSearch,
   selectIsLoading,
+  selectJobCategoriesResponse,
 } from './JobWizardSelectors';
 import { ScheduleType } from './steps/Schedule/ScheduleType';
 import { ScheduleFuture } from './steps/Schedule/ScheduleFuture';
@@ -34,13 +35,18 @@ import ReviewDetails from './steps/ReviewDetails/';
 import { useValidation } from './validation';
 import { useAutoFill } from './autofill';
 import { submit } from './submit';
+import { generateDefaultDescription } from './JobWizardHelpers';
 import './JobWizard.scss';
 
 export const JobWizard = ({ rerunData }) => {
+  const jobCategoriesResponse = useSelector(selectJobCategoriesResponse);
   const [jobTemplateID, setJobTemplateID] = useState(
-    rerunData?.template_invocations?.[0]?.template_id
+    rerunData?.template_invocations?.[0]?.template_id ||
+      jobCategoriesResponse?.default_template
+  );
+  const [category, setCategory] = useState(
+    rerunData?.job_category || jobCategoriesResponse?.default_category || ''
   );
-  const [category, setCategory] = useState(rerunData?.job_category || '');
   const [advancedValues, setAdvancedValues] = useState({ templateValues: {} });
   const [templateValues, setTemplateValues] = useState({}); // TODO use templateValues in advanced fields - description https://github.com/theforeman/foreman_remote_execution/pull/605
   const [scheduleValue, setScheduleValue] = useState(initialScheduleState);
@@ -56,6 +62,7 @@ export const JobWizard = ({ rerunData }) => {
       ? {
           search: rerunData?.targeting?.search_query,
           ...rerunData.inputs,
+          ...routerSearch,
         }
       : routerSearch
   );
@@ -70,6 +77,7 @@ export const JobWizard = ({ rerunData }) => {
         job_template: {
           name,
           execution_timeout_interval,
+          time_to_pickup,
           description_format,
           job_category,
         },
@@ -78,8 +86,8 @@ export const JobWizard = ({ rerunData }) => {
         concurrency_control = {},
       },
     }) => {
-      if (!category.length) {
-        setCategory(current => (current.length ? current : job_category));
+      if (category !== job_category) {
+        setCategory(job_category);
       }
       const advancedTemplateValues = {};
       const defaultTemplateValues = {};
@@ -101,21 +109,19 @@ export const JobWizard = ({ rerunData }) => {
               currentAdvancedValues[input.name] || input?.default || '';
           });
         }
-        const generateDefaultDescription = () => {
-          if (description_format) return description_format;
-          const allInputs = [...advancedInputs, ...inputs];
-          if (!allInputs.length) return name;
-          const inputsString = allInputs
-            .map(({ name: inputname }) => `${inputname}="%{${inputname}}"`)
-            .join(' ');
-          return `${name} with inputs ${inputsString}`;
-        };
         return {
           ...currentAdvancedValues,
           effectiveUserValue: effective_user?.value || '',
           timeoutToKill: execution_timeout_interval || '',
+          timeToPickup: time_to_pickup || '',
           templateValues: advancedTemplateValues,
-          description: generateDefaultDescription() || '',
+          description:
+            generateDefaultDescription({
+              description_format,
+              advancedInputs,
+              inputs,
+              name,
+            }) || '',
           isRandomizedOrdering: randomized_ordering,
           sshUser: ssh_user || '',
           timeSpan: concurrency_control.time_span || '',
@@ -123,6 +129,7 @@ export const JobWizard = ({ rerunData }) => {
         };
       });
     },
+    // eslint-disable-next-line react-hooks/exhaustive-deps
     [category.length]
   );
   useEffect(() => {
@@ -134,6 +141,9 @@ export const JobWizard = ({ rerunData }) => {
           },
           job_template: {
             execution_timeout_interval: rerunData.execution_timeout_interval,
+            description_format: rerunData.description_format,
+            job_category: rerunData.job_category,
+            time_to_pickup: rerunData.time_to_pickup,
           },
           randomized_ordering: rerunData.targeting.randomized_ordering,
           ssh_user: rerunData.ssh_user,
@@ -141,18 +151,39 @@ export const JobWizard = ({ rerunData }) => {
         },
       });
     }
-  }, [rerunData, setDefaults]);
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [rerunData]);
   useEffect(() => {
     if (jobTemplateID) {
       dispatch(
         get({
           key: JOB_TEMPLATE,
           url: `/ui_job_wizard/template/${jobTemplateID}`,
-          handleSuccess: rerunData ? () => {} : setDefaults,
+          handleSuccess: rerunData
+            ? ({
+                data: {
+                  template_inputs = [],
+                  advanced_template_inputs = [],
+                  job_template: { name, description_format },
+                },
+              }) => {
+                setAdvancedValues(currentAdvancedValues => ({
+                  ...currentAdvancedValues,
+                  description:
+                    generateDefaultDescription({
+                      description_format,
+                      advancedInputs: advanced_template_inputs,
+                      inputs: template_inputs,
+                      name,
+                    }) || '',
+                }));
+              }
+            : setDefaults,
         })
       );
     }
-  }, [rerunData, jobTemplateID, setDefaults, dispatch]);
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [rerunData, jobTemplateID, dispatch]);
 
   const [valid, setValid] = useValidation({
     advancedValues,
@@ -187,7 +218,9 @@ export const JobWizard = ({ rerunData }) => {
           setJobTemplate={setJobTemplateID}
           category={category}
           setCategory={setCategory}
-          isCategoryPreselected={!!rerunData || !!fills.feature}
+          isCategoryPreselected={
+            !!rerunData || !!fills.feature || !!fills.template_id
+          }
         />
       ),
       enableNext: isTemplate,
@@ -370,6 +403,7 @@ JobWizard.propTypes = {
       time_span: PropTypes.number,
     }),
     execution_timeout_interval: PropTypes.number,
+    time_to_pickup: PropTypes.number,
     remote_execution_feature_id: PropTypes.string,
     template_invocations: PropTypes.arrayOf(
       PropTypes.shape({
@@ -379,6 +413,7 @@ JobWizard.propTypes = {
       })
     ),
     inputs: PropTypes.object,
+    description_format: PropTypes.string,
   }),
 };
 JobWizard.defaultProps = {

data/webpack/JobWizard/JobWizard.scss

@@ -145,6 +145,9 @@
   .pf-c-radio__body {
     font-size: var(--pf-c-radio__label--FontSize);
   }
+  .reset-default{
+    padding-bottom: 0;
+  }
 }
 
 .job-wizard-alert.pf-c-alert.pf-m-warning {

data/webpack/JobWizard/JobWizardConstants.js

@@ -64,7 +64,7 @@ export const dataName = {
 };
 export const HOSTS_TO_PREVIEW_AMOUNT = 20;
 
-export const DEBOUNCE_HOST_COUNT = 700;
+export const DEBOUNCE_API = 1500;
 export const HOST_IDS = 'HOST_IDS';
 export const REX_FEATURE = 'REX_FEATURE';
 

data/webpack/JobWizard/JobWizardHelpers.js

@@ -0,0 +1,15 @@
+/* eslint-disable camelcase */
+export const generateDefaultDescription = ({
+  description_format,
+  advancedInputs,
+  inputs,
+  name,
+}) => {
+  if (description_format) return description_format;
+  const allInputs = [...advancedInputs, ...inputs];
+  if (!allInputs.length) return name;
+  const inputsString = allInputs
+    .map(({ name: inputname }) => `${inputname}="%{${inputname}}"`)
+    .join(' ');
+  return `${name} with inputs ${inputsString}`;
+};

data/webpack/JobWizard/JobWizardPageRerun.js

@@ -1,7 +1,15 @@
 import React from 'react';
 import PropTypes from 'prop-types';
 import URI from 'urijs';
-import { Alert, Title, Divider, Skeleton } from '@patternfly/react-core';
+import {
+  Alert,
+  Title,
+  Divider,
+  Skeleton,
+  Flex,
+  FlexItem,
+  Button,
+} from '@patternfly/react-core';
 import { sprintf, translate as __ } from 'foremanReact/common/I18n';
 import { useAPI } from 'foremanReact/common/hooks/API/APIHooks';
 import PageLayout from 'foremanReact/routes/common/PageLayout/PageLayout';
@@ -31,7 +39,7 @@ const JobWizardPageRerun = ({
   const title = __('Run job');
   const breadcrumbOptions = {
     breadcrumbItems: [
-      { caption: __('Jobs'), url: `/jobs` },
+      { caption: __('Jobs'), url: `/job_invocations` },
       { caption: title },
     ],
   };
@@ -48,9 +56,25 @@ const JobWizardPageRerun = ({
       searchable={false}
     >
       <React.Fragment>
-        <Title headingLevel="h2" size="2xl">
-          {title}
-        </Title>
+        <React.Fragment>
+          <Flex>
+            <FlexItem>
+              <Title headingLevel="h2" size="2xl">
+                {title}
+              </Title>
+            </FlexItem>
+            <FlexItem align={{ default: 'alignRight' }}>
+              <Button
+                variant="link"
+                component="a"
+                href={`/old/job_invocations/${id}/rerun${search}`}
+              >
+                {__('Use old form')}
+              </Button>
+            </FlexItem>
+          </Flex>
+          <Divider component="div" />
+        </React.Fragment>
         {!status || status === STATUS.PENDING ? (
           <div style={{ height: '400px' }}>
             <Skeleton

data/webpack/JobWizard/JobWizardSelectors.js

@@ -24,11 +24,17 @@ export const filterJobTemplates = templates =>
 export const selectJobTemplates = state =>
   filterJobTemplates(selectAPIResponse(state, JOB_TEMPLATES)?.results);
 
+export const selectJobTemplatesSearch = state =>
+  selectAPIResponse(state, JOB_TEMPLATES)?.search;
+
+export const selectJobCategoriesResponse = state =>
+  selectAPIResponse(state, JOB_CATEGORIES) || {};
+
 export const selectJobCategories = state =>
-  selectAPIResponse(state, JOB_CATEGORIES).job_categories || [];
+  selectJobCategoriesResponse(state).job_categories || [];
 
 export const selectWithKatello = state =>
-  selectAPIResponse(state, JOB_CATEGORIES).with_katello || false;
+  selectJobCategoriesResponse(state).with_katello || false;
 
 export const selectJobCategoriesStatus = state =>
   selectAPIStatus(state, JOB_CATEGORIES);

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

@@ -64,6 +64,11 @@ describe('Job wizard fill', () => {
         selector: 'input',
       }).value
     ).toBe('1');
+    expect(
+      screen.getByLabelText('time to pickup', {
+        selector: 'input',
+      }).value
+    ).toBe('25');
 
     expect(
       screen.getByLabelText('Concurrency level', {

data/webpack/JobWizard/__tests__/fixtures.js

@@ -1,3 +1,4 @@
+/* eslint-disable max-lines */
 import configureMockStore from 'redux-mock-store';
 import hostsQuery from '../steps/HostsAndInputs/hosts.gql';
 import hostgroupsQuery from '../steps/HostsAndInputs/hostgroups.gql';
@@ -14,6 +15,18 @@ export const jobTemplate = {
   execution_timeout_interval: 2,
   description: null,
 };
+export const pupptetJobTemplate = {
+  id: 163,
+  name: 'Puppet Agent Disable - Script Default',
+  template:
+    '<% if @host.operatingsystem.family == \'Debian\' -%>\nexport PATH=/opt/puppetlabs/bin:$PATH\n<% end -%>\npuppet agent --disable "<%= input("comment").present? ? input("comment") : "Disabled using Foreman Remote Execution"  %> - <%= current_user %> - $(date "+%d/%m/%Y %H:%M")"',
+  snippet: false,
+  default: true,
+  job_category: 'Puppet',
+  provider_type: 'script',
+  execution_timeout_interval: 2,
+  description: null,
+};
 
 export const jobTemplates = [jobTemplate];
 
@@ -120,6 +133,7 @@ export const testSetup = (selectors, api) => {
   selectors.selectJobCategories.mockImplementation(() => jobCategories);
   selectors.selectJobTemplates.mockImplementation(() => [
     jobTemplate,
+    pupptetJobTemplate,
     { ...jobTemplate, id: 2, name: 'template2' },
   ]);
   selectors.selectJobTemplate.mockImplementation(() => jobTemplateResponse);
@@ -164,12 +178,21 @@ export const mockApi = api => {
     } else if (action.key === 'JOB_TEMPLATE') {
       handleSuccess &&
         handleSuccess({
-          data: jobTemplateResponse,
+          data:
+            action.url === '/ui_job_wizard/template/163'
+              ? { ...jobTemplateResponse, job_template: pupptetJobTemplate }
+              : jobTemplateResponse,
         });
     } else if (action.key === 'JOB_TEMPLATES') {
       handleSuccess &&
         handleSuccess({
-          data: { results: [jobTemplate] },
+          data: {
+            results:
+              action.url.search() ===
+              '?search=job_category%3D%22Puppet%22&per_page=all'
+                ? [pupptetJobTemplate]
+                : [jobTemplate],
+          },
         });
     } else if (action.key === 'HOST_IDS') {
       handleSuccess &&
@@ -252,6 +275,7 @@ export const jobInvocation = {
       time_span: 4,
     },
     execution_timeout_interval: 1,
+    time_to_pickup: 25,
     remote_execution_feature_id: null,
     template_invocations: [
       {

data/webpack/JobWizard/autofill.js

@@ -17,19 +17,30 @@ export const useAutoFill = ({
 
   useEffect(() => {
     if (Object.keys(fills).length) {
-      const { 'host_ids[]': hostIds, search, feature, ...rest } = { ...fills };
+      const {
+        'host_ids[]': hostIds,
+        search,
+        feature,
+        template_id: templateID,
+        ...rest
+      } = { ...fills };
       setFills({});
       if (hostIds) {
+        const hostSearch = Array.isArray(hostIds)
+          ? `id = ${hostIds.join(' or id = ')}`
+          : `id = ${hostIds}`;
         dispatch(
           get({
             key: HOST_IDS,
             url: '/api/hosts',
-            params: { search: `id = ${hostIds.join(' or id = ')}` },
+            params: {
+              search: hostSearch,
+            },
             handleSuccess: ({ data }) => {
               setSelectedTargets(currentTargets => ({
                 ...currentTargets,
-                hosts: (data.results || []).map(({ name }) => ({
-                  id: name,
+                hosts: (data.results || []).map(({ id, name }) => ({
+                  id,
                   name,
                 })),
               }));
@@ -37,9 +48,12 @@ export const useAutoFill = ({
           })
         );
       }
-      if (search) {
+      if (search && !hostIds?.length) {
         setHostsSearchQuery(search);
       }
+      if (templateID) {
+        setJobTemplateID(+templateID);
+      }
       if (feature) {
         dispatch(
           get({
@@ -56,11 +70,19 @@ export const useAutoFill = ({
           const re = /inputs\[(?<input>.*)\]/g;
           const input = re.exec(key)?.groups?.input;
           if (input) {
-            setTemplateValues(prev => ({ ...prev, [input]: rest[key] }));
-            setAdvancedValues(prev => ({
-              ...prev,
-              templateValues: { ...prev.templateValues, [input]: rest[key] },
-            }));
+            if (typeof rest[key] === 'string') {
+              setTemplateValues(prev => ({ ...prev, [input]: rest[key] }));
+            } else {
+              const { value, advanced } = rest[key];
+              if (advanced) {
+                setAdvancedValues(prev => ({
+                  ...prev,
+                  templateValues: { ...prev.templateValues, [input]: value },
+                }));
+              } else {
+                setTemplateValues(prev => ({ ...prev, [input]: value }));
+              }
+            }
           }
         });
       }

data/webpack/JobWizard/index.js

@@ -1,14 +1,15 @@
 import React from 'react';
-import { Title, Divider } from '@patternfly/react-core';
+import PropTypes from 'prop-types';
+import { Title, Divider, Flex, FlexItem, Button } from '@patternfly/react-core';
 import { translate as __ } from 'foremanReact/common/I18n';
 import PageLayout from 'foremanReact/routes/common/PageLayout/PageLayout';
 import { JobWizard } from './JobWizard';
 
-const JobWizardPage = () => {
+const JobWizardPage = ({ location: { search } }) => {
   const title = __('Run job');
   const breadcrumbOptions = {
     breadcrumbItems: [
-      { caption: __('Jobs'), url: `/jobs` },
+      { caption: __('Jobs'), url: `/job_invocations` },
       { caption: title },
     ],
   };
@@ -19,9 +20,22 @@ const JobWizardPage = () => {
       searchable={false}
     >
       <React.Fragment>
-        <Title headingLevel="h2" size="2xl">
-          {title}
-        </Title>
+        <Flex>
+          <FlexItem>
+            <Title headingLevel="h2" size="2xl">
+              {title}
+            </Title>
+          </FlexItem>
+          <FlexItem align={{ default: 'alignRight' }}>
+            <Button
+              variant="link"
+              component="a"
+              href={`/old/job_invocations/new${search}`}
+            >
+              {__('Use legacy form')}
+            </Button>
+          </FlexItem>
+        </Flex>
         <Divider component="div" />
         <JobWizard />
       </React.Fragment>
@@ -29,4 +43,9 @@ const JobWizardPage = () => {
   );
 };
 
+JobWizardPage.propTypes = {
+  location: PropTypes.shape({
+    search: PropTypes.string,
+  }).isRequired,
+};
 export default JobWizardPage;