foreman_remote_execution 9.0.0 → 9.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4f0a9c455ec484caac7631cec3d1ed8eff22263c96036d7837fdbb86f3faab8
-  data.tar.gz: a73788ec230b20cfd6050733d40f27a59d7bf26d334ce51f0b422aae1a64a68e
+  metadata.gz: 81407b69460f3a75ba7c4c49d66c499af7075afd1546222ff2e02c56bc4e459e
+  data.tar.gz: c3b6c06eb6ba6a44d1e827e5a3507787a974264c30e58d93170d5d66e4eaa3b2
 SHA512:
-  metadata.gz: cb1ef923190e046bc4f9c688ac1040f26e521e7a96a7a154fd461a650d25b04875572e26b75f57dfb425401ae2bf8e82447eb01c635006eb9b51b36df168b999
-  data.tar.gz: 3e47f08ded8554ff2b38c50f7d16b8705441ece2753df227181d7782426c7c320476220f5b12dee496216cda119467ff3a0348f7821811dda702e8a9d852c1f3
+  metadata.gz: 23980086920902efd40d77912e472e0ebd9421c5429dfec561d96c4d7fdfc5cabdde3ff4a999b9ee50227c1163af1a4cffb676b939352d464ab5a6af29899027
+  data.tar.gz: 121f36e745fb79d7364cf42f9de7d875d5da1b1af91ef5138688241f8c520d9c14f0de3b8e584b6d50d0cb7ada113b0c3aa666cba5482214fee978d522c87fe4

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

@@ -71,6 +71,7 @@ module Api
           param :description_format, String, :required => false, :desc => N_('Override the description format from the template for this invocation only')
           param :execution_timeout_interval, Integer, :required => false, :desc => N_('Override the timeout interval from the template for this invocation only')
           param :feature, String, :required => false, :desc => N_('Remote execution feature label that should be triggered, job template assigned to this feature will be used')
+          param :time_to_pickup, Integer, :required => false, :desc => N_('Override the global time to pickup interval for this invocation only')
 
           RemoteExecutionProvider.providers.each_value do |provider|
             next if !provider.respond_to?(:provider_inputs_doc) || provider.provider_inputs_doc.empty?

data/app/controllers/job_invocations_controller.rb

@@ -40,6 +40,16 @@ class JobInvocationsController < ApplicationController
     render :action => 'new'
   end
 
+  def legacy_create
+    @composer = prepare_composer
+    if @composer.trigger
+      redirect_to job_invocation_path(@composer.job_invocation)
+    else
+      @composer.job_invocation.description_format = nil if params.fetch(:job_invocation, {}).key?(:description_override)
+      render :action => 'new'
+    end
+  end
+
   def create
     @composer = prepare_composer
     if @composer.trigger

data/app/controllers/ui_job_wizard_controller.rb

@@ -13,11 +13,13 @@ class UiJobWizardController < ApplicationController
   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"] }
+    provider_inputs = job_template.provider.provider_inputs.map { |input| input.instance_values.merge({:provider_input => true, default: input.value }) }
     render :json => {
       :job_template => job_template,
       :effective_user => job_template.effective_user,
       :template_inputs => template_inputs,
-      :advanced_template_inputs => advanced_template_inputs,
+      :provider_name => job_template.provider.provider_input_namespace,
+      :advanced_template_inputs => advanced_template_inputs+provider_inputs,
     }
   end
 
@@ -66,6 +68,9 @@ class UiJobWizardController < ApplicationController
     job_organization = Taxonomy.find_by(id: job.task.input[:current_organization_id])
     job_location = Taxonomy.find_by(id: job.task.input[:current_location_id])
     render :json => {
+      :provider_input_values => composer[:template_invocations][0][:provider_input_values],
+      :provider_input_values1 => job[:provider_input_values],
+      :job2 => composer[:template_invocations][0],
       :job => composer,
       :job_organization => job_organization,
       :job_location => job_location,

data/app/helpers/remote_execution_helper.rb

@@ -238,7 +238,7 @@ module RemoteExecutionHelper
 
   def load_template_from_task(template_invocation, target)
     task = template_invocation.job_invocation.sub_task_for_host(target)
-    return if task.nil?
+    return if [nil, 'scheduled', 'planning'].include?(task&.state)
 
     task.execution_plan.actions[1].try(:input).try(:[], 'script')
   end

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

@@ -5,6 +5,7 @@ module Actions
       include Dynflow::Action::WithBulkSubPlans
       include Dynflow::Action::WithPollingSubPlans
       include Actions::RecurringAction
+      include Actions::ObservableAction
 
       middleware.use Actions::Middleware::BindJobInvocation
       middleware.use Actions::Middleware::RecurringLogic
@@ -12,6 +13,7 @@ module Actions
 
       execution_plan_hooks.use :notify_on_success, :on => :success
       execution_plan_hooks.use :notify_on_failure, :on => :failure
+      execution_plan_hooks.use :emit_event_running, :on => :running
 
       class CheckOnProxyActions; end
 
@@ -94,9 +96,12 @@ module Actions
         end
       end
 
+      def job_invocation_id
+        input[:job_invocation_id] || input.fetch(:job_invocation, {})[:id]
+      end
+
       def job_invocation
-        id = input[:job_invocation_id] || input.fetch(:job_invocation, {})[:id]
-        @job_invocation ||= JobInvocation.find(id)
+        @job_invocation ||= JobInvocation.find(job_invocation_id)
       end
 
       def batch(from, size)
@@ -152,6 +157,14 @@ module Actions
         input[:proxy_batch_size]
       end
 
+      def self.event_names
+        super + [event_name_base + '_' + event_name_suffix('running')]
+      end
+
+      def emit_event_running(plan)
+        emit_event(plan, :running)
+      end
+
       private
 
       def mail_notification_preference
@@ -163,6 +176,19 @@ module Actions
 
         /\A#{JobInvocation::CACHE_PREFIX}_#{job_invocation_id}/
       end
+
+      extend ApipieDSL::Class
+      apipie :class, "An action representing execution of a job against a set of hosts" do
+        name 'Actions::RemoteExecution::RunHostsJob'
+        refs 'Actions::RemoteExecution::RunHostsJob'
+        sections only: %w[all webhooks]
+        property :task, object_of: 'Task', desc: 'Returns the task to which this action belongs'
+        property :job_invocation_id, Integer, desc: "Returns the id of the job invocation"
+        property :job_invocation, object_of: 'JobInvocation', desc: "Returns the job invocation"
+      end
+      class Jail < ::Actions::ObservableAction::Jail
+        allow :job_invocation_id, :job_invocation
+      end
     end
   end
 end

data/app/models/remote_execution_feature.rb

@@ -43,8 +43,12 @@ class RemoteExecutionFeature < ApplicationRecord
     feature = self.find_by(label: label)
     builder = options[:notification_builder] ? options[:notification_builder].to_s : nil
 
+    if options[:provided_inputs]
+      provided_inputs = Array(options[:provided_inputs]).join(',')
+    end
+
     attributes = { :name => name,
-                   :provided_input_names => options[:provided_inputs],
+                   :provided_inputs => provided_inputs,
                    :description => options[:description],
                    :host_action_button => options[:host_action_button],
                    :proxy_selector_override => options[:proxy_selector_override],
@@ -58,13 +62,12 @@ class RemoteExecutionFeature < ApplicationRecord
     end
 
     self.without_auditing do
-      if feature.nil?
-        feature = self.create!({ :label => label }.merge(attributes))
-      else
-        feature.attributes = attributes
-        feature.save if feature.changed?
-      end
-      return feature
+      # The only validation we currently have is uniqueness validation, which
+      # the upsert will enforce
+      # rubocop:disable Rails/SkipsModelValidations
+      result = self.upsert({ label: label }.merge(attributes), unique_by: :label)
+      self.find(result.first.to_h['id'])
+      # rubocop:enable Rails/SkipsModelValidations
     end
   end
 end

data/app/views/api/v2/job_invocations/base.json.rabl

@@ -1,6 +1,6 @@
 object @job_invocation
 
-attributes :id, :description, :job_category, :targeting_id, :status, :start_at, :status_label, :ssh_user
+attributes :id, :description, :job_category, :targeting_id, :status, :start_at, :status_label, :ssh_user, :time_to_pickup
 
 node do |invocation|
   {

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

@@ -1,6 +1,6 @@
 <% title @job_invocation.description %>
 <% stylesheet 'foreman_remote_execution/foreman_remote_execution' %>
-<% javascript 'charts', 'foreman_remote_execution/template_invocation' %>
+<% javascript 'foreman_remote_execution/template_invocation' %>
 <% javascript *webpack_asset_paths('foreman_remote_execution', :extension => 'js') %>
 <% content_for(:stylesheets) do %>
   <%= webpacked_plugins_css_for :foreman_remote_execution %>

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

@@ -9,6 +9,6 @@
     <p><%= link_to _('Learn more about this in the documentation.'),
            documentation_url('1.ForemanRemoteExecution1.3Manual', :root_url => 'https://www.theforeman.org/plugins/foreman_remote_execution/1.3/index.html#'), :rel => 'external' %></p>
     <div class="blank-slate-pf-main-action">
-        <%= new_link(_("Run Job"), {}, { :class => "btn-lg" }) %>
+        <%= display_link_if_authorized(_("Run Job"), { :action => :create }, { :class => "btn btn-primary btn-lg" }) %>
     </div>
 </div>

data/config/routes.rb

@@ -18,6 +18,7 @@ Rails.application.routes.draw do
 
   match 'job_invocations/new', to: 'react#index', :via => [:get], as: 'new_job_invocation'
   match 'job_invocations/new', to: 'job_invocations#create', via: [:post], as: 'create_job_invocation'
+  match 'job_invocations/', to: 'job_invocations#legacy_create', via: [:post], as: 'legacy_create_job_invocation'
   match 'job_invocations/:id/rerun', to: 'react#index', :via => [:get], as: 'rerun_job_invocation'
   match 'old/job_invocations/new', to: 'job_invocations#new', via: [:get], as: 'form_new_job_invocation'
   match 'old/job_invocations/:id/rerun', to: 'job_invocations#rerun', via: [:get, :post], as: 'form_rerun_job_invocation'

data/db/migrate/20210816100932_rex_setting_category_to_dsl.rb

@@ -1,5 +1,5 @@
 class RexSettingCategoryToDsl < ActiveRecord::Migration[6.0]
   def up
-    Setting.where(category: 'Setting::RemoteExecution').update_all(category: 'Setting')
+    Setting.where(category: 'Setting::RemoteExecution').update_all(category: 'Setting') if column_exists?(:settings, :category)
   end
 end

data/db/migrate/20220426145007_add_unique_feature_label_index.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class AddUniqueFeatureLabelIndex < ActiveRecord::Migration[6.0]
+  def change
+    remove_index :remote_execution_features, :label
+
+    counts = RemoteExecutionFeature.group(:label).count
+    counts.select { |_, count| count > 1 }.each do |label, count|
+      RemoteExecutionFeature.where(label: label).limit(count - 1).delete_all
+    end
+
+    add_index :remote_execution_features, :label, unique: true
+  end
+end

data/lib/foreman_remote_execution/engine.rb

@@ -181,7 +181,7 @@ module ForemanRemoteExecution
           permission :destroy_job_templates, { :job_templates => [:destroy],
                                                :'api/v2/job_templates' => [:destroy] }, :resource_type => 'JobTemplate'
           permission :lock_job_templates, { :job_templates => [:lock, :unlock] }, :resource_type => 'JobTemplate'
-          permission :create_job_invocations, { :job_invocations => [:new, :create, :refresh, :rerun, :preview_hosts],
+          permission :create_job_invocations, { :job_invocations => [:new, :create, :legacy_create, :refresh, :rerun, :preview_hosts],
                                                 'api/v2/job_invocations' => [:create, :rerun] }, :resource_type => 'JobInvocation'
           permission :view_job_invocations, { :job_invocations => [:index, :chart, :show, :auto_complete_search], :template_invocations => [:show],
                                               'api/v2/job_invocations' => [:index, :show, :output, :raw_output, :outputs] }, :resource_type => 'JobInvocation'

data/lib/foreman_remote_execution/version.rb

@@ -1,3 +1,3 @@
 module ForemanRemoteExecution
-  VERSION = '9.0.0'.freeze
+  VERSION = '9.1.0'.freeze
 end

data/locale/action_names.rb

@@ -1,5 +1,5 @@
 # Autogenerated!
-_("Remote action:")
+_("Action with sub plans")
 _("Import Puppet classes")
 _("Import facts")
-_("Action with sub plans")
+_("Remote action:")