foreman_remote_execution 8.2.1 → 8.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6737da9f14dbea916b2e25a4584fabb33ae69c35bad16eb82d3cc88325996e2e
-  data.tar.gz: 9c122c05a61199b05fac84b4a2a46adece501bef4e003f8ae81ff83d0b351a5d
+  metadata.gz: bb6aa7e8d08233993c7f908975b7688460969ad1182b008ab8697767a772fffc
+  data.tar.gz: 8e1096d3d25655600889f7abecd499f7157d344a82f8ead12fc226b4ba180eb4
 SHA512:
-  metadata.gz: f2732d87a947c80a8a39acaf8e2314e4833a6e83d76a77506e789467cb489ddcc3a2aacade6a56d91df04c5e54e762bfbc0e07c45c4c430587c998cae253d7f8
-  data.tar.gz: 872b21b191c597db3789442cc327768f83ea861b718b7a678b83c5964d6a894170454143c5cfd6e43e639239b34613ab09bf158eefdc24756ea07d32a02ce7d2
+  metadata.gz: fa738c870c881c464e22ca4d59361e6ca8c28c878dfa368c09c3c31ea7766fabfe2ddfac585dfe1fdb401d16b56a80bf1a645d53d7df633a8a527b2bc56fec57
+  data.tar.gz: 2db1f5515cc9b3570d629a0a9149883b7691d4bcd3ebfb8e7383604665bd424b78df968949848c661f5ab22350fc4769ceaa524e74550f6402c20c759ab9e212

data/app/controllers/job_invocations_controller.rb

@@ -120,6 +120,25 @@ 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
@@ -130,7 +149,7 @@ class JobInvocationsController < ApplicationController
         'create'
       when 'cancel'
         'cancel'
-      when 'chart'
+      when 'chart', 'preview_job_invocations_per_host'
         'view'
       else
         super

data/app/controllers/ui_job_wizard_controller.rb

@@ -68,9 +68,6 @@ 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_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/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 planed 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 planned 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/config/routes.rb

@@ -23,6 +23,7 @@ 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/extra/cockpit/foreman-cockpit-session

@@ -170,24 +170,41 @@ 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|
-      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
+      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
       end
+      data
     end
 
     proxies = [proxy1, proxy2]
@@ -271,7 +288,7 @@ class Relay
                 end
       raise AccessDeniedError, message
     else
-      raise CockpitError, "Error talking to smart proxy: #{response}"
+      raise CockpitError, "Error talking to smart proxy: #{body}"
     end
   end
 end

data/lib/foreman_remote_execution/engine.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], :template_invocations => [:show],
+          permission :view_job_invocations, { :job_invocations => [:index, :chart, :show, :auto_complete_search, :preview_job_invocations_per_host], :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.2.1'.freeze
+  VERSION = '8.3.1'.freeze
 end

data/webpack/JobWizard/JobWizardConstants.js

@@ -23,7 +23,7 @@ export const SCHEDULE_TYPES = {
 };
 
 export const WIZARD_TITLES = {
-  categoryAndTemplate: __('Category and Template'),
+  categoryAndTemplate: __('Category and template'),
   hostsAndInputs: __('Target hosts and inputs'),
   advanced: __('Advanced fields'),
   schedule: __('Schedule'),

data/webpack/JobWizard/autofill.js

@@ -48,8 +48,11 @@ export const useAutoFill = ({
           })
         );
       }
-      if (search && !hostIds?.length) {
-        setHostsSearchQuery(search);
+      if ((search || search === '') && !hostIds?.length) {
+        // replace an empty string search with a dummy search query to match all hosts
+        // but only if search query was entered (based on presence of :search parameter)
+        const hostSearch = search === '' ? "name != ''" : search;
+        setHostsSearchQuery(hostSearch);
       }
       if (templateID) {
         setJobTemplateID(+templateID);

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

@@ -91,7 +91,7 @@ describe('Hosts', () => {
     expect(screen.queryAllByText('host_collection1')).toHaveLength(1);
 
     await act(async () => {
-      fireEvent.click(screen.getByText('Category and Template'));
+      fireEvent.click(screen.getByText('Category and template'));
     });
     await act(async () => {
       fireEvent.click(screen.getByText('Target hosts and inputs'));

data/webpack/JobWizard/steps/Schedule/QueryType.js

@@ -31,7 +31,7 @@ export const QueryType = ({ isTypeStatic, setIsTypeStatic }) => (
         id="query-type-dynamic"
         label={__('Dynamic query')}
         body={__(
-          "evaluates just before the execution is started, so if it's planed in future, targeted hosts set may change before it"
+          "evaluates just before the execution is started, so if it's planned in future, targeted hosts set may change before it"
         )}
       />
     </FormGroup>

data/webpack/JobWizard/steps/Schedule/RepeatHour.js

@@ -47,7 +47,6 @@ export const RepeatHour = ({ repeatData, setRepeatData }) => {
         }}
         isOpen={minuteOpen}
         width={125}
-        menuAppendTo={() => document.querySelector('.pf-c-form.schedule-tab')}
         toggleAriaLabel="select minute toggle"
         validated={
           isValidMinute(minute)

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

@@ -139,7 +139,7 @@ describe('Schedule', () => {
     });
 
     act(() => {
-      fireEvent.click(screen.getByText('Category and Template'));
+      fireEvent.click(screen.getByText('Category and template'));
     });
     act(() => {
       fireEvent.click(screen.getByRole('button', { name: 'Future execution' }));
@@ -246,7 +246,7 @@ describe('Schedule', () => {
     });
 
     act(() => {
-      fireEvent.click(screen.getByText('Category and Template'));
+      fireEvent.click(screen.getByText('Category and template'));
     });
     act(() => {
       fireEvent.click(
@@ -306,9 +306,9 @@ describe('Schedule', () => {
     expect(screen.getByText('Review details').disabled).toBeFalsy();
 
     await act(async () => {
-      fireEvent.click(screen.getByText('Category and Template'));
+      fireEvent.click(screen.getByText('Category and template'));
     });
-    expect(screen.getAllByText('Category and Template')).toHaveLength(3);
+    expect(screen.getAllByText('Category and template')).toHaveLength(3);
 
     await act(async () => {
       fireEvent.click(

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

@@ -119,7 +119,6 @@ export const DateTimePicker = ({
         is24Hour
         isDisabled={isDisabled || formattedDate.length === 0}
         invalidFormatErrorMessage={__('Invalid time format')}
-        menuAppendTo={() => document.body}
         includeSeconds={includeSeconds}
       />
     </>

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

@@ -68,7 +68,6 @@ export const GroupedSelectField = ({
         selections={selected}
         className="without_select2"
         onClear={onClear}
-        menuAppendTo={() => document.body}
         aria-labelledby={fieldId}
         toggleAriaLabel={`${label} toggle`}
         {...props}

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

@@ -43,7 +43,6 @@ export const SelectField = ({
         isOpen={isOpen}
         className="without_select2"
         maxHeight="45vh"
-        menuAppendTo={() => document.body}
         placeholderText=" " // To prevent showing first option as selected
         aria-labelledby={fieldId}
         toggleAriaLabel={`${label} toggle`}

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

@@ -25,7 +25,7 @@ const RecentJobsCard = ({ hostDetails: { name, id } }) => {
       header={__('Recent jobs')}
       dropdownItems={[
         <DropdownItem
-          href={foremanUrl(`${JOB_BASE_URL}${name}`)}
+          href={foremanUrl(`${JOB_BASE_URL}${id}`)}
           key="link-to-all"
           ouiaId="link-to-all-dropdown-item"
         >
@@ -33,7 +33,7 @@ const RecentJobsCard = ({ hostDetails: { name, id } }) => {
         </DropdownItem>,
         <DropdownItem
           href={foremanUrl(
-            `${JOB_BASE_URL}${name}+and+status+%3D+failed+or+status%3D+succeeded`
+            `${JOB_BASE_URL}${id}+and+status+%3D+failed+or+status%3D+succeeded`
           )}
           key="link-to-finished"
           ouiaId="link-to-finished-dropdown-item"
@@ -41,14 +41,14 @@ const RecentJobsCard = ({ hostDetails: { name, id } }) => {
           {__('View finished jobs')}
         </DropdownItem>,
         <DropdownItem
-          href={foremanUrl(`${JOB_BASE_URL}${name}+and+status+%3D+running`)}
+          href={foremanUrl(`${JOB_BASE_URL}${id}+and+status+%3D+running`)}
           key="link-to-running"
           ouiaId="link-to-running-dropdown-item"
         >
           {__('View running jobs')}
         </DropdownItem>,
         <DropdownItem
-          href={foremanUrl(`${JOB_BASE_URL}${name}+and+status+%3D+queued`)}
+          href={foremanUrl(`${JOB_BASE_URL}${id}+and+status+%3D+queued`)}
           key="link-to-scheduled"
           ouiaId="link-to-scheduled-dropdown-item"
         >

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

@@ -17,10 +17,10 @@ const RecentJobsTable = ({ status, hostId }) => {
   const jobsUrl =
     hostId &&
     foremanUrl(
-      `${JOB_API_URL}${hostId}+and+status%3D${status}&per_page=${JOBS_IN_CARD}`
+      `${JOB_API_URL}${hostId}&status=${status}&limit=${JOBS_IN_CARD}`
     );
   const {
-    response: { results: jobs },
+    response: { job_invocations: jobs },
     status: responseStatus,
   } = useAPI('get', jobsUrl, RECENT_JOBS_KEY);
 

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

@@ -6,8 +6,8 @@ export const SCHEDULED_TAB = 2;
 export const JOB_SUCCESS_STATUS = 0;
 export const JOB_ERROR_STATUS = 1;
 
-export const JOB_BASE_URL = '/job_invocations?search=host+%3D+';
+export const JOB_BASE_URL = '/job_invocations?search=targeted_host_id+%3D+';
 export const JOB_API_URL =
-  '/api/job_invocations?order=start_at+DESC&search=targeted_host_id%3D';
+  '/job_invocations/preview_job_invocations_per_host?host_id=';
 export const JOBS_IN_CARD = 3;
 export const RECENT_JOBS_KEY = { key: 'RECENT_JOBS_KEY' };

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_remote_execution
 version: !ruby/object:Gem::Version
-  version: 8.2.1
+  version: 8.3.1
 platform: ruby
 authors:
 - Foreman Remote Execution team
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-21 00:00:00.000000000 Z
+date: 2023-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
@@ -543,7 +543,7 @@ homepage: https://github.com/theforeman/foreman_remote_execution
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -558,8 +558,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.20
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: A plugin bringing remote execution to the Foreman, completing the config
   management functionality with remote management functionality.