foreman_remote_execution 8.3.3 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7052b1b7ecb7f92386eb7ab37c239d9da0384d5f219dbbff447a2019fec688a5
-  data.tar.gz: 4395d1f84b7931aa4288b64e5ed98469a3b8fa8540cf6cc06691116f3cf0af50
+  metadata.gz: a4f0a9c455ec484caac7631cec3d1ed8eff22263c96036d7837fdbb86f3faab8
+  data.tar.gz: a73788ec230b20cfd6050733d40f27a59d7bf26d334ce51f0b422aae1a64a68e
 SHA512:
-  metadata.gz: f272cfde35b2e072131cf4420c2a1a38b48384becabe8c0ef9f849b6eb654ea9f009ca1b29c4a7dd88dab62dbb6959347d4a3a611a3d0b961442bdc9719481a6
-  data.tar.gz: ae403432e45b27b2783012756dcb99ccb68b8eadb433b8b6710d2198d4d06db64775f9052fea2613fc6c4701cb7ec96f6f8ec70fce10bf82fdb2cbf848c84a88
+  metadata.gz: cb1ef923190e046bc4f9c688ac1040f26e521e7a96a7a154fd461a650d25b04875572e26b75f57dfb425401ae2bf8e82447eb01c635006eb9b51b36df168b999
+  data.tar.gz: 3e47f08ded8554ff2b38c50f7d16b8705441ece2753df227181d7782426c7c320476220f5b12dee496216cda119467ff3a0348f7821811dda702e8a9d852c1f3

data/.github/workflows/ruby_ci.yml

@@ -13,6 +13,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
+      - run: sudo apt-get update
+      - run: sudo apt-get install libyaml-dev
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -42,7 +44,7 @@ jobs:
         node-version: [12]
     steps:
       - run: sudo apt-get update
-      - run: sudo apt-get install build-essential libcurl4-openssl-dev zlib1g-dev libpq-dev
+      - run: sudo apt-get install build-essential libcurl4-openssl-dev zlib1g-dev libpq-dev libyaml-dev
       - uses: actions/checkout@v2
         with:
           repository: theforeman/foreman

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

@@ -71,7 +71,6 @@ 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

@@ -120,25 +120,6 @@ class JobInvocationsController < ApplicationController
     redirect_back(:fallback_location => job_invocation_path(@job_invocation))
   end
 
-  def preview_job_invocations_per_host
-    job_invocations = resource_base.search_for("targeted_host_id = #{params[:host_id]} and (status=#{params[:status]})").limit(params[:limit] || 3)
-
-    job_invocations = job_invocations.map do |job|
-      @job_invocation = job
-      template_invocation = job.template_invocations.find { |template_inv| template_inv.host_id == params[:host_id].to_i }
-      task = template_invocation.try(:run_host_job_task)
-      status_mapper = task ? HostStatus::ExecutionStatus::ExecutionTaskStatusMapper.new(task) : job
-      {
-        start_at: job.start_at,
-        description: job.description,
-        id: job.id,
-        status: status_mapper.status,
-        status_label: status_mapper.status_label,
-      }
-    end
-    render :json => {:job_invocations => job_invocations}
-  end
-
   private
 
   def action_permission
@@ -149,7 +130,7 @@ class JobInvocationsController < ApplicationController
         'create'
       when 'cancel'
         'cancel'
-      when 'chart', 'preview_job_invocations_per_host'
+      when 'chart'
         'view'
       else
         super

data/app/controllers/ui_job_wizard_controller.rb

@@ -1,7 +1,7 @@
 class UiJobWizardController < ApplicationController
   include FiltersHelper
   def categories
-    job_categories = resource_scope(permission: action_permission)
+    job_categories = resource_scope
                      .search_for("job_category ~ \"#{params[:search]}\"")
                      .where(:snippet => false)
                      .select(:job_category).distinct
@@ -13,13 +13,11 @@ 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,
-      :provider_name => job_template.provider.provider_input_namespace,
-      :advanced_template_inputs => advanced_template_inputs+provider_inputs,
+      :advanced_template_inputs => advanced_template_inputs,
     }
   end
 

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 [nil, 'scheduled', 'planning'].include?(task&.state)
+    return if task.nil?
 
     task.execution_plan.actions[1].try(:input).try(:[], 'script')
   end

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

@@ -180,7 +180,7 @@ module Actions
       end
 
       def exit_status
-        input[:with_event_logging] ? task.template_invocation.template_invocation_events.find_by(event_type: 'exit')&.event : delegated_output[:exit_status]
+        input[:with_event_logging] ? task.template_invocation.template_invocation_events.find_by(event_type: 'exit').event : delegated_output[:exit_status]
       end
 
       def host_id

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, :time_to_pickup
+attributes :id, :description, :job_category, :targeting_id, :status, :start_at, :status_label, :ssh_user
 
 node do |invocation|
   {

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

@@ -127,7 +127,7 @@
     </div>
 
     <div class="form-group">
-      <%= add_label({ :label => _('Type of query'), :label_help => _("Type has impact on when is the query evaluated to hosts.<br><ul><li><b>Static</b> - evaluates just after you submit this form</li><li><b>Dynamic</b> - evaluates just before the execution is started, so if it's planned in future, targeted hosts set may change before it</li></ul>") }, f, :targetting_type) %>
+      <%= add_label({ :label => _('Type of query'), :label_help => _("Type has impact on when is the query evaluated to hosts.<br><ul><li><b>Static</b> - evaluates just after you submit this form</li><li><b>Dynamic</b> - evaluates just before the execution is started, so if it's planed in future, targeted hosts set may change before it</li></ul>") }, f, :targetting_type) %>
 
       <div class="col-md-4">
         <%= radio_button_f targeting_fields, :targeting_type, :value => Targeting::STATIC_TYPE, :text => _(Targeting::TYPES[Targeting::STATIC_TYPE]) %>

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

@@ -1,6 +1,6 @@
 <% title @job_invocation.description %>
 <% stylesheet 'foreman_remote_execution/foreman_remote_execution' %>
-<% javascript 'foreman_remote_execution/template_invocation' %>
+<% javascript 'charts', '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">
-        <%= display_link_if_authorized(_("Run Job"), { :action => :create }, { :class => "btn btn-primary btn-lg" }) %>
+        <%= new_link(_("Run Job"), {}, { :class => "btn-lg" }) %>
     </div>
 </div>

data/config/routes.rb

@@ -23,7 +23,6 @@ Rails.application.routes.draw do
   match 'old/job_invocations/:id/rerun', to: 'job_invocations#rerun', via: [:get, :post], as: 'form_rerun_job_invocation'
   resources :job_invocations, :only => [:create, :show, :index] do
     collection do
-      get 'preview_job_invocations_per_host'
       post 'refresh'
       get 'chart'
       get 'preview_hosts'

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') if column_exists?(:settings, :category)
+    Setting.where(category: 'Setting::RemoteExecution').update_all(category: 'Setting')
   end
 end

data/extra/cockpit/foreman-cockpit-session

@@ -170,41 +170,24 @@ class Relay
   def initialize(proxy, params)
     @proxy = proxy
     @params = params
-    @inject_authorization = @params['ssh_user'] != 'root' && @params['effective_user_password']
   end
 
   def proxy_loop
     proxy1 = ProxyBuffer.new($stdin, @sock)
     proxy2 = ProxyBuffer.new(@sock, $stdout)
     proxy2.on_data do |data|
-      if @inject_authorization
-        sio = StringIO.new(data)
-        begin
-          message = Cockpit.read_control(sio)
-        rescue StandardError
-          # We're looking for one specific message, but the expectation that one
-          # invocation of this callback processes one message doesn't really
-          # hold. The message we're looking for is sent quite early in the
-          # communication, if at all, so the chance that it will be aligned with
-          # the beginning of the buffer is quite high. If we somehow fail to
-          # process the contents of the buffer, we should just carry on.
-          #
-          # With the authorization injection check in place, this is more of a
-          # precaution so that unexpectedly big message won't bring the entire
-          # thing down.
-        end
-        if message.is_a?(Hash) && message['command'] == 'authorize'
-          response = {
-            'command' => 'authorize',
-            'cookie' => message['cookie'],
-            'response' => @params['effective_user_password'],
-          }
-          proxy1.enqueue(Cockpit.encode_message(response))
-          @inject_authorization = false
-          data = sio.read # Return whatever was left unread after read_control
-        end
+      message = Cockpit.read_control(StringIO.new(data))
+      if message.is_a?(Hash) && message['command'] == 'authorize'
+        response = {
+          'command' => 'authorize',
+          'cookie' => message['cookie'],
+          'response' => @params['effective_user_password'],
+        }
+        proxy1.enqueue(Cockpit.encode_message(response))
+        ''
+      else
+        data
       end
-      data
     end
 
     proxies = [proxy1, proxy2]
@@ -288,7 +271,7 @@ class Relay
                 end
       raise AccessDeniedError, message
     else
-      raise CockpitError, "Error talking to smart proxy: #{body}"
+      raise CockpitError, "Error talking to smart proxy: #{response}"
     end
   end
 end

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.4'
+        requires_foreman '>= 3.6'
         register_global_js_file 'global'
 
         apipie_documented_controllers ["#{ForemanRemoteExecution::Engine.root}/app/controllers/api/v2/*.rb"]
@@ -183,7 +183,7 @@ module ForemanRemoteExecution
           permission :lock_job_templates, { :job_templates => [:lock, :unlock] }, :resource_type => 'JobTemplate'
           permission :create_job_invocations, { :job_invocations => [:new, :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, :preview_job_invocations_per_host], :template_invocations => [:show],
+          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'
           permission :view_template_invocations, { :template_invocations => [:show],
                                                    'api/v2/template_invocations' => [:template_invocations], :ui_job_wizard => [:job_invocation] }, :resource_type => 'TemplateInvocation'

data/lib/foreman_remote_execution/version.rb

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

data/locale/action_names.rb

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