foreman_remote_execution 16.7.0 → 17.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87f61f660cc9bb15e87453747aca6cef5d600d4fd3994d090c5af8a4e48f1b8a
-  data.tar.gz: 16e86afd877b2c2dec48daba1ff05c98822208a9c777d5351a9bf04edbd21322
+  metadata.gz: 248ba991802a19c3ad70d4c93a1a80931065c77f5e075520c01d35d07d3ef4e3
+  data.tar.gz: 83cad360b0893506f1ace4b8c38e60bdab716a74aaa2ff0a741908059f92e56f
 SHA512:
-  metadata.gz: 16a08a5afdbab46351b5fe9eb4fcf55c82ad0a56160585dbedbec48a32e2d47c9f595a8562505d5c97f69141d5e6174c0fcbb6e3fd0df481dd692b6c2b811b91
-  data.tar.gz: f1e886b6f85fc08820986b812d2d959b65c42e49ab411a42df47da1ec5ad077842f472f58e78f635fd71712fdf15a7bf2541d6921fc1d3788ebec9be1bcad995
+  metadata.gz: d4221e0916237573f00934dac48f0e169cb78ac278ec127b6f57e72cb8982ba12e79624a082986efe878ccbb325dd426ee41dcf0f2a155e08830791e389e3124
+  data.tar.gz: 927fa72b970f31090f729ade6acdbf7b73f33c4ca337af7e3ae4f0dfc998d0f77bc69a6bc32ede1ba3a052a46e98acf38d016277ab0085c75b0bd1edeec93068

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

@@ -117,12 +117,14 @@ module Api
       param_group :search_and_pagination, ::Api::V2::BaseController
       add_scoped_search_description_for(JobInvocation)
       param :id, :identifier, :required => true
+      param :include_permissions, :bool, :required => false, :desc => N_('Include per-host task and permission data in the response')
       def hosts
         set_hosts_and_template_invocations
         @total = @hosts.size
         @hosts = @hosts.search_for(params[:search], :order => params[:order]).paginate(:page => params[:page], :per_page => params[:per_page])
         @subtotal = @hosts.total_entries
         set_statuses_and_smart_proxies
+        set_tasks_and_permissions if Foreman::Cast.to_bool(params[:include_permissions])
         if params[:awaiting]
           @hosts = @hosts.select { |host| @host_statuses[host.id] == 'N/A' }
         end
@@ -321,15 +323,35 @@ module Api
         template_invocations = @template_invocations.where(host_id: @hosts.select(:id))
                                                     .includes(:run_host_job_task).to_a
         hosts = @hosts.to_a
-        template_invocations_by_host_id = template_invocations.index_by(&:host_id)
+        @template_invocations_by_host_id = template_invocations.index_by(&:host_id)
         @host_statuses = hosts.to_h do |host|
-          template_invocation = template_invocations_by_host_id[host.id]
+          template_invocation = @template_invocations_by_host_id[host.id]
           task = template_invocation.try(:run_host_job_task)
           [host.id, template_invocation_status(task, @job_invocation.task)]
         end
         @smart_proxy_id = template_invocations.to_h { |ti| [ti.host_id, ti.smart_proxy_id] }
         @smart_proxy_name = template_invocations.to_h { |ti| [ti.host_id, ti.smart_proxy_name] }
       end
+
+      def set_tasks_and_permissions
+        can_cancel = authorized_for(:permission => :cancel_job_invocations, :auth_object => @job_invocation)
+        can_create = authorized_for(controller: :job_invocations, action: :create)
+        can_execute_on_infra = User.current.can?(:execute_jobs_on_infrastructure_hosts)
+
+        hosts = @hosts.to_a
+        @task_by_host = hosts.to_h do |host|
+          task = @template_invocations_by_host_id[host.id].try(:run_host_job_task)
+          [host.id, task ? { :id => task.id, :cancellable => task.try(:cancellable?) || false } : nil]
+        end
+        @permissions_by_host = hosts.to_h do |host|
+          task = @template_invocations_by_host_id[host.id].try(:run_host_job_task)
+          [host.id, {
+            :view_foreman_tasks => authorized_for(:permission => :view_foreman_tasks, :auth_object => task),
+            :cancel_job_invocations => can_cancel,
+            :execute_jobs => can_create && (!host.infrastructure_host? || can_execute_on_infra),
+          }]
+        end
+      end
     end
   end
 end

data/app/controllers/job_invocations_controller.rb

@@ -149,33 +149,6 @@ class JobInvocationsController < ApplicationController
     render :json => {:job_invocations => job_invocations}
   end
 
-  def list_jobs_hosts
-    @job_invocation = resource_base.find(params[:id])
-    hosts = @job_invocation.targeting.hosts.authorized(:view_hosts, Host)
-    hosts = hosts.search_for(params[:search])
-    template_invocations_task_by_hosts = {}
-    hosts.each do |host|
-      template_invocation = @job_invocation.template_invocations.find { |template_inv| template_inv.host_id == host.id }
-      next unless template_invocation
-      template_invocation_task = template_invocation.run_host_job_task
-      template_invocations_task_by_hosts[host.id] =
-        {
-          :host_name => host.name,
-          :id => host.id,
-          :task => template_invocation_task.attributes.merge({cancellable: template_invocation_task.cancellable? }),
-          :permissions => {
-            :view_foreman_tasks => authorized_for(:permission => :view_foreman_tasks, :auth_object => template_invocation_task),
-            :cancel_job_invocations => authorized_for(:permission => :cancel_job_invocations, :auth_object => @job_invocation),
-            :execute_jobs => authorized_for(controller: :job_invocations, action: :create) && (!host.infrastructure_host? || User.current.can?(:execute_jobs_on_infrastructure_hosts)),
-          },
-        }
-    end
-
-    render json: {
-      :template_invocations_task_by_hosts => template_invocations_task_by_hosts,
-    }
-  end
-
   private
 
   def action_permission
@@ -186,7 +159,7 @@ class JobInvocationsController < ApplicationController
         'create'
       when 'cancel'
         'cancel'
-      when 'chart', 'preview_job_invocations_per_host', 'list_jobs_hosts'
+      when 'chart', 'preview_job_invocations_per_host'
         'view'
       else
         super

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

@@ -13,3 +13,11 @@ end
 node :smart_proxy_name do |host|
   @smart_proxy_name[host.id]
 end
+
+node(:task, :if => ->(_host) { @task_by_host }) do |host|
+  @task_by_host[host.id]
+end
+
+node(:permissions, :if => ->(_host) { @permissions_by_host }) do |host|
+  @permissions_by_host[host.id]
+end

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

@@ -34,6 +34,7 @@ end
 
 child :task do
   attributes :id, :state, :started_at
+  node(:cancellable) { |task| task.try(:cancellable?) }
 end
 
 if @template_invocations

data/app/views/job_templates/_alerts.html.erb

@@ -0,0 +1,4 @@
+<% if @template.locked? -%>
+  <%= locked_warning(::Template.find(params[:id])) %>
+<% end -%>
+

data/config/routes.rb

@@ -35,7 +35,6 @@ Rails.application.routes.draw do
       get 'auto_complete_search'
     end
     member do
-      get 'hosts', to: 'job_invocations#list_jobs_hosts'
       post 'cancel'
     end
   end

data/lib/foreman_remote_execution/plugin.rb

@@ -1,5 +1,5 @@
 Foreman::Plugin.register :foreman_remote_execution do
-  requires_foreman '>= 3.17'
+  requires_foreman '>= 5.0'
   register_global_js_file 'global'
   register_gettext
 
@@ -134,9 +134,9 @@ Foreman::Plugin.register :foreman_remote_execution do
     permission :lock_job_templates, { :job_templates => [:lock, :unlock] }, :resource_type => 'JobTemplate'
     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, :preview_job_invocations_per_host, :list_jobs_hosts], :template_invocations => [:show, :show_template_invocation_by_host],
+    permission :view_job_invocations, { :job_invocations => [:index, :chart, :show, :auto_complete_search, :preview_job_invocations_per_host], :template_invocations => [:show, :show_template_invocation_by_host],
                                         'api/v2/job_invocations' => [:index, :show, :output, :raw_output, :outputs, :hosts] }, :resource_type => 'JobInvocation'
-    permission :view_template_invocations, { :template_invocations => [:show, :template_invocation_preview, :show_template_invocation_by_host], :job_invocations => [:list_jobs_hosts],
+    permission :view_template_invocations, { :template_invocations => [:show, :template_invocation_preview, :show_template_invocation_by_host],
                                             'api/v2/template_invocations' => [:template_invocations], :ui_job_wizard => [:job_invocation] }, :resource_type => 'TemplateInvocation'
     permission :create_template_invocations, {}, :resource_type => 'TemplateInvocation'
     permission :execute_jobs_on_infrastructure_hosts, {}, :resource_type => 'JobInvocation'

data/lib/foreman_remote_execution/version.rb

@@ -1,3 +1,3 @@
 module ForemanRemoteExecution
-  VERSION = '16.7.0'.freeze
+  VERSION = '17.1.0'.freeze
 end

data/test/functional/api/v2/job_invocations_controller_test.rb

@@ -284,20 +284,59 @@ module Api
       end
 
       describe '#hosts' do
-        test 'should compute job_status for the paginated subset' do
-          invocation = FactoryBot.create(:job_invocation, :with_template, :with_task)
-          2.times { invocation.template_invocations << FactoryBot.create(:template_invocation, :with_task, :with_host, :job_invocation => invocation) }
-          invocation.job_category = invocation.pattern_template_invocations.first.template.job_category
-          invocation.targeting.hosts = invocation.template_invocations.map(&:host)
-          invocation.save!
+        setup do
+          @hosts_invocation = FactoryBot.create(:job_invocation, :with_template, :with_task)
+          2.times { @hosts_invocation.template_invocations << FactoryBot.create(:template_invocation, :with_task, :with_host, :job_invocation => @hosts_invocation) }
+          @hosts_invocation.job_category = @hosts_invocation.pattern_template_invocations.first.template.job_category
+          @hosts_invocation.targeting.hosts = @hosts_invocation.template_invocations.map(&:host)
+          @hosts_invocation.save!
+        end
 
-          get :hosts, params: { :id => invocation.id, :page => 2, :per_page => 1 }
+        test 'should compute job_status for the paginated subset' do
+          get :hosts, params: { :id => @hosts_invocation.id, :page => 2, :per_page => 1 }
           assert_response :success
           result = ActiveSupport::JSON.decode(@response.body)
           assert_equal 3, result['total']
           assert_equal 1, result['results'].size
           assert_equal(['success'], result['results'].map { |r| r['job_status'] })
         end
+
+        test 'should not include task and permissions without include_permissions' do
+          get :hosts, params: { :id => @hosts_invocation.id }
+          assert_response :success
+          result = ActiveSupport::JSON.decode(@response.body)
+          result['results'].each do |host|
+            assert_not host.key?('task'), 'Expected task to be absent'
+            assert_not host.key?('permissions'), 'Expected permissions to be absent'
+          end
+        end
+
+        test 'should include task and permissions with include_permissions=true' do
+          get :hosts, params: { :id => @hosts_invocation.id, :include_permissions => true }
+          assert_response :success
+          result = ActiveSupport::JSON.decode(@response.body)
+          result['results'].each do |host|
+            assert host.key?('task'), 'Expected task to be present'
+            assert host.key?('permissions'), 'Expected permissions to be present'
+            permissions = host['permissions']
+            assert permissions.key?('view_foreman_tasks')
+            assert permissions.key?('cancel_job_invocations')
+            assert permissions.key?('execute_jobs')
+          end
+        end
+
+        test 'should handle hosts with nil task gracefully when include_permissions=true' do
+          invocation = FactoryBot.create(:job_invocation, :with_template, :with_task, :with_unplanned_host)
+          invocation.job_category = invocation.pattern_template_invocations.first.template.job_category
+          invocation.save!
+
+          get :hosts, params: { :id => invocation.id, :include_permissions => true }
+          assert_response :success
+          result = ActiveSupport::JSON.decode(@response.body)
+          result['results'].each do |host|
+            assert host.key?('permissions'), 'Expected permissions to be present'
+          end
+        end
       end
 
       describe 'raw output' do

data/webpack/JobInvocationDetail/JobInvocationActions.js

@@ -1,52 +1,73 @@
 import { translate as __, sprintf } from 'foremanReact/common/I18n';
-import { foremanUrl } from 'foremanReact/common/helpers';
 import { addToast } from 'foremanReact/components/ToastsList';
-import { APIActions, get } from 'foremanReact/redux/API';
-import {
-  stopInterval,
-  withInterval,
-} from 'foremanReact/redux/middlewares/IntervalMiddleware';
+import { APIActions } from 'foremanReact/redux/API';
 import {
   CANCEL_JOB,
   CANCEL_RECURRING_LOGIC,
   CHANGE_ENABLED_RECURRING_LOGIC,
-  GET_TASK,
   JOB_INVOCATION_KEY,
-  UPDATE_JOB,
+  STATUS,
+  AUTO_REFRESH_INTERVAL_MS,
 } from './JobInvocationConstants';
 
-export const getJobInvocation = url => dispatch => {
-  const fetchData = withInterval(
-    get({
-      key: JOB_INVOCATION_KEY,
-      params: { include_permissions: true, include_hosts: false },
-      url,
-      handleError: () => {
-        dispatch(stopInterval(JOB_INVOCATION_KEY));
-      },
-      errorToast: ({ response }) =>
-        // eslint-disable-next-line camelcase
-        response?.data?.error?.full_messages?.[0] ||
-        // eslint-disable-next-line camelcase
-        response?.data?.error?.full_messages ||
-        response?.data?.error?.message ||
-        'Error',
-    }),
-    1000
-  );
+export const isJobFinished = statusLabel =>
+  statusLabel === STATUS.FAILED ||
+  statusLabel === STATUS.SUCCEEDED ||
+  statusLabel === STATUS.CANCELLED;
+
+const extractErrorMessage = response =>
+  // eslint-disable-next-line camelcase
+  response?.data?.error?.full_messages?.[0] ||
+  response?.data?.error?.message ||
+  __('Unknown error.');
+
+const createPollState = cancel => ({ timeoutId: null, cancel });
+
+export const getJobInvocation = (url, pollTimeoutRef) => dispatch => {
+  let cancelled = false;
+  let isFirstCall = true;
 
-  dispatch(fetchData);
+  const poll = () => {
+    if (cancelled) return;
+    const params = { include_hosts: false };
+    if (isFirstCall) {
+      params.include_permissions = true;
+      isFirstCall = false;
+    }
+
+    dispatch(
+      APIActions.get({
+        key: JOB_INVOCATION_KEY,
+        params,
+        url,
+        handleSuccess: ({ data }) => {
+          if (cancelled) return;
+          // eslint-disable-next-line camelcase
+          pollTimeoutRef.current.timeoutId = isJobFinished(data?.status_label)
+            ? null
+            : setTimeout(poll, AUTO_REFRESH_INTERVAL_MS);
+        },
+        handleError: () => {
+          if (cancelled) return;
+          pollTimeoutRef.current.timeoutId = null;
+        },
+        errorToast: ({ response }) => extractErrorMessage(response),
+      })
+    );
+  };
+
+  stopJobInvocationPolling(pollTimeoutRef);
+  pollTimeoutRef.current = createPollState(() => {
+    cancelled = true;
+  });
+
+  poll();
 };
 
-export const updateJob = jobId => dispatch => {
-  const url = foremanUrl(`/api/job_invocations/${jobId}`);
-  dispatch(
-    APIActions.get({
-      url,
-      key: UPDATE_JOB,
-      params: { include_hosts: false },
-    })
-  );
+export const stopJobInvocationPolling = pollTimeoutRef => {
+  clearTimeout(pollTimeoutRef.current.timeoutId);
+  pollTimeoutRef.current.cancel();
+  pollTimeoutRef.current = createPollState(() => {});
 };
 
 export const cancelJob = (jobId, force) => dispatch => {
@@ -54,10 +75,6 @@ export const cancelJob = (jobId, force) => dispatch => {
     force
       ? sprintf(__('Trying to abort the job %s.'), jobId)
       : sprintf(__('Trying to cancel the job %s.'), jobId);
-  const errorToast = response =>
-    force
-      ? sprintf(__(`Could not abort the job %s: ${response}`), jobId)
-      : sprintf(__(`Could not cancel the job %s: ${response}`), jobId);
   const url = force
     ? `/job_invocations/${jobId}/cancel?force=true`
     : `/job_invocations/${jobId}/cancel`;
@@ -67,12 +84,17 @@ export const cancelJob = (jobId, force) => dispatch => {
       url,
       key: CANCEL_JOB,
       errorToast: ({ response }) =>
-        errorToast(
-          // eslint-disable-next-line camelcase
-          response?.data?.error?.full_messages ||
-            response?.data?.error?.message ||
-            'Unknown error.'
-        ),
+        force
+          ? sprintf(
+              __('Could not abort the job %s: %s'),
+              jobId,
+              extractErrorMessage(response)
+            )
+          : sprintf(
+              __('Could not cancel the job %s: %s'),
+              jobId,
+              extractErrorMessage(response)
+            ),
       handleSuccess: () => {
         dispatch(
           addToast({
@@ -81,40 +103,16 @@ export const cancelJob = (jobId, force) => dispatch => {
             message: infoToast(),
           })
         );
-        dispatch(updateJob(jobId));
       },
     })
   );
 };
 
-export const getTask = taskId => dispatch => {
-  dispatch(
-    get({
-      key: GET_TASK,
-      url: `/foreman_tasks/api/tasks/${taskId}`,
-    })
-  );
-};
-
-export const enableRecurringLogic = (
-  recurrenceId,
-  enabled,
-  jobId
-) => dispatch => {
+export const enableRecurringLogic = (recurrenceId, enabled) => dispatch => {
   const successToast = () =>
     enabled
       ? sprintf(__('Recurring logic %s disabled successfully.'), recurrenceId)
       : sprintf(__('Recurring logic %s enabled successfully.'), recurrenceId);
-  const errorToast = response =>
-    enabled
-      ? sprintf(
-          __(`Could not disable recurring logic %s: ${response}`),
-          recurrenceId
-        )
-      : sprintf(
-          __(`Could not enable recurring logic %s: ${response}`),
-          recurrenceId
-        );
   const url = `/foreman_tasks/api/recurring_logics/${recurrenceId}`;
   dispatch(
     APIActions.put({
@@ -123,25 +121,24 @@ export const enableRecurringLogic = (
       params: { recurring_logic: { enabled: !enabled } },
       successToast,
       errorToast: ({ response }) =>
-        errorToast(
-          // eslint-disable-next-line camelcase
-          response?.data?.error?.full_messages ||
-            response?.data?.error?.message ||
-            'Unknown error.'
-        ),
-      handleSuccess: () => dispatch(updateJob(jobId)),
+        enabled
+          ? sprintf(
+              __('Could not disable recurring logic %s: %s'),
+              recurrenceId,
+              extractErrorMessage(response)
+            )
+          : sprintf(
+              __('Could not enable recurring logic %s: %s'),
+              recurrenceId,
+              extractErrorMessage(response)
+            ),
     })
   );
 };
 
-export const cancelRecurringLogic = (recurrenceId, jobId) => dispatch => {
+export const cancelRecurringLogic = recurrenceId => dispatch => {
   const successToast = () =>
     sprintf(__('Recurring logic %s cancelled successfully.'), recurrenceId);
-  const errorToast = response =>
-    sprintf(
-      __(`Could not cancel recurring logic %s: ${response}`),
-      recurrenceId
-    );
   const url = `/foreman_tasks/recurring_logics/${recurrenceId}/cancel`;
   dispatch(
     APIActions.post({
@@ -149,13 +146,11 @@ export const cancelRecurringLogic = (recurrenceId, jobId) => dispatch => {
       key: CANCEL_RECURRING_LOGIC,
       successToast,
       errorToast: ({ response }) =>
-        errorToast(
-          // eslint-disable-next-line camelcase
-          response?.data?.error?.full_messages ||
-            response?.data?.error?.message ||
-            'Unknown error.'
+        sprintf(
+          __('Could not cancel recurring logic %s: %s'),
+          recurrenceId,
+          extractErrorMessage(response)
         ),
-      handleSuccess: () => dispatch(updateJob(jobId)),
     })
   );
 };

data/webpack/JobInvocationDetail/JobInvocationConstants.js

@@ -6,9 +6,7 @@ import { useForemanHostDetailsPageUrl } from 'foremanReact/Root/Context/ForemanC
 import JobStatusIcon from '../react_app/components/RecentJobsCard/JobStatusIcon';
 
 export const JOB_INVOCATION_KEY = 'JOB_INVOCATION_KEY';
-export const UPDATE_JOB = 'UPDATE_JOB';
 export const CANCEL_JOB = 'CANCEL_JOB';
-export const GET_TASK = 'GET_TASK';
 export const GET_TEMPLATE_INVOCATIONS = 'GET_TEMPLATE_INVOCATIONS';
 export const CHANGE_ENABLED_RECURRING_LOGIC = 'CHANGE_ENABLED_RECURRING_LOGIC';
 export const CANCEL_RECURRING_LOGIC = 'CANCEL_RECURRING_LOGIC';
@@ -17,12 +15,15 @@ export const GET_REPORT_TEMPLATE_INPUTS = 'GET_REPORT_TEMPLATE_INPUTS';
 export const JOB_INVOCATION_HOSTS = 'JOB_INVOCATION_HOSTS';
 export const GET_TEMPLATE_INVOCATION = 'GET_TEMPLATE_INVOCATION';
 export const DIRECT_OPEN_HOST_LIMIT = 3;
-export const ALL_JOB_HOSTS = 'ALL_JOB_HOSTS';
 export const AWAITING_STATUS_FILTER = '(job_invocation.result = N/A)';
 
+export const AUTO_REFRESH_INTERVAL_MS = 5000;
+export const DEFAULT_CHART_LEGEND_WIDTH = 270;
+export const CLIPBOARD_COPIED_EXIT_DELAY_MS = 1500;
+export const CLIPBOARD_DEFAULT_EXIT_DELAY_MS = 600;
+
 export const showTemplateInvocationUrl = (hostID, jobID) =>
   `/show_template_invocation_by_host/${hostID}/job_invocation/${jobID}`;
-export const LIST_TEMPLATE_INVOCATIONS = 'LIST_TEMPLATE_INVOCATIONS';
 
 export const templateInvocationPageUrl = (hostID, jobID) =>
   `/job_invocations_detail/${jobID}/host_invocation/${hostID}`;
@@ -38,6 +39,7 @@ export const STATUS = {
   SUCCEEDED: 'succeeded',
   FAILED: 'failed',
   CANCELLED: 'cancelled',
+  RUNNING: 'running',
 };
 
 export const STATUS_UPPERCASE = {

data/webpack/JobInvocationDetail/JobInvocationDetail.scss

@@ -1,5 +1,6 @@
 .job-invocation-detail-flex {
   $chart_size: 105px;
+
   padding-top: 0px;
   padding-left: 10px;
   display: flex;
@@ -92,16 +93,17 @@ section.job-additional-info {
       max-height: 25em;
     }
   }
+
   div.invocation-output {
     display: block;
     padding: 9.5px;
     margin: 0 0 10px;
     font-size: 12px;
     word-break: break-all;
-    word-wrap: break-word;
+    overflow-wrap: break-word;
     color: rgba(255, 255, 255, 1);
     background-color: rgba(47, 47, 47, 1);
-    border: 1px solid #000000;
+    border: 1px solid #000;
     border-radius: 0px;
     font-family: Menlo, Monaco, Consolas, monospace;
 
@@ -127,7 +129,7 @@ section.job-additional-info {
     }
 
     a {
-      color: #ffffff;
+      color: #fff;
     }
 
     a.scroll-link{