foreman_remote_execution 10.1.0 → 11.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25c5d179ccedf9911c0f95df7a9c020567b350a668923a589462b89d9fbe056e
-  data.tar.gz: f49191c9a787288bbf00e1049ae65aa9633fb2b06e5491eb690f463f59d29442
+  metadata.gz: '019c69e822a9bf8be86315b9cbdf83901e05e0209c115c82a815e92bf0f912e8'
+  data.tar.gz: 7349a60661ccf18d18874a4332a0267dfc535c29fc3871182898dbd8bcf70091
 SHA512:
-  metadata.gz: ece23e8faa1a113183be16083d6ffee2cfeb8d0e3c460272f9ba017f9eeac692fac95f4a7f87629cbf58d0974da039fd52e74476b05a47e029efd1f6104ed3d2
-  data.tar.gz: c4891b7a8a43ec390d7b50d1bb3a7da6b19fc667a0e53d4551dd7e235da29e1bdabcf5c431e038a386e30e43a396b06e957f0fcf1366692d786b5e8778618838
+  metadata.gz: 97ebac293e75d109be674cb5f01bf760da29d570fa1bd5de83aee24118fb2fd739b384f2b3f058d0400b9a9579e554d2cc401f5c32cd2c557e7a5d012ae4b4ef
+  data.tar.gz: 15557ecad1b8b5a702fa43c235fa381e3e5a9ce18cf9479beef39c4e93e16caf361590559930f4a23de81ef917b57e7ca2a009125e8bd8aaa63559d9a5c5e4a1

data/app/controllers/api/v2/job_invocations_controller.rb

@@ -62,7 +62,6 @@ module Api
           end
 
           param :concurrency_control, Hash, :desc => N_('Control concurrency level and distribution over time') do
-            param :time_span, Integer, :desc => N_('Distribute tasks over N seconds')
             param :concurrency_level, Integer, :desc => N_('Run at most N tasks at a time')
           end
 

data/app/graphql/types/job_invocation.rb

@@ -5,7 +5,6 @@ module Types
     global_id_field :id
     field :job_category, String
     field :description, String
-    field :time_span, Integer
     field :start_at, GraphQL::Types::ISO8601DateTime
     field :status_label, String
 

data/app/lib/actions/remote_execution/run_host_job.rb

@@ -63,7 +63,6 @@ module Actions
                                :execution_timeout_interval => job_invocation.execution_timeout_interval,
                                :secrets => secrets(host, job_invocation, provider),
                                :use_batch_triggering => true,
-                               :use_concurrency_control => options[:use_concurrency_control],
                                :first_execution => first_execution,
                                :alternative_names => provider.alternative_names(host) }
         action_options = provider.proxy_command_options(template_invocation, host)

data/app/lib/actions/remote_execution/run_hosts_job.rb

@@ -1,9 +1,6 @@
 module Actions
   module RemoteExecution
     class RunHostsJob < Actions::ActionWithSubPlans
-
-      include Dynflow::Action::WithBulkSubPlans
-      include Dynflow::Action::WithPollingSubPlans
       include Actions::RecurringAction
       include Actions::ObservableAction
 
@@ -49,7 +46,7 @@ module Actions
           # composer creates just "pattern" for template_invocations because target is evaluated
           # during actual run (here) so we build template invocations from these patterns
           template_invocation = job_invocation.pattern_template_invocation_for_host(host).deep_clone
-          trigger(RunHostJob, job_invocation, host, template_invocation, proxy_selector, { :use_concurrency_control => uses_concurrency_control })
+          trigger(RunHostJob, job_invocation, host, template_invocation, proxy_selector)
         end
       end
 
@@ -60,11 +57,19 @@ module Actions
       end
 
       def trigger_remote_batch
-        batches_ready = (output[:planned_count] - output[:remote_triggered_count]) / proxy_batch_size
-        return unless batches_ready > 0
+        remaining = output[:planned_count] - output[:remote_triggered_count]
+        return if remaining.zero?
+        batches_ready = remaining / proxy_batch_size
+        if concurrency_limit
+          count = remaining
+        else
+          return unless batches_ready > 0
+          count = proxy_batch_size * batches_ready
+        end
+        batches_ready = [1, batches_ready].max
 
         plan_event(Actions::TriggerProxyBatch::TriggerNextBatch[batches_ready], nil, step_id: input[:trigger_run_step_id])
-        output[:remote_triggered_count] += proxy_batch_size * batches_ready
+        output[:remote_triggered_count] += count
       end
 
       def on_planning_finished
@@ -126,11 +131,7 @@ module Actions
       end
 
       def set_up_concurrency_control(invocation)
-        limit_concurrency_level invocation.concurrency_level unless invocation.concurrency_level.nil?
-        unless invocation.time_span.nil?
-          distribute_over_time(invocation.time_span,
-            invocation.targeting.hosts.count)
-        end
+        limit_concurrency_level! invocation.concurrency_level unless invocation.concurrency_level.nil?
       end
 
       def rescue_strategy

data/app/models/job_invocation_composer.rb

@@ -79,7 +79,6 @@ class JobInvocationComposer
 
     def concurrency_control_params
       {
-        :time_span => job_invocation_base[:time_span],
         :level => job_invocation_base[:concurrency_level],
       }
     end
@@ -175,7 +174,6 @@ class JobInvocationComposer
     def concurrency_control_params
       {
         :level => api_params.fetch(:concurrency_control, {})[:concurrency_level],
-        :time_span => api_params.fetch(:concurrency_control, {})[:time_span],
       }
     end
 
@@ -256,7 +254,6 @@ class JobInvocationComposer
     def concurrency_control_params
       {
         :level => job_invocation.concurrency_level,
-        :time_span => job_invocation.time_span,
       }
     end
 
@@ -411,7 +408,6 @@ class JobInvocationComposer
     job_invocation.triggering = build_triggering
     job_invocation.pattern_template_invocations = build_template_invocations
     job_invocation.description_format = params[:description_format]
-    job_invocation.time_span = params[:concurrency_control][:time_span].to_i if params[:concurrency_control][:time_span].present?
     job_invocation.concurrency_level = params[:concurrency_control][:level].to_i if params[:concurrency_control][:level].present?
     job_invocation.execution_timeout_interval = params[:execution_timeout_interval]
     job_invocation.password = params[:password]

data/app/views/job_invocations/_card_schedule.html.erb

@@ -1,4 +1,4 @@
-<% if job_invocation.concurrency_level || job_invocation.time_span ||
+<% if job_invocation.concurrency_level ||
     (job_invocation.task && (job_invocation.task.delayed? || job_invocation.task.recurring?)) ||
     job_invocation.execution_timeout_interval.present? %>
 <div class="card-pf card-pf-accented">
@@ -13,9 +13,6 @@
       <% if job_invocation.concurrency_level %>
         <li><b><%= _("Concurrency level limited to") %></b>: <%= job_invocation.concurrency_level %> <%= _('tasks at a time') %><br></li>
       <% end %>
-      <% if job_invocation.time_span %>
-        <li><b><%= _("Set to distribute over") %></b>: <%= job_invocation.time_span %> <%= _('seconds') %><br></li>
-      <% end %>
       <% if job_invocation.start_before %>
         <li><b><%= _("Scheduled to start before") %></b>: <%= job_invocation.start_before %><br></li>
       <% end %>

data/app/views/job_invocations/_form.html.erb

@@ -114,7 +114,6 @@
 
     <div class="advanced hidden">
       <%= number_f f, :concurrency_level, :label => _('Concurrency level'), :placeholder => 'N', :min => 1, :label_help => N_("Run at most N tasks at a time. If this is set and proxy batch triggering is enabled, then tasks are triggered on the smart proxy in batches of size 1.") %>
-      <%= number_f f, :time_span, :label => _('Time span'), :placeholder => 'N', :min => 1, :label_help => N_("Distribute execution over N seconds. If this is set and proxy batch triggering is enabled, then tasks are triggered on the smart proxy in batches of size 1.") %>
     </div>
 
     <div class="form-group advanced hidden">

data/db/migrate/{2021051713291621250977_add_host_proxy_invocations.rb → 20210517132916_add_host_proxy_invocations.rb}

@@ -1,12 +1,12 @@
 class AddHostProxyInvocations < ActiveRecord::Migration[6.0]
   def change
     # rubocop:disable Rails/CreateTableWithTimestamps
-    create_table :host_proxy_invocations do |t|
+    create_table :host_proxy_invocations, if_not_exists: true do |t|
       t.references :host, :null => false
       t.references :smart_proxy, :null => false
     end
     # rubocop:enable Rails/CreateTableWithTimestamps
 
-    add_index :host_proxy_invocations, [:host_id, :smart_proxy_id], unique: true
+    add_index :host_proxy_invocations, [:host_id, :smart_proxy_id], unique: true, if_not_exists: true
   end
 end

data/db/migrate/20230816154510_drop_time_span_from_job_invocations.rb

@@ -0,0 +1,5 @@
+class DropTimeSpanFromJobInvocations < ActiveRecord::Migration[6.0]
+  def change
+    remove_column :job_invocations, :time_span, :integer, :null => true
+  end
+end

data/foreman_remote_execution.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'deface'
   s.add_dependency 'dynflow', '>= 1.0.2', '< 2.0.0'
-  s.add_dependency 'foreman-tasks', '>= 7.1.0'
+  s.add_dependency 'foreman-tasks', '>= 8.2.0'
 
   s.add_development_dependency 'factory_bot_rails', '~> 4.8.0'
   s.add_development_dependency 'rdoc'

data/lib/foreman_remote_execution/engine.rb

@@ -47,7 +47,7 @@ module ForemanRemoteExecution
 
     initializer 'foreman_remote_execution.register_plugin', before: :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_remote_execution do
-        requires_foreman '>= 3.7'
+        requires_foreman '>= 3.8'
         register_global_js_file 'global'
         register_gettext
 

data/lib/foreman_remote_execution/version.rb

@@ -1,3 +1,3 @@
 module ForemanRemoteExecution
-  VERSION = '10.1.0'.freeze
+  VERSION = '11.1.0'.freeze
 end

data/test/unit/actions/run_hosts_job_test.rb

@@ -122,33 +122,14 @@ module ForemanRemoteExecution
 
     describe 'concurrency control' do
       let(:level) { 5 }
-      let(:span) { 60 }
 
       it 'can be disabled' do
-        job_invocation.expects(:concurrency_level)
-        job_invocation.expects(:time_span)
-        _(planned.input.key?(:concurrency_control)).must_equal false
+        _(planned.concurrency_limit).must_equal nil
       end
 
       it 'can limit concurrency level' do
-        job_invocation.expects(:concurrency_level).returns(level).twice
-        job_invocation.expects(:time_span)
-        planned.input[:concurrency_control][:level].wont_be_empty
-        planned.input[:concurrency_control].key?(:time).must_equal false
-      end
-
-      it 'can distribute tasks over time' do
-        job_invocation.expects(:time_span).returns(span).twice
-        job_invocation.expects(:concurrency_level)
-        planned.input[:concurrency_control][:time].wont_be_empty
-        planned.input[:concurrency_control].key?(:level).must_equal false
-      end
-
-      it 'can use both' do
-        job_invocation.expects(:time_span).returns(span).twice
-        job_invocation.expects(:concurrency_level).returns(level).twice
-        planned.input[:concurrency_control][:time].wont_be_empty
-        planned.input[:concurrency_control][:level].wont_be_empty
+        job_invocation.expects(:concurrency_level).twice.returns(level)
+        _(planned.concurrency_limit).must_equal level
       end
     end
 

data/test/unit/job_invocation_composer_test.rb

@@ -458,18 +458,16 @@ class JobInvocationComposerTest < ActiveSupport::TestCase
 
         describe 'with concurrency control set' do
           let(:params) do
-            { :job_invocation => { :providers => { :ssh => ssh_params }, :concurrency_level => '5', :time_span => '60' } }.with_indifferent_access
+            { :job_invocation => { :providers => { :ssh => ssh_params }, :concurrency_level => '5' } }.with_indifferent_access
           end
 
           it 'accepts the concurrency options' do
             _(composer.job_invocation.concurrency_level).must_equal 5
-            _(composer.job_invocation.time_span).must_equal 60
           end
         end
 
         it 'can be disabled' do
           _(composer.job_invocation.concurrency_level).must_be_nil
-          _(composer.job_invocation.time_span).must_be_nil
         end
       end
 
@@ -568,7 +566,6 @@ class JobInvocationComposerTest < ActiveSupport::TestCase
             :job_invocation => {
               :providers => { :ssh => ssh_params },
               :concurrency_level => 5,
-              :time_span => 60,
             },
             :targeting => {
               :search_query => "name = #{host.name}",
@@ -607,7 +604,6 @@ class JobInvocationComposerTest < ActiveSupport::TestCase
 
         it 'sets the same concurrency control options' do
           _(new_composer.job_invocation.concurrency_level).must_equal existing.concurrency_level
-          _(new_composer.job_invocation.time_span).must_equal existing.time_span
         end
 
       end
@@ -711,22 +707,19 @@ class JobInvocationComposerTest < ActiveSupport::TestCase
 
     context 'with concurrency_control' do
       let(:level) { 5 }
-      let(:time_span) { 60 }
       let(:params) do
         { :job_category => trying_job_template_1.job_category,
           :job_template_id => trying_job_template_1.id,
           :concurrency_control => {
             :concurrency_level => level,
-            :time_span => time_span,
           },
           :targeting_type => 'static_query',
           :search_query => 'some hosts',
           :inputs => { input1.name => 'some_value' } }
       end
 
-      it 'sets the concurrency level and time span based on the input' do
+      it 'sets the concurrency level based on the input' do
         assert composer.save!
-        _(composer.job_invocation.time_span).must_equal time_span
         _(composer.job_invocation.concurrency_level).must_equal level
       end
     end

data/webpack/JobWizard/JobWizard.js

@@ -127,7 +127,6 @@ export const JobWizard = ({ rerunData }) => {
             }) || '',
           isRandomizedOrdering: randomized_ordering,
           sshUser: ssh_user || '',
-          timeSpan: concurrency_control.time_span || '',
           concurrencyLevel: concurrency_control.level || '',
         };
       });
@@ -461,7 +460,6 @@ export const JobWizard = ({ rerunData }) => {
         onClose={() => history.goBack()}
         navAriaLabel="Run Job steps"
         steps={steps}
-        height="100%"
         className="job-wizard"
         onSave={onSave}
         footer={
@@ -491,7 +489,6 @@ JobWizard.propTypes = {
     ssh_user: PropTypes.string,
     concurrency_control: PropTypes.shape({
       level: PropTypes.number,
-      time_span: PropTypes.number,
     }),
     execution_timeout_interval: PropTypes.number,
     time_to_pickup: PropTypes.number,

data/webpack/JobWizard/JobWizard.scss

@@ -11,7 +11,6 @@
   }
 
   .pf-c-wizard__main {
-    overflow: visible;
     z-index: calc(
       var(--pf-c-wizard__toggle--ZIndex) + 1
     ); // So the select box can be shown above the wizard footer and navigation toggle
@@ -127,7 +126,7 @@
   .pf-c-radio__body {
     font-size: var(--pf-c-radio__label--FontSize);
   }
-  .reset-default{
+  .reset-default {
     padding-bottom: 0;
   }
 }
@@ -135,4 +134,4 @@
 .job-wizard-alert.pf-c-alert.pf-m-warning {
   margin-bottom: 10px;
   margin-top: 10px;
-}
+}

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

@@ -75,10 +75,5 @@ describe('Job wizard fill', () => {
         selector: 'input',
       }).value
     ).toBe('6');
-    expect(
-      screen.getByLabelText('Time span', {
-        selector: 'input',
-      }).value
-    ).toBe('4');
   });
 });

data/webpack/JobWizard/__tests__/fixtures.js

@@ -277,7 +277,6 @@ export const jobInvocation = {
     description_format: null,
     concurrency_control: {
       level: 6,
-      time_span: 4,
     },
     execution_timeout_interval: 1,
     time_to_pickup: 25,

data/webpack/JobWizard/index.js

@@ -1,6 +1,6 @@
 import React from 'react';
 import PropTypes from 'prop-types';
-import { Title, Divider, Flex, FlexItem, Button } from '@patternfly/react-core';
+import { Title, 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';
@@ -18,8 +18,7 @@ const JobWizardPage = ({ location: { search } }) => {
       header={title}
       breadcrumbOptions={breadcrumbOptions}
       searchable={false}
-    >
-      <React.Fragment>
+      beforeToolbarComponent={
         <Flex>
           <FlexItem>
             <Title headingLevel="h2" size="2xl">
@@ -36,7 +35,10 @@ const JobWizardPage = ({ location: { search } }) => {
             </Button>
           </FlexItem>
         </Flex>
-        <Divider component="div" />
+      }
+      pageSectionType="wizard"
+    >
+      <React.Fragment>
         <JobWizard />
       </React.Fragment>
     </PageLayout>

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

@@ -17,7 +17,6 @@ import {
   KeyPassphraseField,
   EffectiveUserPasswordField,
   ConcurrencyLevelField,
-  TimeSpanLevelField,
   TemplateInputsFields,
   ExecutionOrderingField,
   SSHUserField,
@@ -128,15 +127,6 @@ export const AdvancedFields = ({
             })
           }
         />
-        <TimeSpanLevelField
-          value={advancedValues.timeSpan}
-          defaultValue={jobTemplate.concurrency_control?.time_span}
-          setValue={newValue =>
-            setAdvancedValues({
-              timeSpan: newValue,
-            })
-          }
-        />
         <ExecutionOrderingField
           isRandomizedOrdering={advancedValues.isRandomizedOrdering}
           setValue={newValue =>

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

@@ -169,32 +169,6 @@ export const ConcurrencyLevelField = ({ value, setValue, defaultValue }) => (
   />
 );
 
-export const TimeSpanLevelField = ({ value, setValue, defaultValue }) => (
-  <NumberInput
-    formProps={{
-      label: __('Time span'),
-      labelIcon: helpLabel(
-        __(
-          'Distribute execution over N seconds. If this is set and proxy batch triggering is enabled, then tasks are triggered on the smart proxy in batches of size 1.'
-        ),
-        'time-span'
-      ),
-      fieldId: 'time-span',
-      labelInfo: (
-        <ResetDefault setValue={setValue} defaultValue={defaultValue} />
-      ),
-    }}
-    inputProps={{
-      min: 1,
-      autoComplete: 'time-span',
-      id: 'time-span',
-      placeholder: __('For example: 1, 2, 3, 4, 5...'),
-      value,
-      onChange: newValue => setValue(newValue),
-    }}
-  />
-);
-
 export const ExecutionOrderingField = ({ isRandomizedOrdering, setValue }) => (
   <FormGroup
     label={__('Execution ordering')}
@@ -274,8 +248,6 @@ EffectiveUserPasswordField.propTypes = EffectiveUserField.propTypes;
 EffectiveUserPasswordField.defaultProps = EffectiveUserField.defaultProps;
 ConcurrencyLevelField.propTypes = EffectiveUserField.propTypes;
 ConcurrencyLevelField.defaultProps = EffectiveUserField.defaultProps;
-TimeSpanLevelField.propTypes = EffectiveUserField.propTypes;
-TimeSpanLevelField.defaultProps = EffectiveUserField.defaultProps;
 ExecutionOrderingField.propTypes = {
   isRandomizedOrdering: PropTypes.bool,
   setValue: PropTypes.func.isRequired,

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

@@ -268,7 +268,6 @@ const ReviewDetails = ({
     { label: __('Timeout to kill'), value: advancedValues.timeoutToKill },
     { label: __('Time to pickup'), value: advancedValues.timeToPickup },
     { label: __('Concurrency level'), value: advancedValues.concurrencyLevel },
-    { label: __('Time span'), value: advancedValues.timeSpan },
     {
       label: __('Execution ordering'),
       value: advancedValues.isRandomizedOrdering

data/webpack/JobWizard/submit.js

@@ -32,7 +32,6 @@ export const submit = ({
     description,
     timeoutToKill,
     isRandomizedOrdering,
-    timeSpan,
     concurrencyLevel,
     templateValues: advancedTemplateValues,
     password,
@@ -109,7 +108,6 @@ export const submit = ({
             }
           : null,
       concurrency_control: {
-        time_span: timeSpan,
         concurrency_level: concurrencyLevel,
       },
       bookmark_id: null,

data/webpack/JobWizard/validation.js

@@ -41,7 +41,6 @@ export const useValidation = ({ advancedValues, templateValues }) => {
       advancedValues.timeoutToKill,
       advancedValues.timeToPickup,
       advancedValues.concurrencyLevel,
-      advancedValues.timeSpan,
     ].forEach(value => {
       if (value && !isPositiveNumber(value)) {
         setValid(currValid => ({ ...currValid, advanced: false }));

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foreman_remote_execution
 version: !ruby/object:Gem::Version
-  version: 10.1.0
+  version: 11.1.0
 platform: ruby
 authors:
 - Foreman Remote Execution team
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.1.0
+        version: 8.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.1.0
+        version: 8.2.0
 - !ruby/object:Gem::Dependency
   name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
@@ -338,7 +338,7 @@ files:
 - db/migrate/20200623073022_rename_sudo_password_to_effective_user_password.rb
 - db/migrate/20200820122057_add_proxy_selector_override_to_remote_execution_feature.rb
 - db/migrate/20210312074713_add_provider_inputs.rb
-- db/migrate/2021051713291621250977_add_host_proxy_invocations.rb
+- db/migrate/20210517132916_add_host_proxy_invocations.rb
 - db/migrate/20210816100932_rex_setting_category_to_dsl.rb
 - db/migrate/20220321101835_rename_ssh_provider_to_script.rb
 - db/migrate/20220331112719_add_ssh_user_to_job_invocation.rb
@@ -346,6 +346,7 @@ files:
 - db/migrate/20220713095705_create_template_invocation_events.rb
 - db/migrate/20220822155946_add_time_to_pickup_to_job_invocation.rb
 - db/migrate/20221129170145_redefine_template_invocation_events_index.rb
+- db/migrate/20230816154510_drop_time_span_from_job_invocations.rb
 - db/seeds.d/100-assign_features_with_templates.rb
 - db/seeds.d/20-permissions.rb
 - db/seeds.d/50-notification_blueprints.rb